Record Class SDL_GPUIndirectDrawCommand

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUIndirectDrawCommand

All Implemented Interfaces:

IPointer, ISDL_GPUIndirectDrawCommand

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUIndirectDrawCommand(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUIndirectDrawCommand

A structure specifying the parameters of an 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_DrawGPUPrimitivesIndirect

Structure

typedef struct SDL_GPUIndirectDrawCommand {
    Uint32 num_vertices;
    Uint32 num_instances;
    Uint32 first_vertex;
    Uint32 first_instance;
} SDL_GPUIndirectDrawCommand;

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_GPUIndirectDrawCommand.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_instance
static final ValueLayout.OfInt	LAYOUT$first_vertex
static final ValueLayout.OfInt	LAYOUT$num_instances
static final ValueLayout.OfInt	LAYOUT$num_vertices
static final long	OFFSET$first_instance
static final long	OFFSET$first_vertex
static final long	OFFSET$num_instances
static final long	OFFSET$num_vertices
static final MemoryLayout.PathElement	PATH$first_instance
static final MemoryLayout.PathElement	PATH$first_vertex
static final MemoryLayout.PathElement	PATH$num_instances
static final MemoryLayout.PathElement	PATH$num_vertices
static final long	SIZE$first_instance
static final long	SIZE$first_vertex
static final long	SIZE$num_instances
static final long	SIZE$num_vertices

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$num_vertices

PATH$num_instances

public static final MemoryLayout.PathElement PATH$num_instances

PATH$first_vertex

public static final MemoryLayout.PathElement PATH$first_vertex

PATH$first_instance

public static final MemoryLayout.PathElement PATH$first_instance

LAYOUT$num_vertices

public static final ValueLayout.OfInt LAYOUT$num_vertices

LAYOUT$num_instances

public static final ValueLayout.OfInt LAYOUT$num_instances

LAYOUT$first_vertex

public static final ValueLayout.OfInt LAYOUT$first_vertex

LAYOUT$first_instance

public static final ValueLayout.OfInt LAYOUT$first_instance

SIZE$num_vertices

public static final long SIZE$num_vertices

SIZE$num_instances

public static final long SIZE$num_instances

SIZE$first_vertex

public static final long SIZE$first_vertex

SIZE$first_instance

public static final long SIZE$first_instance

OFFSET$num_vertices

public static final long OFFSET$num_vertices

OFFSET$num_instances

public static final long OFFSET$num_instances

OFFSET$first_vertex

public static final long OFFSET$first_vertex

OFFSET$first_instance

public static final long OFFSET$first_instance

Constructor Details

SDL_GPUIndirectDrawCommand

public SDL_GPUIndirectDrawCommand(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUIndirectDrawCommand record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUIndirectDrawCommand allocate(Arena arena)

allocate

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

clone

public static SDL_GPUIndirectDrawCommand clone(Arena arena,
 SDL_GPUIndirectDrawCommand src)

num_vertices

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

num_vertices

public SDL_GPUIndirectDrawCommand num_vertices(@NativeType("Uint32") @Unsigned
 int value)

num_instances

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

num_instances

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

first_vertex

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

first_vertex

public SDL_GPUIndirectDrawCommand first_vertex(@NativeType("Uint32") @Unsigned
 int value)

first_instance

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

first_instance

public SDL_GPUIndirectDrawCommand 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