Class SDL_GPUDepthStencilTargetInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_GPUDepthStencilTargetInfo>

org.lwjgl.sdl.SDL_GPUDepthStencilTargetInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_GPUDepthStencilTargetInfo
extends Struct<SDL_GPUDepthStencilTargetInfo>
implements NativeResource

struct SDL_GPUDepthStencilTargetInfo {
    SDL_GPUTexture * texture;
    float clear_depth;
    SDL_GPULoadOp load_op;
    SDL_GPUStoreOp store_op;
    SDL_GPULoadOp stencil_load_op;
    SDL_GPUStoreOp stencil_store_op;
    bool cycle;
    Uint8 clear_stencil;
    Uint8 mip_level;
    Uint8 layer;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CLEAR_DEPTH	The struct member offsets.
static final int	CLEAR_STENCIL	The struct member offsets.
static final int	CYCLE	The struct member offsets.
static final int	LAYER	The struct member offsets.
static final int	LOAD_OP	The struct member offsets.
static final int	MIP_LEVEL	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STENCIL_LOAD_OP	The struct member offsets.
static final int	STENCIL_STORE_OP	The struct member offsets.
static final int	STORE_OP	The struct member offsets.
static final int	TEXTURE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_GPUDepthStencilTargetInfo	calloc()	Returns a new SDL_GPUDepthStencilTargetInfo instance allocated with memCalloc.
static SDL_GPUDepthStencilTargetInfo.Buffer	calloc(int capacity)	Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated with memCalloc.
static SDL_GPUDepthStencilTargetInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_GPUDepthStencilTargetInfo	calloc(MemoryStack stack)	Returns a new SDL_GPUDepthStencilTargetInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
float	clear_depth()
SDL_GPUDepthStencilTargetInfo	clear_depth(float value)	Sets the specified value to the clear_depth field.
byte	clear_stencil()
SDL_GPUDepthStencilTargetInfo	clear_stencil(byte value)	Sets the specified value to the clear_stencil field.
static SDL_GPUDepthStencilTargetInfo	create()	Returns a new SDL_GPUDepthStencilTargetInfo instance allocated with BufferUtils.
static SDL_GPUDepthStencilTargetInfo.Buffer	create(int capacity)	Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated with BufferUtils.
static SDL_GPUDepthStencilTargetInfo	create(long address)	Returns a new SDL_GPUDepthStencilTargetInfo instance for the specified memory address.
static SDL_GPUDepthStencilTargetInfo.Buffer	create(long address, int capacity)	Create a SDL_GPUDepthStencilTargetInfo.Buffer instance at the specified memory.
static @Nullable SDL_GPUDepthStencilTargetInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_GPUDepthStencilTargetInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	cycle()
SDL_GPUDepthStencilTargetInfo	cycle(boolean value)	Sets the specified value to the cycle field.
byte	layer()
SDL_GPUDepthStencilTargetInfo	layer(byte value)	Sets the specified value to the layer field.
int	load_op()
SDL_GPUDepthStencilTargetInfo	load_op(int value)	Sets the specified value to the load_op field.
static SDL_GPUDepthStencilTargetInfo	malloc()	Returns a new SDL_GPUDepthStencilTargetInfo instance allocated with memAlloc.
static SDL_GPUDepthStencilTargetInfo.Buffer	malloc(int capacity)	Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated with memAlloc.
static SDL_GPUDepthStencilTargetInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated on the specified MemoryStack.
static SDL_GPUDepthStencilTargetInfo	malloc(MemoryStack stack)	Returns a new SDL_GPUDepthStencilTargetInfo instance allocated on the specified MemoryStack.
byte	mip_level()
SDL_GPUDepthStencilTargetInfo	mip_level(byte value)	Sets the specified value to the mip_level field.
static float	nclear_depth(long struct)	Unsafe version of clear_depth().
static void	nclear_depth(long struct, float value)	Unsafe version of clear_depth.
static byte	nclear_stencil(long struct)	Unsafe version of clear_stencil().
static void	nclear_stencil(long struct, byte value)	Unsafe version of clear_stencil.
static boolean	ncycle(long struct)	Unsafe version of cycle().
static void	ncycle(long struct, boolean value)	Unsafe version of cycle.
static byte	nlayer(long struct)	Unsafe version of layer().
static void	nlayer(long struct, byte value)	Unsafe version of layer.
static int	nload_op(long struct)	Unsafe version of load_op().
static void	nload_op(long struct, int value)	Unsafe version of load_op.
static byte	nmip_level(long struct)	Unsafe version of mip_level().
static void	nmip_level(long struct, byte value)	Unsafe version of mip_level.
static int	nstencil_load_op(long struct)	Unsafe version of stencil_load_op().
static void	nstencil_load_op(long struct, int value)	Unsafe version of stencil_load_op.
static int	nstencil_store_op(long struct)	Unsafe version of stencil_store_op().
static void	nstencil_store_op(long struct, int value)	Unsafe version of stencil_store_op.
static int	nstore_op(long struct)	Unsafe version of store_op().
static void	nstore_op(long struct, int value)	Unsafe version of store_op.
static long	ntexture(long struct)	Unsafe version of texture().
static void	ntexture(long struct, long value)	Unsafe version of texture.
SDL_GPUDepthStencilTargetInfo	set(long texture, float clear_depth, int load_op, int store_op, int stencil_load_op, int stencil_store_op, boolean cycle, byte clear_stencil, byte mip_level, byte layer)	Initializes this struct with the specified values.
SDL_GPUDepthStencilTargetInfo	set(SDL_GPUDepthStencilTargetInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	stencil_load_op()
SDL_GPUDepthStencilTargetInfo	stencil_load_op(int value)	Sets the specified value to the stencil_load_op field.
int	stencil_store_op()
SDL_GPUDepthStencilTargetInfo	stencil_store_op(int value)	Sets the specified value to the stencil_store_op field.
int	store_op()
SDL_GPUDepthStencilTargetInfo	store_op(int value)	Sets the specified value to the store_op field.
long	texture()
SDL_GPUDepthStencilTargetInfo	texture(long value)	Sets the specified value to the texture field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

TEXTURE

public static final int TEXTURE

The struct member offsets.

CLEAR_DEPTH

public static final int CLEAR_DEPTH

The struct member offsets.

LOAD_OP

public static final int LOAD_OP

The struct member offsets.

STORE_OP

public static final int STORE_OP

The struct member offsets.

STENCIL_LOAD_OP

public static final int STENCIL_LOAD_OP

The struct member offsets.

STENCIL_STORE_OP

public static final int STENCIL_STORE_OP

The struct member offsets.

CYCLE

public static final int CYCLE

The struct member offsets.

CLEAR_STENCIL

public static final int CLEAR_STENCIL

The struct member offsets.

MIP_LEVEL

public static final int MIP_LEVEL

The struct member offsets.

LAYER

public static final int LAYER

The struct member offsets.

Constructor Details

SDL_GPUDepthStencilTargetInfo

public SDL_GPUDepthStencilTargetInfo(ByteBuffer container)

Creates a SDL_GPUDepthStencilTargetInfo 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_GPUDepthStencilTargetInfo>

texture

@NativeType("SDL_GPUTexture *")
public long texture()

Returns:

the value of the texture field.

clear_depth

public float clear_depth()

Returns:

the value of the clear_depth field.

load_op

@NativeType("SDL_GPULoadOp")
public int load_op()

Returns:

the value of the load_op field.

store_op

@NativeType("SDL_GPUStoreOp")
public int store_op()

Returns:

the value of the store_op field.

stencil_load_op

@NativeType("SDL_GPULoadOp")
public int stencil_load_op()

Returns:

the value of the stencil_load_op field.

stencil_store_op

@NativeType("SDL_GPUStoreOp")
public int stencil_store_op()

Returns:

the value of the stencil_store_op field.

cycle

@NativeType("bool")
public boolean cycle()

Returns:

the value of the cycle field.

clear_stencil

@NativeType("Uint8")
public byte clear_stencil()

Returns:

the value of the clear_stencil field.

mip_level

@NativeType("Uint8")
public byte mip_level()

Returns:

the value of the mip_level field.

layer

@NativeType("Uint8")
public byte layer()

Returns:

the value of the layer field.

texture

public SDL_GPUDepthStencilTargetInfo texture(@NativeType("SDL_GPUTexture *")
 long value)

Sets the specified value to the texture field.

clear_depth

public SDL_GPUDepthStencilTargetInfo clear_depth(float value)

Sets the specified value to the clear_depth field.

load_op

public SDL_GPUDepthStencilTargetInfo load_op(@NativeType("SDL_GPULoadOp")
 int value)

Sets the specified value to the load_op field.

store_op

public SDL_GPUDepthStencilTargetInfo store_op(@NativeType("SDL_GPUStoreOp")
 int value)

Sets the specified value to the store_op field.

stencil_load_op

public SDL_GPUDepthStencilTargetInfo stencil_load_op(@NativeType("SDL_GPULoadOp")
 int value)

Sets the specified value to the stencil_load_op field.

stencil_store_op

public SDL_GPUDepthStencilTargetInfo stencil_store_op(@NativeType("SDL_GPUStoreOp")
 int value)

Sets the specified value to the stencil_store_op field.

cycle

public SDL_GPUDepthStencilTargetInfo cycle(@NativeType("bool")
 boolean value)

Sets the specified value to the cycle field.

clear_stencil

public SDL_GPUDepthStencilTargetInfo clear_stencil(@NativeType("Uint8")
 byte value)

Sets the specified value to the clear_stencil field.

mip_level

public SDL_GPUDepthStencilTargetInfo mip_level(@NativeType("Uint8")
 byte value)

Sets the specified value to the mip_level field.

layer

public SDL_GPUDepthStencilTargetInfo layer(@NativeType("Uint8")
 byte value)

Sets the specified value to the layer field.

set

public SDL_GPUDepthStencilTargetInfo set(long texture,
 float clear_depth,
 int load_op,
 int store_op,
 int stencil_load_op,
 int stencil_store_op,
 boolean cycle,
 byte clear_stencil,
 byte mip_level,
 byte layer)

Initializes this struct with the specified values.

set

public SDL_GPUDepthStencilTargetInfo set(SDL_GPUDepthStencilTargetInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_GPUDepthStencilTargetInfo malloc()

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

calloc

public static SDL_GPUDepthStencilTargetInfo calloc()

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

create

public static SDL_GPUDepthStencilTargetInfo create()

Returns a new SDL_GPUDepthStencilTargetInfo instance allocated with BufferUtils.

create

public static SDL_GPUDepthStencilTargetInfo create(long address)

Returns a new SDL_GPUDepthStencilTargetInfo instance for the specified memory address.

createSafe

public static @Nullable SDL_GPUDepthStencilTargetInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUDepthStencilTargetInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static SDL_GPUDepthStencilTargetInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static SDL_GPUDepthStencilTargetInfo.Buffer create(int capacity)

Returns a new SDL_GPUDepthStencilTargetInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a SDL_GPUDepthStencilTargetInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static SDL_GPUDepthStencilTargetInfo malloc(MemoryStack stack)

Returns a new SDL_GPUDepthStencilTargetInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_GPUDepthStencilTargetInfo calloc(MemoryStack stack)

Returns a new SDL_GPUDepthStencilTargetInfo 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_GPUDepthStencilTargetInfo.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new SDL_GPUDepthStencilTargetInfo.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

ntexture

public static long ntexture(long struct)

Unsafe version of texture().

nclear_depth

public static float nclear_depth(long struct)

Unsafe version of clear_depth().

nload_op

public static int nload_op(long struct)

Unsafe version of load_op().

nstore_op

public static int nstore_op(long struct)

Unsafe version of store_op().

nstencil_load_op

public static int nstencil_load_op(long struct)

Unsafe version of stencil_load_op().

nstencil_store_op

public static int nstencil_store_op(long struct)

Unsafe version of stencil_store_op().

ncycle

public static boolean ncycle(long struct)

Unsafe version of cycle().

nclear_stencil

public static byte nclear_stencil(long struct)

Unsafe version of clear_stencil().

nmip_level

public static byte nmip_level(long struct)

Unsafe version of mip_level().

nlayer

public static byte nlayer(long struct)

Unsafe version of layer().

ntexture

public static void ntexture(long struct,
 long value)

Unsafe version of texture.

nclear_depth

public static void nclear_depth(long struct,
 float value)

Unsafe version of clear_depth.

nload_op

public static void nload_op(long struct,
 int value)

Unsafe version of load_op.

nstore_op

public static void nstore_op(long struct,
 int value)

Unsafe version of store_op.

nstencil_load_op

public static void nstencil_load_op(long struct,
 int value)

Unsafe version of stencil_load_op.

nstencil_store_op

public static void nstencil_store_op(long struct,
 int value)

Unsafe version of stencil_store_op.

ncycle

public static void ncycle(long struct,
 boolean value)

Unsafe version of cycle.

nclear_stencil

public static void nclear_stencil(long struct,
 byte value)

Unsafe version of clear_stencil.

nmip_level

public static void nmip_level(long struct,
 byte value)

Unsafe version of mip_level.

nlayer

public static void nlayer(long struct,
 byte value)

Unsafe version of layer.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate