Record Class VkIndirectCommandsIndexBufferTokenEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkIndirectCommandsIndexBufferTokenEXT

All Implemented Interfaces:

IPointer, IVkIndirectCommandsIndexBufferTokenEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkIndirectCommandsIndexBufferTokenEXT(@NotNull MemorySegment segment)
extends Record
implements IVkIndirectCommandsIndexBufferTokenEXT

Represents a pointer to a VkIndirectCommandsIndexBufferTokenEXT structure in native memory.

Structure

typedef struct VkIndirectCommandsIndexBufferTokenEXT {
    VkIndirectCommandsInputModeFlagsEXT mode;
} VkIndirectCommandsIndexBufferTokenEXT;

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:

• VkIndirectCommandsIndexBufferTokenEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$mode
static final long	OFFSET$mode
static final MemoryLayout.PathElement	PATH$mode
static final long	SIZE$mode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkIndirectCommandsIndexBufferTokenEXT	allocate(Arena arena)
static VkIndirectCommandsIndexBufferTokenEXT.Ptr	allocate(Arena arena, long count)
static VkIndirectCommandsIndexBufferTokenEXT	clone(Arena arena, VkIndirectCommandsIndexBufferTokenEXT 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	mode()
VkIndirectCommandsIndexBufferTokenEXT	mode(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$mode

public static final MemoryLayout.PathElement PATH$mode

LAYOUT$mode

public static final ValueLayout.OfInt LAYOUT$mode

SIZE$mode

public static final long SIZE$mode

OFFSET$mode

public static final long OFFSET$mode

Constructor Details

VkIndirectCommandsIndexBufferTokenEXT

public VkIndirectCommandsIndexBufferTokenEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkIndirectCommandsIndexBufferTokenEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkIndirectCommandsIndexBufferTokenEXT allocate(Arena arena)

allocate

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

clone

public static VkIndirectCommandsIndexBufferTokenEXT clone(Arena arena,
 VkIndirectCommandsIndexBufferTokenEXT src)

mode

@EnumType(VkIndirectCommandsInputModeFlagsEXT.class)
public int mode()

mode

public VkIndirectCommandsIndexBufferTokenEXT mode(@EnumType(VkIndirectCommandsInputModeFlagsEXT.class)
 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