Package org.lwjgl.vulkan
Class VkImageSubresourceLayers
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageSubresourceLayers
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageSubresourceLayers extends Struct
Khronos Reference Page
Vulkan SpecificationSpecifies an image subresource of an image.
Valid Usage
aspectMaskmust be a valid combination ofVkImageAspectFlagBitsvaluesaspectMaskmust not be 0- If
aspectMaskcontainsIMAGE_ASPECT_COLOR_BIT, it must not contain either ofIMAGE_ASPECT_DEPTH_BITorIMAGE_ASPECT_STENCIL_BIT aspectMaskmust not containIMAGE_ASPECT_METADATA_BITmipLevelmust be less than themipLevelsspecified inVkImageCreateInfowhen the image was createdbaseArrayLayer + layerCountmust be less than or equal to thearrayLayersspecified inVkImageCreateInfowhen the image was created
Member documentation
aspectMask– a combination ofVkImageAspectFlagBits, selecting the color, depth and/or stencil aspects. One or more of:IMAGE_ASPECT_COLOR_BITIMAGE_ASPECT_DEPTH_BITIMAGE_ASPECT_METADATA_BITIMAGE_ASPECT_STENCIL_BITmipLevel– the mipmap levelbaseArrayLayer– the starting layerlayerCount– the number of layers
Layout
struct VkImageSubresourceLayers { VkImageAspectFlags aspectMask; uint32_t mipLevel; uint32_t baseArrayLayer; uint32_t layerCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkImageSubresourceLayers.BufferAn array ofVkImageSubresourceLayersstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkImageSubresourceLayers(java.nio.ByteBuffer container)Creates aVkImageSubresourceLayersinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description intaspectMask()Returns the value of theaspectMaskfield.VkImageSubresourceLayersaspectMask(int value)Sets the specified value to theaspectMaskfield.intbaseArrayLayer()Returns the value of thebaseArrayLayerfield.VkImageSubresourceLayersbaseArrayLayer(int value)Sets the specified value to thebaseArrayLayerfield.static VkImageSubresourceLayerscalloc()Returns a newVkImageSubresourceLayersinstance allocated withmemCalloc.static VkImageSubresourceLayers.Buffercalloc(int capacity)Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemCalloc.static VkImageSubresourceLayerscallocStack()Returns a newVkImageSubresourceLayersinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayers.BuffercallocStack(int capacity)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayers.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayerscallocStack(MemoryStack stack)Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayerscreate()Returns a newVkImageSubresourceLayersinstance allocated withBufferUtils.static VkImageSubresourceLayers.Buffercreate(int capacity)Returns a newVkImageSubresourceLayers.Bufferinstance allocated withBufferUtils.static VkImageSubresourceLayerscreate(long address)Returns a newVkImageSubresourceLayersinstance for the specified memory address ornullif the address isNULL.static VkImageSubresourceLayers.Buffercreate(long address, int capacity)Create aVkImageSubresourceLayers.Bufferinstance at the specified memory.intlayerCount()Returns the value of thelayerCountfield.VkImageSubresourceLayerslayerCount(int value)Sets the specified value to thelayerCountfield.static VkImageSubresourceLayersmalloc()Returns a newVkImageSubresourceLayersinstance allocated withmemAlloc.static VkImageSubresourceLayers.Buffermalloc(int capacity)Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemAlloc.static VkImageSubresourceLayersmallocStack()Returns a newVkImageSubresourceLayersinstance allocated on the thread-localMemoryStack.static VkImageSubresourceLayers.BuffermallocStack(int capacity)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the thread-localMemoryStack.static VkImageSubresourceLayers.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStack.static VkImageSubresourceLayersmallocStack(MemoryStack stack)Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.intmipLevel()Returns the value of themipLevelfield.VkImageSubresourceLayersmipLevel(int value)Sets the specified value to themipLevelfield.VkImageSubresourceLayersnset(long struct)Unsafe version ofset.VkImageSubresourceLayersset(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)Initializes this struct with the specified values.VkImageSubresourceLayersset(VkImageSubresourceLayers src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkImageSubresourceLayers
public VkImageSubresourceLayers(java.nio.ByteBuffer container)
Creates aVkImageSubresourceLayersinstance 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()
Description copied from class:StructReturns thesizeof(struct).
-
aspectMask
public int aspectMask()
Returns the value of theaspectMaskfield.
-
mipLevel
public int mipLevel()
Returns the value of themipLevelfield.
-
baseArrayLayer
public int baseArrayLayer()
Returns the value of thebaseArrayLayerfield.
-
layerCount
public int layerCount()
Returns the value of thelayerCountfield.
-
aspectMask
public VkImageSubresourceLayers aspectMask(int value)
Sets the specified value to theaspectMaskfield.
-
mipLevel
public VkImageSubresourceLayers mipLevel(int value)
Sets the specified value to themipLevelfield.
-
baseArrayLayer
public VkImageSubresourceLayers baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayerfield.
-
layerCount
public VkImageSubresourceLayers layerCount(int value)
Sets the specified value to thelayerCountfield.
-
set
public VkImageSubresourceLayers set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Initializes this struct with the specified values.
-
nset
public VkImageSubresourceLayers nset(long struct)
Unsafe version ofset.
-
set
public VkImageSubresourceLayers set(VkImageSubresourceLayers src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkImageSubresourceLayers malloc()
Returns a newVkImageSubresourceLayersinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkImageSubresourceLayers calloc()
Returns a newVkImageSubresourceLayersinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkImageSubresourceLayers create()
Returns a newVkImageSubresourceLayersinstance allocated withBufferUtils.
-
create
public static VkImageSubresourceLayers create(long address)
Returns a newVkImageSubresourceLayersinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkImageSubresourceLayers.Buffer malloc(int capacity)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkImageSubresourceLayers.Buffer calloc(int capacity)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageSubresourceLayers.Buffer create(int capacity)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkImageSubresourceLayers.Buffer create(long address, int capacity)
Create aVkImageSubresourceLayers.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkImageSubresourceLayers mallocStack()
Returns a newVkImageSubresourceLayersinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkImageSubresourceLayers callocStack()
Returns a newVkImageSubresourceLayersinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkImageSubresourceLayers mallocStack(MemoryStack stack)
Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImageSubresourceLayers callocStack(MemoryStack stack)
Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkImageSubresourceLayers.Buffer mallocStack(int capacity)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkImageSubresourceLayers.Buffer callocStack(int capacity)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkImageSubresourceLayers.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkImageSubresourceLayers.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-