Record Class SDL_GPURasterizerState

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPURasterizerState

All Implemented Interfaces:

IPointer, ISDL_GPURasterizerState

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPURasterizerState(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPURasterizerState

A structure specifying the parameters of the graphics pipeline rasterizer state.

Note that SDL_GPU_FILLMODE_LINE is not supported on many Android devices. For those devices, the fill mode will automatically fall back to FILL.

Also note that the D3D12 driver will enable depth clamping even if enable_depth_clip is true. If you need this clamp+clip behavior, consider enabling depth clip and then manually clamping depth in your fragment shaders on Metal and Vulkan.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUGraphicsPipelineCreateInfo

Structure

typedef struct SDL_GPURasterizerState {
    SDL_GPUFillMode fill_mode;
    SDL_GPUCullMode cull_mode;
    SDL_GPUFrontFace front_face;
    float depth_bias_constant_factor;
    float depth_bias_clamp;
    float depth_bias_slope_factor;
    bool enable_depth_bias;
    bool enable_depth_clip;
    Uint8 padding1;
    Uint8 padding2;
} SDL_GPURasterizerState;

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_GPURasterizerState.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$cull_mode
static final ValueLayout.OfFloat	LAYOUT$depth_bias_clamp
static final ValueLayout.OfFloat	LAYOUT$depth_bias_constant_factor
static final ValueLayout.OfFloat	LAYOUT$depth_bias_slope_factor
static final ValueLayout.OfBoolean	LAYOUT$enable_depth_bias
static final ValueLayout.OfBoolean	LAYOUT$enable_depth_clip
static final ValueLayout.OfInt	LAYOUT$fill_mode
static final ValueLayout.OfInt	LAYOUT$front_face
static final ValueLayout.OfByte	LAYOUT$padding1
static final ValueLayout.OfByte	LAYOUT$padding2
static final long	OFFSET$cull_mode
static final long	OFFSET$depth_bias_clamp
static final long	OFFSET$depth_bias_constant_factor
static final long	OFFSET$depth_bias_slope_factor
static final long	OFFSET$enable_depth_bias
static final long	OFFSET$enable_depth_clip
static final long	OFFSET$fill_mode
static final long	OFFSET$front_face
static final long	OFFSET$padding1
static final long	OFFSET$padding2
static final MemoryLayout.PathElement	PATH$cull_mode
static final MemoryLayout.PathElement	PATH$depth_bias_clamp
static final MemoryLayout.PathElement	PATH$depth_bias_constant_factor
static final MemoryLayout.PathElement	PATH$depth_bias_slope_factor
static final MemoryLayout.PathElement	PATH$enable_depth_bias
static final MemoryLayout.PathElement	PATH$enable_depth_clip
static final MemoryLayout.PathElement	PATH$fill_mode
static final MemoryLayout.PathElement	PATH$front_face
static final MemoryLayout.PathElement	PATH$padding1
static final MemoryLayout.PathElement	PATH$padding2
static final long	SIZE$cull_mode
static final long	SIZE$depth_bias_clamp
static final long	SIZE$depth_bias_constant_factor
static final long	SIZE$depth_bias_slope_factor
static final long	SIZE$enable_depth_bias
static final long	SIZE$enable_depth_clip
static final long	SIZE$fill_mode
static final long	SIZE$front_face
static final long	SIZE$padding1
static final long	SIZE$padding2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPURasterizerState	allocate(Arena arena)
static SDL_GPURasterizerState.Ptr	allocate(Arena arena, long count)
static SDL_GPURasterizerState	clone(Arena arena, SDL_GPURasterizerState src)
int	cull_mode()
SDL_GPURasterizerState	cull_mode(int value)
float	depth_bias_clamp()
SDL_GPURasterizerState	depth_bias_clamp(float value)
float	depth_bias_constant_factor()
SDL_GPURasterizerState	depth_bias_constant_factor(float value)
float	depth_bias_slope_factor()
SDL_GPURasterizerState	depth_bias_slope_factor(float value)
boolean	enable_depth_bias()
SDL_GPURasterizerState	enable_depth_bias(boolean value)
boolean	enable_depth_clip()
SDL_GPURasterizerState	enable_depth_clip(boolean value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	fill_mode()
SDL_GPURasterizerState	fill_mode(int value)
int	front_face()
SDL_GPURasterizerState	front_face(int value)
final int	hashCode()	Returns a hash code value for this object.
byte	padding1()
SDL_GPURasterizerState	padding1(byte value)
byte	padding2()
SDL_GPURasterizerState	padding2(byte 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$fill_mode

public static final MemoryLayout.PathElement PATH$fill_mode

PATH$cull_mode

public static final MemoryLayout.PathElement PATH$cull_mode

PATH$front_face

public static final MemoryLayout.PathElement PATH$front_face

PATH$depth_bias_constant_factor

public static final MemoryLayout.PathElement PATH$depth_bias_constant_factor

PATH$depth_bias_clamp

public static final MemoryLayout.PathElement PATH$depth_bias_clamp

PATH$depth_bias_slope_factor

public static final MemoryLayout.PathElement PATH$depth_bias_slope_factor

PATH$enable_depth_bias

public static final MemoryLayout.PathElement PATH$enable_depth_bias

PATH$enable_depth_clip

public static final MemoryLayout.PathElement PATH$enable_depth_clip

PATH$padding1

public static final MemoryLayout.PathElement PATH$padding1

PATH$padding2

public static final MemoryLayout.PathElement PATH$padding2

LAYOUT$fill_mode

public static final ValueLayout.OfInt LAYOUT$fill_mode

LAYOUT$cull_mode

public static final ValueLayout.OfInt LAYOUT$cull_mode

LAYOUT$front_face

public static final ValueLayout.OfInt LAYOUT$front_face

LAYOUT$depth_bias_constant_factor

public static final ValueLayout.OfFloat LAYOUT$depth_bias_constant_factor

LAYOUT$depth_bias_clamp

public static final ValueLayout.OfFloat LAYOUT$depth_bias_clamp

LAYOUT$depth_bias_slope_factor

public static final ValueLayout.OfFloat LAYOUT$depth_bias_slope_factor

LAYOUT$enable_depth_bias

public static final ValueLayout.OfBoolean LAYOUT$enable_depth_bias

LAYOUT$enable_depth_clip

public static final ValueLayout.OfBoolean LAYOUT$enable_depth_clip

LAYOUT$padding1

public static final ValueLayout.OfByte LAYOUT$padding1

LAYOUT$padding2

public static final ValueLayout.OfByte LAYOUT$padding2

SIZE$fill_mode

public static final long SIZE$fill_mode

SIZE$cull_mode

public static final long SIZE$cull_mode

SIZE$front_face

public static final long SIZE$front_face

SIZE$depth_bias_constant_factor

public static final long SIZE$depth_bias_constant_factor

SIZE$depth_bias_clamp

public static final long SIZE$depth_bias_clamp

SIZE$depth_bias_slope_factor

public static final long SIZE$depth_bias_slope_factor

SIZE$enable_depth_bias

public static final long SIZE$enable_depth_bias

SIZE$enable_depth_clip

public static final long SIZE$enable_depth_clip

SIZE$padding1

public static final long SIZE$padding1

SIZE$padding2

public static final long SIZE$padding2

OFFSET$fill_mode

public static final long OFFSET$fill_mode

OFFSET$cull_mode

public static final long OFFSET$cull_mode

OFFSET$front_face

public static final long OFFSET$front_face

OFFSET$depth_bias_constant_factor

public static final long OFFSET$depth_bias_constant_factor

OFFSET$depth_bias_clamp

public static final long OFFSET$depth_bias_clamp

OFFSET$depth_bias_slope_factor

public static final long OFFSET$depth_bias_slope_factor

OFFSET$enable_depth_bias

public static final long OFFSET$enable_depth_bias

OFFSET$enable_depth_clip

public static final long OFFSET$enable_depth_clip

OFFSET$padding1

public static final long OFFSET$padding1

OFFSET$padding2

public static final long OFFSET$padding2

Constructor Details

SDL_GPURasterizerState

public SDL_GPURasterizerState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPURasterizerState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPURasterizerState allocate(Arena arena)

allocate

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

clone

public static SDL_GPURasterizerState clone(Arena arena,
 SDL_GPURasterizerState src)

fill_mode

@EnumType(SDL_GPUFillMode.class)
public int fill_mode()

fill_mode

public SDL_GPURasterizerState fill_mode(@EnumType(SDL_GPUFillMode.class)
 int value)

cull_mode

@EnumType(SDL_GPUCullMode.class)
public int cull_mode()

cull_mode

public SDL_GPURasterizerState cull_mode(@EnumType(SDL_GPUCullMode.class)
 int value)

front_face

@EnumType(SDL_GPUFrontFace.class)
public int front_face()

front_face

public SDL_GPURasterizerState front_face(@EnumType(SDL_GPUFrontFace.class)
 int value)

depth_bias_constant_factor

public float depth_bias_constant_factor()

depth_bias_constant_factor

public SDL_GPURasterizerState depth_bias_constant_factor(float value)

depth_bias_clamp

public float depth_bias_clamp()

depth_bias_clamp

public SDL_GPURasterizerState depth_bias_clamp(float value)

depth_bias_slope_factor

public float depth_bias_slope_factor()

depth_bias_slope_factor

public SDL_GPURasterizerState depth_bias_slope_factor(float value)

enable_depth_bias

@NativeType("boolean")
public boolean enable_depth_bias()

enable_depth_bias

public SDL_GPURasterizerState enable_depth_bias(@NativeType("boolean")
 boolean value)

enable_depth_clip

@NativeType("boolean")
public boolean enable_depth_clip()

enable_depth_clip

public SDL_GPURasterizerState enable_depth_clip(@NativeType("boolean")
 boolean value)

padding1

@NativeType("Uint8")
@Unsigned
public byte padding1()

padding1

public SDL_GPURasterizerState padding1(@NativeType("Uint8") @Unsigned
 byte value)

padding2

@NativeType("Uint8")
@Unsigned
public byte padding2()

padding2

public SDL_GPURasterizerState padding2(@NativeType("Uint8") @Unsigned
 byte 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