Record Class VkCheckpointData2NV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCheckpointData2NV

All Implemented Interfaces:

IPointer, IVkCheckpointData2NV

@ValueBasedCandidate
@UnsafeConstructor
public record VkCheckpointData2NV(@NotNull MemorySegment segment)
extends Record
implements IVkCheckpointData2NV

Represents a pointer to a VkCheckpointData2NV structure in native memory.

Structure

typedef struct VkCheckpointData2NV {
    VkStructureType sType;
    void* pNext; // optional
    VkPipelineStageFlags2 stage;
    void* pCheckpointMarker;
} VkCheckpointData2NV;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_CHECKPOINT_DATA_2_NV

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:

• VkCheckpointData2NV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$stage

PATH$pCheckpointMarker

public static final MemoryLayout.PathElement PATH$pCheckpointMarker

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$stage

public static final ValueLayout.OfLong LAYOUT$stage

LAYOUT$pCheckpointMarker

public static final AddressLayout LAYOUT$pCheckpointMarker

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$stage

public static final long SIZE$stage

SIZE$pCheckpointMarker

public static final long SIZE$pCheckpointMarker

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$stage

public static final long OFFSET$stage

OFFSET$pCheckpointMarker

public static final long OFFSET$pCheckpointMarker

Constructor Details

VkCheckpointData2NV

public VkCheckpointData2NV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCheckpointData2NV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCheckpointData2NV allocate(Arena arena)

allocate

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

clone

public static VkCheckpointData2NV clone(Arena arena,
 VkCheckpointData2NV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCheckpointData2NV pNext(@Nullable
 @Nullable IPointer pointer)

stage

@EnumType(VkPipelineStageFlags2.class)
public long stage()

stage

public VkCheckpointData2NV stage(@EnumType(VkPipelineStageFlags2.class)
 long value)

pCheckpointMarker

@Pointer(comment="void*")
public MemorySegment pCheckpointMarker()

pCheckpointMarker

public void pCheckpointMarker(@Pointer(comment="void*")
 MemorySegment value)

pCheckpointMarker

public VkCheckpointData2NV pCheckpointMarker(@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