Top Description Inners Fields Constructors Methods
org.lwjgl.util.vma

public Class VmaDefragmentationPassMoveInfo

extends Struct<VmaDefragmentationPassMoveInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Parameters for incremental defragmentation steps.

To be used with function BeginDefragmentationPass.

Layout


struct VmaDefragmentationPassMoveInfo {
    uint32_t moveCount;
    VmaDefragmentationMove * pMoves;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MOVECOUNT

The struct member offsets.

public static final int
PMOVES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VmaDefragmentationPassMoveInfo(long address, ByteBuffer container)

public
VmaDefragmentationPassMoveInfo(ByteBuffer container)

Creates a VmaDefragmentationPassMoveInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VmaDefragmentationPassMoveInfo
calloc()

Returns a new VmaDefragmentationPassMoveInfo instance allocated with memCalloc.

public static VmaDefragmentationPassMoveInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with memCalloc.

public static VmaDefragmentationPassMoveInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VmaDefragmentationPassMoveInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected VmaDefragmentationPassMoveInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VmaDefragmentationPassMoveInfo
create()

Returns a new VmaDefragmentationPassMoveInfo instance allocated with BufferUtils.

public static VmaDefragmentationPassMoveInfo
create(long address)

Returns a new VmaDefragmentationPassMoveInfo instance for the specified memory address.

public static VmaDefragmentationPassMoveInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with BufferUtils.

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

Create a VmaDefragmentationPassMoveInfo.Buffer instance at the specified memory.

public static VmaDefragmentationPassMoveInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VmaDefragmentationPassMoveInfo
malloc()

Returns a new VmaDefragmentationPassMoveInfo instance allocated with memAlloc.

public static VmaDefragmentationPassMoveInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with memAlloc.

public static VmaDefragmentationPassMoveInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VmaDefragmentationPassMoveInfo instance allocated on the specified MemoryStack.

public static VmaDefragmentationPassMoveInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public int
moveCount()

number of elements in the pMoves array.

public VmaDefragmentationPassMoveInfo
moveCount(int value)

Sets the specified value to the moveCount field.

public static int
nmoveCount(long struct)

Unsafe version of moveCount.

public static void
nmoveCount(long struct, int value)

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

public static VmaDefragmentationMove.Buffer
npMoves(long struct)

Unsafe version of pMoves.

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

Unsafe version of pMoves.

public VmaDefragmentationMove.Buffer
pMoves()

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

public VmaDefragmentationPassMoveInfo
pMoves(VmaDefragmentationMove.Buffer value)

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

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

Initializes this struct with the specified values.

public VmaDefragmentationPassMoveInfo

Returns:

this struct
set
(VmaDefragmentationPassMoveInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MOVECOUNTback to summary
public static final int MOVECOUNT

The struct member offsets.

PMOVESback to summary
public static final int PMOVES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VmaDefragmentationPassMoveInfoback to summary
protected VmaDefragmentationPassMoveInfo(long address, ByteBuffer container)
VmaDefragmentationPassMoveInfoback to summary
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 Detail

callocback to summary
public static VmaDefragmentationPassMoveInfo calloc()

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

callocback to summary
public static VmaDefragmentationPassMoveInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VmaDefragmentationPassMoveInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VmaDefragmentationPassMoveInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VmaDefragmentationPassMoveInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VmaDefragmentationPassMoveInfo create()

Returns a new VmaDefragmentationPassMoveInfo instance allocated with BufferUtils.

createback to summary
public static VmaDefragmentationPassMoveInfo create(long address)

Returns a new VmaDefragmentationPassMoveInfo instance for the specified memory address.

createback to summary
public static VmaDefragmentationPassMoveInfo.Buffer create(int capacity)

Returns a new VmaDefragmentationPassMoveInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VmaDefragmentationPassMoveInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VmaDefragmentationPassMoveInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VmaDefragmentationPassMoveInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VmaDefragmentationPassMoveInfo malloc()

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

mallocback to summary
public static VmaDefragmentationPassMoveInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VmaDefragmentationPassMoveInfo malloc(MemoryStack stack)

Returns a new VmaDefragmentationPassMoveInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VmaDefragmentationPassMoveInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

moveCountback to summary
public int moveCount()

number of elements in the pMoves array.

Annotations
@NativeType:uint32_t
moveCountback to summary
public VmaDefragmentationPassMoveInfo moveCount(int value)

Sets the specified value to the moveCount field.

nmoveCountback to summary
public static int nmoveCount(long struct)

Unsafe version of moveCount.

nmoveCountback to summary
public static void nmoveCount(long struct, int value)

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

npMovesback to summary
public static VmaDefragmentationMove.Buffer npMoves(long struct)

Unsafe version of pMoves.

Annotations
@Nullable
npMovesback to summary
public static void npMoves(long struct, VmaDefragmentationMove.Buffer value)

Unsafe version of pMoves.

pMovesback to summary
public 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.

Annotations
@Nullable
@NativeType:VmaDefragmentationMove *
pMovesback to summary
public VmaDefragmentationPassMoveInfo pMoves(VmaDefragmentationMove.Buffer value)

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

setback to summary
public VmaDefragmentationPassMoveInfo set(int moveCount, VmaDefragmentationMove.Buffer pMoves)

Initializes this struct with the specified values.

setback to summary
public VmaDefragmentationPassMoveInfo set(VmaDefragmentationPassMoveInfo src)

Copies the specified struct data to this struct.

Parameters
src:VmaDefragmentationPassMoveInfo

the source struct

Returns:VmaDefragmentationPassMoveInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.util.vma back to summary

public Class VmaDefragmentationPassMoveInfo.Buffer

extends StructBuffer<VmaDefragmentationPassMoveInfo, VmaDefragmentationPassMoveInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VmaDefragmentationPassMoveInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VmaDefragmentationPassMoveInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VmaDefragmentationPassMoveInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VmaDefragmentationPassMoveInfo
public int

Returns:

the value of the VmaDefragmentationPassMoveInfo#moveCount field.
moveCount
()

public VmaDefragmentationPassMoveInfo.Buffer
moveCount(int value)

Sets the specified value to the VmaDefragmentationPassMoveInfo#moveCount field.

public VmaDefragmentationMove.Buffer

Returns:

a VmaDefragmentationMove.Buffer view of the struct array pointed to by the VmaDefragmentationPassMoveInfo#pMoves field.
pMoves
()

public VmaDefragmentationPassMoveInfo.Buffer
protected VmaDefragmentationPassMoveInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VmaDefragmentationPassMoveInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VmaDefragmentationPassMoveInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VmaDefragmentationPassMoveInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VmaDefragmentationPassMoveInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
moveCountback to summary
public int moveCount()
Returns:int

the value of the VmaDefragmentationPassMoveInfo#moveCount field.

Annotations
@NativeType:uint32_t
moveCountback to summary
public VmaDefragmentationPassMoveInfo.Buffer moveCount(int value)

Sets the specified value to the VmaDefragmentationPassMoveInfo#moveCount field.

pMovesback to summary
public VmaDefragmentationMove.Buffer pMoves()
Returns:VmaDefragmentationMove.Buffer

a VmaDefragmentationMove.Buffer view of the struct array pointed to by the VmaDefragmentationPassMoveInfo#pMoves field.

Annotations
@Nullable
@NativeType:VmaDefragmentationMove *
pMovesback to summary
public VmaDefragmentationPassMoveInfo.Buffer pMoves(VmaDefragmentationMove.Buffer value)

Sets the address of the specified VmaDefragmentationMove.Buffer to the VmaDefragmentationPassMoveInfo#pMoves field.

selfback to summary
protected VmaDefragmentationPassMoveInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override