Record Class SDL_GPUVertexAttribute

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUVertexAttribute

All Implemented Interfaces:

IPointer, ISDL_GPUVertexAttribute

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUVertexAttribute(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUVertexAttribute

A structure specifying a vertex attribute.

All vertex attribute locations provided to an SDL_GPUVertexInputState must be unique.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUVertexBufferDescription
• SDL_GPUVertexInputState
• SDL_GPUVertexElementFormat

Structure

typedef struct SDL_GPUVertexAttribute {
    Uint32 location;
    Uint32 buffer_slot;
    SDL_GPUVertexElementFormat format;
    Uint32 offset;
} SDL_GPUVertexAttribute;

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_GPUVertexAttribute.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$buffer_slot
static final ValueLayout.OfInt	LAYOUT$format
static final ValueLayout.OfInt	LAYOUT$location
static final ValueLayout.OfInt	LAYOUT$offset
static final long	OFFSET$buffer_slot
static final long	OFFSET$format
static final long	OFFSET$location
static final long	OFFSET$offset
static final MemoryLayout.PathElement	PATH$buffer_slot
static final MemoryLayout.PathElement	PATH$format
static final MemoryLayout.PathElement	PATH$location
static final MemoryLayout.PathElement	PATH$offset
static final long	SIZE$buffer_slot
static final long	SIZE$format
static final long	SIZE$location
static final long	SIZE$offset

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$location

PATH$buffer_slot

public static final MemoryLayout.PathElement PATH$buffer_slot

PATH$format

public static final MemoryLayout.PathElement PATH$format

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

LAYOUT$location

public static final ValueLayout.OfInt LAYOUT$location

LAYOUT$buffer_slot

public static final ValueLayout.OfInt LAYOUT$buffer_slot

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

LAYOUT$offset

public static final ValueLayout.OfInt LAYOUT$offset

SIZE$location

public static final long SIZE$location

SIZE$buffer_slot

public static final long SIZE$buffer_slot

SIZE$format

public static final long SIZE$format

SIZE$offset

public static final long SIZE$offset

OFFSET$location

public static final long OFFSET$location

OFFSET$buffer_slot

public static final long OFFSET$buffer_slot

OFFSET$format

public static final long OFFSET$format

OFFSET$offset

public static final long OFFSET$offset

Constructor Details

SDL_GPUVertexAttribute

public SDL_GPUVertexAttribute(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUVertexAttribute record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUVertexAttribute allocate(Arena arena)

allocate

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

clone

public static SDL_GPUVertexAttribute clone(Arena arena,
 SDL_GPUVertexAttribute src)

location

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

location

public SDL_GPUVertexAttribute location(@NativeType("Uint32") @Unsigned
 int value)

buffer_slot

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

buffer_slot

public SDL_GPUVertexAttribute buffer_slot(@NativeType("Uint32") @Unsigned
 int value)

format

@EnumType(SDL_GPUVertexElementFormat.class)
public int format()

format

public SDL_GPUVertexAttribute format(@EnumType(SDL_GPUVertexElementFormat.class)
 int value)

offset

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

offset

public SDL_GPUVertexAttribute offset(@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