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
aspectMask
must be a valid combination ofVkImageAspectFlagBits
valuesaspectMask
must not be 0- 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
mipLevel
must be less than themipLevels
specified inVkImageCreateInfo
when the image was createdbaseArrayLayer + layerCount
must be less than or equal to thearrayLayers
specified inVkImageCreateInfo
when 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_BIT
IMAGE_ASPECT_DEPTH_BIT
IMAGE_ASPECT_METADATA_BIT
IMAGE_ASPECT_STENCIL_BIT
mipLevel
– 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 class
VkImageSubresourceLayers.Buffer
An array ofVkImageSubresourceLayers
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkImageSubresourceLayers
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and 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, MemoryStack stack)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageSubresourceLayers
callocStack(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 ornull
if the address isNULL
.static VkImageSubresourceLayers.Buffer
create(long address, int capacity)
Create aVkImageSubresourceLayers.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkImageSubresourceLayers.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageSubresourceLayers
mallocStack(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.VkImageSubresourceLayers
nset(long struct)
Unsafe version ofset
.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()
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 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()
Description copied from class:Struct
Returns thesizeof(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.
-
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 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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkImageSubresourceLayers
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageSubresourceLayers callocStack(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, 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, 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
-
-