Package org.lwjgl.util.vma

Class VmaAllocationInfo2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaAllocationInfo2>

org.lwjgl.util.vma.VmaAllocationInfo2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VmaAllocationInfo2
extends Struct<VmaAllocationInfo2>
implements NativeResource

 struct VmaAllocationInfo2 {
     VmaAllocationInfo allocationInfo;
     VkDeviceSize blockSize;
     VkBool32 dedicatedMemory;
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ALLOCATIONINFO	The struct member offsets.
static final int	BLOCKSIZE	The struct member offsets.
static final int	DEDICATEDMEMORY	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
VmaAllocationInfo2(ByteBuffer container)	Creates a VmaAllocationInfo2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
VmaAllocationInfo	allocationInfo()
long	blockSize()
static VmaAllocationInfo2	calloc()	Returns a new VmaAllocationInfo2 instance allocated with memCalloc.
static VmaAllocationInfo2.Buffer	calloc(int capacity)	Returns a new VmaAllocationInfo2.Buffer instance allocated with memCalloc.
static VmaAllocationInfo2.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VmaAllocationInfo2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaAllocationInfo2	calloc(MemoryStack stack)	Returns a new VmaAllocationInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaAllocationInfo2	create()	Returns a new VmaAllocationInfo2 instance allocated with BufferUtils.
static VmaAllocationInfo2.Buffer	create(int capacity)	Returns a new VmaAllocationInfo2.Buffer instance allocated with BufferUtils.
static VmaAllocationInfo2	create(long address)	Returns a new VmaAllocationInfo2 instance for the specified memory address.
static VmaAllocationInfo2.Buffer	create(long address, int capacity)	Create a VmaAllocationInfo2.Buffer instance at the specified memory.
static @Nullable VmaAllocationInfo2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaAllocationInfo2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	dedicatedMemory()
static VmaAllocationInfo2	malloc()	Returns a new VmaAllocationInfo2 instance allocated with memAlloc.
static VmaAllocationInfo2.Buffer	malloc(int capacity)	Returns a new VmaAllocationInfo2.Buffer instance allocated with memAlloc.
static VmaAllocationInfo2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VmaAllocationInfo2.Buffer instance allocated on the specified MemoryStack.
static VmaAllocationInfo2	malloc(MemoryStack stack)	Returns a new VmaAllocationInfo2 instance allocated on the specified MemoryStack.
static VmaAllocationInfo	nallocationInfo(long struct)	Unsafe version of allocationInfo().
static long	nblockSize(long struct)	Unsafe version of blockSize().
static int	ndedicatedMemory(long struct)	Unsafe version of dedicatedMemory().
int	sizeof()	Returns sizeof(struct).

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.

ALLOCATIONINFO

public static final int ALLOCATIONINFO

The struct member offsets.

BLOCKSIZE

public static final int BLOCKSIZE

The struct member offsets.

DEDICATEDMEMORY

public static final int DEDICATEDMEMORY

The struct member offsets.

Constructor Details

VmaAllocationInfo2

public VmaAllocationInfo2(ByteBuffer container)

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

allocationInfo

public VmaAllocationInfo allocationInfo()

Returns:

a VmaAllocationInfo view of the allocationInfo field.

blockSize

public long blockSize()

Returns:

the value of the blockSize field.

dedicatedMemory

public boolean dedicatedMemory()

Returns:

the value of the dedicatedMemory field.

malloc

public static VmaAllocationInfo2 malloc()

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

calloc

public static VmaAllocationInfo2 calloc()

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

create

public static VmaAllocationInfo2 create()

Returns a new VmaAllocationInfo2 instance allocated with BufferUtils.

create

public static VmaAllocationInfo2 create(long address)

Returns a new VmaAllocationInfo2 instance for the specified memory address.

createSafe

public static @Nullable VmaAllocationInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaAllocationInfo2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaAllocationInfo2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaAllocationInfo2.Buffer create(int capacity)

Returns a new VmaAllocationInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VmaAllocationInfo2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VmaAllocationInfo2 malloc(MemoryStack stack)

Returns a new VmaAllocationInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VmaAllocationInfo2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nallocationInfo

public static VmaAllocationInfo nallocationInfo(long struct)

Unsafe version of allocationInfo().

nblockSize

public static long nblockSize(long struct)

Unsafe version of blockSize().

ndedicatedMemory

public static int ndedicatedMemory(long struct)

Unsafe version of dedicatedMemory().