Record Class SDL_GPUIndirectDispatchCommand

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUIndirectDispatchCommand

All Implemented Interfaces:

IPointer, ISDL_GPUIndirectDispatchCommand

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUIndirectDispatchCommand(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUIndirectDispatchCommand

A structure specifying the parameters of an indexed dispatch command.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_DispatchGPUComputeIndirect

Structure

typedef struct SDL_GPUIndirectDispatchCommand {
    Uint32 groupcount_x;
    Uint32 groupcount_y;
    Uint32 groupcount_z;
} SDL_GPUIndirectDispatchCommand;

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_GPUIndirectDispatchCommand.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$groupcount_x
static final ValueLayout.OfInt	LAYOUT$groupcount_y
static final ValueLayout.OfInt	LAYOUT$groupcount_z
static final long	OFFSET$groupcount_x
static final long	OFFSET$groupcount_y
static final long	OFFSET$groupcount_z
static final MemoryLayout.PathElement	PATH$groupcount_x
static final MemoryLayout.PathElement	PATH$groupcount_y
static final MemoryLayout.PathElement	PATH$groupcount_z
static final long	SIZE$groupcount_x
static final long	SIZE$groupcount_y
static final long	SIZE$groupcount_z

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$groupcount_x

PATH$groupcount_y

public static final MemoryLayout.PathElement PATH$groupcount_y

PATH$groupcount_z

public static final MemoryLayout.PathElement PATH$groupcount_z

LAYOUT$groupcount_x

public static final ValueLayout.OfInt LAYOUT$groupcount_x

LAYOUT$groupcount_y

public static final ValueLayout.OfInt LAYOUT$groupcount_y

LAYOUT$groupcount_z

public static final ValueLayout.OfInt LAYOUT$groupcount_z

SIZE$groupcount_x

public static final long SIZE$groupcount_x

SIZE$groupcount_y

public static final long SIZE$groupcount_y

SIZE$groupcount_z

public static final long SIZE$groupcount_z

OFFSET$groupcount_x

public static final long OFFSET$groupcount_x

OFFSET$groupcount_y

public static final long OFFSET$groupcount_y

OFFSET$groupcount_z

public static final long OFFSET$groupcount_z

Constructor Details

SDL_GPUIndirectDispatchCommand

public SDL_GPUIndirectDispatchCommand(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUIndirectDispatchCommand record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUIndirectDispatchCommand allocate(Arena arena)

allocate

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

clone

public static SDL_GPUIndirectDispatchCommand clone(Arena arena,
 SDL_GPUIndirectDispatchCommand src)

groupcount_x

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

groupcount_x

public SDL_GPUIndirectDispatchCommand groupcount_x(@NativeType("Uint32") @Unsigned
 int value)

groupcount_y

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

groupcount_y

public SDL_GPUIndirectDispatchCommand groupcount_y(@NativeType("Uint32") @Unsigned
 int value)

groupcount_z

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

groupcount_z

public SDL_GPUIndirectDispatchCommand groupcount_z(@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