Record Class VkBaseOutStructure

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBaseOutStructure

All Implemented Interfaces:

IPointer, IVkBaseOutStructure

@ValueBasedCandidate
@UnsafeConstructor
public record VkBaseOutStructure(@NotNull MemorySegment segment)
extends Record
implements IVkBaseOutStructure

Represents a pointer to a VkBaseOutStructure structure in native memory.

Structure

typedef struct VkBaseOutStructure {
    VkStructureType sType;
    VkBaseOutStructure* pNext; // optional
} VkBaseOutStructure;

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:

• VkBaseOutStructure

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBaseOutStructure	allocate(Arena arena)
static VkBaseOutStructure.Ptr	allocate(Arena arena, long count)
static VkBaseOutStructure	clone(Arena arena, VkBaseOutStructure 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 VkBaseOutStructure	pNext()
VkBaseOutStructure.Ptr	pNext(int assumedCount)
VkBaseOutStructure	pNext(@Nullable IVkBaseOutStructure value)
@NotNull MemorySegment	pNextRaw()
void	pNextRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkBaseOutStructure	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

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

Constructor Details

VkBaseOutStructure

public VkBaseOutStructure(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBaseOutStructure record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBaseOutStructure allocate(Arena arena)

allocate

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

clone

public static VkBaseOutStructure clone(Arena arena,
 VkBaseOutStructure src)

sType

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

sType

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

pNext

public VkBaseOutStructure pNext(@Nullable
 @Nullable IVkBaseOutStructure value)

pNext

@Unsafe
@Nullable
public VkBaseOutStructure.Ptr pNext(int assumedCount)

pNext

@Nullable
public @Nullable VkBaseOutStructure pNext()

pNextRaw

@Pointer(target=VkBaseOutStructure.class)
@NotNull
public @NotNull MemorySegment pNextRaw()

pNextRaw

public void pNextRaw(@Pointer(target=VkBaseOutStructure.class) @NotNull
 @NotNull MemorySegment 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