Record Class VkMemoryAllocateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkMemoryAllocateInfo

All Implemented Interfaces:

IPointer, IVkMemoryAllocateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkMemoryAllocateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkMemoryAllocateInfo

Represents a pointer to a VkMemoryAllocateInfo structure in native memory.

Structure

typedef struct VkMemoryAllocateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceSize allocationSize;
    uint32_t memoryTypeIndex;
} VkMemoryAllocateInfo;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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.

See Also:

• VkMemoryAllocateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkMemoryAllocateInfo.Ptr	Represents a pointer to / an array of VkMemoryAllocateInfo 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$allocationSize
static final ValueLayout.OfInt	LAYOUT$memoryTypeIndex
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$allocationSize
static final long	OFFSET$memoryTypeIndex
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$allocationSize
static final MemoryLayout.PathElement	PATH$memoryTypeIndex
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$allocationSize
static final long	SIZE$memoryTypeIndex
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryAllocateInfo	allocate(Arena arena)
static VkMemoryAllocateInfo.Ptr	allocate(Arena arena, long count)
long	allocationSize()
VkMemoryAllocateInfo	allocationSize(long value)
void	autoInit()
static VkMemoryAllocateInfo	clone(Arena arena, VkMemoryAllocateInfo 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.
int	memoryTypeIndex()
VkMemoryAllocateInfo	memoryTypeIndex(int value)
@NotNull MemorySegment	pNext()
VkMemoryAllocateInfo	pNext(@Nullable IPointer pointer)
VkMemoryAllocateInfo	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkMemoryAllocateInfo	sType(int 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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$allocationSize

public static final MemoryLayout.PathElement PATH$allocationSize

PATH$memoryTypeIndex

public static final MemoryLayout.PathElement PATH$memoryTypeIndex

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$allocationSize

public static final ValueLayout.OfLong LAYOUT$allocationSize

LAYOUT$memoryTypeIndex

public static final ValueLayout.OfInt LAYOUT$memoryTypeIndex

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$allocationSize

public static final long SIZE$allocationSize

SIZE$memoryTypeIndex

public static final long SIZE$memoryTypeIndex

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$allocationSize

public static final long OFFSET$allocationSize

OFFSET$memoryTypeIndex

public static final long OFFSET$memoryTypeIndex

Constructor Details

VkMemoryAllocateInfo

public VkMemoryAllocateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkMemoryAllocateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkMemoryAllocateInfo allocate(Arena arena)

allocate

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

clone

public static VkMemoryAllocateInfo clone(Arena arena,
 VkMemoryAllocateInfo src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkMemoryAllocateInfo sType(@EnumType(VkStructureType.class)
 int value)

pNext

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

pNext

public VkMemoryAllocateInfo pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkMemoryAllocateInfo pNext(@Nullable
 @Nullable IPointer pointer)

allocationSize

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

allocationSize

public VkMemoryAllocateInfo allocationSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

memoryTypeIndex

@Unsigned
public int memoryTypeIndex()

memoryTypeIndex

public VkMemoryAllocateInfo memoryTypeIndex(@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