Package org.lwjgl.util.vma

Class VmaVirtualAllocationCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaVirtualAllocationCreateInfo>

org.lwjgl.util.vma.VmaVirtualAllocationCreateInfo

All Implemented Interfaces:

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

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

Parameters of created virtual allocation to be passed to VirtualAllocate.

Layout

 struct VmaVirtualAllocationCreateInfo {
     VkDeviceSize size();
     VkDeviceSize alignment();
     VmaVirtualAllocationCreateFlags flags();
     void * pUserData();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmaVirtualAllocationCreateInfo.Buffer	An array of VmaVirtualAllocationCreateInfo 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	ALIGNMENT	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PUSERDATA	The struct member offsets.
static final int	SIZE	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
VmaVirtualAllocationCreateInfo(ByteBuffer container)	Creates a VmaVirtualAllocationCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	alignment()	required alignment of the allocation.
VmaVirtualAllocationCreateInfo	alignment(long value)	Sets the specified value to the alignment() field.
static VmaVirtualAllocationCreateInfo	calloc()	Returns a new VmaVirtualAllocationCreateInfo instance allocated with memCalloc.
static VmaVirtualAllocationCreateInfo.Buffer	calloc(int capacity)	Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memCalloc.
static VmaVirtualAllocationCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaVirtualAllocationCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaVirtualAllocationCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaVirtualAllocationCreateInfo	create()	Returns a new VmaVirtualAllocationCreateInfo instance allocated with BufferUtils.
static VmaVirtualAllocationCreateInfo.Buffer	create(int capacity)	Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with BufferUtils.
static VmaVirtualAllocationCreateInfo	create(long address)	Returns a new VmaVirtualAllocationCreateInfo instance for the specified memory address.
static VmaVirtualAllocationCreateInfo.Buffer	create(long address, int capacity)	Create a VmaVirtualAllocationCreateInfo.Buffer instance at the specified memory.
static @Nullable VmaVirtualAllocationCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaVirtualAllocationCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	use combination of VmaVirtualAllocationCreateFlagBits.
VmaVirtualAllocationCreateInfo	flags(int value)	Sets the specified value to the flags() field.
static VmaVirtualAllocationCreateInfo	malloc()	Returns a new VmaVirtualAllocationCreateInfo instance allocated with memAlloc.
static VmaVirtualAllocationCreateInfo.Buffer	malloc(int capacity)	Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with memAlloc.
static VmaVirtualAllocationCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VmaVirtualAllocationCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaVirtualAllocationCreateInfo instance allocated on the specified MemoryStack.
static long	nalignment(long struct)	Unsafe version of alignment().
static void	nalignment(long struct, long value)	Unsafe version of alignment.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npUserData(long struct)	Unsafe version of pUserData().
static void	npUserData(long struct, long value)	Unsafe version of pUserData.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
long	pUserData()	custom pointer to be associated with the allocation.
VmaVirtualAllocationCreateInfo	pUserData(long value)	Sets the specified value to the pUserData() field.
VmaVirtualAllocationCreateInfo	set(long size, long alignment, int flags, long pUserData)	Initializes this struct with the specified values.
VmaVirtualAllocationCreateInfo	set(VmaVirtualAllocationCreateInfo src)	Copies the specified struct data to this struct.
long	size()	size of the allocation.
VmaVirtualAllocationCreateInfo	size(long value)	Sets the specified value to the size() field.
int	sizeof()

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.

SIZE

public static final int SIZE

The struct member offsets.

ALIGNMENT

public static final int ALIGNMENT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

PUSERDATA

public static final int PUSERDATA

The struct member offsets.

Constructor Details

VmaVirtualAllocationCreateInfo

public VmaVirtualAllocationCreateInfo(ByteBuffer container)

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

size

public long size()

size of the allocation.

Cannot be zero.

alignment

public long alignment()

required alignment of the allocation. Optional.

Must be power of two. Special value 0 has the same meaning as 1 - means no special alignment is required, so allocation can start at any offset.

flags

public int flags()

use combination of VmaVirtualAllocationCreateFlagBits. One or more of:

VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT

VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT

VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT

VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_OFFSET_BIT

VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK

pUserData

public long pUserData()

custom pointer to be associated with the allocation. Optional.

It can be any value and can be used for user-defined purposes. It can be fetched or changed later.

size

public VmaVirtualAllocationCreateInfo size(long value)

Sets the specified value to the size() field.

alignment

public VmaVirtualAllocationCreateInfo alignment(long value)

Sets the specified value to the alignment() field.

flags

public VmaVirtualAllocationCreateInfo flags(int value)

Sets the specified value to the flags() field.

pUserData

public VmaVirtualAllocationCreateInfo pUserData(long value)

Sets the specified value to the pUserData() field.

set

public VmaVirtualAllocationCreateInfo set(long size,
 long alignment,
 int flags,
 long pUserData)

Initializes this struct with the specified values.

set

public VmaVirtualAllocationCreateInfo set(VmaVirtualAllocationCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VmaVirtualAllocationCreateInfo malloc()

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

calloc

public static VmaVirtualAllocationCreateInfo calloc()

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

create

public static VmaVirtualAllocationCreateInfo create()

Returns a new VmaVirtualAllocationCreateInfo instance allocated with BufferUtils.

create

public static VmaVirtualAllocationCreateInfo create(long address)

Returns a new VmaVirtualAllocationCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VmaVirtualAllocationCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaVirtualAllocationCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaVirtualAllocationCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaVirtualAllocationCreateInfo.Buffer create(int capacity)

Returns a new VmaVirtualAllocationCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VmaVirtualAllocationCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VmaVirtualAllocationCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsize

public static long nsize(long struct)

Unsafe version of size().

nalignment

public static long nalignment(long struct)

Unsafe version of alignment().

nflags

public static int nflags(long struct)

Unsafe version of flags().

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.

nalignment

public static void nalignment(long struct,
 long value)

Unsafe version of alignment.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

npUserData

public static void npUserData(long struct,
 long value)

Unsafe version of pUserData.