Record Class VmaDefragmentationInfo

java.lang.Object

java.lang.Record

club.doki7.vma.datatype.VmaDefragmentationInfo

All Implemented Interfaces:

IPointer, IVmaDefragmentationInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VmaDefragmentationInfo(@NotNull MemorySegment segment)
extends Record
implements IVmaDefragmentationInfo

Parameters for defragmentation.

To be used with function vmaBeginDefragmentation().

Structure

typedef struct VmaDefragmentationInfo {
    VmaDefragmentationFlags flags;
    VmaPool pool; // optional
    VkDeviceSize maxBytesPerPass;
    uint32_t maxAllocationsPerPass;
    PFN_vmaCheckDefragmentationBreakFunction pfnBreakCallback; // optional
    void* pBreakCallbackUserData; // optional
} VmaDefragmentationInfo;

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

• flags() Use combination of VmaDefragmentationFlagBits.
• pool() Custom pool to be defragmented.

  If null then default pools will undergo defragmentation process.

• maxBytesPerPass() Maximum numbers of bytes that can be copied during single pass, while moving allocations to different places.

  0 means no limit.

• maxAllocationsPerPass() Maximum number of allocations that can be moved during single pass to a different place.

  0 means no limit.

• pfnBreakCallback() Optional custom callback for stopping vmaBeginDefragmentation().

  Have to return true for breaking current defragmentation pass.

• pBreakCallbackUserData() Optional data to pass to custom callback for stopping pass of defragmentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VmaDefragmentationInfo.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 ValueLayout.OfInt	LAYOUT$flags
static final ValueLayout.OfInt	LAYOUT$maxAllocationsPerPass
static final ValueLayout.OfLong	LAYOUT$maxBytesPerPass
static final AddressLayout	LAYOUT$pBreakCallbackUserData
static final AddressLayout	LAYOUT$pfnBreakCallback
static final AddressLayout	LAYOUT$pool
static final long	OFFSET$flags
static final long	OFFSET$maxAllocationsPerPass
static final long	OFFSET$maxBytesPerPass
static final long	OFFSET$pBreakCallbackUserData
static final long	OFFSET$pfnBreakCallback
static final long	OFFSET$pool
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$maxAllocationsPerPass
static final MemoryLayout.PathElement	PATH$maxBytesPerPass
static final MemoryLayout.PathElement	PATH$pBreakCallbackUserData
static final MemoryLayout.PathElement	PATH$pfnBreakCallback
static final MemoryLayout.PathElement	PATH$pool
static final long	SIZE$flags
static final long	SIZE$maxAllocationsPerPass
static final long	SIZE$maxBytesPerPass
static final long	SIZE$pBreakCallbackUserData
static final long	SIZE$pfnBreakCallback
static final long	SIZE$pool

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VmaDefragmentationInfo	allocate(Arena arena)
static VmaDefragmentationInfo.Ptr	allocate(Arena arena, long count)
static VmaDefragmentationInfo	clone(Arena arena, VmaDefragmentationInfo src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VmaDefragmentationInfo	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
int	maxAllocationsPerPass()
VmaDefragmentationInfo	maxAllocationsPerPass(int value)
long	maxBytesPerPass()
VmaDefragmentationInfo	maxBytesPerPass(long value)
@NotNull MemorySegment	pBreakCallbackUserData()
VmaDefragmentationInfo	pBreakCallbackUserData(@Nullable IPointer pointer)
VmaDefragmentationInfo	pBreakCallbackUserData(@NotNull MemorySegment value)
@NotNull MemorySegment	pfnBreakCallback()
VmaDefragmentationInfo	pfnBreakCallback(@Nullable IPointer pointer)
VmaDefragmentationInfo	pfnBreakCallback(@NotNull VMAFunctionTypes.IPFN_vmaCheckDefragmentationBreakFunction value)
VmaDefragmentationInfo	pfnBreakCallback(@NotNull Arena arena, @NotNull VMAFunctionTypes.IPFN_vmaCheckDefragmentationBreakFunction value)
VmaDefragmentationInfo	pfnBreakCallback(@NotNull MemorySegment value)
@Nullable VmaPool	pool()
VmaDefragmentationInfo	pool(@Nullable VmaPool value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$pool

public static final MemoryLayout.PathElement PATH$pool

PATH$maxBytesPerPass

public static final MemoryLayout.PathElement PATH$maxBytesPerPass

PATH$maxAllocationsPerPass

public static final MemoryLayout.PathElement PATH$maxAllocationsPerPass

PATH$pfnBreakCallback

public static final MemoryLayout.PathElement PATH$pfnBreakCallback

PATH$pBreakCallbackUserData

public static final MemoryLayout.PathElement PATH$pBreakCallbackUserData

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$pool

public static final AddressLayout LAYOUT$pool

LAYOUT$maxBytesPerPass

public static final ValueLayout.OfLong LAYOUT$maxBytesPerPass

LAYOUT$maxAllocationsPerPass

public static final ValueLayout.OfInt LAYOUT$maxAllocationsPerPass

LAYOUT$pfnBreakCallback

public static final AddressLayout LAYOUT$pfnBreakCallback

LAYOUT$pBreakCallbackUserData

public static final AddressLayout LAYOUT$pBreakCallbackUserData

SIZE$flags

public static final long SIZE$flags

SIZE$pool

public static final long SIZE$pool

SIZE$maxBytesPerPass

public static final long SIZE$maxBytesPerPass

SIZE$maxAllocationsPerPass

public static final long SIZE$maxAllocationsPerPass

SIZE$pfnBreakCallback

public static final long SIZE$pfnBreakCallback

SIZE$pBreakCallbackUserData

public static final long SIZE$pBreakCallbackUserData

OFFSET$flags

public static final long OFFSET$flags

OFFSET$pool

public static final long OFFSET$pool

OFFSET$maxBytesPerPass

public static final long OFFSET$maxBytesPerPass

OFFSET$maxAllocationsPerPass

public static final long OFFSET$maxAllocationsPerPass

OFFSET$pfnBreakCallback

public static final long OFFSET$pfnBreakCallback

OFFSET$pBreakCallbackUserData

public static final long OFFSET$pBreakCallbackUserData

Constructor Details

VmaDefragmentationInfo

public VmaDefragmentationInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VmaDefragmentationInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VmaDefragmentationInfo allocate(Arena arena)

allocate

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

clone

public static VmaDefragmentationInfo clone(Arena arena,
 VmaDefragmentationInfo src)

flags

@Bitmask(VmaDefragmentationFlags.class)
public int flags()

flags

public VmaDefragmentationInfo flags(@Bitmask(VmaDefragmentationFlags.class)
 int value)

pool

@Nullable
public @Nullable VmaPool pool()

pool

public VmaDefragmentationInfo pool(@Nullable
 @Nullable VmaPool value)

maxBytesPerPass

@NativeType("VkDeviceSize")
@Unsigned
public long maxBytesPerPass()

maxBytesPerPass

public VmaDefragmentationInfo maxBytesPerPass(@NativeType("VkDeviceSize") @Unsigned
 long value)

maxAllocationsPerPass

@Unsigned
public int maxAllocationsPerPass()

maxAllocationsPerPass

public VmaDefragmentationInfo maxAllocationsPerPass(@Unsigned
 int value)

pfnBreakCallback

@Pointer(comment="PFN_vmaCheckDefragmentationBreakFunction")
@NotNull
public @NotNull MemorySegment pfnBreakCallback()

pfnBreakCallback

public VmaDefragmentationInfo pfnBreakCallback(@Pointer(comment="PFN_vmaCheckDefragmentationBreakFunction") @NotNull
 @NotNull MemorySegment value)

pfnBreakCallback

public VmaDefragmentationInfo pfnBreakCallback(@NotNull
 @NotNull VMAFunctionTypes.IPFN_vmaCheckDefragmentationBreakFunction value)

pfnBreakCallback

public VmaDefragmentationInfo pfnBreakCallback(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull VMAFunctionTypes.IPFN_vmaCheckDefragmentationBreakFunction value)

pfnBreakCallback

public VmaDefragmentationInfo pfnBreakCallback(@Nullable
 @Nullable IPointer pointer)

pBreakCallbackUserData

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pBreakCallbackUserData()

pBreakCallbackUserData

public VmaDefragmentationInfo pBreakCallbackUserData(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pBreakCallbackUserData

public VmaDefragmentationInfo pBreakCallbackUserData(@Nullable
 @Nullable IPointer pointer)

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