Record Class VmaVirtualAllocationInfo

java.lang.Object

java.lang.Record

club.doki7.vma.datatype.VmaVirtualAllocationInfo

All Implemented Interfaces:

IPointer, IVmaVirtualAllocationInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VmaVirtualAllocationInfo(@NotNull MemorySegment segment)
extends Record
implements IVmaVirtualAllocationInfo

Parameters of an existing virtual allocation, returned by vmaGetVirtualAllocationInfo().

Structure

typedef struct VmaVirtualAllocationInfo {
    VkDeviceSize offset;
    VkDeviceSize size;
    void* pUserData; // optional
} VmaVirtualAllocationInfo;

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

• offset() Offset of the allocation.

  Offset at which the allocation was made.

• size() Size of the allocation.

  Same value as passed in VmaVirtualAllocationCreateInfo::size.

• pUserData() Custom pointer associated with the allocation.

  Same value as passed in VmaVirtualAllocationCreateInfo::pUserData or to vmaSetVirtualAllocationUserData().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VmaVirtualAllocationInfo.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 ValueLayout.OfLong	LAYOUT$offset
static final AddressLayout	LAYOUT$pUserData
static final ValueLayout.OfLong	LAYOUT$size
static final long	OFFSET$offset
static final long	OFFSET$pUserData
static final long	OFFSET$size
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$pUserData
static final MemoryLayout.PathElement	PATH$size
static final long	SIZE$offset
static final long	SIZE$pUserData
static final long	SIZE$size

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VmaVirtualAllocationInfo	allocate(Arena arena)
static VmaVirtualAllocationInfo.Ptr	allocate(Arena arena, long count)
static VmaVirtualAllocationInfo	clone(Arena arena, VmaVirtualAllocationInfo 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.
long	offset()
VmaVirtualAllocationInfo	offset(long value)
@NotNull MemorySegment	pUserData()
VmaVirtualAllocationInfo	pUserData(@Nullable IPointer pointer)
VmaVirtualAllocationInfo	pUserData(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VmaVirtualAllocationInfo	size(long value)
final String	toString()	Returns a string representation of this record class.

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

public static final MemoryLayout.PathElement PATH$offset

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$pUserData

public static final MemoryLayout.PathElement PATH$pUserData

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$pUserData

public static final AddressLayout LAYOUT$pUserData

SIZE$offset

public static final long SIZE$offset

SIZE$size

public static final long SIZE$size

SIZE$pUserData

public static final long SIZE$pUserData

OFFSET$offset

public static final long OFFSET$offset

OFFSET$size

public static final long OFFSET$size

OFFSET$pUserData

public static final long OFFSET$pUserData

Constructor Details

VmaVirtualAllocationInfo

public VmaVirtualAllocationInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VmaVirtualAllocationInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VmaVirtualAllocationInfo allocate(Arena arena)

allocate

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

clone

public static VmaVirtualAllocationInfo clone(Arena arena,
 VmaVirtualAllocationInfo src)

offset

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

offset

public VmaVirtualAllocationInfo offset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

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

size

public VmaVirtualAllocationInfo size(@NativeType("VkDeviceSize") @Unsigned
 long value)

pUserData

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pUserData()

pUserData

public VmaVirtualAllocationInfo pUserData(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pUserData

public VmaVirtualAllocationInfo pUserData(@Nullable
 @Nullable IPointer pointer)

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