Package org.lwjgl.util.vma

Class VmaDefragmentationPassMoveInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VmaDefragmentationPassMoveInfo>

org.lwjgl.util.vma.VmaDefragmentationPassMoveInfo

All Implemented Interfaces:

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

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

Parameters for incremental defragmentation steps.

To be used with function BeginDefragmentationPass.

Layout

 struct VmaDefragmentationPassMoveInfo {
     uint32_t moveCount();
     VmaDefragmentationMove * pMoves();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VmaDefragmentationPassMoveInfo.Buffer	An array of VmaDefragmentationPassMoveInfo 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	MOVECOUNT	The struct member offsets.
static final int	PMOVES	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
VmaDefragmentationPassMoveInfo(ByteBuffer container)	Creates a VmaDefragmentationPassMoveInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VmaDefragmentationPassMoveInfo	calloc()	Returns a new VmaDefragmentationPassMoveInfo instance allocated with memCalloc.
static VmaDefragmentationPassMoveInfo.Buffer	calloc(int capacity)	Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with memCalloc.
static VmaDefragmentationPassMoveInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDefragmentationPassMoveInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaDefragmentationPassMoveInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VmaDefragmentationPassMoveInfo	create()	Returns a new VmaDefragmentationPassMoveInfo instance allocated with BufferUtils.
static VmaDefragmentationPassMoveInfo.Buffer	create(int capacity)	Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with BufferUtils.
static VmaDefragmentationPassMoveInfo	create(long address)	Returns a new VmaDefragmentationPassMoveInfo instance for the specified memory address.
static VmaDefragmentationPassMoveInfo.Buffer	create(long address, int capacity)	Create a VmaDefragmentationPassMoveInfo.Buffer instance at the specified memory.
static @Nullable VmaDefragmentationPassMoveInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VmaDefragmentationPassMoveInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VmaDefragmentationPassMoveInfo	malloc()	Returns a new VmaDefragmentationPassMoveInfo instance allocated with memAlloc.
static VmaDefragmentationPassMoveInfo.Buffer	malloc(int capacity)	Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with memAlloc.
static VmaDefragmentationPassMoveInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated on the specified MemoryStack.
static VmaDefragmentationPassMoveInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VmaDefragmentationPassMoveInfo instance allocated on the specified MemoryStack.
int	moveCount()	number of elements in the pMoves array.
VmaDefragmentationPassMoveInfo	moveCount(int value)	Sets the specified value to the moveCount() field.
static int	nmoveCount(long struct)	Unsafe version of moveCount().
static void	nmoveCount(long struct, int value)	Sets the specified value to the moveCount field of the specified struct.
static @Nullable VmaDefragmentationMove.Buffer	npMoves(long struct)	Unsafe version of pMoves().
static void	npMoves(long struct, @Nullable VmaDefragmentationMove.Buffer value)	Unsafe version of pMoves.
@Nullable VmaDefragmentationMove.Buffer	pMoves()	array of moves to be performed by the user in the current defragmentation pass.
VmaDefragmentationPassMoveInfo	pMoves(@Nullable VmaDefragmentationMove.Buffer value)	Sets the address of the specified VmaDefragmentationMove.Buffer to the pMoves() field.
VmaDefragmentationPassMoveInfo	set(int moveCount, @Nullable VmaDefragmentationMove.Buffer pMoves)	Initializes this struct with the specified values.
VmaDefragmentationPassMoveInfo	set(VmaDefragmentationPassMoveInfo 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.

MOVECOUNT

public static final int MOVECOUNT

The struct member offsets.

PMOVES

public static final int PMOVES

The struct member offsets.

Constructor Details

VmaDefragmentationPassMoveInfo

public VmaDefragmentationPassMoveInfo(ByteBuffer container)

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

moveCount

public int moveCount()

number of elements in the pMoves array.

pMoves

public @Nullable VmaDefragmentationMove.Buffer pMoves()

array of moves to be performed by the user in the current defragmentation pass.

Pointer to an array of moveCount elements, owned by VMA, created in BeginDefragmentationPass, destroyed in EndDefragmentationPass.

For each element, you should:

1. Create a new buffer/image in the place pointed by VmaDefragmentationMove::dstMemory + VmaDefragmentationMove::dstOffset.
2. Copy data from the VmaDefragmentationMove::srcAllocation e.g. using vkCmdCopyBuffer, vkCmdCopyImage.
3. Make sure these commands finished executing on the GPU.
4. Destroy the old buffer/image.

Only then you can finish defragmentation pass by calling vmaEndDefragmentationPass(). After this call, the allocation will point to the new place in memory.

Alternatively, if you cannot move specific allocation, you can set VmaDefragmentationMove::operation to DEFRAGMENTATION_MOVE_OPERATION_IGNORE.

Alternatively, if you decide you want to completely remove the allocation:

1. Destroy its buffer/image.
2. Set VmaDefragmentationMove::operation to DEFRAGMENTATION_MOVE_OPERATION_DESTROY.

Then, after vmaEndDefragmentationPass() the allocation will be freed.

moveCount

public VmaDefragmentationPassMoveInfo moveCount(int value)

Sets the specified value to the moveCount() field.

pMoves

public VmaDefragmentationPassMoveInfo pMoves(@Nullable VmaDefragmentationMove.Buffer value)

Sets the address of the specified VmaDefragmentationMove.Buffer to the pMoves() field.

set

public VmaDefragmentationPassMoveInfo set(int moveCount,
 @Nullable VmaDefragmentationMove.Buffer pMoves)

Initializes this struct with the specified values.

set

public VmaDefragmentationPassMoveInfo set(VmaDefragmentationPassMoveInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VmaDefragmentationPassMoveInfo malloc()

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

calloc

public static VmaDefragmentationPassMoveInfo calloc()

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

create

public static VmaDefragmentationPassMoveInfo create()

Returns a new VmaDefragmentationPassMoveInfo instance allocated with BufferUtils.

create

public static VmaDefragmentationPassMoveInfo create(long address)

Returns a new VmaDefragmentationPassMoveInfo instance for the specified memory address.

createSafe

public static @Nullable VmaDefragmentationPassMoveInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VmaDefragmentationPassMoveInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VmaDefragmentationPassMoveInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VmaDefragmentationPassMoveInfo.Buffer create(int capacity)

Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VmaDefragmentationPassMoveInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VmaDefragmentationPassMoveInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmoveCount

public static int nmoveCount(long struct)

Unsafe version of moveCount().

npMoves

public static @Nullable VmaDefragmentationMove.Buffer npMoves(long struct)

Unsafe version of pMoves().

nmoveCount

public static void nmoveCount(long struct,
 int value)

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

npMoves

public static void npMoves(long struct,
 @Nullable VmaDefragmentationMove.Buffer value)

Unsafe version of pMoves.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate