Record Class SDL_GPUVertexInputState

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUVertexInputState

All Implemented Interfaces:

IPointer, ISDL_GPUVertexInputState

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUVertexInputState(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUVertexInputState

A structure specifying the parameters of a graphics pipeline vertex input state.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUGraphicsPipelineCreateInfo
• SDL_GPUVertexBufferDescription
• SDL_GPUVertexAttribute

Structure

typedef struct SDL_GPUVertexInputState {
    SDL_GPUVertexBufferDescription const* vertex_buffer_descriptions;
    Uint32 num_vertex_buffers;
    SDL_GPUVertexAttribute const* vertex_attributes;
    Uint32 num_vertex_attributes;
} SDL_GPUVertexInputState;

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_GPUVertexInputState.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$num_vertex_attributes
static final ValueLayout.OfInt	LAYOUT$num_vertex_buffers
static final AddressLayout	LAYOUT$vertex_attributes
static final AddressLayout	LAYOUT$vertex_buffer_descriptions
static final long	OFFSET$num_vertex_attributes
static final long	OFFSET$num_vertex_buffers
static final long	OFFSET$vertex_attributes
static final long	OFFSET$vertex_buffer_descriptions
static final MemoryLayout.PathElement	PATH$num_vertex_attributes
static final MemoryLayout.PathElement	PATH$num_vertex_buffers
static final MemoryLayout.PathElement	PATH$vertex_attributes
static final MemoryLayout.PathElement	PATH$vertex_buffer_descriptions
static final long	SIZE$num_vertex_attributes
static final long	SIZE$num_vertex_buffers
static final long	SIZE$vertex_attributes
static final long	SIZE$vertex_buffer_descriptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUVertexInputState	allocate(Arena arena)
static SDL_GPUVertexInputState.Ptr	allocate(Arena arena, long count)
static SDL_GPUVertexInputState	clone(Arena arena, SDL_GPUVertexInputState 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.
int	num_vertex_attributes()
SDL_GPUVertexInputState	num_vertex_attributes(int value)
int	num_vertex_buffers()
SDL_GPUVertexInputState	num_vertex_buffers(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
@Nullable SDL_GPUVertexAttribute	vertex_attributes()
SDL_GPUVertexAttribute.Ptr	vertex_attributes(int assumedCount)
SDL_GPUVertexInputState	vertex_attributes(@Nullable ISDL_GPUVertexAttribute value)
MemorySegment	vertex_attributesRaw()
void	vertex_attributesRaw(MemorySegment value)
@Nullable SDL_GPUVertexBufferDescription	vertex_buffer_descriptions()
SDL_GPUVertexBufferDescription.Ptr	vertex_buffer_descriptions(int assumedCount)
SDL_GPUVertexInputState	vertex_buffer_descriptions(@Nullable ISDL_GPUVertexBufferDescription value)
MemorySegment	vertex_buffer_descriptionsRaw()
void	vertex_buffer_descriptionsRaw(MemorySegment 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$vertex_buffer_descriptions

public static final MemoryLayout.PathElement PATH$vertex_buffer_descriptions

PATH$num_vertex_buffers

public static final MemoryLayout.PathElement PATH$num_vertex_buffers

PATH$vertex_attributes

public static final MemoryLayout.PathElement PATH$vertex_attributes

PATH$num_vertex_attributes

public static final MemoryLayout.PathElement PATH$num_vertex_attributes

LAYOUT$vertex_buffer_descriptions

public static final AddressLayout LAYOUT$vertex_buffer_descriptions

LAYOUT$num_vertex_buffers

public static final ValueLayout.OfInt LAYOUT$num_vertex_buffers

LAYOUT$vertex_attributes

public static final AddressLayout LAYOUT$vertex_attributes

LAYOUT$num_vertex_attributes

public static final ValueLayout.OfInt LAYOUT$num_vertex_attributes

SIZE$vertex_buffer_descriptions

public static final long SIZE$vertex_buffer_descriptions

SIZE$num_vertex_buffers

public static final long SIZE$num_vertex_buffers

SIZE$vertex_attributes

public static final long SIZE$vertex_attributes

SIZE$num_vertex_attributes

public static final long SIZE$num_vertex_attributes

OFFSET$vertex_buffer_descriptions

public static final long OFFSET$vertex_buffer_descriptions

OFFSET$num_vertex_buffers

public static final long OFFSET$num_vertex_buffers

OFFSET$vertex_attributes

public static final long OFFSET$vertex_attributes

OFFSET$num_vertex_attributes

public static final long OFFSET$num_vertex_attributes

Constructor Details

SDL_GPUVertexInputState

public SDL_GPUVertexInputState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUVertexInputState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUVertexInputState allocate(Arena arena)

allocate

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

clone

public static SDL_GPUVertexInputState clone(Arena arena,
 SDL_GPUVertexInputState src)

vertex_buffer_descriptions

public SDL_GPUVertexInputState vertex_buffer_descriptions(@Nullable
 @Nullable ISDL_GPUVertexBufferDescription value)

vertex_buffer_descriptions

@Unsafe
@Nullable
public SDL_GPUVertexBufferDescription.Ptr vertex_buffer_descriptions(int assumedCount)

vertex_buffer_descriptions

@Nullable
public @Nullable SDL_GPUVertexBufferDescription vertex_buffer_descriptions()

vertex_buffer_descriptionsRaw

@Pointer(target=SDL_GPUVertexBufferDescription.class)
public MemorySegment vertex_buffer_descriptionsRaw()

vertex_buffer_descriptionsRaw

public void vertex_buffer_descriptionsRaw(@Pointer(target=SDL_GPUVertexBufferDescription.class)
 MemorySegment value)

num_vertex_buffers

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

num_vertex_buffers

public SDL_GPUVertexInputState num_vertex_buffers(@NativeType("Uint32") @Unsigned
 int value)

vertex_attributes

public SDL_GPUVertexInputState vertex_attributes(@Nullable
 @Nullable ISDL_GPUVertexAttribute value)

vertex_attributes

@Unsafe
@Nullable
public SDL_GPUVertexAttribute.Ptr vertex_attributes(int assumedCount)

vertex_attributes

@Nullable
public @Nullable SDL_GPUVertexAttribute vertex_attributes()

vertex_attributesRaw

@Pointer(target=SDL_GPUVertexAttribute.class)
public MemorySegment vertex_attributesRaw()

vertex_attributesRaw

public void vertex_attributesRaw(@Pointer(target=SDL_GPUVertexAttribute.class)
 MemorySegment value)

num_vertex_attributes

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

num_vertex_attributes

public SDL_GPUVertexInputState num_vertex_attributes(@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