Package org.lwjgl.vulkan
Class VkSparseImageFormatProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkSparseImageFormatProperties
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkSparseImageFormatProperties extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying sparse image format properties.Member documentation
aspectMask
– a bitmaskVkImageAspectFlagBits
specifying which aspects of the image the properties apply to.imageGranularity
– the width, height, and depth of the sparse image block in texels or compressed texel blocks.flags
– a bitmask ofVkSparseImageFormatFlagBits
specifying additional information about the sparse resource.
Layout
struct VkSparseImageFormatProperties { VkImageAspectFlags aspectMask;
VkExtent3D
imageGranularity; VkSparseImageFormatFlags flags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkSparseImageFormatProperties.Buffer
An array ofVkSparseImageFormatProperties
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ASPECTMASK
FLAGS
IMAGEGRANULARITYThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description VkSparseImageFormatProperties(java.nio.ByteBuffer container)
Creates aVkSparseImageFormatProperties
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.static VkSparseImageFormatProperties
calloc()
Returns a newVkSparseImageFormatProperties
instance allocated withmemCalloc
.static VkSparseImageFormatProperties.Buffer
calloc(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withmemCalloc
.static VkSparseImageFormatProperties
callocStack()
Returns a newVkSparseImageFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageFormatProperties.Buffer
callocStack(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkSparseImageFormatProperties.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageFormatProperties
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageFormatProperties
create()
Returns a newVkSparseImageFormatProperties
instance allocated withBufferUtils
.static VkSparseImageFormatProperties.Buffer
create(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withBufferUtils
.static VkSparseImageFormatProperties
create(long address)
Returns a newVkSparseImageFormatProperties
instance for the specified memory address.static VkSparseImageFormatProperties.Buffer
create(long address, int capacity)
Create aVkSparseImageFormatProperties.Buffer
instance at the specified memory.static VkSparseImageFormatProperties
createSafe(long address)
static VkSparseImageFormatProperties.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkExtent3D
imageGranularity()
Returns aVkExtent3D
view of theimageGranularity
field.static VkSparseImageFormatProperties
malloc()
Returns a newVkSparseImageFormatProperties
instance allocated withmemAlloc
.static VkSparseImageFormatProperties.Buffer
malloc(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withmemAlloc
.static VkSparseImageFormatProperties
mallocStack()
Returns a newVkSparseImageFormatProperties
instance allocated on the thread-localMemoryStack
.static VkSparseImageFormatProperties.Buffer
mallocStack(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkSparseImageFormatProperties.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseImageFormatProperties
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
.static int
naspectMask(long struct)
Unsafe version ofaspectMask()
.static int
nflags(long struct)
Unsafe version offlags()
.static VkExtent3D
nimageGranularity(long struct)
Unsafe version ofimageGranularity()
.int
sizeof()
-
-
-
Constructor Detail
-
VkSparseImageFormatProperties
public VkSparseImageFormatProperties(java.nio.ByteBuffer container)
Creates aVkSparseImageFormatProperties
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.
-
imageGranularity
public VkExtent3D imageGranularity()
Returns aVkExtent3D
view of theimageGranularity
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
malloc
public static VkSparseImageFormatProperties malloc()
Returns a newVkSparseImageFormatProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkSparseImageFormatProperties calloc()
Returns a newVkSparseImageFormatProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkSparseImageFormatProperties create()
Returns a newVkSparseImageFormatProperties
instance allocated withBufferUtils
.
-
create
public static VkSparseImageFormatProperties create(long address)
Returns a newVkSparseImageFormatProperties
instance for the specified memory address.
-
createSafe
@Nullable public static VkSparseImageFormatProperties createSafe(long address)
-
malloc
public static VkSparseImageFormatProperties.Buffer malloc(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkSparseImageFormatProperties.Buffer calloc(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageFormatProperties.Buffer create(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkSparseImageFormatProperties.Buffer create(long address, int capacity)
Create aVkSparseImageFormatProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkSparseImageFormatProperties.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkSparseImageFormatProperties mallocStack()
Returns a newVkSparseImageFormatProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkSparseImageFormatProperties callocStack()
Returns a newVkSparseImageFormatProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkSparseImageFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseImageFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkSparseImageFormatProperties.Buffer mallocStack(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkSparseImageFormatProperties.Buffer callocStack(int capacity)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkSparseImageFormatProperties.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkSparseImageFormatProperties.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkSparseImageFormatProperties.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()
.
-
nimageGranularity
public static VkExtent3D nimageGranularity(long struct)
Unsafe version ofimageGranularity()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
-