Record Class VmaDetailedStatistics

java.lang.Object

java.lang.Record

club.doki7.vma.datatype.VmaDetailedStatistics

All Implemented Interfaces:

IPointer, IVmaDetailedStatistics

@ValueBasedCandidate
@UnsafeConstructor
public record VmaDetailedStatistics(@NotNull MemorySegment segment)
extends Record
implements IVmaDetailedStatistics

More detailed statistics than VmaStatistics.

These are slower to calculate. Use for debugging purposes. See functions: vmaCalculateStatistics(), vmaCalculatePoolStatistics().

Previous version of the statistics API provided averages, but they have been removed because they can be easily calculated as:

VkDeviceSize allocationSizeAvg = detailedStats.statistics.allocationBytes / detailedStats.statistics.allocationCount;
VkDeviceSize unusedBytes = detailedStats.statistics.blockBytes - detailedStats.statistics.allocationBytes;
VkDeviceSize unusedRangeSizeAvg = unusedBytes / detailedStats.unusedRangeCount;

Structure

typedef struct VmaDetailedStatistics {
    VmaStatistics statistics;
    uint32_t unusedRangeCount;
    VkDeviceSize allocationSizeMin;
    VkDeviceSize allocationSizeMax;
    VkDeviceSize unusedRangeSizeMin;
    VkDeviceSize unusedRangeSizeMax;
} VmaDetailedStatistics;

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

• statistics() Basic statistics.
• unusedRangeCount() Number of free ranges of memory between allocations.
• allocationSizeMin() Smallest allocation size. `VK_WHOLE_SIZE` if there are 0 allocations.
• allocationSizeMax() Largest allocation size. 0 if there are 0 allocations.
• unusedRangeSizeMin() Smallest empty range size. `VK_WHOLE_SIZE` if there are 0 empty ranges.
• unusedRangeSizeMax() Largest empty range size. 0 if there are 0 empty ranges.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VmaDetailedStatistics.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.OfLong	LAYOUT$allocationSizeMax
static final ValueLayout.OfLong	LAYOUT$allocationSizeMin
static final StructLayout	LAYOUT$statistics
static final ValueLayout.OfInt	LAYOUT$unusedRangeCount
static final ValueLayout.OfLong	LAYOUT$unusedRangeSizeMax
static final ValueLayout.OfLong	LAYOUT$unusedRangeSizeMin
static final long	OFFSET$allocationSizeMax
static final long	OFFSET$allocationSizeMin
static final long	OFFSET$statistics
static final long	OFFSET$unusedRangeCount
static final long	OFFSET$unusedRangeSizeMax
static final long	OFFSET$unusedRangeSizeMin
static final MemoryLayout.PathElement	PATH$allocationSizeMax
static final MemoryLayout.PathElement	PATH$allocationSizeMin
static final MemoryLayout.PathElement	PATH$statistics
static final MemoryLayout.PathElement	PATH$unusedRangeCount
static final MemoryLayout.PathElement	PATH$unusedRangeSizeMax
static final MemoryLayout.PathElement	PATH$unusedRangeSizeMin
static final long	SIZE$allocationSizeMax
static final long	SIZE$allocationSizeMin
static final long	SIZE$statistics
static final long	SIZE$unusedRangeCount
static final long	SIZE$unusedRangeSizeMax
static final long	SIZE$unusedRangeSizeMin

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VmaDetailedStatistics	allocate(Arena arena)
static VmaDetailedStatistics.Ptr	allocate(Arena arena, long count)
long	allocationSizeMax()
VmaDetailedStatistics	allocationSizeMax(long value)
long	allocationSizeMin()
VmaDetailedStatistics	allocationSizeMin(long value)
static VmaDetailedStatistics	clone(Arena arena, VmaDetailedStatistics src)
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.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull VmaStatistics	statistics()
VmaDetailedStatistics	statistics(@NotNull VmaStatistics value)
VmaDetailedStatistics	statistics(Consumer<@NotNull VmaStatistics> consumer)
final String	toString()	Returns a string representation of this record class.
int	unusedRangeCount()
VmaDetailedStatistics	unusedRangeCount(int value)
long	unusedRangeSizeMax()
VmaDetailedStatistics	unusedRangeSizeMax(long value)
long	unusedRangeSizeMin()
VmaDetailedStatistics	unusedRangeSizeMin(long value)

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$statistics

public static final MemoryLayout.PathElement PATH$statistics

PATH$unusedRangeCount

public static final MemoryLayout.PathElement PATH$unusedRangeCount

PATH$allocationSizeMin

public static final MemoryLayout.PathElement PATH$allocationSizeMin

PATH$allocationSizeMax

public static final MemoryLayout.PathElement PATH$allocationSizeMax

PATH$unusedRangeSizeMin

public static final MemoryLayout.PathElement PATH$unusedRangeSizeMin

PATH$unusedRangeSizeMax

public static final MemoryLayout.PathElement PATH$unusedRangeSizeMax

LAYOUT$statistics

public static final StructLayout LAYOUT$statistics

LAYOUT$unusedRangeCount

public static final ValueLayout.OfInt LAYOUT$unusedRangeCount

LAYOUT$allocationSizeMin

public static final ValueLayout.OfLong LAYOUT$allocationSizeMin

LAYOUT$allocationSizeMax

public static final ValueLayout.OfLong LAYOUT$allocationSizeMax

LAYOUT$unusedRangeSizeMin

public static final ValueLayout.OfLong LAYOUT$unusedRangeSizeMin

LAYOUT$unusedRangeSizeMax

public static final ValueLayout.OfLong LAYOUT$unusedRangeSizeMax

SIZE$statistics

public static final long SIZE$statistics

SIZE$unusedRangeCount

public static final long SIZE$unusedRangeCount

SIZE$allocationSizeMin

public static final long SIZE$allocationSizeMin

SIZE$allocationSizeMax

public static final long SIZE$allocationSizeMax

SIZE$unusedRangeSizeMin

public static final long SIZE$unusedRangeSizeMin

SIZE$unusedRangeSizeMax

public static final long SIZE$unusedRangeSizeMax

OFFSET$statistics

public static final long OFFSET$statistics

OFFSET$unusedRangeCount

public static final long OFFSET$unusedRangeCount

OFFSET$allocationSizeMin

public static final long OFFSET$allocationSizeMin

OFFSET$allocationSizeMax

public static final long OFFSET$allocationSizeMax

OFFSET$unusedRangeSizeMin

public static final long OFFSET$unusedRangeSizeMin

OFFSET$unusedRangeSizeMax

public static final long OFFSET$unusedRangeSizeMax

Constructor Details

VmaDetailedStatistics

public VmaDetailedStatistics(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VmaDetailedStatistics record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VmaDetailedStatistics allocate(Arena arena)

allocate

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

clone

public static VmaDetailedStatistics clone(Arena arena,
 VmaDetailedStatistics src)

statistics

@NotNull
public @NotNull VmaStatistics statistics()

statistics

public VmaDetailedStatistics statistics(@NotNull
 @NotNull VmaStatistics value)

statistics

public VmaDetailedStatistics statistics(Consumer<@NotNull VmaStatistics> consumer)

unusedRangeCount

@Unsigned
public int unusedRangeCount()

unusedRangeCount

public VmaDetailedStatistics unusedRangeCount(@Unsigned
 int value)

allocationSizeMin

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

allocationSizeMin

public VmaDetailedStatistics allocationSizeMin(@NativeType("VkDeviceSize") @Unsigned
 long value)

allocationSizeMax

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

allocationSizeMax

public VmaDetailedStatistics allocationSizeMax(@NativeType("VkDeviceSize") @Unsigned
 long value)

unusedRangeSizeMin

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

unusedRangeSizeMin

public VmaDetailedStatistics unusedRangeSizeMin(@NativeType("VkDeviceSize") @Unsigned
 long value)

unusedRangeSizeMax

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

unusedRangeSizeMax

public VmaDetailedStatistics unusedRangeSizeMax(@NativeType("VkDeviceSize") @Unsigned
 long 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