Record Class VmaDefragmentationStats

java.lang.Object
java.lang.Record
club.doki7.vma.datatype.VmaDefragmentationStats
All Implemented Interfaces:
IPointer, IVmaDefragmentationStats
@ValueBasedCandidate @UnsafeConstructor public record VmaDefragmentationStats(@NotNull MemorySegment segment) extends Record implements IVmaDefragmentationStats

Statistics returned for defragmentation process in function vmaEndDefragmentation().

Structure

typedef struct VmaDefragmentationStats {
    VkDeviceSize bytesMoved;
    VkDeviceSize bytesFreed;
    uint32_t allocationsMoved;
    uint32_t deviceMemoryBlocksFreed;
} VmaDefragmentationStats;

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

  • bytesMoved() Total number of bytes that have been copied while moving allocations to different places.
  • bytesFreed() Total number of bytes that have been released to the system by freeing empty `VkDeviceMemory` objects.
  • allocationsMoved() Number of allocations that have been moved to different places.
  • deviceMemoryBlocksFreed() Number of empty `VkDeviceMemory` objects that have been released to the system.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$bytesMoved

      public static final MemoryLayout.PathElement PATH$bytesMoved

    • PATH$bytesFreed

      public static final MemoryLayout.PathElement PATH$bytesFreed

    • PATH$allocationsMoved

      public static final MemoryLayout.PathElement PATH$allocationsMoved

    • PATH$deviceMemoryBlocksFreed

      public static final MemoryLayout.PathElement PATH$deviceMemoryBlocksFreed

    • LAYOUT$bytesMoved

      public static final ValueLayout.OfLong LAYOUT$bytesMoved

    • LAYOUT$bytesFreed

      public static final ValueLayout.OfLong LAYOUT$bytesFreed

    • LAYOUT$allocationsMoved

      public static final ValueLayout.OfInt LAYOUT$allocationsMoved

    • LAYOUT$deviceMemoryBlocksFreed

      public static final ValueLayout.OfInt LAYOUT$deviceMemoryBlocksFreed

    • SIZE$bytesMoved

      public static final long SIZE$bytesMoved

    • SIZE$bytesFreed

      public static final long SIZE$bytesFreed

    • SIZE$allocationsMoved

      public static final long SIZE$allocationsMoved

    • SIZE$deviceMemoryBlocksFreed

      public static final long SIZE$deviceMemoryBlocksFreed

    • OFFSET$bytesMoved

      public static final long OFFSET$bytesMoved

    • OFFSET$bytesFreed

      public static final long OFFSET$bytesFreed

    • OFFSET$allocationsMoved

      public static final long OFFSET$allocationsMoved

    • OFFSET$deviceMemoryBlocksFreed

      public static final long OFFSET$deviceMemoryBlocksFreed

  • Constructor Details

    • VmaDefragmentationStats

      public VmaDefragmentationStats(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VmaDefragmentationStats record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static VmaDefragmentationStats allocate(Arena arena)

    • allocate

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

    • clone

      public static VmaDefragmentationStats clone(Arena arena, VmaDefragmentationStats src)

    • bytesMoved

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

    • bytesMoved

      public VmaDefragmentationStats bytesMoved(@NativeType("VkDeviceSize") @Unsigned long value)

    • bytesFreed

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

    • bytesFreed

      public VmaDefragmentationStats bytesFreed(@NativeType("VkDeviceSize") @Unsigned long value)

    • allocationsMoved

      @Unsigned public int allocationsMoved()

    • allocationsMoved

      public VmaDefragmentationStats allocationsMoved(@Unsigned int value)

    • deviceMemoryBlocksFreed

      @Unsigned public int deviceMemoryBlocksFreed()

    • deviceMemoryBlocksFreed

      public VmaDefragmentationStats deviceMemoryBlocksFreed(@Unsigned int 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