Record Class SDL_GPUDepthStencilState

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUDepthStencilState

All Implemented Interfaces:

IPointer, ISDL_GPUDepthStencilState

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUDepthStencilState(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUDepthStencilState

A structure specifying the parameters of the graphics pipeline depth stencil state.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUGraphicsPipelineCreateInfo

Structure

typedef struct SDL_GPUDepthStencilState {
    SDL_GPUCompareOp compare_op;
    SDL_GPUStencilOpState back_stencil_state;
    SDL_GPUStencilOpState front_stencil_state;
    Uint8 compare_mask;
    Uint8 write_mask;
    bool enable_depth_test;
    bool enable_depth_write;
    bool enable_stencil_test;
    Uint8 padding1;
    Uint8 padding2;
    Uint8 padding3;
} SDL_GPUDepthStencilState;

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_GPUDepthStencilState.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$back_stencil_state
static final ValueLayout.OfByte	LAYOUT$compare_mask
static final ValueLayout.OfInt	LAYOUT$compare_op
static final ValueLayout.OfBoolean	LAYOUT$enable_depth_test
static final ValueLayout.OfBoolean	LAYOUT$enable_depth_write
static final ValueLayout.OfBoolean	LAYOUT$enable_stencil_test
static final StructLayout	LAYOUT$front_stencil_state
static final ValueLayout.OfByte	LAYOUT$padding1
static final ValueLayout.OfByte	LAYOUT$padding2
static final ValueLayout.OfByte	LAYOUT$padding3
static final ValueLayout.OfByte	LAYOUT$write_mask
static final long	OFFSET$back_stencil_state
static final long	OFFSET$compare_mask
static final long	OFFSET$compare_op
static final long	OFFSET$enable_depth_test
static final long	OFFSET$enable_depth_write
static final long	OFFSET$enable_stencil_test
static final long	OFFSET$front_stencil_state
static final long	OFFSET$padding1
static final long	OFFSET$padding2
static final long	OFFSET$padding3
static final long	OFFSET$write_mask
static final MemoryLayout.PathElement	PATH$back_stencil_state
static final MemoryLayout.PathElement	PATH$compare_mask
static final MemoryLayout.PathElement	PATH$compare_op
static final MemoryLayout.PathElement	PATH$enable_depth_test
static final MemoryLayout.PathElement	PATH$enable_depth_write
static final MemoryLayout.PathElement	PATH$enable_stencil_test
static final MemoryLayout.PathElement	PATH$front_stencil_state
static final MemoryLayout.PathElement	PATH$padding1
static final MemoryLayout.PathElement	PATH$padding2
static final MemoryLayout.PathElement	PATH$padding3
static final MemoryLayout.PathElement	PATH$write_mask
static final long	SIZE$back_stencil_state
static final long	SIZE$compare_mask
static final long	SIZE$compare_op
static final long	SIZE$enable_depth_test
static final long	SIZE$enable_depth_write
static final long	SIZE$enable_stencil_test
static final long	SIZE$front_stencil_state
static final long	SIZE$padding1
static final long	SIZE$padding2
static final long	SIZE$padding3
static final long	SIZE$write_mask

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUDepthStencilState	allocate(Arena arena)
static SDL_GPUDepthStencilState.Ptr	allocate(Arena arena, long count)
@NotNull SDL_GPUStencilOpState	back_stencil_state()
SDL_GPUDepthStencilState	back_stencil_state(@NotNull SDL_GPUStencilOpState value)
SDL_GPUDepthStencilState	back_stencil_state(Consumer<@NotNull SDL_GPUStencilOpState> consumer)
static SDL_GPUDepthStencilState	clone(Arena arena, SDL_GPUDepthStencilState src)
byte	compare_mask()
SDL_GPUDepthStencilState	compare_mask(byte value)
int	compare_op()
SDL_GPUDepthStencilState	compare_op(int value)
boolean	enable_depth_test()
SDL_GPUDepthStencilState	enable_depth_test(boolean value)
boolean	enable_depth_write()
SDL_GPUDepthStencilState	enable_depth_write(boolean value)
boolean	enable_stencil_test()
SDL_GPUDepthStencilState	enable_stencil_test(boolean value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull SDL_GPUStencilOpState	front_stencil_state()
SDL_GPUDepthStencilState	front_stencil_state(@NotNull SDL_GPUStencilOpState value)
SDL_GPUDepthStencilState	front_stencil_state(Consumer<@NotNull SDL_GPUStencilOpState> consumer)
final int	hashCode()	Returns a hash code value for this object.
byte	padding1()
SDL_GPUDepthStencilState	padding1(byte value)
byte	padding2()
SDL_GPUDepthStencilState	padding2(byte value)
byte	padding3()
SDL_GPUDepthStencilState	padding3(byte value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
byte	write_mask()
SDL_GPUDepthStencilState	write_mask(byte 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$compare_op

public static final MemoryLayout.PathElement PATH$compare_op

PATH$back_stencil_state

public static final MemoryLayout.PathElement PATH$back_stencil_state

PATH$front_stencil_state

public static final MemoryLayout.PathElement PATH$front_stencil_state

PATH$compare_mask

public static final MemoryLayout.PathElement PATH$compare_mask

PATH$write_mask

public static final MemoryLayout.PathElement PATH$write_mask

PATH$enable_depth_test

public static final MemoryLayout.PathElement PATH$enable_depth_test

PATH$enable_depth_write

public static final MemoryLayout.PathElement PATH$enable_depth_write

PATH$enable_stencil_test

public static final MemoryLayout.PathElement PATH$enable_stencil_test

PATH$padding1

public static final MemoryLayout.PathElement PATH$padding1

PATH$padding2

public static final MemoryLayout.PathElement PATH$padding2

PATH$padding3

public static final MemoryLayout.PathElement PATH$padding3

LAYOUT$compare_op

public static final ValueLayout.OfInt LAYOUT$compare_op

LAYOUT$back_stencil_state

public static final StructLayout LAYOUT$back_stencil_state

LAYOUT$front_stencil_state

public static final StructLayout LAYOUT$front_stencil_state

LAYOUT$compare_mask

public static final ValueLayout.OfByte LAYOUT$compare_mask

LAYOUT$write_mask

public static final ValueLayout.OfByte LAYOUT$write_mask

LAYOUT$enable_depth_test

public static final ValueLayout.OfBoolean LAYOUT$enable_depth_test

LAYOUT$enable_depth_write

public static final ValueLayout.OfBoolean LAYOUT$enable_depth_write

LAYOUT$enable_stencil_test

public static final ValueLayout.OfBoolean LAYOUT$enable_stencil_test

LAYOUT$padding1

public static final ValueLayout.OfByte LAYOUT$padding1

LAYOUT$padding2

public static final ValueLayout.OfByte LAYOUT$padding2

LAYOUT$padding3

public static final ValueLayout.OfByte LAYOUT$padding3

SIZE$compare_op

public static final long SIZE$compare_op

SIZE$back_stencil_state

public static final long SIZE$back_stencil_state

SIZE$front_stencil_state

public static final long SIZE$front_stencil_state

SIZE$compare_mask

public static final long SIZE$compare_mask

SIZE$write_mask

public static final long SIZE$write_mask

SIZE$enable_depth_test

public static final long SIZE$enable_depth_test

SIZE$enable_depth_write

public static final long SIZE$enable_depth_write

SIZE$enable_stencil_test

public static final long SIZE$enable_stencil_test

SIZE$padding1

public static final long SIZE$padding1

SIZE$padding2

public static final long SIZE$padding2

SIZE$padding3

public static final long SIZE$padding3

OFFSET$compare_op

public static final long OFFSET$compare_op

OFFSET$back_stencil_state

public static final long OFFSET$back_stencil_state

OFFSET$front_stencil_state

public static final long OFFSET$front_stencil_state

OFFSET$compare_mask

public static final long OFFSET$compare_mask

OFFSET$write_mask

public static final long OFFSET$write_mask

OFFSET$enable_depth_test

public static final long OFFSET$enable_depth_test

OFFSET$enable_depth_write

public static final long OFFSET$enable_depth_write

OFFSET$enable_stencil_test

public static final long OFFSET$enable_stencil_test

OFFSET$padding1

public static final long OFFSET$padding1

OFFSET$padding2

public static final long OFFSET$padding2

OFFSET$padding3

public static final long OFFSET$padding3

Constructor Details

SDL_GPUDepthStencilState

public SDL_GPUDepthStencilState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUDepthStencilState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUDepthStencilState allocate(Arena arena)

allocate

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

clone

public static SDL_GPUDepthStencilState clone(Arena arena,
 SDL_GPUDepthStencilState src)

compare_op

@EnumType(SDL_GPUCompareOp.class)
public int compare_op()

compare_op

public SDL_GPUDepthStencilState compare_op(@EnumType(SDL_GPUCompareOp.class)
 int value)

back_stencil_state

@NotNull
public @NotNull SDL_GPUStencilOpState back_stencil_state()

back_stencil_state

public SDL_GPUDepthStencilState back_stencil_state(@NotNull
 @NotNull SDL_GPUStencilOpState value)

back_stencil_state

public SDL_GPUDepthStencilState back_stencil_state(Consumer<@NotNull SDL_GPUStencilOpState> consumer)

front_stencil_state

@NotNull
public @NotNull SDL_GPUStencilOpState front_stencil_state()

front_stencil_state

public SDL_GPUDepthStencilState front_stencil_state(@NotNull
 @NotNull SDL_GPUStencilOpState value)

front_stencil_state

public SDL_GPUDepthStencilState front_stencil_state(Consumer<@NotNull SDL_GPUStencilOpState> consumer)

compare_mask

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

compare_mask

public SDL_GPUDepthStencilState compare_mask(@NativeType("Uint8") @Unsigned
 byte value)

write_mask

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

write_mask

public SDL_GPUDepthStencilState write_mask(@NativeType("Uint8") @Unsigned
 byte value)

enable_depth_test

@NativeType("boolean")
public boolean enable_depth_test()

enable_depth_test

public SDL_GPUDepthStencilState enable_depth_test(@NativeType("boolean")
 boolean value)

enable_depth_write

@NativeType("boolean")
public boolean enable_depth_write()

enable_depth_write

public SDL_GPUDepthStencilState enable_depth_write(@NativeType("boolean")
 boolean value)

enable_stencil_test

@NativeType("boolean")
public boolean enable_stencil_test()

enable_stencil_test

public SDL_GPUDepthStencilState enable_stencil_test(@NativeType("boolean")
 boolean value)

padding1

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

padding1

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

padding2

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

padding2

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

padding3

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

padding3

public SDL_GPUDepthStencilState padding3(@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