Package org.lwjgl.vulkan
Class VkImageSubresource
- 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.NativeResourceStructure specifying an image subresource.Valid Usage (Implicit)
aspectMaskmust be a valid combination ofVkImageAspectFlagBitsvaluesaspectMaskmust not be 0
See Also
VkSparseImageMemoryBind,GetImageSubresourceLayoutMember documentation
aspectMask– aVkImageAspectFlagsselecting 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 Description static classVkImageSubresource.BufferAn array ofVkImageSubresourcestructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intARRAYLAYER
ASPECTMASK
MIPLEVELThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkImageSubresource(java.nio.ByteBuffer container)Creates aVkImageSubresourceinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intarrayLayer()Returns the value of thearrayLayerfield.VkImageSubresourcearrayLayer(int value)Sets the specified value to thearrayLayerfield.intaspectMask()Returns the value of theaspectMaskfield.VkImageSubresourceaspectMask(int value)Sets the specified value to theaspectMaskfield.static VkImageSubresourcecalloc()Returns a newVkImageSubresourceinstance allocated withmemCalloc.static VkImageSubresource.Buffercalloc(int capacity)Returns a newVkImageSubresource.Bufferinstance allocated withmemCalloc.static VkImageSubresourcecallocStack()Returns a newVkImageSubresourceinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageSubresource.BuffercallocStack(int capacity)Returns a newVkImageSubresource.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageSubresource.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresource.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourcecallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresourceinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourcecreate()Returns a newVkImageSubresourceinstance allocated withBufferUtils.static VkImageSubresource.Buffercreate(int capacity)Returns a newVkImageSubresource.Bufferinstance allocated withBufferUtils.static VkImageSubresourcecreate(long address)Returns a newVkImageSubresourceinstance for the specified memory address.static VkImageSubresource.Buffercreate(long address, int capacity)Create aVkImageSubresource.Bufferinstance at the specified memory.static VkImageSubresourcecreateSafe(long address)static VkImageSubresource.BuffercreateSafe(long address, int capacity)static VkImageSubresourcemalloc()Returns a newVkImageSubresourceinstance allocated withmemAlloc.static VkImageSubresource.Buffermalloc(int capacity)Returns a newVkImageSubresource.Bufferinstance allocated withmemAlloc.static VkImageSubresourcemallocStack()Returns a newVkImageSubresourceinstance allocated on the thread-localMemoryStack.static VkImageSubresource.BuffermallocStack(int capacity)Returns a newVkImageSubresource.Bufferinstance allocated on the thread-localMemoryStack.static VkImageSubresource.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresource.Bufferinstance allocated on the specifiedMemoryStack.static VkImageSubresourcemallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresourceinstance allocated on the specifiedMemoryStack.intmipLevel()Returns the value of themipLevelfield.VkImageSubresourcemipLevel(int value)Sets the specified value to themipLevelfield.static intnarrayLayer(long struct)Unsafe version ofarrayLayer().static voidnarrayLayer(long struct, int value)Unsafe version ofarrayLayer.static intnaspectMask(long struct)Unsafe version ofaspectMask().static voidnaspectMask(long struct, int value)Unsafe version ofaspectMask.static intnmipLevel(long struct)Unsafe version ofmipLevel().static voidnmipLevel(long struct, int value)Unsafe version ofmipLevel.VkImageSubresourceset(int aspectMask, int mipLevel, int arrayLayer)Initializes this struct with the specified values.VkImageSubresourceset(VkImageSubresource src)Copies the specified struct data to this struct.intsizeof()
-
-
-
Constructor Detail
-
VkImageSubresource
public VkImageSubresource(java.nio.ByteBuffer container)
Creates aVkImageSubresourceinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
aspectMask
public int aspectMask()
Returns the value of theaspectMaskfield.
-
mipLevel
public int mipLevel()
Returns the value of themipLevelfield.
-
arrayLayer
public int arrayLayer()
Returns the value of thearrayLayerfield.
-
aspectMask
public VkImageSubresource aspectMask(int value)
Sets the specified value to theaspectMaskfield.
-
mipLevel
public VkImageSubresource mipLevel(int value)
Sets the specified value to themipLevelfield.
-
arrayLayer
public VkImageSubresource arrayLayer(int value)
Sets the specified value to thearrayLayerfield.
-
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 newVkImageSubresourceinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageSubresource calloc()
Returns a newVkImageSubresourceinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageSubresource create()
Returns a newVkImageSubresourceinstance allocated withBufferUtils.
-
create
public static VkImageSubresource create(long address)
Returns a newVkImageSubresourceinstance for the specified memory address.
-
createSafe
@Nullable public static VkImageSubresource createSafe(long address)
-
malloc
public static VkImageSubresource.Buffer malloc(int capacity)
Returns a newVkImageSubresource.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageSubresource.Buffer calloc(int capacity)
Returns a newVkImageSubresource.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageSubresource.Buffer create(int capacity)
Returns a newVkImageSubresource.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageSubresource.Buffer create(long address, int capacity)
Create aVkImageSubresource.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkImageSubresource.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkImageSubresource mallocStack()
Returns a newVkImageSubresourceinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImageSubresource callocStack()
Returns a newVkImageSubresourceinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImageSubresource mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImageSubresource callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImageSubresource.Buffer mallocStack(int capacity)
Returns a newVkImageSubresource.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImageSubresource.Buffer callocStack(int capacity)
Returns a newVkImageSubresource.Bufferinstance allocated on the thread-localMemoryStackand 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 newVkImageSubresource.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImageSubresource.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresource.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
naspectMask
public static int naspectMask(long struct)
Unsafe version ofaspectMask().
-
nmipLevel
public static int nmipLevel(long struct)
Unsafe version ofmipLevel().
-
narrayLayer
public static int narrayLayer(long struct)
Unsafe version ofarrayLayer().
-
naspectMask
public static void naspectMask(long struct, int value)Unsafe version ofaspectMask.
-
nmipLevel
public static void nmipLevel(long struct, int value)Unsafe version ofmipLevel.
-
narrayLayer
public static void narrayLayer(long struct, int value)Unsafe version ofarrayLayer.
-
-