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, NativeResource, Pointer
public class VkSparseImageFormatProperties extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes properties for a set of image aspects that are bound simultaneously in an image.
Member documentation
aspectMask
– aVkImageAspectFlags
specifying which aspects of the image the properties apply toimageGranularity
– the width, height, and depth of the sparse image block in texels or compressed texel blocksflags
– aVkSparseImageFormatFlagBits
bitmask specifying additional information about the sparse resource. One or more of:SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT
SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT
SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT
Layout
struct VkSparseImageFormatProperties { VkImageAspectFlags aspectMask;
VkExtent3D
imageGranularity; VkSparseImageFormatFlags flags; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkSparseImageFormatProperties.Buffer
An array ofVkSparseImageFormatProperties
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 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 and 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, MemoryStack stack)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkSparseImageFormatProperties
callocStack(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 ornull
if the address isNULL
.static VkSparseImageFormatProperties.Buffer
create(long address, int capacity)
Create aVkSparseImageFormatProperties.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkSparseImageFormatProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkSparseImageFormatProperties
mallocStack(MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
.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
-
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()
Description copied from class:Struct
Returns thesizeof(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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkSparseImageFormatProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkSparseImageFormatProperties callocStack(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, 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, 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
-
-