VkImageSubresource (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkImageSubresource

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageSubresource
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an image subresource.
Valid Usage (Implicit)
- aspectMask must be a valid combination of VkImageAspectFlagBits values
- aspectMask must not be 0
See Also

VkSparseImageMemoryBind, GetImageSubresourceLayout

Member documentation
- aspectMask – a VkImageAspectFlags selecting the image aspect.
- mipLevel – selects the mipmap level.
- arrayLayer – selects the array layer.
Layout
```
 struct VkImageSubresource {
     VkImageAspectFlags aspectMask;
     uint32_t mipLevel;
     uint32_t arrayLayer;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageSubresource.Buffer
An array of VkImageSubresource structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkImageSubresource.Buffer` An array of `VkImageSubresource` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`ARRAYLAYER` The struct member offsets.
`static int`	`ASPECTMASK` The struct member offsets.
`static int`	`MIPLEVEL` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkImageSubresource(java.nio.ByteBuffer container)` Creates a `VkImageSubresource` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`arrayLayer()` Returns the value of the `arrayLayer` field.
`VkImageSubresource`	`arrayLayer(int value)` Sets the specified value to the `arrayLayer` field.
`int`	`aspectMask()` Returns the value of the `aspectMask` field.
`VkImageSubresource`	`aspectMask(int value)` Sets the specified value to the `aspectMask` field.
`static VkImageSubresource`	`calloc()` Returns a new `VkImageSubresource` instance allocated with `memCalloc`.
`static VkImageSubresource.Buffer`	`calloc(int capacity)` Returns a new `VkImageSubresource.Buffer` instance allocated with `memCalloc`.
`static VkImageSubresource`	`callocStack()` Returns a new `VkImageSubresource` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresource.Buffer`	`callocStack(int capacity)` Returns a new `VkImageSubresource.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresource.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresource.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresource`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresource` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageSubresource`	`create()` Returns a new `VkImageSubresource` instance allocated with `BufferUtils`.
`static VkImageSubresource.Buffer`	`create(int capacity)` Returns a new `VkImageSubresource.Buffer` instance allocated with `BufferUtils`.
`static VkImageSubresource`	`create(long address)` Returns a new `VkImageSubresource` instance for the specified memory address.
`static VkImageSubresource.Buffer`	`create(long address, int capacity)` Create a `VkImageSubresource.Buffer` instance at the specified memory.
`static VkImageSubresource`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageSubresource.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageSubresource`	`malloc()` Returns a new `VkImageSubresource` instance allocated with `memAlloc`.
`static VkImageSubresource.Buffer`	`malloc(int capacity)` Returns a new `VkImageSubresource.Buffer` instance allocated with `memAlloc`.
`static VkImageSubresource`	`mallocStack()` Returns a new `VkImageSubresource` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresource.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageSubresource.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageSubresource.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresource.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageSubresource`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageSubresource` instance allocated on the specified `MemoryStack`.
`int`	`mipLevel()` Returns the value of the `mipLevel` field.
`VkImageSubresource`	`mipLevel(int value)` Sets the specified value to the `mipLevel` field.
`static int`	`narrayLayer(long struct)` Unsafe version of `arrayLayer()`.
`static void`	`narrayLayer(long struct, int value)` Unsafe version of `arrayLayer`.
`static int`	`naspectMask(long struct)` Unsafe version of `aspectMask()`.
`static void`	`naspectMask(long struct, int value)` Unsafe version of `aspectMask`.
`static int`	`nmipLevel(long struct)` Unsafe version of `mipLevel()`.
`static void`	`nmipLevel(long struct, int value)` Unsafe version of `mipLevel`.
`VkImageSubresource`	`set(int aspectMask, int mipLevel, int arrayLayer)` Initializes this struct with the specified values.
`VkImageSubresource`	`set(VkImageSubresource src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - ASPECTMASK
```
public static final int ASPECTMASK
```
    The struct member offsets.
  - MIPLEVEL
```
public static final int MIPLEVEL
```
    The struct member offsets.
  - ARRAYLAYER
```
public static final int ARRAYLAYER
```
    The struct member offsets.
- Constructor Detail
  - VkImageSubresource
```
public VkImageSubresource(java.nio.ByteBuffer container)
```
    Creates a VkImageSubresource instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - aspectMask
```
public int aspectMask()
```
    Returns the value of the aspectMask field.
  - mipLevel
```
public int mipLevel()
```
    Returns the value of the mipLevel field.
  - arrayLayer
```
public int arrayLayer()
```
    Returns the value of the arrayLayer field.
  - aspectMask
```
public VkImageSubresource aspectMask(int value)
```
    Sets the specified value to the aspectMask field.
  - mipLevel
```
public VkImageSubresource mipLevel(int value)
```
    Sets the specified value to the mipLevel field.
  - arrayLayer
```
public VkImageSubresource arrayLayer(int value)
```
    Sets the specified value to the arrayLayer field.
  - set
```
public VkImageSubresource set(int aspectMask,
                              int mipLevel,
                              int arrayLayer)
```
    Initializes this struct with the specified values.
  - set
```
public VkImageSubresource set(VkImageSubresource src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageSubresource malloc()
```
    Returns a new VkImageSubresource instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageSubresource calloc()
```
    Returns a new VkImageSubresource instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageSubresource create()
```
    Returns a new VkImageSubresource instance allocated with BufferUtils.
  - create
```
public static VkImageSubresource create(long address)
```
    Returns a new VkImageSubresource instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImageSubresource createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImageSubresource.Buffer malloc(int capacity)
```
    Returns a new VkImageSubresource.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageSubresource.Buffer calloc(int capacity)
```
    Returns a new VkImageSubresource.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresource.Buffer create(int capacity)
```
    Returns a new VkImageSubresource.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageSubresource.Buffer create(long address,
                                               int capacity)
```
    Create a VkImageSubresource.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImageSubresource.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkImageSubresource mallocStack()
```
    Returns a new VkImageSubresource instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageSubresource callocStack()
```
    Returns a new VkImageSubresource instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageSubresource mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresource instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageSubresource callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresource instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageSubresource.Buffer mallocStack(int capacity)
```
    Returns a new VkImageSubresource.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresource.Buffer callocStack(int capacity)
```
    Returns a new VkImageSubresource.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageSubresource.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresource.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageSubresource.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageSubresource.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - naspectMask
```
public static int naspectMask(long struct)
```
    Unsafe version of aspectMask().
  - nmipLevel
```
public static int nmipLevel(long struct)
```
    Unsafe version of mipLevel().
  - narrayLayer
```
public static int narrayLayer(long struct)
```
    Unsafe version of arrayLayer().
  - naspectMask
```
public static void naspectMask(long struct,
                               int value)
```
    Unsafe version of aspectMask.
  - nmipLevel
```
public static void nmipLevel(long struct,
                             int value)
```
    Unsafe version of mipLevel.
  - narrayLayer
```
public static void narrayLayer(long struct,
                               int value)
```
    Unsafe version of arrayLayer.

Class VkImageSubresource

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ASPECTMASK

MIPLEVEL

ARRAYLAYER

Constructor Detail

VkImageSubresource

Method Detail

sizeof

aspectMask

mipLevel

arrayLayer

aspectMask

mipLevel

arrayLayer

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

naspectMask

nmipLevel

narrayLayer

naspectMask

nmipLevel

narrayLayer