Package org.lwjgl.sdl

Class SDL_GPUDepthStencilState

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_GPUDepthStencilState>

org.lwjgl.sdl.SDL_GPUDepthStencilState

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_GPUDepthStencilState
extends Struct<SDL_GPUDepthStencilState>
implements NativeResource

 struct SDL_GPUDepthStencilState {
     SDL_GPUCompareOp compare_op;
     {@link SDL_GPUStencilOpState SDL_GPUStencilOpState} back_stencil_state;
     {@link SDL_GPUStencilOpState 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;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_GPUDepthStencilState.Buffer	An array of SDL_GPUDepthStencilState structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BACK_STENCIL_STATE	The struct member offsets.
static final int	COMPARE_MASK	The struct member offsets.
static final int	COMPARE_OP	The struct member offsets.
static final int	ENABLE_DEPTH_TEST	The struct member offsets.
static final int	ENABLE_DEPTH_WRITE	The struct member offsets.
static final int	ENABLE_STENCIL_TEST	The struct member offsets.
static final int	FRONT_STENCIL_STATE	The struct member offsets.
static final int	PADDING1	The struct member offsets.
static final int	PADDING2	The struct member offsets.
static final int	PADDING3	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WRITE_MASK	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
SDL_GPUDepthStencilState(ByteBuffer container)	Creates a SDL_GPUDepthStencilState instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
SDL_GPUStencilOpState	back_stencil_state()
SDL_GPUDepthStencilState	back_stencil_state(Consumer<SDL_GPUStencilOpState> consumer)	Passes the back_stencil_state field to the specified Consumer.
SDL_GPUDepthStencilState	back_stencil_state(SDL_GPUStencilOpState value)	Copies the specified SDL_GPUStencilOpState to the back_stencil_state field.
static SDL_GPUDepthStencilState	calloc()	Returns a new SDL_GPUDepthStencilState instance allocated with memCalloc.
static SDL_GPUDepthStencilState.Buffer	calloc(int capacity)	Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with memCalloc.
static SDL_GPUDepthStencilState.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUDepthStencilState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_GPUDepthStencilState	calloc(MemoryStack stack)	Returns a new SDL_GPUDepthStencilState instance allocated on the specified MemoryStack and initializes all its bits to zero.
byte	compare_mask()
SDL_GPUDepthStencilState	compare_mask(byte value)	Sets the specified value to the compare_mask field.
int	compare_op()
SDL_GPUDepthStencilState	compare_op(int value)	Sets the specified value to the compare_op field.
static SDL_GPUDepthStencilState	create()	Returns a new SDL_GPUDepthStencilState instance allocated with BufferUtils.
static SDL_GPUDepthStencilState.Buffer	create(int capacity)	Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with BufferUtils.
static SDL_GPUDepthStencilState	create(long address)	Returns a new SDL_GPUDepthStencilState instance for the specified memory address.
static SDL_GPUDepthStencilState.Buffer	create(long address, int capacity)	Create a SDL_GPUDepthStencilState.Buffer instance at the specified memory.
static @Nullable SDL_GPUDepthStencilState	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_GPUDepthStencilState.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	enable_depth_test()
SDL_GPUDepthStencilState	enable_depth_test(boolean value)	Sets the specified value to the enable_depth_test field.
boolean	enable_depth_write()
SDL_GPUDepthStencilState	enable_depth_write(boolean value)	Sets the specified value to the enable_depth_write field.
boolean	enable_stencil_test()
SDL_GPUDepthStencilState	enable_stencil_test(boolean value)	Sets the specified value to the enable_stencil_test field.
SDL_GPUStencilOpState	front_stencil_state()
SDL_GPUDepthStencilState	front_stencil_state(Consumer<SDL_GPUStencilOpState> consumer)	Passes the front_stencil_state field to the specified Consumer.
SDL_GPUDepthStencilState	front_stencil_state(SDL_GPUStencilOpState value)	Copies the specified SDL_GPUStencilOpState to the front_stencil_state field.
static SDL_GPUDepthStencilState	malloc()	Returns a new SDL_GPUDepthStencilState instance allocated with memAlloc.
static SDL_GPUDepthStencilState.Buffer	malloc(int capacity)	Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with memAlloc.
static SDL_GPUDepthStencilState.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUDepthStencilState.Buffer instance allocated on the specified MemoryStack.
static SDL_GPUDepthStencilState	malloc(MemoryStack stack)	Returns a new SDL_GPUDepthStencilState instance allocated on the specified MemoryStack.
static SDL_GPUStencilOpState	nback_stencil_state(long struct)	Unsafe version of back_stencil_state().
static void	nback_stencil_state(long struct, SDL_GPUStencilOpState value)	Unsafe version of back_stencil_state.
static byte	ncompare_mask(long struct)	Unsafe version of compare_mask().
static void	ncompare_mask(long struct, byte value)	Unsafe version of compare_mask.
static int	ncompare_op(long struct)	Unsafe version of compare_op().
static void	ncompare_op(long struct, int value)	Unsafe version of compare_op.
static boolean	nenable_depth_test(long struct)	Unsafe version of enable_depth_test().
static void	nenable_depth_test(long struct, boolean value)	Unsafe version of enable_depth_test.
static boolean	nenable_depth_write(long struct)	Unsafe version of enable_depth_write().
static void	nenable_depth_write(long struct, boolean value)	Unsafe version of enable_depth_write.
static boolean	nenable_stencil_test(long struct)	Unsafe version of enable_stencil_test().
static void	nenable_stencil_test(long struct, boolean value)	Unsafe version of enable_stencil_test.
static SDL_GPUStencilOpState	nfront_stencil_state(long struct)	Unsafe version of front_stencil_state().
static void	nfront_stencil_state(long struct, SDL_GPUStencilOpState value)	Unsafe version of front_stencil_state.
static byte	npadding1(long struct)
static void	npadding1(long struct, byte value)
static byte	npadding2(long struct)
static void	npadding2(long struct, byte value)
static byte	npadding3(long struct)
static void	npadding3(long struct, byte value)
static byte	nwrite_mask(long struct)	Unsafe version of write_mask().
static void	nwrite_mask(long struct, byte value)	Unsafe version of write_mask.
SDL_GPUDepthStencilState	set(int compare_op, SDL_GPUStencilOpState back_stencil_state, SDL_GPUStencilOpState front_stencil_state, byte compare_mask, byte write_mask, boolean enable_depth_test, boolean enable_depth_write, boolean enable_stencil_test)	Initializes this struct with the specified values.
SDL_GPUDepthStencilState	set(SDL_GPUDepthStencilState src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
byte	write_mask()
SDL_GPUDepthStencilState	write_mask(byte value)	Sets the specified value to the write_mask field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

COMPARE_OP

public static final int COMPARE_OP

The struct member offsets.

BACK_STENCIL_STATE

public static final int BACK_STENCIL_STATE

The struct member offsets.

FRONT_STENCIL_STATE

public static final int FRONT_STENCIL_STATE

The struct member offsets.

COMPARE_MASK

public static final int COMPARE_MASK

The struct member offsets.

WRITE_MASK

public static final int WRITE_MASK

The struct member offsets.

ENABLE_DEPTH_TEST

public static final int ENABLE_DEPTH_TEST

The struct member offsets.

ENABLE_DEPTH_WRITE

public static final int ENABLE_DEPTH_WRITE

The struct member offsets.

ENABLE_STENCIL_TEST

public static final int ENABLE_STENCIL_TEST

The struct member offsets.

PADDING1

public static final int PADDING1

The struct member offsets.

PADDING2

public static final int PADDING2

The struct member offsets.

PADDING3

public static final int PADDING3

The struct member offsets.

Constructor Details

SDL_GPUDepthStencilState

public SDL_GPUDepthStencilState(ByteBuffer container)

Creates a SDL_GPUDepthStencilState instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<SDL_GPUDepthStencilState>

compare_op

public int compare_op()

Returns:

the value of the compare_op field.

back_stencil_state

public SDL_GPUStencilOpState back_stencil_state()

Returns:

a SDL_GPUStencilOpState view of the back_stencil_state field.

front_stencil_state

public SDL_GPUStencilOpState front_stencil_state()

Returns:

a SDL_GPUStencilOpState view of the front_stencil_state field.

compare_mask

public byte compare_mask()

Returns:

the value of the compare_mask field.

write_mask

public byte write_mask()

Returns:

the value of the write_mask field.

enable_depth_test

public boolean enable_depth_test()

Returns:

the value of the enable_depth_test field.

enable_depth_write

public boolean enable_depth_write()

Returns:

the value of the enable_depth_write field.

enable_stencil_test

public boolean enable_stencil_test()

Returns:

the value of the enable_stencil_test field.

compare_op

public SDL_GPUDepthStencilState compare_op(int value)

Sets the specified value to the compare_op field.

back_stencil_state

public SDL_GPUDepthStencilState back_stencil_state(SDL_GPUStencilOpState value)

Copies the specified SDL_GPUStencilOpState to the back_stencil_state field.

back_stencil_state

public SDL_GPUDepthStencilState back_stencil_state(Consumer<SDL_GPUStencilOpState> consumer)

Passes the back_stencil_state field to the specified Consumer.

front_stencil_state

public SDL_GPUDepthStencilState front_stencil_state(SDL_GPUStencilOpState value)

Copies the specified SDL_GPUStencilOpState to the front_stencil_state field.

front_stencil_state

public SDL_GPUDepthStencilState front_stencil_state(Consumer<SDL_GPUStencilOpState> consumer)

Passes the front_stencil_state field to the specified Consumer.

compare_mask

public SDL_GPUDepthStencilState compare_mask(byte value)

Sets the specified value to the compare_mask field.

write_mask

public SDL_GPUDepthStencilState write_mask(byte value)

Sets the specified value to the write_mask field.

enable_depth_test

public SDL_GPUDepthStencilState enable_depth_test(boolean value)

Sets the specified value to the enable_depth_test field.

enable_depth_write

public SDL_GPUDepthStencilState enable_depth_write(boolean value)

Sets the specified value to the enable_depth_write field.

enable_stencil_test

public SDL_GPUDepthStencilState enable_stencil_test(boolean value)

Sets the specified value to the enable_stencil_test field.

set

public SDL_GPUDepthStencilState set(int compare_op,
 SDL_GPUStencilOpState back_stencil_state,
 SDL_GPUStencilOpState front_stencil_state,
 byte compare_mask,
 byte write_mask,
 boolean enable_depth_test,
 boolean enable_depth_write,
 boolean enable_stencil_test)

Initializes this struct with the specified values.

set

public SDL_GPUDepthStencilState set(SDL_GPUDepthStencilState src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_GPUDepthStencilState malloc()

Returns a new SDL_GPUDepthStencilState instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static SDL_GPUDepthStencilState calloc()

Returns a new SDL_GPUDepthStencilState instance allocated with memCalloc. The instance must be explicitly freed.

create

public static SDL_GPUDepthStencilState create()

Returns a new SDL_GPUDepthStencilState instance allocated with BufferUtils.

create

public static SDL_GPUDepthStencilState create(long address)

Returns a new SDL_GPUDepthStencilState instance for the specified memory address.

createSafe

public static @Nullable SDL_GPUDepthStencilState createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUDepthStencilState.Buffer malloc(int capacity)

Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static SDL_GPUDepthStencilState.Buffer calloc(int capacity)

Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static SDL_GPUDepthStencilState.Buffer create(int capacity)

Returns a new SDL_GPUDepthStencilState.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static SDL_GPUDepthStencilState.Buffer create(long address,
 int capacity)

Create a SDL_GPUDepthStencilState.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable SDL_GPUDepthStencilState.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUDepthStencilState malloc(MemoryStack stack)

Returns a new SDL_GPUDepthStencilState instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_GPUDepthStencilState calloc(MemoryStack stack)

Returns a new SDL_GPUDepthStencilState instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static SDL_GPUDepthStencilState.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new SDL_GPUDepthStencilState.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static SDL_GPUDepthStencilState.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new SDL_GPUDepthStencilState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ncompare_op

public static int ncompare_op(long struct)

Unsafe version of compare_op().

nback_stencil_state

public static SDL_GPUStencilOpState nback_stencil_state(long struct)

Unsafe version of back_stencil_state().

nfront_stencil_state

public static SDL_GPUStencilOpState nfront_stencil_state(long struct)

Unsafe version of front_stencil_state().

ncompare_mask

public static byte ncompare_mask(long struct)

Unsafe version of compare_mask().

nwrite_mask

public static byte nwrite_mask(long struct)

Unsafe version of write_mask().

nenable_depth_test

public static boolean nenable_depth_test(long struct)

Unsafe version of enable_depth_test().

nenable_depth_write

public static boolean nenable_depth_write(long struct)

Unsafe version of enable_depth_write().

nenable_stencil_test

public static boolean nenable_stencil_test(long struct)

Unsafe version of enable_stencil_test().

npadding1

public static byte npadding1(long struct)

npadding2

public static byte npadding2(long struct)

npadding3

public static byte npadding3(long struct)

ncompare_op

public static void ncompare_op(long struct,
 int value)

Unsafe version of compare_op.

nback_stencil_state

public static void nback_stencil_state(long struct,
 SDL_GPUStencilOpState value)

Unsafe version of back_stencil_state.

nfront_stencil_state

public static void nfront_stencil_state(long struct,
 SDL_GPUStencilOpState value)

Unsafe version of front_stencil_state.

ncompare_mask

public static void ncompare_mask(long struct,
 byte value)

Unsafe version of compare_mask.

nwrite_mask

public static void nwrite_mask(long struct,
 byte value)

Unsafe version of write_mask.

nenable_depth_test

public static void nenable_depth_test(long struct,
 boolean value)

Unsafe version of enable_depth_test.

nenable_depth_write

public static void nenable_depth_write(long struct,
 boolean value)

Unsafe version of enable_depth_write.

nenable_stencil_test

public static void nenable_stencil_test(long struct,
 boolean value)

Unsafe version of enable_stencil_test.

npadding1

public static void npadding1(long struct,
 byte value)

npadding2

public static void npadding2(long struct,
 byte value)

npadding3

public static void npadding3(long struct,
 byte value)