Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPerformanceMetricsStateMETA

extends Struct<XrPerformanceMetricsStateMETA>
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 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)
See Also

GetPerformanceMetricsStateMETA, SetPerformanceMetricsStateMETA

Layout


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

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
ENABLED

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrPerformanceMetricsStateMETA(long address, ByteBuffer container)

public
XrPerformanceMetricsStateMETA(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrPerformanceMetricsStateMETA
calloc()

Returns a new XrPerformanceMetricsStateMETA instance allocated with memCalloc.

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

Returns a new XrPerformanceMetricsStateMETA.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrPerformanceMetricsStateMETA
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 XrPerformanceMetricsStateMETA
create()

Returns a new XrPerformanceMetricsStateMETA instance allocated with BufferUtils.

public static XrPerformanceMetricsStateMETA
create(long address)

Returns a new XrPerformanceMetricsStateMETA instance for the specified memory address.

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

Returns a new XrPerformanceMetricsStateMETA.Buffer instance allocated with BufferUtils.

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

Create a XrPerformanceMetricsStateMETA.Buffer instance at the specified memory.

public static XrPerformanceMetricsStateMETA
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
enabled()

set to TRUE to indicate the performance metrics system is enabled, FALSE otherwise, when getting state.

public XrPerformanceMetricsStateMETA
enabled(boolean value)

Sets the specified value to the enabled field.

public static XrPerformanceMetricsStateMETA
malloc()

Returns a new XrPerformanceMetricsStateMETA instance allocated with memAlloc.

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

Returns a new XrPerformanceMetricsStateMETA.Buffer instance allocated with memAlloc.

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

Returns a new XrPerformanceMetricsStateMETA instance allocated on the specified MemoryStack.

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

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

public static int
nenabled(long struct)

Unsafe version of enabled.

public static void
nenabled(long struct, int value)

Unsafe version of enabled.

public long
next()

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

public XrPerformanceMetricsStateMETA
next(long value)

Sets the specified value to the next field.

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 XrPerformanceMetricsStateMETA
set(int type, long next, boolean enabled)

Initializes this struct with the specified values.

public XrPerformanceMetricsStateMETA

Returns:

this struct
set
(XrPerformanceMetricsStateMETA
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 XrPerformanceMetricsStateMETA
type(int value)

Sets the specified value to the type field.

public XrPerformanceMetricsStateMETA
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.

ENABLEDback to summary
public static final int ENABLED

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.

Constructor Detail

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

callocback to summary
public static XrPerformanceMetricsStateMETA calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPerformanceMetricsStateMETA calloc(MemoryStack stack)

Returns a new XrPerformanceMetricsStateMETA 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 XrPerformanceMetricsStateMETA.Buffer calloc(int capacity, MemoryStack stack)

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

createback to summary
protected XrPerformanceMetricsStateMETA 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 XrPerformanceMetricsStateMETA create()

Returns a new XrPerformanceMetricsStateMETA instance allocated with BufferUtils.

createback to summary
public static XrPerformanceMetricsStateMETA create(long address)

Returns a new XrPerformanceMetricsStateMETA instance for the specified memory address.

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

Returns a new XrPerformanceMetricsStateMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPerformanceMetricsStateMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPerformanceMetricsStateMETA createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
enabledback to summary
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.

Annotations
@NativeType:XrBool32
enabledback to summary
public XrPerformanceMetricsStateMETA enabled(boolean value)

Sets the specified value to the enabled field.

mallocback to summary
public static XrPerformanceMetricsStateMETA malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPerformanceMetricsStateMETA malloc(MemoryStack stack)

Returns a new XrPerformanceMetricsStateMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nenabledback to summary
public static int nenabled(long struct)

Unsafe version of enabled.

nenabledback to summary
public static void nenabled(long struct, int value)

Unsafe version of enabled.

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 XrPerformanceMetricsStateMETA next(long value)

Sets the specified value to the next field.

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.

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

Initializes this struct with the specified values.

setback to summary
public XrPerformanceMetricsStateMETA set(XrPerformanceMetricsStateMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrPerformanceMetricsStateMETA

the source struct

Returns:XrPerformanceMetricsStateMETA

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 XrPerformanceMetricsStateMETA type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_PERFORMANCE_METRICS_STATE_META value to the type field.

org.lwjgl.openxr back to summary

public Class XrPerformanceMetricsStateMETA.Buffer

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

An array of XrPerformanceMetricsStateMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrPerformanceMetricsStateMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPerformanceMetricsStateMETA.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 boolean

Returns:

the value of the XrPerformanceMetricsStateMETA#enabled field.
enabled
()

public XrPerformanceMetricsStateMETA.Buffer
enabled(boolean value)

Sets the specified value to the XrPerformanceMetricsStateMETA#enabled field.

protected XrPerformanceMetricsStateMETA
public long

Returns:

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

public XrPerformanceMetricsStateMETA.Buffer
next(long value)

Sets the specified value to the XrPerformanceMetricsStateMETA#next field.

protected XrPerformanceMetricsStateMETA.Buffer
public int

Returns:

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

public XrPerformanceMetricsStateMETA.Buffer
type(int value)

Sets the specified value to the XrPerformanceMetricsStateMETA#type field.

public XrPerformanceMetricsStateMETA.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPerformanceMetricsStateMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrPerformanceMetricsStateMETA.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 XrPerformanceMetricsStateMETA#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

enabledback to summary
public boolean enabled()
Returns:boolean

the value of the XrPerformanceMetricsStateMETA#enabled field.

Annotations
@NativeType:XrBool32
enabledback to summary
public XrPerformanceMetricsStateMETA.Buffer enabled(boolean value)

Sets the specified value to the XrPerformanceMetricsStateMETA#enabled field.

getElementFactoryback to summary
protected XrPerformanceMetricsStateMETA getElementFactory()

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

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

the value of the XrPerformanceMetricsStateMETA#next field.

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

Sets the specified value to the XrPerformanceMetricsStateMETA#next field.

selfback to summary
protected XrPerformanceMetricsStateMETA.Buffer self()

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

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

the value of the XrPerformanceMetricsStateMETA#type field.

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

Sets the specified value to the XrPerformanceMetricsStateMETA#type field.

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

Sets the TYPE_PERFORMANCE_METRICS_STATE_META value to the XrPerformanceMetricsStateMETA#type field.