Package org.lwjgl.openxr

Class XrPerformanceMetricsStateMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPerformanceMetricsStateMETA>

org.lwjgl.openxr.XrPerformanceMetricsStateMETA

All Implemented Interfaces:

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

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

Performance metrics enable state.

Description

XrPerformanceMetricsStateMETA is provided as input when calling SetPerformanceMetricsStateMETA to enable or disable the performance metrics system. XrPerformanceMetricsStateMETA is populated as an output parameter when calling GetPerformanceMetricsStateMETA to query if the performance metrics system is enabled.

Valid Usage (Implicit)

• The XR_META_performance_metrics extension must be enabled prior to using XrPerformanceMetricsStateMETA
• type must be TYPE_PERFORMANCE_METRICS_STATE_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

GetPerformanceMetricsStateMETA, SetPerformanceMetricsStateMETA

Layout

 struct XrPerformanceMetricsStateMETA {
     XrStructureType type();
     void const * next();
     XrBool32 enabled();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

ENABLED

public static final int ENABLED

The struct member offsets.

Constructor Details

XrPerformanceMetricsStateMETA

public XrPerformanceMetricsStateMETA(ByteBuffer container)

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

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.

enabled

public boolean enabled()

set to TRUE to indicate the performance metrics system is enabled, FALSE otherwise, when getting state. When setting state, set to TRUE to enable the performance metrics system and FALSE to disable it.

type

public XrPerformanceMetricsStateMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrPerformanceMetricsStateMETA type$Default()

Sets the TYPE_PERFORMANCE_METRICS_STATE_META value to the type() field.

next

public XrPerformanceMetricsStateMETA next(long value)

Sets the specified value to the next() field.

enabled

public XrPerformanceMetricsStateMETA enabled(boolean value)

Sets the specified value to the enabled() field.

set

public XrPerformanceMetricsStateMETA set(int type,
 long next,
 boolean enabled)

Initializes this struct with the specified values.

set

public XrPerformanceMetricsStateMETA set(XrPerformanceMetricsStateMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPerformanceMetricsStateMETA malloc()

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

calloc

public static XrPerformanceMetricsStateMETA calloc()

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

create

public static XrPerformanceMetricsStateMETA create()

Returns a new XrPerformanceMetricsStateMETA instance allocated with BufferUtils.

create

public static XrPerformanceMetricsStateMETA create(long address)

Returns a new XrPerformanceMetricsStateMETA instance for the specified memory address.

createSafe

public static @Nullable XrPerformanceMetricsStateMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPerformanceMetricsStateMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPerformanceMetricsStateMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPerformanceMetricsStateMETA.Buffer create(int capacity)

Returns a new XrPerformanceMetricsStateMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPerformanceMetricsStateMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPerformanceMetricsStateMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nenabled

public static int nenabled(long struct)

Unsafe version of enabled().

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.

nenabled

public static void nenabled(long struct,
 int value)

Unsafe version of enabled.