Package org.lwjgl.vulkan
Class VkImageSubresource
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkImageSubresource
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkImageSubresource extends Struct
Khronos Reference Page
Vulkan SpecificationSelects a specific image of an image subresource (mipLevel/arrayLayer) of an image created with linear tiling.
Valid Usage
aspectMask
must be a valid combination ofVkImageAspectFlagBits
valuesaspectMask
must not be 0mipLevel
must be less than themipLevels
specified inVkImageCreateInfo
when the image was createdarrayLayer
must be less than thearrayLayers
specified inVkImageCreateInfo
when the image was created
Member documentation
aspectMask
– aVkImageAspectFlags
selecting the image aspect. One or more of:IMAGE_ASPECT_COLOR_BIT
IMAGE_ASPECT_DEPTH_BIT
IMAGE_ASPECT_METADATA_BIT
IMAGE_ASPECT_STENCIL_BIT
mipLevel
– selects the mipmap levelarrayLayer
– selects the array layer
Layout
struct VkImageSubresource { VkImageAspectFlags aspectMask; uint32_t mipLevel; uint32_t arrayLayer; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkImageSubresource.Buffer
An array ofVkImageSubresource
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 VkImageSubresource(java.nio.ByteBuffer container)
Creates aVkImageSubresource
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
arrayLayer()
Returns the value of thearrayLayer
field.VkImageSubresource
arrayLayer(int value)
Sets the specified value to thearrayLayer
field.int
aspectMask()
Returns the value of theaspectMask
field.VkImageSubresource
aspectMask(int value)
Sets the specified value to theaspectMask
field.static VkImageSubresource
calloc()
Returns a newVkImageSubresource
instance allocated withmemCalloc
.static VkImageSubresource.Buffer
calloc(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withmemCalloc
.static VkImageSubresource
callocStack()
Returns a newVkImageSubresource
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageSubresource.Buffer
callocStack(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkImageSubresource.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresource.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageSubresource
callocStack(MemoryStack stack)
Returns a newVkImageSubresource
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkImageSubresource
create()
Returns a newVkImageSubresource
instance allocated withBufferUtils
.static VkImageSubresource.Buffer
create(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withBufferUtils
.static VkImageSubresource
create(long address)
Returns a newVkImageSubresource
instance for the specified memory address ornull
if the address isNULL
.static VkImageSubresource.Buffer
create(long address, int capacity)
Create aVkImageSubresource.Buffer
instance at the specified memory.static VkImageSubresource
malloc()
Returns a newVkImageSubresource
instance allocated withmemAlloc
.static VkImageSubresource.Buffer
malloc(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withmemAlloc
.static VkImageSubresource
mallocStack()
Returns a newVkImageSubresource
instance allocated on the thread-localMemoryStack
.static VkImageSubresource.Buffer
mallocStack(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated on the thread-localMemoryStack
.static VkImageSubresource.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresource.Buffer
instance allocated on the specifiedMemoryStack
.static VkImageSubresource
mallocStack(MemoryStack stack)
Returns a newVkImageSubresource
instance allocated on the specifiedMemoryStack
.int
mipLevel()
Returns the value of themipLevel
field.VkImageSubresource
mipLevel(int value)
Sets the specified value to themipLevel
field.VkImageSubresource
nset(long struct)
Unsafe version ofset
.VkImageSubresource
set(int aspectMask, int mipLevel, int arrayLayer)
Initializes this struct with the specified values.VkImageSubresource
set(VkImageSubresource 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
-
VkImageSubresource
public VkImageSubresource(java.nio.ByteBuffer container)
Creates aVkImageSubresource
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.
-
arrayLayer
public int arrayLayer()
Returns the value of thearrayLayer
field.
-
aspectMask
public VkImageSubresource aspectMask(int value)
Sets the specified value to theaspectMask
field.
-
mipLevel
public VkImageSubresource mipLevel(int value)
Sets the specified value to themipLevel
field.
-
arrayLayer
public VkImageSubresource arrayLayer(int value)
Sets the specified value to thearrayLayer
field.
-
set
public VkImageSubresource set(int aspectMask, int mipLevel, int arrayLayer)
Initializes this struct with the specified values.
-
nset
public VkImageSubresource nset(long struct)
Unsafe version ofset
.
-
set
public VkImageSubresource set(VkImageSubresource src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkImageSubresource malloc()
Returns a newVkImageSubresource
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkImageSubresource calloc()
Returns a newVkImageSubresource
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkImageSubresource create()
Returns a newVkImageSubresource
instance allocated withBufferUtils
.
-
create
public static VkImageSubresource create(long address)
Returns a newVkImageSubresource
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkImageSubresource.Buffer malloc(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkImageSubresource.Buffer calloc(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageSubresource.Buffer create(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkImageSubresource.Buffer create(long address, int capacity)
Create aVkImageSubresource.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkImageSubresource mallocStack()
Returns a newVkImageSubresource
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkImageSubresource callocStack()
Returns a newVkImageSubresource
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkImageSubresource mallocStack(MemoryStack stack)
Returns a newVkImageSubresource
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkImageSubresource callocStack(MemoryStack stack)
Returns a newVkImageSubresource
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkImageSubresource.Buffer mallocStack(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkImageSubresource.Buffer callocStack(int capacity)
Returns a newVkImageSubresource.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkImageSubresource.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresource.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkImageSubresource.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkImageSubresource.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-