Package org.lwjgl.vulkan
Class VkImageSubresourceLayers
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkImageSubresourceLayers>
org.lwjgl.vulkan.VkImageSubresourceLayers
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkImageSubresourceLayers
extends org.lwjgl.system.Struct<VkImageSubresourceLayers>
implements org.lwjgl.system.NativeResource
Structure 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 index i- If the
maintenance5feature is not enabled,layerCountmust not beREMAINING_ARRAY_LAYERS - If
layerCountis notREMAINING_ARRAY_LAYERS, it must be greater than 0
Valid Usage (Implicit)
aspectMaskmust be a valid combination ofVkImageAspectFlagBitsvaluesaspectMaskmust not be 0
See Also
VkBufferImageCopy, VkBufferImageCopy2, VkCopyMemoryToImageIndirectCommandNV, VkImageBlit, VkImageBlit2, VkImageCopy, VkImageCopy2, VkImageResolve, VkImageResolve2, VkImageToMemoryCopy, VkMemoryToImageCopy, CmdCopyMemoryToImageIndirectNV
Layout
struct VkImageSubresourceLayers {
VkImageAspectFlags aspectMask();
uint32_t mipLevel();
uint32_t baseArrayLayer();
uint32_t layerCount();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkImageSubresourceLayers(ByteBuffer container) Creates aVkImageSubresourceLayersinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioninta combination ofVkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied.aspectMask(int value) Sets the specified value to theaspectMask()field.intbaseArrayLayerandlayerCountare the starting layer and number of layers to copy.baseArrayLayer(int value) Sets the specified value to thebaseArrayLayer()field.static VkImageSubresourceLayerscalloc()Returns a newVkImageSubresourceLayersinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayerscalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkImageSubresourceLayersDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageSubresourceLayerscallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageSubresourceLayerscreate()Returns a newVkImageSubresourceLayersinstance allocated withBufferUtils.create(int capacity) Returns a newVkImageSubresourceLayers.Bufferinstance allocated withBufferUtils.static VkImageSubresourceLayerscreate(long address) Returns a newVkImageSubresourceLayersinstance for the specified memory address.create(long address, int capacity) Create aVkImageSubresourceLayers.Bufferinstance at the specified memory.static @Nullable VkImageSubresourceLayerscreateSafe(long address) static @Nullable VkImageSubresourceLayers.BuffercreateSafe(long address, int capacity) intseebaseArrayLayerlayerCount(int value) Sets the specified value to thelayerCount()field.static VkImageSubresourceLayersmalloc()Returns a newVkImageSubresourceLayersinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStack.static VkImageSubresourceLayersmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.static VkImageSubresourceLayersDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkImageSubresourceLayersmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.intmipLevel()the mipmap level to copymipLevel(int value) Sets the specified value to themipLevel()field.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.set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
ASPECTMASK
public static final int ASPECTMASKThe struct member offsets. -
MIPLEVEL
public static final int MIPLEVELThe struct member offsets. -
BASEARRAYLAYER
public static final int BASEARRAYLAYERThe struct member offsets. -
LAYERCOUNT
public static final int LAYERCOUNTThe struct member offsets.
-
-
Constructor Details
-
VkImageSubresourceLayers
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkImageSubresourceLayers>
-
aspectMask
public int aspectMask()a combination ofVkImageAspectFlagBits, selecting the color, depth and/or stencil aspects to be copied. -
mipLevel
public int mipLevel()the mipmap level to copy -
baseArrayLayer
public int baseArrayLayer()baseArrayLayerandlayerCountare the starting layer and number of layers to copy. -
layerCount
public int layerCount()seebaseArrayLayer -
aspectMask
Sets the specified value to theaspectMask()field. -
mipLevel
Sets the specified value to themipLevel()field. -
baseArrayLayer
Sets the specified value to thebaseArrayLayer()field. -
layerCount
Sets the specified value to thelayerCount()field. -
set
public VkImageSubresourceLayers set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkImageSubresourceLayersinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkImageSubresourceLayersinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkImageSubresourceLayersinstance allocated withBufferUtils. -
create
Returns a newVkImageSubresourceLayersinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkImageSubresourceLayers.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkImageSubresourceLayers.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkImageSubresourceLayers.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkImageSubresourceLayers.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkImageSubresourceLayersinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkImageSubresourceLayers.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkImageSubresourceLayers.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkImageSubresourceLayers.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
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.
-