Package org.lwjgl.vulkan
Class VkPhysicalDeviceSparseProperties
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPhysicalDeviceSparseProperties
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPhysicalDeviceSparseProperties extends Struct
Khronos Reference Page
Vulkan SpecificationSome features of the implementation are not possible to disable, and are reported to allow applications to alter their sparse resource usage accordingly.
Member documentation
residencyStandard2DBlockShape–TRUEif the physical device will access all single-sample 2D sparse resources using the standard sparse image block shapesresidencyStandard2DMultisampleBlockShape–TRUEif the physical device will access all multisample 2D sparse resources using the standard sparse image block shapesresidencyStandard3DBlockShape–TRUEif the physical device will access all 3D sparse resources using the standard sparse image block shapesresidencyAlignedMipSize– TRUE if images with mip level dimensions that are not integer multiples of the corresponding dimensions of the sparse image block may be placed in the mip tailresidencyNonResidentStrict– whether the physical device can consistently access non-resident regions of a resource
Layout
struct VkPhysicalDeviceSparseProperties { VkBool32 residencyStandard2DBlockShape; VkBool32 residencyStandard2DMultisampleBlockShape; VkBool32 residencyStandard3DBlockShape; VkBool32 residencyAlignedMipSize; VkBool32 residencyNonResidentStrict; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkPhysicalDeviceSparseProperties.BufferAn array ofVkPhysicalDeviceSparsePropertiesstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkPhysicalDeviceSparseProperties(java.nio.ByteBuffer container)Creates aVkPhysicalDeviceSparsePropertiesinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkPhysicalDeviceSparsePropertiescalloc()Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withmemCalloc.static VkPhysicalDeviceSparseProperties.Buffercalloc(int capacity)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withmemCalloc.static VkPhysicalDeviceSparsePropertiescallocStack()Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSparseProperties.BuffercallocStack(int capacity)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSparseProperties.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSparsePropertiescallocStack(MemoryStack stack)Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPhysicalDeviceSparsePropertiescreate()Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withBufferUtils.static VkPhysicalDeviceSparseProperties.Buffercreate(int capacity)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withBufferUtils.static VkPhysicalDeviceSparsePropertiescreate(long address)Returns a newVkPhysicalDeviceSparsePropertiesinstance for the specified memory address ornullif the address isNULL.static VkPhysicalDeviceSparseProperties.Buffercreate(long address, int capacity)Create aVkPhysicalDeviceSparseProperties.Bufferinstance at the specified memory.static VkPhysicalDeviceSparsePropertiesmalloc()Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withmemAlloc.static VkPhysicalDeviceSparseProperties.Buffermalloc(int capacity)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withmemAlloc.static VkPhysicalDeviceSparsePropertiesmallocStack()Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceSparseProperties.BuffermallocStack(int capacity)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the thread-localMemoryStack.static VkPhysicalDeviceSparseProperties.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the specifiedMemoryStack.static VkPhysicalDeviceSparsePropertiesmallocStack(MemoryStack stack)Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the specifiedMemoryStack.intresidencyAlignedMipSize()Returns the value of theresidencyAlignedMipSizefield.intresidencyNonResidentStrict()Returns the value of theresidencyNonResidentStrictfield.intresidencyStandard2DBlockShape()Returns the value of theresidencyStandard2DBlockShapefield.intresidencyStandard2DMultisampleBlockShape()Returns the value of theresidencyStandard2DMultisampleBlockShapefield.intresidencyStandard3DBlockShape()Returns the value of theresidencyStandard3DBlockShapefield.intsizeof()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
-
VkPhysicalDeviceSparseProperties
public VkPhysicalDeviceSparseProperties(java.nio.ByteBuffer container)
Creates aVkPhysicalDeviceSparsePropertiesinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
residencyStandard2DBlockShape
public int residencyStandard2DBlockShape()
Returns the value of theresidencyStandard2DBlockShapefield.
-
residencyStandard2DMultisampleBlockShape
public int residencyStandard2DMultisampleBlockShape()
Returns the value of theresidencyStandard2DMultisampleBlockShapefield.
-
residencyStandard3DBlockShape
public int residencyStandard3DBlockShape()
Returns the value of theresidencyStandard3DBlockShapefield.
-
residencyAlignedMipSize
public int residencyAlignedMipSize()
Returns the value of theresidencyAlignedMipSizefield.
-
residencyNonResidentStrict
public int residencyNonResidentStrict()
Returns the value of theresidencyNonResidentStrictfield.
-
malloc
public static VkPhysicalDeviceSparseProperties malloc()
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPhysicalDeviceSparseProperties calloc()
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPhysicalDeviceSparseProperties create()
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated withBufferUtils.
-
create
public static VkPhysicalDeviceSparseProperties create(long address)
Returns a newVkPhysicalDeviceSparsePropertiesinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkPhysicalDeviceSparseProperties.Buffer malloc(int capacity)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPhysicalDeviceSparseProperties.Buffer calloc(int capacity)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceSparseProperties.Buffer create(int capacity)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPhysicalDeviceSparseProperties.Buffer create(long address, int capacity)
Create aVkPhysicalDeviceSparseProperties.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceSparseProperties mallocStack()
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPhysicalDeviceSparseProperties callocStack()
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPhysicalDeviceSparseProperties mallocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPhysicalDeviceSparseProperties callocStack(MemoryStack stack)
Returns a newVkPhysicalDeviceSparsePropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkPhysicalDeviceSparseProperties.Buffer mallocStack(int capacity)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSparseProperties.Buffer callocStack(int capacity)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPhysicalDeviceSparseProperties.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkPhysicalDeviceSparseProperties.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPhysicalDeviceSparseProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-