Record Class VkIndirectCommandsTokenDataEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkIndirectCommandsTokenDataEXT

All Implemented Interfaces:

IPointer, IVkIndirectCommandsTokenDataEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkIndirectCommandsTokenDataEXT(@NotNull MemorySegment segment)
extends Record
implements IVkIndirectCommandsTokenDataEXT

Represents a pointer to a VkIndirectCommandsTokenDataEXT structure in native memory.

Structure

typedef union VkIndirectCommandsTokenDataEXT {
    VkIndirectCommandsPushConstantTokenEXT const* pPushConstant;
    VkIndirectCommandsVertexBufferTokenEXT const* pVertexBuffer;
    VkIndirectCommandsIndexBufferTokenEXT const* pIndexBuffer;
    VkIndirectCommandsExecutionSetTokenEXT const* pExecutionSet;
} VkIndirectCommandsTokenDataEXT;

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:

• VkIndirectCommandsTokenDataEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final UnionLayout	LAYOUT
static final AddressLayout	LAYOUT$pExecutionSet
static final AddressLayout	LAYOUT$pIndexBuffer
static final AddressLayout	LAYOUT$pPushConstant
static final AddressLayout	LAYOUT$pVertexBuffer
static final long	OFFSET$pExecutionSet
static final long	OFFSET$pIndexBuffer
static final long	OFFSET$pPushConstant
static final long	OFFSET$pVertexBuffer
static final MemoryLayout.PathElement	PATH$pExecutionSet
static final MemoryLayout.PathElement	PATH$pIndexBuffer
static final MemoryLayout.PathElement	PATH$pPushConstant
static final MemoryLayout.PathElement	PATH$pVertexBuffer
static final long	SIZE$pExecutionSet
static final long	SIZE$pIndexBuffer
static final long	SIZE$pPushConstant
static final long	SIZE$pVertexBuffer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkIndirectCommandsTokenDataEXT	allocate(Arena arena)
static VkIndirectCommandsTokenDataEXT.Ptr	allocate(Arena arena, long count)
static VkIndirectCommandsTokenDataEXT	clone(Arena arena, VkIndirectCommandsTokenDataEXT 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 VkIndirectCommandsExecutionSetTokenEXT	pExecutionSet()
VkIndirectCommandsExecutionSetTokenEXT.Ptr	pExecutionSet(int assumedCount)
VkIndirectCommandsTokenDataEXT	pExecutionSet(@Nullable IVkIndirectCommandsExecutionSetTokenEXT value)
@NotNull MemorySegment	pExecutionSetRaw()
void	pExecutionSetRaw(@NotNull MemorySegment value)
@Nullable VkIndirectCommandsIndexBufferTokenEXT	pIndexBuffer()
VkIndirectCommandsIndexBufferTokenEXT.Ptr	pIndexBuffer(int assumedCount)
VkIndirectCommandsTokenDataEXT	pIndexBuffer(@Nullable IVkIndirectCommandsIndexBufferTokenEXT value)
@NotNull MemorySegment	pIndexBufferRaw()
void	pIndexBufferRaw(@NotNull MemorySegment value)
@Nullable VkIndirectCommandsPushConstantTokenEXT	pPushConstant()
VkIndirectCommandsPushConstantTokenEXT.Ptr	pPushConstant(int assumedCount)
VkIndirectCommandsTokenDataEXT	pPushConstant(@Nullable IVkIndirectCommandsPushConstantTokenEXT value)
@NotNull MemorySegment	pPushConstantRaw()
void	pPushConstantRaw(@NotNull MemorySegment value)
@Nullable VkIndirectCommandsVertexBufferTokenEXT	pVertexBuffer()
VkIndirectCommandsVertexBufferTokenEXT.Ptr	pVertexBuffer(int assumedCount)
VkIndirectCommandsTokenDataEXT	pVertexBuffer(@Nullable IVkIndirectCommandsVertexBufferTokenEXT value)
@NotNull MemorySegment	pVertexBufferRaw()
void	pVertexBufferRaw(@NotNull MemorySegment 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 UnionLayout LAYOUT

BYTES

public static final long BYTES

PATH$pPushConstant

public static final MemoryLayout.PathElement PATH$pPushConstant

PATH$pVertexBuffer

public static final MemoryLayout.PathElement PATH$pVertexBuffer

PATH$pIndexBuffer

public static final MemoryLayout.PathElement PATH$pIndexBuffer

PATH$pExecutionSet

public static final MemoryLayout.PathElement PATH$pExecutionSet

LAYOUT$pPushConstant

public static final AddressLayout LAYOUT$pPushConstant

LAYOUT$pVertexBuffer

public static final AddressLayout LAYOUT$pVertexBuffer

LAYOUT$pIndexBuffer

public static final AddressLayout LAYOUT$pIndexBuffer

LAYOUT$pExecutionSet

public static final AddressLayout LAYOUT$pExecutionSet

SIZE$pPushConstant

public static final long SIZE$pPushConstant

SIZE$pVertexBuffer

public static final long SIZE$pVertexBuffer

SIZE$pIndexBuffer

public static final long SIZE$pIndexBuffer

SIZE$pExecutionSet

public static final long SIZE$pExecutionSet

OFFSET$pPushConstant

public static final long OFFSET$pPushConstant

OFFSET$pVertexBuffer

public static final long OFFSET$pVertexBuffer

OFFSET$pIndexBuffer

public static final long OFFSET$pIndexBuffer

OFFSET$pExecutionSet

public static final long OFFSET$pExecutionSet

Constructor Details

VkIndirectCommandsTokenDataEXT

public VkIndirectCommandsTokenDataEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkIndirectCommandsTokenDataEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkIndirectCommandsTokenDataEXT allocate(Arena arena)

allocate

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

clone

public static VkIndirectCommandsTokenDataEXT clone(Arena arena,
 VkIndirectCommandsTokenDataEXT src)

pPushConstant

public VkIndirectCommandsTokenDataEXT pPushConstant(@Nullable
 @Nullable IVkIndirectCommandsPushConstantTokenEXT value)

pPushConstant

@Unsafe
@Nullable
public VkIndirectCommandsPushConstantTokenEXT.Ptr pPushConstant(int assumedCount)

pPushConstant

@Nullable
public @Nullable VkIndirectCommandsPushConstantTokenEXT pPushConstant()

pPushConstantRaw

@Pointer(target=VkIndirectCommandsPushConstantTokenEXT.class)
@NotNull
public @NotNull MemorySegment pPushConstantRaw()

pPushConstantRaw

public void pPushConstantRaw(@Pointer(target=VkIndirectCommandsPushConstantTokenEXT.class) @NotNull
 @NotNull MemorySegment value)

pVertexBuffer

public VkIndirectCommandsTokenDataEXT pVertexBuffer(@Nullable
 @Nullable IVkIndirectCommandsVertexBufferTokenEXT value)

pVertexBuffer

@Unsafe
@Nullable
public VkIndirectCommandsVertexBufferTokenEXT.Ptr pVertexBuffer(int assumedCount)

pVertexBuffer

@Nullable
public @Nullable VkIndirectCommandsVertexBufferTokenEXT pVertexBuffer()

pVertexBufferRaw

@Pointer(target=VkIndirectCommandsVertexBufferTokenEXT.class)
@NotNull
public @NotNull MemorySegment pVertexBufferRaw()

pVertexBufferRaw

public void pVertexBufferRaw(@Pointer(target=VkIndirectCommandsVertexBufferTokenEXT.class) @NotNull
 @NotNull MemorySegment value)

pIndexBuffer

public VkIndirectCommandsTokenDataEXT pIndexBuffer(@Nullable
 @Nullable IVkIndirectCommandsIndexBufferTokenEXT value)

pIndexBuffer

@Unsafe
@Nullable
public VkIndirectCommandsIndexBufferTokenEXT.Ptr pIndexBuffer(int assumedCount)

pIndexBuffer

@Nullable
public @Nullable VkIndirectCommandsIndexBufferTokenEXT pIndexBuffer()

pIndexBufferRaw

@Pointer(target=VkIndirectCommandsIndexBufferTokenEXT.class)
@NotNull
public @NotNull MemorySegment pIndexBufferRaw()

pIndexBufferRaw

public void pIndexBufferRaw(@Pointer(target=VkIndirectCommandsIndexBufferTokenEXT.class) @NotNull
 @NotNull MemorySegment value)

pExecutionSet

public VkIndirectCommandsTokenDataEXT pExecutionSet(@Nullable
 @Nullable IVkIndirectCommandsExecutionSetTokenEXT value)

pExecutionSet

@Unsafe
@Nullable
public VkIndirectCommandsExecutionSetTokenEXT.Ptr pExecutionSet(int assumedCount)

pExecutionSet

@Nullable
public @Nullable VkIndirectCommandsExecutionSetTokenEXT pExecutionSet()

pExecutionSetRaw

@Pointer(target=VkIndirectCommandsExecutionSetTokenEXT.class)
@NotNull
public @NotNull MemorySegment pExecutionSetRaw()

pExecutionSetRaw

public void pExecutionSetRaw(@Pointer(target=VkIndirectCommandsExecutionSetTokenEXT.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