Package org.lwjgl.openxr

Class XrPerformanceMetricsCounterMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPerformanceMetricsCounterMETA>

org.lwjgl.openxr.XrPerformanceMetricsCounterMETA

All Implemented Interfaces:

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

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

Performance metrics counter value.

Description

XrPerformanceMetricsCounterMETA is populated by calling QueryPerformanceMetricsCounterMETA to query real-time performance metrics counter information.

Valid Usage (Implicit)

• The XR_META_performance_metrics extension must be enabled prior to using XrPerformanceMetricsCounterMETA
• type must be TYPE_PERFORMANCE_METRICS_COUNTER_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• counterFlags must be 0 or a valid combination of XrPerformanceMetricsCounterFlagBitsMETA values
• counterUnit must be a valid XrPerformanceMetricsCounterUnitMETA value

See Also

QueryPerformanceMetricsCounterMETA

Layout

 struct XrPerformanceMetricsCounterMETA {
     XrStructureType type();
     void const * next();
     XrPerformanceMetricsCounterFlagsMETA counterFlags();
     XrPerformanceMetricsCounterUnitMETA counterUnit();
     uint32_t uintValue();
     float floatValue();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrPerformanceMetricsCounterMETA.Buffer	An array of XrPerformanceMetricsCounterMETA 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	COUNTERFLAGS	The struct member offsets.
static final int	COUNTERUNIT	The struct member offsets.
static final int	FLOATVALUE	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.
static final int	UINTVALUE	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
XrPerformanceMetricsCounterMETA(ByteBuffer container)	Creates a XrPerformanceMetricsCounterMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrPerformanceMetricsCounterMETA	calloc()	Returns a new XrPerformanceMetricsCounterMETA instance allocated with memCalloc.
static XrPerformanceMetricsCounterMETA.Buffer	calloc(int capacity)	Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with memCalloc.
static XrPerformanceMetricsCounterMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrPerformanceMetricsCounterMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPerformanceMetricsCounterMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
long	counterFlags()	a bitmask of XrPerformanceMetricsCounterFlagBitsMETA describing the validity of value members.
XrPerformanceMetricsCounterMETA	counterFlags(long value)	Sets the specified value to the counterFlags() field.
int	counterUnit()	a enum of XrPerformanceMetricsCounterUnitMETA describing the measurement unit.
XrPerformanceMetricsCounterMETA	counterUnit(int value)	Sets the specified value to the counterUnit() field.
static XrPerformanceMetricsCounterMETA	create()	Returns a new XrPerformanceMetricsCounterMETA instance allocated with BufferUtils.
static XrPerformanceMetricsCounterMETA.Buffer	create(int capacity)	Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with BufferUtils.
static XrPerformanceMetricsCounterMETA	create(long address)	Returns a new XrPerformanceMetricsCounterMETA instance for the specified memory address.
static XrPerformanceMetricsCounterMETA.Buffer	create(long address, int capacity)	Create a XrPerformanceMetricsCounterMETA.Buffer instance at the specified memory.
static @Nullable XrPerformanceMetricsCounterMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrPerformanceMetricsCounterMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
float	floatValue()	the counter value in float format.
XrPerformanceMetricsCounterMETA	floatValue(float value)	Sets the specified value to the floatValue() field.
static XrPerformanceMetricsCounterMETA	malloc()	Returns a new XrPerformanceMetricsCounterMETA instance allocated with memAlloc.
static XrPerformanceMetricsCounterMETA.Buffer	malloc(int capacity)	Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with memAlloc.
static XrPerformanceMetricsCounterMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated on the specified MemoryStack.
static XrPerformanceMetricsCounterMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrPerformanceMetricsCounterMETA instance allocated on the specified MemoryStack.
static long	ncounterFlags(long struct)	Unsafe version of counterFlags().
static void	ncounterFlags(long struct, long value)	Unsafe version of counterFlags.
static int	ncounterUnit(long struct)	Unsafe version of counterUnit().
static void	ncounterUnit(long struct, int value)	Unsafe version of counterUnit.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrPerformanceMetricsCounterMETA	next(long value)	Sets the specified value to the next() field.
static float	nfloatValue(long struct)	Unsafe version of floatValue().
static void	nfloatValue(long struct, float value)	Unsafe version of floatValue.
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.
static int	nuintValue(long struct)	Unsafe version of uintValue().
static void	nuintValue(long struct, int value)	Unsafe version of uintValue.
XrPerformanceMetricsCounterMETA	set(int type, long next, long counterFlags, int counterUnit, int uintValue, float floatValue)	Initializes this struct with the specified values.
XrPerformanceMetricsCounterMETA	set(XrPerformanceMetricsCounterMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrPerformanceMetricsCounterMETA	type(int value)	Sets the specified value to the type() field.
XrPerformanceMetricsCounterMETA	type$Default()	Sets the TYPE_PERFORMANCE_METRICS_COUNTER_META value to the type() field.
int	uintValue()	the counter value in uint32_t format.
XrPerformanceMetricsCounterMETA	uintValue(int value)	Sets the specified value to the uintValue() 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.

COUNTERFLAGS

public static final int COUNTERFLAGS

The struct member offsets.

COUNTERUNIT

public static final int COUNTERUNIT

The struct member offsets.

UINTVALUE

public static final int UINTVALUE

The struct member offsets.

FLOATVALUE

public static final int FLOATVALUE

The struct member offsets.

Constructor Details

XrPerformanceMetricsCounterMETA

public XrPerformanceMetricsCounterMETA(ByteBuffer container)

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

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.

counterFlags

public long counterFlags()

a bitmask of XrPerformanceMetricsCounterFlagBitsMETA describing the validity of value members.

counterUnit

public int counterUnit()

a enum of XrPerformanceMetricsCounterUnitMETA describing the measurement unit.

uintValue

public int uintValue()

the counter value in uint32_t format. It is valid if counterFlags contains PERFORMANCE_METRICS_COUNTER_UINT_VALUE_VALID_BIT_META.

floatValue

public float floatValue()

the counter value in float format. It is valid if counterFlags contains PERFORMANCE_METRICS_COUNTER_FLOAT_VALUE_VALID_BIT_META.

type

public XrPerformanceMetricsCounterMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrPerformanceMetricsCounterMETA type$Default()

Sets the TYPE_PERFORMANCE_METRICS_COUNTER_META value to the type() field.

next

public XrPerformanceMetricsCounterMETA next(long value)

Sets the specified value to the next() field.

counterFlags

public XrPerformanceMetricsCounterMETA counterFlags(long value)

Sets the specified value to the counterFlags() field.

counterUnit

public XrPerformanceMetricsCounterMETA counterUnit(int value)

Sets the specified value to the counterUnit() field.

uintValue

public XrPerformanceMetricsCounterMETA uintValue(int value)

Sets the specified value to the uintValue() field.

floatValue

public XrPerformanceMetricsCounterMETA floatValue(float value)

Sets the specified value to the floatValue() field.

set

public XrPerformanceMetricsCounterMETA set(int type,
 long next,
 long counterFlags,
 int counterUnit,
 int uintValue,
 float floatValue)

Initializes this struct with the specified values.

set

public XrPerformanceMetricsCounterMETA set(XrPerformanceMetricsCounterMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPerformanceMetricsCounterMETA malloc()

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

calloc

public static XrPerformanceMetricsCounterMETA calloc()

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

create

public static XrPerformanceMetricsCounterMETA create()

Returns a new XrPerformanceMetricsCounterMETA instance allocated with BufferUtils.

create

public static XrPerformanceMetricsCounterMETA create(long address)

Returns a new XrPerformanceMetricsCounterMETA instance for the specified memory address.

createSafe

public static @Nullable XrPerformanceMetricsCounterMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPerformanceMetricsCounterMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPerformanceMetricsCounterMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPerformanceMetricsCounterMETA.Buffer create(int capacity)

Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPerformanceMetricsCounterMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPerformanceMetricsCounterMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncounterFlags

public static long ncounterFlags(long struct)

Unsafe version of counterFlags().

ncounterUnit

public static int ncounterUnit(long struct)

Unsafe version of counterUnit().

nuintValue

public static int nuintValue(long struct)

Unsafe version of uintValue().

nfloatValue

public static float nfloatValue(long struct)

Unsafe version of floatValue().

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.

ncounterFlags

public static void ncounterFlags(long struct,
 long value)

Unsafe version of counterFlags.

ncounterUnit

public static void ncounterUnit(long struct,
 int value)

Unsafe version of counterUnit.

nuintValue

public static void nuintValue(long struct,
 int value)

Unsafe version of uintValue.

nfloatValue

public static void nfloatValue(long struct,
 float value)

Unsafe version of floatValue.