Record Class SDL_GPUStencilOpState

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_GPUStencilOpState

All Implemented Interfaces:

IPointer, ISDL_GPUStencilOpState

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_GPUStencilOpState(@NotNull MemorySegment segment)
extends Record
implements ISDL_GPUStencilOpState

A structure specifying the stencil operation state of a graphics pipeline.

Since: This struct is available since SDL 3.2.0.

See also:

• SDL_GPUDepthStencilState

Structure

typedef struct SDL_GPUStencilOpState {
    SDL_GPUStencilOp fail_op;
    SDL_GPUStencilOp pass_op;
    SDL_GPUStencilOp depth_fail_op;
    SDL_GPUCompareOp compare_op;
} SDL_GPUStencilOpState;

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_GPUStencilOpState.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$compare_op
static final ValueLayout.OfInt	LAYOUT$depth_fail_op
static final ValueLayout.OfInt	LAYOUT$fail_op
static final ValueLayout.OfInt	LAYOUT$pass_op
static final long	OFFSET$compare_op
static final long	OFFSET$depth_fail_op
static final long	OFFSET$fail_op
static final long	OFFSET$pass_op
static final MemoryLayout.PathElement	PATH$compare_op
static final MemoryLayout.PathElement	PATH$depth_fail_op
static final MemoryLayout.PathElement	PATH$fail_op
static final MemoryLayout.PathElement	PATH$pass_op
static final long	SIZE$compare_op
static final long	SIZE$depth_fail_op
static final long	SIZE$fail_op
static final long	SIZE$pass_op

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$fail_op

PATH$pass_op

public static final MemoryLayout.PathElement PATH$pass_op

PATH$depth_fail_op

public static final MemoryLayout.PathElement PATH$depth_fail_op

PATH$compare_op

public static final MemoryLayout.PathElement PATH$compare_op

LAYOUT$fail_op

public static final ValueLayout.OfInt LAYOUT$fail_op

LAYOUT$pass_op

public static final ValueLayout.OfInt LAYOUT$pass_op

LAYOUT$depth_fail_op

public static final ValueLayout.OfInt LAYOUT$depth_fail_op

LAYOUT$compare_op

public static final ValueLayout.OfInt LAYOUT$compare_op

SIZE$fail_op

public static final long SIZE$fail_op

SIZE$pass_op

public static final long SIZE$pass_op

SIZE$depth_fail_op

public static final long SIZE$depth_fail_op

SIZE$compare_op

public static final long SIZE$compare_op

OFFSET$fail_op

public static final long OFFSET$fail_op

OFFSET$pass_op

public static final long OFFSET$pass_op

OFFSET$depth_fail_op

public static final long OFFSET$depth_fail_op

OFFSET$compare_op

public static final long OFFSET$compare_op

Constructor Details

SDL_GPUStencilOpState

public SDL_GPUStencilOpState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_GPUStencilOpState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_GPUStencilOpState allocate(Arena arena)

allocate

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

clone

public static SDL_GPUStencilOpState clone(Arena arena,
 SDL_GPUStencilOpState src)

fail_op

@EnumType(SDL_GPUStencilOp.class)
public int fail_op()

fail_op

public SDL_GPUStencilOpState fail_op(@EnumType(SDL_GPUStencilOp.class)
 int value)

pass_op

@EnumType(SDL_GPUStencilOp.class)
public int pass_op()

pass_op

public SDL_GPUStencilOpState pass_op(@EnumType(SDL_GPUStencilOp.class)
 int value)

depth_fail_op

@EnumType(SDL_GPUStencilOp.class)
public int depth_fail_op()

depth_fail_op

public SDL_GPUStencilOpState depth_fail_op(@EnumType(SDL_GPUStencilOp.class)
 int value)

compare_op

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

compare_op

public SDL_GPUStencilOpState compare_op(@EnumType(SDL_GPUCompareOp.class)
 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