Package org.lwjgl.openxr

Class XrCompositionLayerDepthTestFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerDepthTestFB>

org.lwjgl.openxr.XrCompositionLayerDepthTestFB

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrCompositionLayerDepthTestFB
extends org.lwjgl.system.Struct<XrCompositionLayerDepthTestFB>
implements org.lwjgl.system.NativeResource

specifies depth test for composition layer.

Description

To specify that a layer should be depth tested, a XrCompositionLayerDepthTestFB structure must be passed via the polymorphic XrCompositionLayerBaseHeader structure’s next parameter chain.

Valid Usage (Implicit)

• The XR_FB_composition_layer_depth_test extension must be enabled prior to using XrCompositionLayerDepthTestFB
• type must be TYPE_COMPOSITION_LAYER_DEPTH_TEST_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• compareOp must be a valid XrCompareOpFB value

See Also

XrCompositionLayerBaseHeader

Layout

 struct XrCompositionLayerDepthTestFB {
     XrStructureType type();
     void const * next();
     XrBool32 depthMask();
     XrCompareOpFB compareOp();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	COMPAREOP	The struct member offsets.
static final int	DEPTHMASK	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	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
XrCompositionLayerDepthTestFB(ByteBuffer container)	Creates a XrCompositionLayerDepthTestFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerDepthTestFB	calloc()	Returns a new XrCompositionLayerDepthTestFB instance allocated with memCalloc.
static XrCompositionLayerDepthTestFB.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated with memCalloc.
static XrCompositionLayerDepthTestFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerDepthTestFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthTestFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
int	compareOp()	an enum that indicates which compare operation is used in the depth test.
XrCompositionLayerDepthTestFB	compareOp(int value)	Sets the specified value to the compareOp() field.
static XrCompositionLayerDepthTestFB	create()	Returns a new XrCompositionLayerDepthTestFB instance allocated with BufferUtils.
static XrCompositionLayerDepthTestFB.Buffer	create(int capacity)	Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated with BufferUtils.
static XrCompositionLayerDepthTestFB	create(long address)	Returns a new XrCompositionLayerDepthTestFB instance for the specified memory address.
static XrCompositionLayerDepthTestFB.Buffer	create(long address, int capacity)	Create a XrCompositionLayerDepthTestFB.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerDepthTestFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerDepthTestFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	depthMask()	a boolean indicating whether writes to the composition depth buffer are enabled.
XrCompositionLayerDepthTestFB	depthMask(boolean value)	Sets the specified value to the depthMask() field.
static XrCompositionLayerDepthTestFB	malloc()	Returns a new XrCompositionLayerDepthTestFB instance allocated with memAlloc.
static XrCompositionLayerDepthTestFB.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated with memAlloc.
static XrCompositionLayerDepthTestFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerDepthTestFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerDepthTestFB instance allocated on the specified MemoryStack.
static int	ncompareOp(long struct)	Unsafe version of compareOp().
static void	ncompareOp(long struct, int value)	Unsafe version of compareOp.
static int	ndepthMask(long struct)	Unsafe version of depthMask().
static void	ndepthMask(long struct, int value)	Unsafe version of depthMask.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerDepthTestFB	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrCompositionLayerDepthTestFB	set(int type, long next, boolean depthMask, int compareOp)	Initializes this struct with the specified values.
XrCompositionLayerDepthTestFB	set(XrCompositionLayerDepthTestFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerDepthTestFB	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerDepthTestFB	type$Default()	Sets the TYPE_COMPOSITION_LAYER_DEPTH_TEST_FB value to the type() 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

DEPTHMASK

public static final int DEPTHMASK

The struct member offsets.

COMPAREOP

public static final int COMPAREOP

The struct member offsets.

Constructor Details

XrCompositionLayerDepthTestFB

public XrCompositionLayerDepthTestFB(ByteBuffer container)

Creates a XrCompositionLayerDepthTestFB 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrCompositionLayerDepthTestFB>

type

public int type()

the XrStructureType of this structure.

next

public long next()

NULL or a pointer to the next structure in a structure chain.

depthMask

public boolean depthMask()

a boolean indicating whether writes to the composition depth buffer are enabled.

compareOp

public int compareOp()

an enum that indicates which compare operation is used in the depth test.

type

public XrCompositionLayerDepthTestFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerDepthTestFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_DEPTH_TEST_FB value to the type() field.

next

public XrCompositionLayerDepthTestFB next(long value)

Sets the specified value to the next() field.

depthMask

public XrCompositionLayerDepthTestFB depthMask(boolean value)

Sets the specified value to the depthMask() field.

compareOp

public XrCompositionLayerDepthTestFB compareOp(int value)

Sets the specified value to the compareOp() field.

set

public XrCompositionLayerDepthTestFB set(int type,
 long next,
 boolean depthMask,
 int compareOp)

Initializes this struct with the specified values.

set

public XrCompositionLayerDepthTestFB set(XrCompositionLayerDepthTestFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerDepthTestFB malloc()

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

calloc

public static XrCompositionLayerDepthTestFB calloc()

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

create

public static XrCompositionLayerDepthTestFB create()

Returns a new XrCompositionLayerDepthTestFB instance allocated with BufferUtils.

create

public static XrCompositionLayerDepthTestFB create(long address)

Returns a new XrCompositionLayerDepthTestFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerDepthTestFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerDepthTestFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerDepthTestFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerDepthTestFB.Buffer create(int capacity)

Returns a new XrCompositionLayerDepthTestFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerDepthTestFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerDepthTestFB malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrCompositionLayerDepthTestFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrCompositionLayerDepthTestFB calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrCompositionLayerDepthTestFB.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrCompositionLayerDepthTestFB.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

ndepthMask

public static int ndepthMask(long struct)

Unsafe version of depthMask().

ncompareOp

public static int ncompareOp(long struct)

Unsafe version of compareOp().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

ndepthMask

public static void ndepthMask(long struct,
 int value)

Unsafe version of depthMask.

ncompareOp

public static void ncompareOp(long struct,
 int value)

Unsafe version of compareOp.