Package org.lwjgl.vulkan

Class VkSparseBufferMemoryBindInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseBufferMemoryBindInfo>

org.lwjgl.vulkan.VkSparseBufferMemoryBindInfo

All Implemented Interfaces:

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

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

Structure specifying a sparse buffer memory bind operation.

Valid Usage (Implicit)

• buffer must be a valid VkBuffer handle
• pBinds must be a valid pointer to an array of bindCount valid VkSparseMemoryBind structures
• bindCount must be greater than 0

See Also

VkBindSparseInfo, VkSparseMemoryBind

Layout

 struct VkSparseBufferMemoryBindInfo {
     VkBuffer buffer();
     uint32_t bindCount();
     VkSparseMemoryBind const * pBinds();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSparseBufferMemoryBindInfo.Buffer	An array of VkSparseBufferMemoryBindInfo 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	BINDCOUNT	The struct member offsets.
static final int	BUFFER	The struct member offsets.
static final int	PBINDS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	bindCount()	the number of VkSparseMemoryBind structures in the pBinds array.
long	buffer()	the VkBuffer object to be bound.
VkSparseBufferMemoryBindInfo	buffer(long value)	Sets the specified value to the buffer() field.
static VkSparseBufferMemoryBindInfo	calloc()	Returns a new VkSparseBufferMemoryBindInfo instance allocated with memCalloc.
static VkSparseBufferMemoryBindInfo.Buffer	calloc(int capacity)	Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with memCalloc.
static VkSparseBufferMemoryBindInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseBufferMemoryBindInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseBufferMemoryBindInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseBufferMemoryBindInfo	callocStack()	Deprecated.
static VkSparseBufferMemoryBindInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkSparseBufferMemoryBindInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseBufferMemoryBindInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseBufferMemoryBindInfo	create()	Returns a new VkSparseBufferMemoryBindInfo instance allocated with BufferUtils.
static VkSparseBufferMemoryBindInfo.Buffer	create(int capacity)	Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with BufferUtils.
static VkSparseBufferMemoryBindInfo	create(long address)	Returns a new VkSparseBufferMemoryBindInfo instance for the specified memory address.
static VkSparseBufferMemoryBindInfo.Buffer	create(long address, int capacity)	Create a VkSparseBufferMemoryBindInfo.Buffer instance at the specified memory.
static @Nullable VkSparseBufferMemoryBindInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSparseBufferMemoryBindInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSparseBufferMemoryBindInfo	malloc()	Returns a new VkSparseBufferMemoryBindInfo instance allocated with memAlloc.
static VkSparseBufferMemoryBindInfo.Buffer	malloc(int capacity)	Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with memAlloc.
static VkSparseBufferMemoryBindInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated on the specified MemoryStack.
static VkSparseBufferMemoryBindInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSparseBufferMemoryBindInfo instance allocated on the specified MemoryStack.
static VkSparseBufferMemoryBindInfo	mallocStack()	Deprecated.
static VkSparseBufferMemoryBindInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkSparseBufferMemoryBindInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkSparseBufferMemoryBindInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nbindCount(long struct)	Unsafe version of bindCount().
static void	nbindCount(long struct, int value)	Sets the specified value to the bindCount field of the specified struct.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static VkSparseMemoryBind.Buffer	npBinds(long struct)	Unsafe version of pBinds().
static void	npBinds(long struct, VkSparseMemoryBind.Buffer value)	Unsafe version of pBinds.
VkSparseMemoryBind.Buffer	pBinds()	a pointer to an array of VkSparseMemoryBind structures.
VkSparseBufferMemoryBindInfo	pBinds(VkSparseMemoryBind.Buffer value)	Sets the address of the specified VkSparseMemoryBind.Buffer to the pBinds() field.
VkSparseBufferMemoryBindInfo	set(long buffer, VkSparseMemoryBind.Buffer pBinds)	Initializes this struct with the specified values.
VkSparseBufferMemoryBindInfo	set(VkSparseBufferMemoryBindInfo src)	Copies the specified struct data to this struct.
int	sizeof()
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

BUFFER

public static final int BUFFER

The struct member offsets.

BINDCOUNT

public static final int BINDCOUNT

The struct member offsets.

PBINDS

public static final int PBINDS

The struct member offsets.

Constructor Details

VkSparseBufferMemoryBindInfo

public VkSparseBufferMemoryBindInfo(ByteBuffer container)

Creates a VkSparseBufferMemoryBindInfo 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<VkSparseBufferMemoryBindInfo>

buffer

public long buffer()

the VkBuffer object to be bound.

bindCount

public int bindCount()

the number of VkSparseMemoryBind structures in the pBinds array.

pBinds

public VkSparseMemoryBind.Buffer pBinds()

a pointer to an array of VkSparseMemoryBind structures.

buffer

public VkSparseBufferMemoryBindInfo buffer(long value)

Sets the specified value to the buffer() field.

pBinds

public VkSparseBufferMemoryBindInfo pBinds(VkSparseMemoryBind.Buffer value)

Sets the address of the specified VkSparseMemoryBind.Buffer to the pBinds() field.

set

public VkSparseBufferMemoryBindInfo set(long buffer,
 VkSparseMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

set

public VkSparseBufferMemoryBindInfo set(VkSparseBufferMemoryBindInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSparseBufferMemoryBindInfo malloc()

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

calloc

public static VkSparseBufferMemoryBindInfo calloc()

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

create

public static VkSparseBufferMemoryBindInfo create()

Returns a new VkSparseBufferMemoryBindInfo instance allocated with BufferUtils.

create

public static VkSparseBufferMemoryBindInfo create(long address)

Returns a new VkSparseBufferMemoryBindInfo instance for the specified memory address.

createSafe

public static @Nullable VkSparseBufferMemoryBindInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseBufferMemoryBindInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseBufferMemoryBindInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseBufferMemoryBindInfo.Buffer create(int capacity)

Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseBufferMemoryBindInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSparseBufferMemoryBindInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSparseBufferMemoryBindInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseBufferMemoryBindInfo.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 VkSparseBufferMemoryBindInfo.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 VkSparseBufferMemoryBindInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkSparseBufferMemoryBindInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkSparseBufferMemoryBindInfo.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

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

nbindCount

public static int nbindCount(long struct)

Unsafe version of bindCount().

npBinds

public static VkSparseMemoryBind.Buffer npBinds(long struct)

Unsafe version of pBinds().

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

nbindCount

public static void nbindCount(long struct,
 int value)

Sets the specified value to the bindCount field of the specified struct.

npBinds

public static void npBinds(long struct,
 VkSparseMemoryBind.Buffer value)

Unsafe version of pBinds.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate