Modifier and Type	Class and Description
public static class	VkPhysicalDeviceSparseProperties.Buffer An array of `VkPhysicalDeviceSparseProperties` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	RESIDENCYALIGNEDMIPSIZE The struct member offsets.
public static final int	RESIDENCYNONRESIDENTSTRICT The struct member offsets.
public static final int	RESIDENCYSTANDARD2DBLOCKSHAPE The struct member offsets.
public static final int	RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE The struct member offsets.
public static final int	RESIDENCYSTANDARD3DBLOCKSHAPE The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

Access	Constructor and Description
protected	VkPhysicalDeviceSparseProperties(long address, ByteBuffer container)
public	VkPhysicalDeviceSparseProperties(ByteBuffer container) Creates a `VkPhysicalDeviceSparseProperties` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
protected VkPhysicalDeviceSparseProperties	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkPhysicalDeviceSparseProperties	create(long address) Returns a new `VkPhysicalDeviceSparseProperties` instance for the specified memory address.
public static VkPhysicalDeviceSparseProperties.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPhysicalDeviceSparseProperties.Buffer` instance at the specified memory.
public static VkPhysicalDeviceSparseProperties	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPhysicalDeviceSparseProperties.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static int	nresidencyAlignedMipSize(long struct) Unsafe version of `residencyAlignedMipSize`.
public static int	nresidencyNonResidentStrict(long struct) Unsafe version of `residencyNonResidentStrict`.
public static int	nresidencyStandard2DBlockShape(long struct) Unsafe version of `residencyStandard2DBlockShape`.
public static int	nresidencyStandard2DMultisampleBlockShape(long struct) Unsafe version of `residencyStandard2DMultisampleBlockShape`.
public static int	nresidencyStandard3DBlockShape(long struct) Unsafe version of `residencyStandard3DBlockShape`.
public boolean	residencyAlignedMipSize() `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 tail.
public boolean	residencyNonResidentStrict() specifies whether the physical device can consistently access non-resident regions of a resource.
public boolean	residencyStandard2DBlockShape() `TRUE` if the physical device will access all single-sample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table.
public boolean	residencyStandard2DMultisampleBlockShape() `TRUE` if the physical device will access all multisample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (MSAA) table.
public boolean	residencyStandard3DBlockShape() `TRUE` if the physical device will access all 3D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

RESIDENCYALIGNEDMIPSIZE	back to summary
public static final int RESIDENCYALIGNEDMIPSIZE The struct member offsets.

RESIDENCYNONRESIDENTSTRICT	back to summary
public static final int RESIDENCYNONRESIDENTSTRICT The struct member offsets.

RESIDENCYSTANDARD2DBLOCKSHAPE	back to summary
public static final int RESIDENCYSTANDARD2DBLOCKSHAPE The struct member offsets.

RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE	back to summary
public static final int RESIDENCYSTANDARD2DMULTISAMPLEBLOCKSHAPE The struct member offsets.

RESIDENCYSTANDARD3DBLOCKSHAPE	back to summary
public static final int RESIDENCYSTANDARD3DBLOCKSHAPE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkPhysicalDeviceSparseProperties	back to summary
protected VkPhysicalDeviceSparseProperties(long address, ByteBuffer container)

VkPhysicalDeviceSparseProperties back to summary

VkPhysicalDeviceSparseProperties	back to summary
public VkPhysicalDeviceSparseProperties(ByteBuffer container) Creates a `VkPhysicalDeviceSparseProperties` instance at the current position of the specified `ByteBuffer` 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.

public VkPhysicalDeviceSparseProperties(ByteBuffer container)

Creates a VkPhysicalDeviceSparseProperties instance at the current position of the specified ByteBuffer 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

create back to summary

create	back to summary
protected VkPhysicalDeviceSparseProperties create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkPhysicalDeviceSparseProperties create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkPhysicalDeviceSparseProperties create(long address) Returns a new `VkPhysicalDeviceSparseProperties` instance for the specified memory address.

create back to summary

create	back to summary
public static VkPhysicalDeviceSparseProperties.Buffer create(long address, int capacity) Create a `VkPhysicalDeviceSparseProperties.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkPhysicalDeviceSparseProperties.Buffer create(long address, int capacity)

Create a VkPhysicalDeviceSparseProperties.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkPhysicalDeviceSparseProperties createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkPhysicalDeviceSparseProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkPhysicalDeviceSparseProperties.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkPhysicalDeviceSparseProperties.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

nresidencyAlignedMipSize	back to summary
public static int nresidencyAlignedMipSize(long struct) Unsafe version of `residencyAlignedMipSize`.

nresidencyNonResidentStrict	back to summary
public static int nresidencyNonResidentStrict(long struct) Unsafe version of `residencyNonResidentStrict`.

nresidencyStandard2DBlockShape	back to summary
public static int nresidencyStandard2DBlockShape(long struct) Unsafe version of `residencyStandard2DBlockShape`.

nresidencyStandard2DMultisampleBlockShape	back to summary
public static int nresidencyStandard2DMultisampleBlockShape(long struct) Unsafe version of `residencyStandard2DMultisampleBlockShape`.

nresidencyStandard3DBlockShape	back to summary
public static int nresidencyStandard3DBlockShape(long struct) Unsafe version of `residencyStandard3DBlockShape`.

residencyAlignedMipSize back to summary

residencyAlignedMipSize	back to summary
public boolean residencyAlignedMipSize() `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 tail. If this property is not reported, only mip levels with dimensions smaller than the `imageGranularity` member of the `VkSparseImageFormatProperties` structure will be placed in the mip tail. If this property is reported the implementation is allowed to return `SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT` in the `flags` member of `VkSparseImageFormatProperties`, indicating that mip level dimensions that are not integer multiples of the corresponding dimensions of the sparse image block will be placed in the mip tail. Annotations @NativeType:VkBool32

public boolean residencyAlignedMipSize()

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 tail. If this property is not reported, only mip levels with dimensions smaller than the imageGranularity member of the VkSparseImageFormatProperties structure will be placed in the mip tail. If this property is reported the implementation is allowed to return SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT in the flags member of VkSparseImageFormatProperties, indicating that mip level dimensions that are not integer multiples of the corresponding dimensions of the sparse image block will be placed in the mip tail.

Annotations

@NativeType:VkBool32

residencyNonResidentStrict back to summary

residencyNonResidentStrict	back to summary
public boolean residencyNonResidentStrict() specifies whether the physical device can consistently access non-resident regions of a resource. If this property is `TRUE`, access to non-resident regions of resources will be guaranteed to return values as if the resource was populated with 0; writes to non-resident regions will be discarded. Annotations @NativeType:VkBool32

public boolean residencyNonResidentStrict()

specifies whether the physical device can consistently access non-resident regions of a resource. If this property is TRUE, access to non-resident regions of resources will be guaranteed to return values as if the resource was populated with 0; writes to non-resident regions will be discarded.

Annotations

@NativeType:VkBool32

residencyStandard2DBlockShape back to summary

residencyStandard2DBlockShape	back to summary
public boolean residencyStandard2DBlockShape() `TRUE` if the physical device will access all single-sample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported the value returned in the `imageGranularity` member of the `VkSparseImageFormatProperties` structure for single-sample 2D images is not required to match the standard sparse image block dimensions listed in the table. Annotations @NativeType:VkBool32

public boolean residencyStandard2DBlockShape()

TRUE if the physical device will access all single-sample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for single-sample 2D images is not required to match the standard sparse image block dimensions listed in the table.

Annotations

@NativeType:VkBool32

residencyStandard2DMultisampleBlockShape back to summary

residencyStandard2DMultisampleBlockShape	back to summary
public boolean residencyStandard2DMultisampleBlockShape() `TRUE` if the physical device will access all multisample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (MSAA) table. If this property is not supported, the value returned in the `imageGranularity` member of the `VkSparseImageFormatProperties` structure for multisample 2D images is not required to match the standard sparse image block dimensions listed in the table. Annotations @NativeType:VkBool32

public boolean residencyStandard2DMultisampleBlockShape()

TRUE if the physical device will access all multisample 2D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (MSAA) table. If this property is not supported, the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for multisample 2D images is not required to match the standard sparse image block dimensions listed in the table.

Annotations

@NativeType:VkBool32

residencyStandard3DBlockShape back to summary

residencyStandard3DBlockShape	back to summary
public boolean residencyStandard3DBlockShape() `TRUE` if the physical device will access all 3D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported, the value returned in the `imageGranularity` member of the `VkSparseImageFormatProperties` structure for 3D images is not required to match the standard sparse image block dimensions listed in the table. Annotations @NativeType:VkBool32

public boolean residencyStandard3DBlockShape()

TRUE if the physical device will access all 3D sparse resources using the standard sparse image block shapes (based on image format), as described in the Standard Sparse Image Block Shapes (Single Sample) table. If this property is not supported, the value returned in the imageGranularity member of the VkSparseImageFormatProperties structure for 3D images is not required to match the standard sparse image block dimensions listed in the table.

Annotations

@NativeType:VkBool32

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceSparseProperties.Buffer

Class Inheritance

extends StructBuffer<VkPhysicalDeviceSparseProperties, VkPhysicalDeviceSparseProperties.Buffer>

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkPhysicalDeviceSparseProperties.Buffer

An array of VkPhysicalDeviceSparseProperties structs.

Field Summary

Modifier and Type	Field and Description
private static final VkPhysicalDeviceSparseProperties	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkPhysicalDeviceSparseProperties.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
protected VkPhysicalDeviceSparseProperties	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public boolean	Returns: the value of the `VkPhysicalDeviceSparseProperties#residencyAlignedMipSize` field. residencyAlignedMipSize()
public boolean	Returns: the value of the `VkPhysicalDeviceSparseProperties#residencyNonResidentStrict` field. residencyNonResidentStrict()
public boolean	Returns: the value of the `VkPhysicalDeviceSparseProperties#residencyStandard2DBlockShape` field. residencyStandard2DBlockShape()
public boolean	Returns: the value of the `VkPhysicalDeviceSparseProperties#residencyStandard2DMultisampleBlockShape` field. residencyStandard2DMultisampleBlockShape()
public boolean	Returns: the value of the `VkPhysicalDeviceSparseProperties#residencyStandard3DBlockShape` field. residencyStandard3DBlockShape()
protected VkPhysicalDeviceSparseProperties.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkPhysicalDeviceSparseProperties ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkPhysicalDeviceSparseProperties.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `VkPhysicalDeviceSparseProperties#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceSparseProperties.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPhysicalDeviceSparseProperties#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactory	back to summary
protected VkPhysicalDeviceSparseProperties getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkPhysicalDeviceSparseProperties getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

residencyAlignedMipSize	back to summary
public boolean residencyAlignedMipSize() Returns:boolean the value of the `VkPhysicalDeviceSparseProperties#residencyAlignedMipSize` field. Annotations @NativeType:VkBool32

residencyNonResidentStrict	back to summary
public boolean residencyNonResidentStrict() Returns:boolean the value of the `VkPhysicalDeviceSparseProperties#residencyNonResidentStrict` field. Annotations @NativeType:VkBool32

residencyStandard2DBlockShape	back to summary
public boolean residencyStandard2DBlockShape() Returns:boolean the value of the `VkPhysicalDeviceSparseProperties#residencyStandard2DBlockShape` field. Annotations @NativeType:VkBool32

residencyStandard2DMultisampleBlockShape	back to summary
public boolean residencyStandard2DMultisampleBlockShape() Returns:boolean the value of the `VkPhysicalDeviceSparseProperties#residencyStandard2DMultisampleBlockShape` field. Annotations @NativeType:VkBool32

residencyStandard3DBlockShape	back to summary
public boolean residencyStandard3DBlockShape() Returns:boolean the value of the `VkPhysicalDeviceSparseProperties#residencyStandard3DBlockShape` field. Annotations @NativeType:VkBool32

self	back to summary
protected VkPhysicalDeviceSparseProperties.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected VkPhysicalDeviceSparseProperties.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

public Class VkPhysicalDeviceSparseProperties

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkPhysicalDeviceSparseProperties.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail