Record Class VmaBudget

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

Statistics of current memory usage and available budget for a specific memory heap.

These are fast to calculate. See function vmaGetHeapBudgets().

Structure

typedef struct VmaBudget {
    VmaStatistics statistics;
    VkDeviceSize usage;
    VkDeviceSize budget;
} VmaBudget;

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() Statistics fetched from the library.
  • usage() Estimated current memory usage of the program, in bytes.

    Fetched from system using VK_EXT_memory_budget extension if enabled.

    It might be different than statistics.blockBytes (usually higher) due to additional implicit objects also occupying the memory, like swapchain, pipelines, descriptor heaps, command buffers, or VkDeviceMemory blocks allocated outside of this library, if any.

  • budget() Estimated amount of memory available to the program, in bytes.

    Fetched from system using VK_EXT_memory_budget extension if enabled.

    It might be different (most probably smaller) than VkMemoryHeap::size[heapIndex] due to factors external to the program, decided by the operating system. Difference budget - usage is the amount of additional memory that can probably be allocated without problems. Exceeding the budget may result in various problems.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$statistics

      public static final MemoryLayout.PathElement PATH$statistics

    • PATH$usage

      public static final MemoryLayout.PathElement PATH$usage

    • PATH$budget

      public static final MemoryLayout.PathElement PATH$budget

    • LAYOUT$statistics

      public static final StructLayout LAYOUT$statistics

    • LAYOUT$usage

      public static final ValueLayout.OfLong LAYOUT$usage

    • LAYOUT$budget

      public static final ValueLayout.OfLong LAYOUT$budget

    • SIZE$statistics

      public static final long SIZE$statistics

    • SIZE$usage

      public static final long SIZE$usage

    • SIZE$budget

      public static final long SIZE$budget

    • OFFSET$statistics

      public static final long OFFSET$statistics

    • OFFSET$usage

      public static final long OFFSET$usage

    • OFFSET$budget

      public static final long OFFSET$budget

  • Constructor Details

    • VmaBudget

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

  • Method Details

    • allocate

      public static VmaBudget allocate(Arena arena)

    • allocate

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

    • clone

      public static VmaBudget clone(Arena arena, VmaBudget src)

    • statistics

      @NotNull public @NotNull VmaStatistics statistics()

    • statistics

      public VmaBudget statistics(@NotNull @NotNull VmaStatistics value)

    • statistics

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

    • usage

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

    • usage

      public VmaBudget usage(@NativeType("VkDeviceSize") @Unsigned long value)

    • budget

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

    • budget

      public VmaBudget budget(@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