Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPerformanceMetricsCounterMETA

extends Struct<XrPerformanceMetricsCounterMETA>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Performance metrics counter value.
Description

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

Valid Usage (Implicit)
See Also

QueryPerformanceMetricsCounterMETA

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COUNTERFLAGS

The struct member offsets.

public static final int
COUNTERUNIT

The struct member offsets.

public static final int
FLOATVALUE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

public static final int
UINTVALUE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrPerformanceMetricsCounterMETA(ByteBuffer container)

Creates a XrPerformanceMetricsCounterMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrPerformanceMetricsCounterMETA
calloc()

Returns a new XrPerformanceMetricsCounterMETA instance allocated with memCalloc.

public static XrPerformanceMetricsCounterMETA.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with memCalloc.

public static XrPerformanceMetricsCounterMETA
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrPerformanceMetricsCounterMETA.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public long
counterFlags()

a bitmask of XrPerformanceMetricsCounterFlagBitsMETA describing the validity of value members.

public XrPerformanceMetricsCounterMETA
counterFlags(long value)

Sets the specified value to the counterFlags field.

public int
counterUnit()

a enum of XrPerformanceMetricsCounterUnitMETA describing the measurement unit.

public XrPerformanceMetricsCounterMETA
counterUnit(int value)

Sets the specified value to the counterUnit field.

protected XrPerformanceMetricsCounterMETA
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrPerformanceMetricsCounterMETA
create()

Returns a new XrPerformanceMetricsCounterMETA instance allocated with BufferUtils.

public static XrPerformanceMetricsCounterMETA
create(long address)

Returns a new XrPerformanceMetricsCounterMETA instance for the specified memory address.

public static XrPerformanceMetricsCounterMETA.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with BufferUtils.

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

Create a XrPerformanceMetricsCounterMETA.Buffer instance at the specified memory.

public static XrPerformanceMetricsCounterMETA
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
floatValue()

the counter value in float format.

public XrPerformanceMetricsCounterMETA
floatValue(float value)

Sets the specified value to the floatValue field.

public static XrPerformanceMetricsCounterMETA
malloc()

Returns a new XrPerformanceMetricsCounterMETA instance allocated with memAlloc.

public static XrPerformanceMetricsCounterMETA.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with memAlloc.

public static XrPerformanceMetricsCounterMETA
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrPerformanceMetricsCounterMETA instance allocated on the specified MemoryStack.

public static XrPerformanceMetricsCounterMETA.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
ncounterFlags(long struct)

Unsafe version of counterFlags.

public static void
ncounterFlags(long struct, long value)

Unsafe version of counterFlags.

public static int
ncounterUnit(long struct)

Unsafe version of counterUnit.

public static void
ncounterUnit(long struct, int value)

Unsafe version of counterUnit.

public long
next()

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

public XrPerformanceMetricsCounterMETA
next(long value)

Sets the specified value to the next field.

public static float
nfloatValue(long struct)

Unsafe version of floatValue.

public static void
nfloatValue(long struct, float value)

Unsafe version of floatValue.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public static int
nuintValue(long struct)

Unsafe version of uintValue.

public static void
nuintValue(long struct, int value)

Unsafe version of uintValue.

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

Initializes this struct with the specified values.

public XrPerformanceMetricsCounterMETA

Returns:

this struct
set
(XrPerformanceMetricsCounterMETA
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
type()

the XrStructureType of this structure.

public XrPerformanceMetricsCounterMETA
type(int value)

Sets the specified value to the type field.

public XrPerformanceMetricsCounterMETA
public int
uintValue()

the counter value in uint32_t format.

public XrPerformanceMetricsCounterMETA
uintValue(int value)

Sets the specified value to the uintValue field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

COUNTERFLAGSback to summary
public static final int COUNTERFLAGS

The struct member offsets.

COUNTERUNITback to summary
public static final int COUNTERUNIT

The struct member offsets.

FLOATVALUEback to summary
public static final int FLOATVALUE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

UINTVALUEback to summary
public static final int UINTVALUE

The struct member offsets.

Constructor Detail

XrPerformanceMetricsCounterMETAback to summary
protected XrPerformanceMetricsCounterMETA(long address, ByteBuffer container)
XrPerformanceMetricsCounterMETAback to summary
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 Detail

callocback to summary
public static XrPerformanceMetricsCounterMETA calloc()

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

callocback to summary
public static XrPerformanceMetricsCounterMETA.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPerformanceMetricsCounterMETA calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrPerformanceMetricsCounterMETA.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

counterFlagsback to summary
public long counterFlags()

a bitmask of XrPerformanceMetricsCounterFlagBitsMETA describing the validity of value members.

Annotations
@NativeType:XrPerformanceMetricsCounterFlagsMETA
counterFlagsback to summary
public XrPerformanceMetricsCounterMETA counterFlags(long value)

Sets the specified value to the counterFlags field.

counterUnitback to summary
public int counterUnit()

a enum of XrPerformanceMetricsCounterUnitMETA describing the measurement unit.

Annotations
@NativeType:XrPerformanceMetricsCounterUnitMETA
counterUnitback to summary
public XrPerformanceMetricsCounterMETA counterUnit(int value)

Sets the specified value to the counterUnit field.

createback to summary
protected XrPerformanceMetricsCounterMETA create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrPerformanceMetricsCounterMETA create()

Returns a new XrPerformanceMetricsCounterMETA instance allocated with BufferUtils.

createback to summary
public static XrPerformanceMetricsCounterMETA create(long address)

Returns a new XrPerformanceMetricsCounterMETA instance for the specified memory address.

createback to summary
public static XrPerformanceMetricsCounterMETA.Buffer create(int capacity)

Returns a new XrPerformanceMetricsCounterMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPerformanceMetricsCounterMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPerformanceMetricsCounterMETA createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrPerformanceMetricsCounterMETA.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
floatValueback to summary
public float floatValue()

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

floatValueback to summary
public XrPerformanceMetricsCounterMETA floatValue(float value)

Sets the specified value to the floatValue field.

mallocback to summary
public static XrPerformanceMetricsCounterMETA malloc()

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

mallocback to summary
public static XrPerformanceMetricsCounterMETA.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPerformanceMetricsCounterMETA malloc(MemoryStack stack)

Returns a new XrPerformanceMetricsCounterMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrPerformanceMetricsCounterMETA.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncounterFlagsback to summary
public static long ncounterFlags(long struct)

Unsafe version of counterFlags.

ncounterFlagsback to summary
public static void ncounterFlags(long struct, long value)

Unsafe version of counterFlags.

ncounterUnitback to summary
public static int ncounterUnit(long struct)

Unsafe version of counterUnit.

ncounterUnitback to summary
public static void ncounterUnit(long struct, int value)

Unsafe version of counterUnit.

nextback to summary
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.

Annotations
@NativeType:void const *
nextback to summary
public XrPerformanceMetricsCounterMETA next(long value)

Sets the specified value to the next field.

nfloatValueback to summary
public static float nfloatValue(long struct)

Unsafe version of floatValue.

nfloatValueback to summary
public static void nfloatValue(long struct, float value)

Unsafe version of floatValue.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

nuintValueback to summary
public static int nuintValue(long struct)

Unsafe version of uintValue.

nuintValueback to summary
public static void nuintValue(long struct, int value)

Unsafe version of uintValue.

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

Initializes this struct with the specified values.

setback to summary
public XrPerformanceMetricsCounterMETA set(XrPerformanceMetricsCounterMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrPerformanceMetricsCounterMETA

the source struct

Returns:XrPerformanceMetricsCounterMETA

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPerformanceMetricsCounterMETA type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrPerformanceMetricsCounterMETA type$Default()

Sets the TYPE_PERFORMANCE_METRICS_COUNTER_META value to the type field.

uintValueback to summary
public int uintValue()

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

Annotations
@NativeType:uint32_t
uintValueback to summary
public XrPerformanceMetricsCounterMETA uintValue(int value)

Sets the specified value to the uintValue field.

org.lwjgl.openxr back to summary

public Class XrPerformanceMetricsCounterMETA.Buffer

extends StructBuffer<XrPerformanceMetricsCounterMETA, XrPerformanceMetricsCounterMETA.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrPerformanceMetricsCounterMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrPerformanceMetricsCounterMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPerformanceMetricsCounterMETA.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long
public XrPerformanceMetricsCounterMETA.Buffer
counterFlags(long value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#counterFlags field.

public int

Returns:

the value of the XrPerformanceMetricsCounterMETA#counterUnit field.
counterUnit
()

public XrPerformanceMetricsCounterMETA.Buffer
counterUnit(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#counterUnit field.

public float

Returns:

the value of the XrPerformanceMetricsCounterMETA#floatValue field.
floatValue
()

public XrPerformanceMetricsCounterMETA.Buffer
floatValue(float value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#floatValue field.

protected XrPerformanceMetricsCounterMETA
public long

Returns:

the value of the XrPerformanceMetricsCounterMETA#next field.
next
()

public XrPerformanceMetricsCounterMETA.Buffer
next(long value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#next field.

protected XrPerformanceMetricsCounterMETA.Buffer
public int

Returns:

the value of the XrPerformanceMetricsCounterMETA#type field.
type
()

public XrPerformanceMetricsCounterMETA.Buffer
type(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#type field.

public XrPerformanceMetricsCounterMETA.Buffer
public int

Returns:

the value of the XrPerformanceMetricsCounterMETA#uintValue field.
uintValue
()

public XrPerformanceMetricsCounterMETA.Buffer
uintValue(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#uintValue field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPerformanceMetricsCounterMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrPerformanceMetricsCounterMETA.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrPerformanceMetricsCounterMETA#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

counterFlagsback to summary
public long counterFlags()
Returns:long

the value of the XrPerformanceMetricsCounterMETA#counterFlags field.

Annotations
@NativeType:XrPerformanceMetricsCounterFlagsMETA
counterFlagsback to summary
public XrPerformanceMetricsCounterMETA.Buffer counterFlags(long value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#counterFlags field.

counterUnitback to summary
public int counterUnit()
Returns:int

the value of the XrPerformanceMetricsCounterMETA#counterUnit field.

Annotations
@NativeType:XrPerformanceMetricsCounterUnitMETA
counterUnitback to summary
public XrPerformanceMetricsCounterMETA.Buffer counterUnit(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#counterUnit field.

floatValueback to summary
public float floatValue()
Returns:float

the value of the XrPerformanceMetricsCounterMETA#floatValue field.

floatValueback to summary
public XrPerformanceMetricsCounterMETA.Buffer floatValue(float value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#floatValue field.

getElementFactoryback to summary
protected XrPerformanceMetricsCounterMETA getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrPerformanceMetricsCounterMETA#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrPerformanceMetricsCounterMETA.Buffer next(long value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#next field.

selfback to summary
protected XrPerformanceMetricsCounterMETA.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrPerformanceMetricsCounterMETA#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPerformanceMetricsCounterMETA.Buffer type(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#type field.

type$Defaultback to summary
public XrPerformanceMetricsCounterMETA.Buffer type$Default()

Sets the TYPE_PERFORMANCE_METRICS_COUNTER_META value to the XrPerformanceMetricsCounterMETA#type field.

uintValueback to summary
public int uintValue()
Returns:int

the value of the XrPerformanceMetricsCounterMETA#uintValue field.

Annotations
@NativeType:uint32_t
uintValueback to summary
public XrPerformanceMetricsCounterMETA.Buffer uintValue(int value)

Sets the specified value to the XrPerformanceMetricsCounterMETA#uintValue field.