Package org.lwjgl.vulkan

Class VkSparseImageFormatProperties2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageFormatProperties2>

org.lwjgl.vulkan.VkSparseImageFormatProperties2

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkSparseImageFormatProperties2KHR

public class VkSparseImageFormatProperties2
extends org.lwjgl.system.Struct<VkSparseImageFormatProperties2>
implements org.lwjgl.system.NativeResource

Structure specifying sparse image format properties.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2
• pNext must be NULL

See Also

VkSparseImageFormatProperties, GetPhysicalDeviceSparseImageFormatProperties2, GetPhysicalDeviceSparseImageFormatProperties2KHR

Layout

 struct VkSparseImageFormatProperties2 {
     VkStructureType sType();
     void * pNext();
     VkSparseImageFormatProperties properties();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSparseImageFormatProperties2.Buffer	An array of VkSparseImageFormatProperties2 structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	PROPERTIES	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkSparseImageFormatProperties2(ByteBuffer container)	Creates a VkSparseImageFormatProperties2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSparseImageFormatProperties2	calloc()	Returns a new VkSparseImageFormatProperties2 instance allocated with memCalloc.
static VkSparseImageFormatProperties2.Buffer	calloc(int capacity)	Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memCalloc.
static VkSparseImageFormatProperties2.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageFormatProperties2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageFormatProperties2	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageFormatProperties2	callocStack()	Deprecated.
static VkSparseImageFormatProperties2.Buffer	callocStack(int capacity)	Deprecated.
static VkSparseImageFormatProperties2.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseImageFormatProperties2	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseImageFormatProperties2	create()	Returns a new VkSparseImageFormatProperties2 instance allocated with BufferUtils.
static VkSparseImageFormatProperties2.Buffer	create(int capacity)	Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with BufferUtils.
static VkSparseImageFormatProperties2	create(long address)	Returns a new VkSparseImageFormatProperties2 instance for the specified memory address.
static VkSparseImageFormatProperties2.Buffer	create(long address, int capacity)	Create a VkSparseImageFormatProperties2.Buffer instance at the specified memory.
static @Nullable VkSparseImageFormatProperties2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSparseImageFormatProperties2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSparseImageFormatProperties2	malloc()	Returns a new VkSparseImageFormatProperties2 instance allocated with memAlloc.
static VkSparseImageFormatProperties2.Buffer	malloc(int capacity)	Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memAlloc.
static VkSparseImageFormatProperties2.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageFormatProperties2.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageFormatProperties2	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack.
static VkSparseImageFormatProperties2	mallocStack()	Deprecated.
static VkSparseImageFormatProperties2.Buffer	mallocStack(int capacity)	Deprecated.
static VkSparseImageFormatProperties2.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseImageFormatProperties2	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static VkSparseImageFormatProperties	nproperties(long struct)	Unsafe version of properties().
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSparseImageFormatProperties2	pNext(long value)	Sets the specified value to the pNext() field.
VkSparseImageFormatProperties	properties()	a VkSparseImageFormatProperties structure which is populated with the same values as in GetPhysicalDeviceSparseImageFormatProperties.
VkSparseImageFormatProperties2	set(int sType, long pNext)	Initializes this struct with the specified values.
VkSparseImageFormatProperties2	set(VkSparseImageFormatProperties2 src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSparseImageFormatProperties2	sType(int value)	Sets the specified value to the sType() field.
VkSparseImageFormatProperties2	sType$Default()	Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

PROPERTIES

public static final int PROPERTIES

The struct member offsets.

Constructor Details

VkSparseImageFormatProperties2

public VkSparseImageFormatProperties2(ByteBuffer container)

Creates a VkSparseImageFormatProperties2 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkSparseImageFormatProperties2>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

properties

public VkSparseImageFormatProperties properties()

a VkSparseImageFormatProperties structure which is populated with the same values as in GetPhysicalDeviceSparseImageFormatProperties.

sType

public VkSparseImageFormatProperties2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSparseImageFormatProperties2 sType$Default()

Sets the STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2 value to the sType() field.

pNext

public VkSparseImageFormatProperties2 pNext(long value)

Sets the specified value to the pNext() field.

set

public VkSparseImageFormatProperties2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkSparseImageFormatProperties2 set(VkSparseImageFormatProperties2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSparseImageFormatProperties2 malloc()

Returns a new VkSparseImageFormatProperties2 instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkSparseImageFormatProperties2 calloc()

Returns a new VkSparseImageFormatProperties2 instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkSparseImageFormatProperties2 create()

Returns a new VkSparseImageFormatProperties2 instance allocated with BufferUtils.

create

public static VkSparseImageFormatProperties2 create(long address)

Returns a new VkSparseImageFormatProperties2 instance for the specified memory address.

createSafe

public static @Nullable VkSparseImageFormatProperties2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageFormatProperties2.Buffer malloc(int capacity)

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageFormatProperties2.Buffer calloc(int capacity)

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageFormatProperties2.Buffer create(int capacity)

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageFormatProperties2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkSparseImageFormatProperties2.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSparseImageFormatProperties2 mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageFormatProperties2 callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageFormatProperties2 mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageFormatProperties2 callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageFormatProperties2.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageFormatProperties2.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkSparseImageFormatProperties2.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkSparseImageFormatProperties2.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkSparseImageFormatProperties2 malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageFormatProperties2 calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseImageFormatProperties2 instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkSparseImageFormatProperties2.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSparseImageFormatProperties2.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseImageFormatProperties2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nproperties

public static VkSparseImageFormatProperties nproperties(long struct)

Unsafe version of properties().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.