Record Class SDL_GPUColorTargetDescription

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUColorTargetDescription

All Implemented Interfaces:

IPointer, ISDL_GPUColorTargetDescription

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUColorTargetDescription(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUColorTargetDescription

A structure specifying the parameters of color targets used in a graphics pipeline.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUGraphicsPipelineTargetInfo

Structure

typedef struct SDL_GPUColorTargetDescription {
    SDL_GPUTextureFormat format;
    SDL_GPUColorTargetBlendState blend_state;
} SDL_GPUColorTargetDescription;

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_GPUColorTargetDescription.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 StructLayout	LAYOUT$blend_state
static final ValueLayout.OfInt	LAYOUT$format
static final long	OFFSET$blend_state
static final long	OFFSET$format
static final MemoryLayout.PathElement	PATH$blend_state
static final MemoryLayout.PathElement	PATH$format
static final long	SIZE$blend_state
static final long	SIZE$format

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUColorTargetDescription	allocate(Arena arena)
static SDL_GPUColorTargetDescription.Ptr	allocate(Arena arena, long count)
@NotNull SDL_GPUColorTargetBlendState	blend_state()
SDL_GPUColorTargetDescription	blend_state(@NotNull SDL_GPUColorTargetBlendState value)
SDL_GPUColorTargetDescription	blend_state(Consumer<@NotNull SDL_GPUColorTargetBlendState> consumer)
static SDL_GPUColorTargetDescription	clone(Arena arena, SDL_GPUColorTargetDescription src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	format()
SDL_GPUColorTargetDescription	format(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$format

public static final MemoryLayout.PathElement PATH$format

PATH$blend_state

public static final MemoryLayout.PathElement PATH$blend_state

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

LAYOUT$blend_state

public static final StructLayout LAYOUT$blend_state

SIZE$format

public static final long SIZE$format

SIZE$blend_state

public static final long SIZE$blend_state

OFFSET$format

public static final long OFFSET$format

OFFSET$blend_state

public static final long OFFSET$blend_state

Constructor Details

SDL_GPUColorTargetDescription

public SDL_GPUColorTargetDescription(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUColorTargetDescription record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUColorTargetDescription allocate(Arena arena)

allocate

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

clone

public static SDL_GPUColorTargetDescription clone(Arena arena,
 SDL_GPUColorTargetDescription src)

format

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

format

public SDL_GPUColorTargetDescription format(@EnumType(SDL_GPUTextureFormat.class)
 int value)

blend_state

@NotNull
public @NotNull SDL_GPUColorTargetBlendState blend_state()

blend_state

public SDL_GPUColorTargetDescription blend_state(@NotNull
 @NotNull SDL_GPUColorTargetBlendState value)

blend_state

public SDL_GPUColorTargetDescription blend_state(Consumer<@NotNull SDL_GPUColorTargetBlendState> consumer)

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