Record Class VmaDefragmentationMove

java.lang.Object

java.lang.Record

club.doki7.vma.datatype.VmaDefragmentationMove

All Implemented Interfaces:

IPointer, IVmaDefragmentationMove

@ValueBasedCandidate
@UnsafeConstructor
public record VmaDefragmentationMove(@NotNull MemorySegment segment)
extends Record
implements IVmaDefragmentationMove

Single move of an allocation to be done for defragmentation.

Structure

typedef struct VmaDefragmentationMove {
    VmaDefragmentationMoveOperation operation;
    VmaAllocation srcAllocation;
    VmaAllocation dstTmpAllocation;
} VmaDefragmentationMove;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

Member documentation

• operation() Operation to be performed on the allocation by vmaEndDefragmentationPass(). Default value is VMA_DEFRAGMENTATION_MOVE_OPERATION_COPY. You can modify it.
• srcAllocation() Allocation that should be moved.
• dstTmpAllocation() Temporary allocation pointing to destination memory that will replace `srcAllocation`.

  Warning: Do not store this allocation in your data structures! It exists only temporarily, for the duration of the defragmentation pass, to be used for binding new buffer/image to the destination memory using e.g. vmaBindBufferMemory(). vmaEndDefragmentationPass() will destroy it and make srcAllocation point to this memory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VmaDefragmentationMove.Ptr	Represents a pointer to / an array of null structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$dstTmpAllocation
static final ValueLayout.OfInt	LAYOUT$operation
static final AddressLayout	LAYOUT$srcAllocation
static final long	OFFSET$dstTmpAllocation
static final long	OFFSET$operation
static final long	OFFSET$srcAllocation
static final MemoryLayout.PathElement	PATH$dstTmpAllocation
static final MemoryLayout.PathElement	PATH$operation
static final MemoryLayout.PathElement	PATH$srcAllocation
static final long	SIZE$dstTmpAllocation
static final long	SIZE$operation
static final long	SIZE$srcAllocation

Constructor Summary

Constructors

Constructor	Description
VmaDefragmentationMove(@NotNull MemorySegment segment)	Creates an instance of a VmaDefragmentationMove record class.

Method Summary

Modifier and Type	Method	Description
static VmaDefragmentationMove	allocate(Arena arena)
static VmaDefragmentationMove.Ptr	allocate(Arena arena, long count)
static VmaDefragmentationMove	clone(Arena arena, VmaDefragmentationMove src)
@Nullable VmaAllocation	dstTmpAllocation()
VmaDefragmentationMove	dstTmpAllocation(@Nullable VmaAllocation value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	operation()
VmaDefragmentationMove	operation(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VmaAllocation	srcAllocation()
VmaDefragmentationMove	srcAllocation(@Nullable VmaAllocation value)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$operation

public static final MemoryLayout.PathElement PATH$operation

PATH$srcAllocation

public static final MemoryLayout.PathElement PATH$srcAllocation

PATH$dstTmpAllocation

public static final MemoryLayout.PathElement PATH$dstTmpAllocation

LAYOUT$operation

public static final ValueLayout.OfInt LAYOUT$operation

LAYOUT$srcAllocation

public static final AddressLayout LAYOUT$srcAllocation

LAYOUT$dstTmpAllocation

public static final AddressLayout LAYOUT$dstTmpAllocation

SIZE$operation

public static final long SIZE$operation

SIZE$srcAllocation

public static final long SIZE$srcAllocation

SIZE$dstTmpAllocation

public static final long SIZE$dstTmpAllocation

OFFSET$operation

public static final long OFFSET$operation

OFFSET$srcAllocation

public static final long OFFSET$srcAllocation

OFFSET$dstTmpAllocation

public static final long OFFSET$dstTmpAllocation

Constructor Details

VmaDefragmentationMove

public VmaDefragmentationMove(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VmaDefragmentationMove record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VmaDefragmentationMove allocate(Arena arena)

allocate

public static VmaDefragmentationMove.Ptr allocate(Arena arena,
 long count)

clone

public static VmaDefragmentationMove clone(Arena arena,
 VmaDefragmentationMove src)

operation

@EnumType(VmaDefragmentationMoveOperation.class)
public int operation()

operation

public VmaDefragmentationMove operation(@EnumType(VmaDefragmentationMoveOperation.class)
 int value)

srcAllocation

@Nullable
public @Nullable VmaAllocation srcAllocation()

srcAllocation

public VmaDefragmentationMove srcAllocation(@Nullable
 @Nullable VmaAllocation value)

dstTmpAllocation

@Nullable
public @Nullable VmaAllocation dstTmpAllocation()

dstTmpAllocation

public VmaDefragmentationMove dstTmpAllocation(@Nullable
 @Nullable VmaAllocation value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component