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,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkImageSubresourceLayers extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying an image subresource layers.Valid Usage
- If
aspectMaskcontainsIMAGE_ASPECT_COLOR_BIT, it must not contain either ofIMAGE_ASPECT_DEPTH_BITorIMAGE_ASPECT_STENCIL_BIT aspectMaskmust not containIMAGE_ASPECT_METADATA_BITaspectMaskmust not includeVK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXTfor any indexi.layerCountmust be greater than 0
Valid Usage (Implicit)
aspectMaskmust be a valid combination ofVkImageAspectFlagBitsvaluesaspectMaskmust not be 0
See Also
VkBufferImageCopy,VkImageBlit,VkImageCopy,VkImageResolveMember documentation
aspectMask– a combination ofVkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.mipLevel– the mipmap level to copy from.baseArrayLayer–baseArrayLayerandlayerCountare the starting layer and number of layers to copy.layerCount– seebaseArrayLayer
Layout
struct VkImageSubresourceLayers { VkImageAspectFlags aspectMask; uint32_t mipLevel; uint32_t baseArrayLayer; uint32_t layerCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkImageSubresourceLayers.BufferAn array ofVkImageSubresourceLayersstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intASPECTMASK
BASEARRAYLAYER
LAYERCOUNT
MIPLEVELThe struct member offsets.static intSIZEOFThe struct size in bytes.
-
Constructor Summary
Constructors Constructor 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 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, org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayerscallocStack(org.lwjgl.system.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.static VkImageSubresourceLayers.Buffercreate(long address, int capacity)Create aVkImageSubresourceLayers.Bufferinstance at the specified memory.static VkImageSubresourceLayerscreateSafe(long address)static VkImageSubresourceLayers.BuffercreateSafe(long address, int capacity)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, org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStack.static VkImageSubresourceLayersmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.intmipLevel()Returns the value of themipLevelfield.VkImageSubresourceLayersmipLevel(int value)Sets the specified value to themipLevelfield.static intnaspectMask(long struct)Unsafe version ofaspectMask().static voidnaspectMask(long struct, int value)Unsafe version ofaspectMask.static intnbaseArrayLayer(long struct)Unsafe version ofbaseArrayLayer().static voidnbaseArrayLayer(long struct, int value)Unsafe version ofbaseArrayLayer.static intnlayerCount(long struct)Unsafe version oflayerCount().static voidnlayerCount(long struct, int value)Unsafe version oflayerCount.static intnmipLevel(long struct)Unsafe version ofmipLevel().static voidnmipLevel(long struct, int value)Unsafe version ofmipLevel.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()
-
-
-
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()
- 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.
-
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.
-
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.
-
createSafe
@Nullable public static VkImageSubresourceLayers createSafe(long address)
-
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
-
createSafe
@Nullable public static VkImageSubresourceLayers.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkImageSubresourceLayers callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
naspectMask
public static int naspectMask(long struct)
Unsafe version ofaspectMask().
-
nmipLevel
public static int nmipLevel(long struct)
Unsafe version ofmipLevel().
-
nbaseArrayLayer
public static int nbaseArrayLayer(long struct)
Unsafe version ofbaseArrayLayer().
-
nlayerCount
public static int nlayerCount(long struct)
Unsafe version oflayerCount().
-
naspectMask
public static void naspectMask(long struct, int value)Unsafe version ofaspectMask.
-
nmipLevel
public static void nmipLevel(long struct, int value)Unsafe version ofmipLevel.
-
nbaseArrayLayer
public static void nbaseArrayLayer(long struct, int value)Unsafe version ofbaseArrayLayer.
-
nlayerCount
public static void nlayerCount(long struct, int value)Unsafe version oflayerCount.
-
-