Package org.lwjgl.openxr

Class XrCompositionLayerSecureContentFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrCompositionLayerSecureContentFB>

org.lwjgl.openxr.XrCompositionLayerSecureContentFB

All Implemented Interfaces:

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

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

specifies secure content mode for composition layers.

Description

XrCompositionLayerSecureContentFB contains additional flags to indicate a composition layer contains secure content and must not be written to external outputs.

If both COMPOSITION_LAYER_SECURE_CONTENT_EXCLUDE_LAYER_BIT_FB and COMPOSITION_LAYER_SECURE_CONTENT_REPLACE_LAYER_BIT_FB are set, COMPOSITION_LAYER_SECURE_CONTENT_EXCLUDE_LAYER_BIT_FB will take precedence.

To specify the additional flags, you must create a XrCompositionLayerSecureContentFB structure and pass it via the XrCompositionLayerBaseHeader structure’s next parameter.

Valid Usage (Implicit)

• The XR_FB_composition_layer_secure_content extension must be enabled prior to using XrCompositionLayerSecureContentFB
• type must be TYPE_COMPOSITION_LAYER_SECURE_CONTENT_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• flags must be a valid combination of XrCompositionLayerSecureContentFlagBitsFB values
• flags must not be 0

See Also

XrCompositionLayerBaseHeader

Layout

 struct XrCompositionLayerSecureContentFB {
     XrStructureType type();
     void const * next();
     XrCompositionLayerSecureContentFlagsFB flags();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrCompositionLayerSecureContentFB.Buffer	An array of XrCompositionLayerSecureContentFB 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	FLAGS	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
XrCompositionLayerSecureContentFB(ByteBuffer container)	Creates a XrCompositionLayerSecureContentFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerSecureContentFB	calloc()	Returns a new XrCompositionLayerSecureContentFB instance allocated with memCalloc.
static XrCompositionLayerSecureContentFB.Buffer	calloc(int capacity)	Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated with memCalloc.
static XrCompositionLayerSecureContentFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerSecureContentFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSecureContentFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrCompositionLayerSecureContentFB	create()	Returns a new XrCompositionLayerSecureContentFB instance allocated with BufferUtils.
static XrCompositionLayerSecureContentFB.Buffer	create(int capacity)	Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated with BufferUtils.
static XrCompositionLayerSecureContentFB	create(long address)	Returns a new XrCompositionLayerSecureContentFB instance for the specified memory address.
static XrCompositionLayerSecureContentFB.Buffer	create(long address, int capacity)	Create a XrCompositionLayerSecureContentFB.Buffer instance at the specified memory.
static @Nullable XrCompositionLayerSecureContentFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrCompositionLayerSecureContentFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	a bitmask of XrCompositionLayerSecureContentFlagBitsFB.
XrCompositionLayerSecureContentFB	flags(long value)	Sets the specified value to the flags() field.
static XrCompositionLayerSecureContentFB	malloc()	Returns a new XrCompositionLayerSecureContentFB instance allocated with memAlloc.
static XrCompositionLayerSecureContentFB.Buffer	malloc(int capacity)	Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated with memAlloc.
static XrCompositionLayerSecureContentFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated on the specified MemoryStack.
static XrCompositionLayerSecureContentFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrCompositionLayerSecureContentFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrCompositionLayerSecureContentFB	next(long value)	Sets the specified value to the next() field.
static long	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, long value)	Unsafe version of flags.
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.
XrCompositionLayerSecureContentFB	set(int type, long next, long flags)	Initializes this struct with the specified values.
XrCompositionLayerSecureContentFB	set(XrCompositionLayerSecureContentFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrCompositionLayerSecureContentFB	type(int value)	Sets the specified value to the type() field.
XrCompositionLayerSecureContentFB	type$Default()	Sets the TYPE_COMPOSITION_LAYER_SECURE_CONTENT_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.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

XrCompositionLayerSecureContentFB

public XrCompositionLayerSecureContentFB(ByteBuffer container)

Creates a XrCompositionLayerSecureContentFB 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<XrCompositionLayerSecureContentFB>

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. No such structures are defined in core OpenXR or this extension.

flags

public long flags()

a bitmask of XrCompositionLayerSecureContentFlagBitsFB.

type

public XrCompositionLayerSecureContentFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrCompositionLayerSecureContentFB type$Default()

Sets the TYPE_COMPOSITION_LAYER_SECURE_CONTENT_FB value to the type() field.

next

public XrCompositionLayerSecureContentFB next(long value)

Sets the specified value to the next() field.

flags

public XrCompositionLayerSecureContentFB flags(long value)

Sets the specified value to the flags() field.

set

public XrCompositionLayerSecureContentFB set(int type,
 long next,
 long flags)

Initializes this struct with the specified values.

set

public XrCompositionLayerSecureContentFB set(XrCompositionLayerSecureContentFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrCompositionLayerSecureContentFB malloc()

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

calloc

public static XrCompositionLayerSecureContentFB calloc()

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

create

public static XrCompositionLayerSecureContentFB create()

Returns a new XrCompositionLayerSecureContentFB instance allocated with BufferUtils.

create

public static XrCompositionLayerSecureContentFB create(long address)

Returns a new XrCompositionLayerSecureContentFB instance for the specified memory address.

createSafe

public static @Nullable XrCompositionLayerSecureContentFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrCompositionLayerSecureContentFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrCompositionLayerSecureContentFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrCompositionLayerSecureContentFB.Buffer create(int capacity)

Returns a new XrCompositionLayerSecureContentFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrCompositionLayerSecureContentFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrCompositionLayerSecureContentFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new XrCompositionLayerSecureContentFB.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().

nflags

public static long nflags(long struct)

Unsafe version of flags().

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.

nflags

public static void nflags(long struct,
 long value)

Unsafe version of flags.