Record Class VmaAllocatorInfo

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

Information about existing VmaAllocator object.

Structure

typedef struct VmaAllocatorInfo {
    VkInstance instance;
    VkPhysicalDevice physicalDevice;
    VkDevice device;
} VmaAllocatorInfo;

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

  • instance() Handle to Vulkan instance object.

    This is the same value as has been passed through VmaAllocatorCreateInfo::instance.

  • physicalDevice() Handle to Vulkan physical device object.

    This is the same value as has been passed through VmaAllocatorCreateInfo::physicalDevice.

  • device() Handle to Vulkan device object.

    This is the same value as has been passed through VmaAllocatorCreateInfo::device.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$instance

      public static final MemoryLayout.PathElement PATH$instance

    • PATH$physicalDevice

      public static final MemoryLayout.PathElement PATH$physicalDevice

    • PATH$device

      public static final MemoryLayout.PathElement PATH$device

    • LAYOUT$instance

      public static final AddressLayout LAYOUT$instance

    • LAYOUT$physicalDevice

      public static final AddressLayout LAYOUT$physicalDevice

    • LAYOUT$device

      public static final AddressLayout LAYOUT$device

    • SIZE$instance

      public static final long SIZE$instance

    • SIZE$physicalDevice

      public static final long SIZE$physicalDevice

    • SIZE$device

      public static final long SIZE$device

    • OFFSET$instance

      public static final long OFFSET$instance

    • OFFSET$physicalDevice

      public static final long OFFSET$physicalDevice

    • OFFSET$device

      public static final long OFFSET$device

  • Constructor Details

    • VmaAllocatorInfo

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

  • Method Details

    • allocate

      public static VmaAllocatorInfo allocate(Arena arena)

    • allocate

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

    • clone

      public static VmaAllocatorInfo clone(Arena arena, VmaAllocatorInfo src)

    • instance

      @Nullable public @Nullable VkInstance instance()

    • instance

      public VmaAllocatorInfo instance(@Nullable @Nullable VkInstance value)

    • physicalDevice

      @Nullable public @Nullable VkPhysicalDevice physicalDevice()

    • physicalDevice

      public VmaAllocatorInfo physicalDevice(@Nullable @Nullable VkPhysicalDevice value)

    • device

      @Nullable public @Nullable VkDevice device()

    • device

      public VmaAllocatorInfo device(@Nullable @Nullable VkDevice 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