Record Class VmaTotalStatistics

java.lang.Object

java.lang.Record

club.doki7.vma.datatype.VmaTotalStatistics

All Implemented Interfaces:

IPointer, IVmaTotalStatistics

@ValueBasedCandidate
@UnsafeConstructor
public record VmaTotalStatistics(@NotNull MemorySegment segment)
extends Record
implements IVmaTotalStatistics

General statistics from current state of the Allocator - total memory usage across all memory heaps and types.

These are slower to calculate. Use for debugging purposes. See function vmaCalculateStatistics().

Structure

typedef struct VmaTotalStatistics {
    VmaDetailedStatistics[VK_MAX_MEMORY_TYPES] memoryType;
    VmaDetailedStatistics[VK_MAX_MEMORY_HEAPS] memoryHeap;
    VmaDetailedStatistics total;
} VmaTotalStatistics;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VmaTotalStatistics.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 SequenceLayout	LAYOUT$memoryHeap
static final SequenceLayout	LAYOUT$memoryType
static final StructLayout	LAYOUT$total
static final long	OFFSET$memoryHeap
static final long	OFFSET$memoryType
static final long	OFFSET$total
static final MemoryLayout.PathElement	PATH$memoryHeap
static final MemoryLayout.PathElement	PATH$memoryType
static final MemoryLayout.PathElement	PATH$total
static final long	SIZE$memoryHeap
static final long	SIZE$memoryType
static final long	SIZE$total

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VmaTotalStatistics	allocate(Arena arena)
static VmaTotalStatistics.Ptr	allocate(Arena arena, long count)
static VmaTotalStatistics	clone(Arena arena, VmaTotalStatistics 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.
VmaDetailedStatistics.Ptr	memoryHeap()
VmaTotalStatistics	memoryHeap(VmaDetailedStatistics.Ptr value)
VmaTotalStatistics	memoryHeap(@NotNull Consumer<VmaDetailedStatistics.Ptr> consumer)
VmaDetailedStatistics	memoryHeapAt(int index)
void	memoryHeapAt(int index, VmaDetailedStatistics value)
@NotNull MemorySegment	memoryHeapRaw()
VmaDetailedStatistics.Ptr	memoryType()
VmaTotalStatistics	memoryType(VmaDetailedStatistics.Ptr value)
VmaTotalStatistics	memoryType(@NotNull Consumer<VmaDetailedStatistics.Ptr> consumer)
VmaDetailedStatistics	memoryTypeAt(int index)
void	memoryTypeAt(int index, VmaDetailedStatistics value)
@NotNull MemorySegment	memoryTypeRaw()
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
@NotNull VmaDetailedStatistics	total()
VmaTotalStatistics	total(@NotNull VmaDetailedStatistics value)
VmaTotalStatistics	total(Consumer<@NotNull VmaDetailedStatistics> consumer)

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

public static final MemoryLayout.PathElement PATH$memoryType

PATH$memoryHeap

public static final MemoryLayout.PathElement PATH$memoryHeap

PATH$total

public static final MemoryLayout.PathElement PATH$total

LAYOUT$memoryType

public static final SequenceLayout LAYOUT$memoryType

LAYOUT$memoryHeap

public static final SequenceLayout LAYOUT$memoryHeap

LAYOUT$total

public static final StructLayout LAYOUT$total

SIZE$memoryType

public static final long SIZE$memoryType

SIZE$memoryHeap

public static final long SIZE$memoryHeap

SIZE$total

public static final long SIZE$total

OFFSET$memoryType

public static final long OFFSET$memoryType

OFFSET$memoryHeap

public static final long OFFSET$memoryHeap

OFFSET$total

public static final long OFFSET$total

Constructor Details

VmaTotalStatistics

public VmaTotalStatistics(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VmaTotalStatistics record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VmaTotalStatistics allocate(Arena arena)

allocate

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

clone

public static VmaTotalStatistics clone(Arena arena,
 VmaTotalStatistics src)

memoryType

public VmaDetailedStatistics.Ptr memoryType()

memoryType

public VmaTotalStatistics memoryType(@NotNull
 @NotNull Consumer<VmaDetailedStatistics.Ptr> consumer)

memoryType

public VmaTotalStatistics memoryType(VmaDetailedStatistics.Ptr value)

memoryTypeAt

public VmaDetailedStatistics memoryTypeAt(int index)

memoryTypeAt

public void memoryTypeAt(int index,
 VmaDetailedStatistics value)

memoryTypeRaw

@NotNull
public @NotNull MemorySegment memoryTypeRaw()

memoryHeap

public VmaDetailedStatistics.Ptr memoryHeap()

memoryHeap

public VmaTotalStatistics memoryHeap(@NotNull
 @NotNull Consumer<VmaDetailedStatistics.Ptr> consumer)

memoryHeap

public VmaTotalStatistics memoryHeap(VmaDetailedStatistics.Ptr value)

memoryHeapAt

public VmaDetailedStatistics memoryHeapAt(int index)

memoryHeapAt

public void memoryHeapAt(int index,
 VmaDetailedStatistics value)

memoryHeapRaw

@NotNull
public @NotNull MemorySegment memoryHeapRaw()

total

@NotNull
public @NotNull VmaDetailedStatistics total()

total

public VmaTotalStatistics total(@NotNull
 @NotNull VmaDetailedStatistics value)

total

public VmaTotalStatistics total(Consumer<@NotNull VmaDetailedStatistics> consumer)

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