Package org.lwjgl.util.vma

Class VmaVirtualAllocationInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaVirtualAllocationInfo>

org.lwjgl.util.vma.VmaVirtualAllocationInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VmaVirtualAllocationInfo
extends Struct<VmaVirtualAllocationInfo>
implements NativeResource

 struct VmaVirtualAllocationInfo {
     VkDeviceSize offset;
     VkDeviceSize size;
     void * pUserData;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmaVirtualAllocationInfo.Buffer	An array of VmaVirtualAllocationInfo 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	OFFSET	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
VmaVirtualAllocationInfo(ByteBuffer container)	Creates a VmaVirtualAllocationInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VmaVirtualAllocationInfo	calloc()	Returns a new VmaVirtualAllocationInfo instance allocated with memCalloc.
static VmaVirtualAllocationInfo.Buffer	calloc(int capacity)	Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with memCalloc.
static VmaVirtualAllocationInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VmaVirtualAllocationInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaVirtualAllocationInfo	calloc(MemoryStack stack)	Returns a new VmaVirtualAllocationInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaVirtualAllocationInfo	create()	Returns a new VmaVirtualAllocationInfo instance allocated with BufferUtils.
static VmaVirtualAllocationInfo.Buffer	create(int capacity)	Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with BufferUtils.
static VmaVirtualAllocationInfo	create(long address)	Returns a new VmaVirtualAllocationInfo instance for the specified memory address.
static VmaVirtualAllocationInfo.Buffer	create(long address, int capacity)	Create a VmaVirtualAllocationInfo.Buffer instance at the specified memory.
static @Nullable VmaVirtualAllocationInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaVirtualAllocationInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VmaVirtualAllocationInfo	malloc()	Returns a new VmaVirtualAllocationInfo instance allocated with memAlloc.
static VmaVirtualAllocationInfo.Buffer	malloc(int capacity)	Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with memAlloc.
static VmaVirtualAllocationInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VmaVirtualAllocationInfo.Buffer instance allocated on the specified MemoryStack.
static VmaVirtualAllocationInfo	malloc(MemoryStack stack)	Returns a new VmaVirtualAllocationInfo instance allocated on the specified MemoryStack.
static long	noffset(long struct)	Unsafe version of offset().
static long	npUserData(long struct)	Unsafe version of pUserData().
static long	nsize(long struct)	Unsafe version of size().
long	offset()
long	pUserData()
long	size()
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.

OFFSET

public static final int OFFSET

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

PUSERDATA

public static final int PUSERDATA

The struct member offsets.

Constructor Details

VmaVirtualAllocationInfo

public VmaVirtualAllocationInfo(ByteBuffer container)

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

offset

public long offset()

Returns:

the value of the offset field.

size

public long size()

Returns:

the value of the size field.

pUserData

public long pUserData()

Returns:

the value of the pUserData field.

malloc

public static VmaVirtualAllocationInfo malloc()

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

calloc

public static VmaVirtualAllocationInfo calloc()

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

create

public static VmaVirtualAllocationInfo create()

Returns a new VmaVirtualAllocationInfo instance allocated with BufferUtils.

create

public static VmaVirtualAllocationInfo create(long address)

Returns a new VmaVirtualAllocationInfo instance for the specified memory address.

createSafe

public static @Nullable VmaVirtualAllocationInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaVirtualAllocationInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaVirtualAllocationInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaVirtualAllocationInfo.Buffer create(int capacity)

Returns a new VmaVirtualAllocationInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VmaVirtualAllocationInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VmaVirtualAllocationInfo malloc(MemoryStack stack)

Returns a new VmaVirtualAllocationInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VmaVirtualAllocationInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

noffset

public static long noffset(long struct)

Unsafe version of offset().

nsize

public static long nsize(long struct)

Unsafe version of size().

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().