Class VkSparseImageMemoryBindInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageMemoryBindInfo>

org.lwjgl.vulkan.VkSparseImageMemoryBindInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSparseImageMemoryBindInfo
extends Struct<VkSparseImageMemoryBindInfo>
implements NativeResource

struct VkSparseImageMemoryBindInfo {
    VkImage image;
    uint32_t bindCount;
    VkSparseImageMemoryBind const * pBinds;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

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	IMAGE	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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	bindCount()
static VkSparseImageMemoryBindInfo	calloc()	Returns a new VkSparseImageMemoryBindInfo instance allocated with memCalloc.
static VkSparseImageMemoryBindInfo.Buffer	calloc(int capacity)	Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memCalloc.
static VkSparseImageMemoryBindInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryBindInfo	calloc(MemoryStack stack)	Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryBindInfo	create()	Returns a new VkSparseImageMemoryBindInfo instance allocated with BufferUtils.
static VkSparseImageMemoryBindInfo.Buffer	create(int capacity)	Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with BufferUtils.
static VkSparseImageMemoryBindInfo	create(long address)	Returns a new VkSparseImageMemoryBindInfo instance for the specified memory address.
static VkSparseImageMemoryBindInfo.Buffer	create(long address, int capacity)	Create a VkSparseImageMemoryBindInfo.Buffer instance at the specified memory.
static @Nullable VkSparseImageMemoryBindInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSparseImageMemoryBindInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()
VkSparseImageMemoryBindInfo	image(long value)	Sets the specified value to the image field.
static VkSparseImageMemoryBindInfo	malloc()	Returns a new VkSparseImageMemoryBindInfo instance allocated with memAlloc.
static VkSparseImageMemoryBindInfo.Buffer	malloc(int capacity)	Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memAlloc.
static VkSparseImageMemoryBindInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageMemoryBindInfo	malloc(MemoryStack stack)	Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack.
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	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
static VkSparseImageMemoryBind.Buffer	npBinds(long struct)	Unsafe version of pBinds().
static void	npBinds(long struct, VkSparseImageMemoryBind.Buffer value)	Unsafe version of pBinds.
VkSparseImageMemoryBind.Buffer	pBinds()
VkSparseImageMemoryBindInfo	pBinds(VkSparseImageMemoryBind.Buffer value)	Sets the address of the specified VkSparseImageMemoryBind.Buffer to the pBinds field.
VkSparseImageMemoryBindInfo	set(long image, VkSparseImageMemoryBind.Buffer pBinds)	Initializes this struct with the specified values.
VkSparseImageMemoryBindInfo	set(VkSparseImageMemoryBindInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

IMAGE

public static final int IMAGE

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

VkSparseImageMemoryBindInfo

public VkSparseImageMemoryBindInfo(ByteBuffer container)

Creates a VkSparseImageMemoryBindInfo 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkSparseImageMemoryBindInfo>

image

@NativeType("VkImage")
public long image()

Returns:

the value of the image field.

bindCount

@NativeType("uint32_t")
public int bindCount()

Returns:

the value of the bindCount field.

pBinds

@NativeType("VkSparseImageMemoryBind const *")
public VkSparseImageMemoryBind.Buffer pBinds()

Returns:

a VkSparseImageMemoryBind.Buffer view of the struct array pointed to by the pBinds field.

image

public VkSparseImageMemoryBindInfo image(@NativeType("VkImage")
 long value)

Sets the specified value to the image field.

pBinds

public VkSparseImageMemoryBindInfo pBinds(@NativeType("VkSparseImageMemoryBind const *")
 VkSparseImageMemoryBind.Buffer value)

Sets the address of the specified VkSparseImageMemoryBind.Buffer to the pBinds field.

set

public VkSparseImageMemoryBindInfo set(long image,
 VkSparseImageMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

set

public VkSparseImageMemoryBindInfo set(VkSparseImageMemoryBindInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSparseImageMemoryBindInfo malloc()

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

calloc

public static VkSparseImageMemoryBindInfo calloc()

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

create

public static VkSparseImageMemoryBindInfo create()

Returns a new VkSparseImageMemoryBindInfo instance allocated with BufferUtils.

create

public static VkSparseImageMemoryBindInfo create(long address)

Returns a new VkSparseImageMemoryBindInfo instance for the specified memory address.

createSafe

public static @Nullable VkSparseImageMemoryBindInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageMemoryBindInfo.Buffer create(int capacity)

Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageMemoryBindInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryBindInfo malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageMemoryBindInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity,
 MemoryStack stack)

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

nimage

public static long nimage(long struct)

Unsafe version of image().

nbindCount

public static int nbindCount(long struct)

Unsafe version of bindCount().

npBinds

public static VkSparseImageMemoryBind.Buffer npBinds(long struct)

Unsafe version of pBinds().

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.

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,
 VkSparseImageMemoryBind.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