Record Class SDL_GPUIndexedIndirectDrawCommand

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUIndexedIndirectDrawCommand

All Implemented Interfaces:

IPointer, ISDL_GPUIndexedIndirectDrawCommand

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUIndexedIndirectDrawCommand(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUIndexedIndirectDrawCommand

A structure specifying the parameters of an indexed indirect draw command.

Note that the first_vertex and first_instance parameters are NOT compatible with built-in vertex/instance ID variables in shaders (for example, SV_VertexID); GPU APIs and shader languages do not define these built-in variables consistently, so if your shader depends on them, the only way to keep behavior consistent and portable is to always pass 0 for the correlating parameter in the draw calls.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_DrawGPUIndexedPrimitivesIndirect

Structure

typedef struct SDL_GPUIndexedIndirectDrawCommand {
    Uint32 num_indices;
    Uint32 num_instances;
    Uint32 first_index;
    Sint32 vertex_offset;
    Uint32 first_instance;
} SDL_GPUIndexedIndirectDrawCommand;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SDL_GPUIndexedIndirectDrawCommand.Ptr	Represents a pointer to / an array of null 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$first_index
static final ValueLayout.OfInt	LAYOUT$first_instance
static final ValueLayout.OfInt	LAYOUT$num_indices
static final ValueLayout.OfInt	LAYOUT$num_instances
static final ValueLayout.OfInt	LAYOUT$vertex_offset
static final long	OFFSET$first_index
static final long	OFFSET$first_instance
static final long	OFFSET$num_indices
static final long	OFFSET$num_instances
static final long	OFFSET$vertex_offset
static final MemoryLayout.PathElement	PATH$first_index
static final MemoryLayout.PathElement	PATH$first_instance
static final MemoryLayout.PathElement	PATH$num_indices
static final MemoryLayout.PathElement	PATH$num_instances
static final MemoryLayout.PathElement	PATH$vertex_offset
static final long	SIZE$first_index
static final long	SIZE$first_instance
static final long	SIZE$num_indices
static final long	SIZE$num_instances
static final long	SIZE$vertex_offset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUIndexedIndirectDrawCommand	allocate(Arena arena)
static SDL_GPUIndexedIndirectDrawCommand.Ptr	allocate(Arena arena, long count)
static SDL_GPUIndexedIndirectDrawCommand	clone(Arena arena, SDL_GPUIndexedIndirectDrawCommand src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	first_index()
SDL_GPUIndexedIndirectDrawCommand	first_index(int value)
int	first_instance()
SDL_GPUIndexedIndirectDrawCommand	first_instance(int value)
final int	hashCode()	Returns a hash code value for this object.
int	num_indices()
SDL_GPUIndexedIndirectDrawCommand	num_indices(int value)
int	num_instances()
SDL_GPUIndexedIndirectDrawCommand	num_instances(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	vertex_offset()
SDL_GPUIndexedIndirectDrawCommand	vertex_offset(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$num_indices

public static final MemoryLayout.PathElement PATH$num_indices

PATH$num_instances

public static final MemoryLayout.PathElement PATH$num_instances

PATH$first_index

public static final MemoryLayout.PathElement PATH$first_index

PATH$vertex_offset

public static final MemoryLayout.PathElement PATH$vertex_offset

PATH$first_instance

public static final MemoryLayout.PathElement PATH$first_instance

LAYOUT$num_indices

public static final ValueLayout.OfInt LAYOUT$num_indices

LAYOUT$num_instances

public static final ValueLayout.OfInt LAYOUT$num_instances

LAYOUT$first_index

public static final ValueLayout.OfInt LAYOUT$first_index

LAYOUT$vertex_offset

public static final ValueLayout.OfInt LAYOUT$vertex_offset

LAYOUT$first_instance

public static final ValueLayout.OfInt LAYOUT$first_instance

SIZE$num_indices

public static final long SIZE$num_indices

SIZE$num_instances

public static final long SIZE$num_instances

SIZE$first_index

public static final long SIZE$first_index

SIZE$vertex_offset

public static final long SIZE$vertex_offset

SIZE$first_instance

public static final long SIZE$first_instance

OFFSET$num_indices

public static final long OFFSET$num_indices

OFFSET$num_instances

public static final long OFFSET$num_instances

OFFSET$first_index

public static final long OFFSET$first_index

OFFSET$vertex_offset

public static final long OFFSET$vertex_offset

OFFSET$first_instance

public static final long OFFSET$first_instance

Constructor Details

SDL_GPUIndexedIndirectDrawCommand

public SDL_GPUIndexedIndirectDrawCommand(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUIndexedIndirectDrawCommand record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUIndexedIndirectDrawCommand allocate(Arena arena)

allocate

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

clone

public static SDL_GPUIndexedIndirectDrawCommand clone(Arena arena,
 SDL_GPUIndexedIndirectDrawCommand src)

num_indices

@NativeType("Uint32")
@Unsigned
public int num_indices()

num_indices

public SDL_GPUIndexedIndirectDrawCommand num_indices(@NativeType("Uint32") @Unsigned
 int value)

num_instances

@NativeType("Uint32")
@Unsigned
public int num_instances()

num_instances

public SDL_GPUIndexedIndirectDrawCommand num_instances(@NativeType("Uint32") @Unsigned
 int value)

first_index

@NativeType("Uint32")
@Unsigned
public int first_index()

first_index

public SDL_GPUIndexedIndirectDrawCommand first_index(@NativeType("Uint32") @Unsigned
 int value)

vertex_offset

@NativeType("Sint32")
public int vertex_offset()

vertex_offset

public SDL_GPUIndexedIndirectDrawCommand vertex_offset(@NativeType("Sint32")
 int value)

first_instance

@NativeType("Uint32")
@Unsigned
public int first_instance()

first_instance

public SDL_GPUIndexedIndirectDrawCommand first_instance(@NativeType("Uint32") @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