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.NativeResource
Structure specifying an image subresource layers.Valid Usage
- If
aspectMask
containsIMAGE_ASPECT_COLOR_BIT
, it must not contain either ofIMAGE_ASPECT_DEPTH_BIT
orIMAGE_ASPECT_STENCIL_BIT
aspectMask
must not containIMAGE_ASPECT_METADATA_BIT
aspectMask
must not includeVK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
for any indexi
.layerCount
must be greater than 0
Valid Usage (Implicit)
aspectMask
must be a valid combination ofVkImageAspectFlagBits
valuesaspectMask
must not be 0
See Also
VkBufferImageCopy
,VkImageBlit
,VkImageCopy
,VkImageResolve
Member documentation
aspectMask
– a combination ofVkImageAspectFlagBits
, selecting the color, depth and/or stencil aspects to be copied.mipLevel
– the mipmap level to copy from.baseArrayLayer
–baseArrayLayer
andlayerCount
are 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 class
VkImageSubresourceLayers.Buffer
An array ofVkImageSubresourceLayers
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ASPECTMASK
BASEARRAYLAYER
LAYERCOUNT
MIPLEVELThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkImageSubresourceLayers(java.nio.ByteBuffer container)
Creates aVkImageSubresourceLayers
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
aspectMask()
Returns the value of theaspectMask
field.VkImageSubresourceLayers
aspectMask(int value)
Sets the specified value to theaspectMask
field.int
baseArrayLayer()
Returns the value of thebaseArrayLayer
field.VkImageSubresourceLayers
baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayer
field.static VkImageSubresourceLayers
calloc()
Returns a newVkImageSubresourceLayers
instance allocated withmemCalloc
.static VkImageSubresourceLayers.Buffer
calloc(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withmemCalloc
.static VkImageSubresourceLayers
callocStack()
Returns a newVkImageSubresourceLayers
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageSubresourceLayers.Buffer
callocStack(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageSubresourceLayers.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageSubresourceLayers
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageSubresourceLayers
create()
Returns a newVkImageSubresourceLayers
instance allocated withBufferUtils
.static VkImageSubresourceLayers.Buffer
create(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withBufferUtils
.static VkImageSubresourceLayers
create(long address)
Returns a newVkImageSubresourceLayers
instance for the specified memory address.static VkImageSubresourceLayers.Buffer
create(long address, int capacity)
Create aVkImageSubresourceLayers.Buffer
instance at the specified memory.static VkImageSubresourceLayers
createSafe(long address)
static VkImageSubresourceLayers.Buffer
createSafe(long address, int capacity)
int
layerCount()
Returns the value of thelayerCount
field.VkImageSubresourceLayers
layerCount(int value)
Sets the specified value to thelayerCount
field.static VkImageSubresourceLayers
malloc()
Returns a newVkImageSubresourceLayers
instance allocated withmemAlloc
.static VkImageSubresourceLayers.Buffer
malloc(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withmemAlloc
.static VkImageSubresourceLayers
mallocStack()
Returns a newVkImageSubresourceLayers
instance allocated on the thread-localMemoryStack
.static VkImageSubresourceLayers.Buffer
mallocStack(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageSubresourceLayers.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageSubresourceLayers
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers
instance allocated on the specifiedMemoryStack
.int
mipLevel()
Returns the value of themipLevel
field.VkImageSubresourceLayers
mipLevel(int value)
Sets the specified value to themipLevel
field.static int
naspectMask(long struct)
Unsafe version ofaspectMask()
.static void
naspectMask(long struct, int value)
Unsafe version ofaspectMask
.static int
nbaseArrayLayer(long struct)
Unsafe version ofbaseArrayLayer()
.static void
nbaseArrayLayer(long struct, int value)
Unsafe version ofbaseArrayLayer
.static int
nlayerCount(long struct)
Unsafe version oflayerCount()
.static void
nlayerCount(long struct, int value)
Unsafe version oflayerCount
.static int
nmipLevel(long struct)
Unsafe version ofmipLevel()
.static void
nmipLevel(long struct, int value)
Unsafe version ofmipLevel
.VkImageSubresourceLayers
set(int aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Initializes this struct with the specified values.VkImageSubresourceLayers
set(VkImageSubresourceLayers src)
Copies the specified struct data to this struct.int
sizeof()
-
-
-
Constructor Detail
-
VkImageSubresourceLayers
public VkImageSubresourceLayers(java.nio.ByteBuffer container)
Creates aVkImageSubresourceLayers
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
aspectMask
public int aspectMask()
Returns the value of theaspectMask
field.
-
mipLevel
public int mipLevel()
Returns the value of themipLevel
field.
-
baseArrayLayer
public int baseArrayLayer()
Returns the value of thebaseArrayLayer
field.
-
layerCount
public int layerCount()
Returns the value of thelayerCount
field.
-
aspectMask
public VkImageSubresourceLayers aspectMask(int value)
Sets the specified value to theaspectMask
field.
-
mipLevel
public VkImageSubresourceLayers mipLevel(int value)
Sets the specified value to themipLevel
field.
-
baseArrayLayer
public VkImageSubresourceLayers baseArrayLayer(int value)
Sets the specified value to thebaseArrayLayer
field.
-
layerCount
public VkImageSubresourceLayers layerCount(int value)
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
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 newVkImageSubresourceLayers
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageSubresourceLayers calloc()
Returns a newVkImageSubresourceLayers
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageSubresourceLayers create()
Returns a newVkImageSubresourceLayers
instance allocated withBufferUtils
.
-
create
public static VkImageSubresourceLayers create(long address)
Returns a newVkImageSubresourceLayers
instance for the specified memory address.
-
createSafe
@Nullable public static VkImageSubresourceLayers createSafe(long address)
-
malloc
public static VkImageSubresourceLayers.Buffer malloc(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageSubresourceLayers.Buffer calloc(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageSubresourceLayers.Buffer create(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageSubresourceLayers.Buffer create(long address, int capacity)
Create aVkImageSubresourceLayers.Buffer
instance 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 newVkImageSubresourceLayers
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageSubresourceLayers callocStack()
Returns a newVkImageSubresourceLayers
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageSubresourceLayers mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageSubresourceLayers callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkImageSubresourceLayers
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageSubresourceLayers.Buffer callocStack(int capacity)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-