Package org.lwjgl.util.vma

Class VmaBudget

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VmaBudget>
org.lwjgl.util.vma.VmaBudget
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VmaBudget extends Struct<VmaBudget> implements NativeResource

 struct VmaBudget {
     {@link VmaStatistics VmaStatistics} statistics;
     VkDeviceSize usage;
     VkDeviceSize budget;
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STATISTICS

      public static final int STATISTICS
      The struct member offsets.

    • USAGE

      public static final int USAGE
      The struct member offsets.

    • BUDGET

      public static final int BUDGET
      The struct member offsets.

  • Constructor Details

    • VmaBudget

      public VmaBudget(ByteBuffer container)
      Creates a VmaBudget instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

      The created instance holds a strong reference to the container object.

  • Method Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VmaBudget>

    • statistics

      public VmaStatistics statistics()
      Returns:
      a VmaStatistics view of the statistics field.

    • usage

      public long usage()
      Returns:
      the value of the usage field.

    • budget

      public long budget()
      Returns:
      the value of the budget field.

    • malloc

      public static VmaBudget malloc()
      Returns a new VmaBudget instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VmaBudget calloc()
      Returns a new VmaBudget instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VmaBudget create()
      Returns a new VmaBudget instance allocated with BufferUtils.

    • create

      public static VmaBudget create(long address)
      Returns a new VmaBudget instance for the specified memory address.

    • createSafe

      public static @Nullable VmaBudget createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VmaBudget.Buffer malloc(int capacity)
      Returns a new VmaBudget.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VmaBudget.Buffer calloc(int capacity)
      Returns a new VmaBudget.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VmaBudget.Buffer create(int capacity)
      Returns a new VmaBudget.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VmaBudget.Buffer create(long address, int capacity)
      Create a VmaBudget.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VmaBudget.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VmaBudget malloc(MemoryStack stack)
      Returns a new VmaBudget instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VmaBudget calloc(MemoryStack stack)
      Returns a new VmaBudget instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VmaBudget.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new VmaBudget.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VmaBudget.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VmaBudget.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • nstatistics

      public static VmaStatistics nstatistics(long struct)
      Unsafe version of statistics().

    • nusage

      public static long nusage(long struct)
      Unsafe version of usage().

    • nbudget

      public static long nbudget(long struct)
      Unsafe version of budget().