Record Class VkMemoryDedicatedAllocateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkMemoryDedicatedAllocateInfo

All Implemented Interfaces:

IPointer, IVkMemoryDedicatedAllocateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkMemoryDedicatedAllocateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkMemoryDedicatedAllocateInfo

Represents a pointer to a VkMemoryDedicatedAllocateInfo structure in native memory.

Structure

typedef struct VkMemoryDedicatedAllocateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkImage image; // optional
    VkBuffer buffer; // optional
} VkMemoryDedicatedAllocateInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_MEMORY_DEDICATED_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:

• VkMemoryDedicatedAllocateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkMemoryDedicatedAllocateInfo.Ptr	Represents a pointer to / an array of VkMemoryDedicatedAllocateInfo structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$buffer
static final AddressLayout	LAYOUT$image
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$buffer
static final long	OFFSET$image
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$image
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$buffer
static final long	SIZE$image
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$image

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$image

public static final AddressLayout LAYOUT$image

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$image

public static final long SIZE$image

SIZE$buffer

public static final long SIZE$buffer

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$image

public static final long OFFSET$image

OFFSET$buffer

public static final long OFFSET$buffer

Constructor Details

VkMemoryDedicatedAllocateInfo

public VkMemoryDedicatedAllocateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkMemoryDedicatedAllocateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkMemoryDedicatedAllocateInfo allocate(Arena arena)

allocate

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

clone

public static VkMemoryDedicatedAllocateInfo clone(Arena arena,
 VkMemoryDedicatedAllocateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkMemoryDedicatedAllocateInfo pNext(@Nullable
 @Nullable IPointer pointer)

image

@Nullable
public @Nullable VkImage image()

image

public VkMemoryDedicatedAllocateInfo image(@Nullable
 @Nullable VkImage value)

buffer

@Nullable
public @Nullable VkBuffer buffer()

buffer

public VkMemoryDedicatedAllocateInfo buffer(@Nullable
 @Nullable VkBuffer 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