Record Class VkDrawIndexedIndirectCommand

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDrawIndexedIndirectCommand

All Implemented Interfaces:

IPointer, IVkDrawIndexedIndirectCommand

@ValueBasedCandidate
@UnsafeConstructor
public record VkDrawIndexedIndirectCommand(@NotNull MemorySegment segment)
extends Record
implements IVkDrawIndexedIndirectCommand

Represents a pointer to a VkDrawIndexedIndirectCommand structure in native memory.

Structure

typedef struct VkDrawIndexedIndirectCommand {
    uint32_t indexCount;
    uint32_t instanceCount;
    uint32_t firstIndex;
    int32_t vertexOffset;
    uint32_t firstInstance;
} VkDrawIndexedIndirectCommand;

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:

• VkDrawIndexedIndirectCommand

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDrawIndexedIndirectCommand	allocate(Arena arena)
static VkDrawIndexedIndirectCommand.Ptr	allocate(Arena arena, long count)
static VkDrawIndexedIndirectCommand	clone(Arena arena, VkDrawIndexedIndirectCommand src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	firstIndex()
VkDrawIndexedIndirectCommand	firstIndex(int value)
int	firstInstance()
VkDrawIndexedIndirectCommand	firstInstance(int value)
final int	hashCode()	Returns a hash code value for this object.
int	indexCount()
VkDrawIndexedIndirectCommand	indexCount(int value)
int	instanceCount()
VkDrawIndexedIndirectCommand	instanceCount(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	vertexOffset()
VkDrawIndexedIndirectCommand	vertexOffset(int value)

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$indexCount

public static final MemoryLayout.PathElement PATH$indexCount

PATH$instanceCount

public static final MemoryLayout.PathElement PATH$instanceCount

PATH$firstIndex

public static final MemoryLayout.PathElement PATH$firstIndex

PATH$vertexOffset

public static final MemoryLayout.PathElement PATH$vertexOffset

PATH$firstInstance

public static final MemoryLayout.PathElement PATH$firstInstance

LAYOUT$indexCount

public static final ValueLayout.OfInt LAYOUT$indexCount

LAYOUT$instanceCount

public static final ValueLayout.OfInt LAYOUT$instanceCount

LAYOUT$firstIndex

public static final ValueLayout.OfInt LAYOUT$firstIndex

LAYOUT$vertexOffset

public static final ValueLayout.OfInt LAYOUT$vertexOffset

LAYOUT$firstInstance

public static final ValueLayout.OfInt LAYOUT$firstInstance

SIZE$indexCount

public static final long SIZE$indexCount

SIZE$instanceCount

public static final long SIZE$instanceCount

SIZE$firstIndex

public static final long SIZE$firstIndex

SIZE$vertexOffset

public static final long SIZE$vertexOffset

SIZE$firstInstance

public static final long SIZE$firstInstance

OFFSET$indexCount

public static final long OFFSET$indexCount

OFFSET$instanceCount

public static final long OFFSET$instanceCount

OFFSET$firstIndex

public static final long OFFSET$firstIndex

OFFSET$vertexOffset

public static final long OFFSET$vertexOffset

OFFSET$firstInstance

public static final long OFFSET$firstInstance

Constructor Details

VkDrawIndexedIndirectCommand

public VkDrawIndexedIndirectCommand(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDrawIndexedIndirectCommand record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDrawIndexedIndirectCommand allocate(Arena arena)

allocate

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

clone

public static VkDrawIndexedIndirectCommand clone(Arena arena,
 VkDrawIndexedIndirectCommand src)

indexCount

@Unsigned
public int indexCount()

indexCount

public VkDrawIndexedIndirectCommand indexCount(@Unsigned
 int value)

instanceCount

@Unsigned
public int instanceCount()

instanceCount

public VkDrawIndexedIndirectCommand instanceCount(@Unsigned
 int value)

firstIndex

@Unsigned
public int firstIndex()

firstIndex

public VkDrawIndexedIndirectCommand firstIndex(@Unsigned
 int value)

vertexOffset

public int vertexOffset()

vertexOffset

public VkDrawIndexedIndirectCommand vertexOffset(int value)

firstInstance

@Unsigned
public int firstInstance()

firstInstance

public VkDrawIndexedIndirectCommand firstInstance(@Unsigned
 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