Frame prediction structure.

Description

XrFrameState describes the time at which the next frame will be displayed to the user. predictedDisplayTime must refer to the midpoint of the interval during which the frame is displayed. The runtime may report a different predictedDisplayPeriod from the hardware’s refresh cycle.

For any frame where shouldRender is FALSE, the application should avoid heavy GPU work for that frame, for example by not rendering its layers. This typically happens when the application is transitioning into or out of a running session, or when some system UI is fully covering the application at the moment. As long as the session is running, the application should keep running the frame loop to maintain the frame synchronization to the runtime, even if this requires calling EndFrame with all layers omitted.

Valid Usage (Implicit)

type must be TYPE_FRAME_STATE
next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrSecondaryViewConfigurationFrameStateMSFT

Layout


struct XrFrameState {
    XrStructureType type;
    void * next;
    XrTime predictedDisplayTime;
    XrDuration predictedDisplayPeriod;
    XrBool32 shouldRender;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrFrameState.Buffer An array of `XrFrameState` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	NEXT The struct member offsets.
public static final int	PREDICTEDDISPLAYPERIOD The struct member offsets.
public static final int	PREDICTEDDISPLAYTIME The struct member offsets.
public static final int	SHOULDRENDER 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrFrameState(long address, ByteBuffer container)
public	XrFrameState(ByteBuffer container) Creates a `XrFrameState` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static XrFrameState	calloc() Returns a new `XrFrameState` instance allocated with `memCalloc`.
public static XrFrameState.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrFrameState.Buffer` instance allocated with `memCalloc`.
public static XrFrameState	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrFrameState` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrFrameState.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrFrameState.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrFrameState	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 XrFrameState	create() Returns a new `XrFrameState` instance allocated with `BufferUtils`.
public static XrFrameState	create(long address) Returns a new `XrFrameState` instance for the specified memory address.
public static XrFrameState.Buffer	create(int the buffer capacity capacity) Returns a new `XrFrameState.Buffer` instance allocated with `BufferUtils`.
public static XrFrameState.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrFrameState.Buffer` instance at the specified memory.
public static XrFrameState	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrFrameState.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrFrameState	malloc() Returns a new `XrFrameState` instance allocated with `memAlloc`.
public static XrFrameState.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrFrameState.Buffer` instance allocated with `memAlloc`.
public static XrFrameState	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrFrameState` instance allocated on the specified `MemoryStack`.
public static XrFrameState.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrFrameState.Buffer` instance allocated on the specified `MemoryStack`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrFrameState	next(long value) Sets the specified value to the `next` field.
public XrFrameState	next(XrSecondaryViewConfigurationFrameStateMSFT value) Prepends the specified `XrSecondaryViewConfigurationFrameStateMSFT` value to the `next` chain.
public static long	nnext(long struct) Unsafe version of `next`.
public static void	nnext(long struct, long value) Unsafe version of `next`.
public static long	npredictedDisplayPeriod(long struct) Unsafe version of `predictedDisplayPeriod`.
public static void	npredictedDisplayPeriod(long struct, long value) Unsafe version of `predictedDisplayPeriod`.
public static long	npredictedDisplayTime(long struct) Unsafe version of `predictedDisplayTime`.
public static void	npredictedDisplayTime(long struct, long value) Unsafe version of `predictedDisplayTime`.
public static int	nshouldRender(long struct) Unsafe version of `shouldRender`.
public static void	nshouldRender(long struct, int value) Unsafe version of `shouldRender`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public long	predictedDisplayPeriod() the `XrDuration` of the display period for the next application-generated frame, for use in predicting display times beyond the next one.
public XrFrameState	predictedDisplayPeriod(long value) Sets the specified value to the `predictedDisplayPeriod` field.
public long	predictedDisplayTime() the anticipated display `XrTime` for the next application-generated frame.
public XrFrameState	predictedDisplayTime(long value) Sets the specified value to the `predictedDisplayTime` field.
public XrFrameState	set(int type, long next, long predictedDisplayTime, long predictedDisplayPeriod, boolean shouldRender) Initializes this struct with the specified values.
public XrFrameState	Returns: this struct set(XrFrameState the source struct src) Copies the specified struct data to this struct.
public boolean	shouldRender() `TRUE` if the application should render its layers as normal and submit them to `EndFrame`.
public XrFrameState	shouldRender(boolean value) Sets the specified value to the `shouldRender` field.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	type() the `XrStructureType` of this structure.
public XrFrameState	type(int value) Sets the specified value to the `type` field.
public XrFrameState	type$Default() Sets the `TYPE_FRAME_STATE` value to the `type` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

NEXT	back to summary
public static final int NEXT The struct member offsets.

PREDICTEDDISPLAYPERIOD	back to summary
public static final int PREDICTEDDISPLAYPERIOD The struct member offsets.

PREDICTEDDISPLAYTIME	back to summary
public static final int PREDICTEDDISPLAYTIME The struct member offsets.

SHOULDRENDER	back to summary
public static final int SHOULDRENDER The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrFrameState	back to summary
protected XrFrameState(long address, ByteBuffer container)

XrFrameState back to summary

XrFrameState	back to summary
public XrFrameState(ByteBuffer container) Creates a `XrFrameState` 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.

public XrFrameState(ByteBuffer container)

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

calloc	back to summary
public static XrFrameState calloc() Returns a new `XrFrameState` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrFrameState.Buffer calloc(int capacity) Returns a new `XrFrameState.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrFrameState.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrFrameState calloc(MemoryStack stack) Returns a new `XrFrameState` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrFrameState calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrFrameState.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrFrameState.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

public static XrFrameState.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected XrFrameState 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

protected XrFrameState 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

create	back to summary
public static XrFrameState create() Returns a new `XrFrameState` instance allocated with `BufferUtils`.

create	back to summary
public static XrFrameState create(long address) Returns a new `XrFrameState` instance for the specified memory address.

create back to summary

create	back to summary
public static XrFrameState.Buffer create(int capacity) Returns a new `XrFrameState.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrFrameState.Buffer create(int capacity)

Returns a new XrFrameState.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrFrameState.Buffer create(long address, int capacity) Create a `XrFrameState.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrFrameState.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static XrFrameState createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrFrameState createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrFrameState.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrFrameState malloc() Returns a new `XrFrameState` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrFrameState.Buffer malloc(int capacity) Returns a new `XrFrameState.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrFrameState.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrFrameState malloc(MemoryStack stack) Returns a new `XrFrameState` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrFrameState malloc(MemoryStack stack)

Returns a new XrFrameState instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrFrameState.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrFrameState.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrFrameState.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

next back to summary

next	back 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. Annotations @NativeType:void *

public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

Annotations

@NativeType:void *

next	back to summary
public XrFrameState next(long value) Sets the specified value to the `next` field.

next	back to summary
public XrFrameState next(XrSecondaryViewConfigurationFrameStateMSFT value) Prepends the specified `XrSecondaryViewConfigurationFrameStateMSFT` value to the `next` chain.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

npredictedDisplayPeriod	back to summary
public static long npredictedDisplayPeriod(long struct) Unsafe version of `predictedDisplayPeriod`.

npredictedDisplayPeriod	back to summary
public static void npredictedDisplayPeriod(long struct, long value) Unsafe version of `predictedDisplayPeriod`.

npredictedDisplayTime	back to summary
public static long npredictedDisplayTime(long struct) Unsafe version of `predictedDisplayTime`.

npredictedDisplayTime	back to summary
public static void npredictedDisplayTime(long struct, long value) Unsafe version of `predictedDisplayTime`.

nshouldRender	back to summary
public static int nshouldRender(long struct) Unsafe version of `shouldRender`.

nshouldRender	back to summary
public static void nshouldRender(long struct, int value) Unsafe version of `shouldRender`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

predictedDisplayPeriod back to summary

predictedDisplayPeriod	back to summary
public long predictedDisplayPeriod() the `XrDuration` of the display period for the next application-generated frame, for use in predicting display times beyond the next one. Annotations @NativeType:XrDuration

public long predictedDisplayPeriod()

the XrDuration of the display period for the next application-generated frame, for use in predicting display times beyond the next one.

Annotations

@NativeType:XrDuration

predictedDisplayPeriod	back to summary
public XrFrameState predictedDisplayPeriod(long value) Sets the specified value to the `predictedDisplayPeriod` field.

predictedDisplayTime back to summary

predictedDisplayTime	back to summary
public long predictedDisplayTime() the anticipated display `XrTime` for the next application-generated frame. Annotations @NativeType:XrTime

public long predictedDisplayTime()

the anticipated display XrTime for the next application-generated frame.

Annotations

@NativeType:XrTime

predictedDisplayTime	back to summary
public XrFrameState predictedDisplayTime(long value) Sets the specified value to the `predictedDisplayTime` field.

set	back to summary
public XrFrameState set(int type, long next, long predictedDisplayTime, long predictedDisplayPeriod, boolean shouldRender) Initializes this struct with the specified values.

set	back to summary
public XrFrameState set(XrFrameState src) Copies the specified struct data to this struct. Parameters src:XrFrameState the source struct Returns:XrFrameState this struct

set

back to summary

public XrFrameState set(XrFrameState src)

Copies the specified struct data to this struct.

Parameters

src:XrFrameState: the source struct

Returns:XrFrameState

this struct

shouldRender back to summary

shouldRender	back to summary
public boolean shouldRender() `TRUE` if the application should render its layers as normal and submit them to `EndFrame`. When this value is `FALSE`, the application should avoid heavy GPU work where possible, for example by skipping layer rendering and then omitting those layers when calling `EndFrame`. Annotations @NativeType:XrBool32

public boolean shouldRender()

TRUE if the application should render its layers as normal and submit them to EndFrame. When this value is FALSE, the application should avoid heavy GPU work where possible, for example by skipping layer rendering and then omitting those layers when calling EndFrame.

Annotations

@NativeType:XrBool32

shouldRender	back to summary
public XrFrameState shouldRender(boolean value) Sets the specified value to the `shouldRender` field.

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

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

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

Returns sizeof(struct).

Annotations

@Override

type back to summary

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrFrameState type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrFrameState type$Default() Sets the `TYPE_FRAME_STATE` value to the `type` field.

org.lwjgl.openxr back to summary

public Class XrFrameState.Buffer

Class Inheritance

extends StructBuffer<XrFrameState, XrFrameState.Buffer>
implements NativeResource

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrFrameState structs.

Field Summary

Modifier and Type	Field and Description
private static final XrFrameState	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrFrameState.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 Type	Method and Description
protected XrFrameState	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrFrameState#next` field. next()
public XrFrameState.Buffer	next(long value) Sets the specified value to the `XrFrameState#next` field.
public XrFrameState.Buffer	next(XrSecondaryViewConfigurationFrameStateMSFT value) Prepends the specified `XrSecondaryViewConfigurationFrameStateMSFT` value to the `next` chain.
public long	Returns: the value of the `XrFrameState#predictedDisplayPeriod` field. predictedDisplayPeriod()
public XrFrameState.Buffer	predictedDisplayPeriod(long value) Sets the specified value to the `XrFrameState#predictedDisplayPeriod` field.
public long	Returns: the value of the `XrFrameState#predictedDisplayTime` field. predictedDisplayTime()
public XrFrameState.Buffer	predictedDisplayTime(long value) Sets the specified value to the `XrFrameState#predictedDisplayTime` field.
protected XrFrameState.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public boolean	Returns: the value of the `XrFrameState#shouldRender` field. shouldRender()
public XrFrameState.Buffer	shouldRender(boolean value) Sets the specified value to the `XrFrameState#shouldRender` field.
public int	Returns: the value of the `XrFrameState#type` field. type()
public XrFrameState.Buffer	type(int value) Sets the specified value to the `XrFrameState#type` field.
public XrFrameState.Buffer	type$Default() Sets the `TYPE_FRAME_STATE` value to the `XrFrameState#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrFrameState ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new XrFrameState.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 XrFrameState#SIZEOF, and its mark will be undefined.

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

Buffer	back to summary
public Buffer(long address, int cap)

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

Method Detail

getElementFactory

back to summary

protected XrFrameState getElementFactory()

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

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrFrameState#next` field. Annotations @NativeType:void *

next	back to summary
public XrFrameState.Buffer next(long value) Sets the specified value to the `XrFrameState#next` field.

next	back to summary
public XrFrameState.Buffer next(XrSecondaryViewConfigurationFrameStateMSFT value) Prepends the specified `XrSecondaryViewConfigurationFrameStateMSFT` value to the `next` chain.

predictedDisplayPeriod	back to summary
public long predictedDisplayPeriod() Returns:long the value of the `XrFrameState#predictedDisplayPeriod` field. Annotations @NativeType:XrDuration

predictedDisplayPeriod	back to summary
public XrFrameState.Buffer predictedDisplayPeriod(long value) Sets the specified value to the `XrFrameState#predictedDisplayPeriod` field.

predictedDisplayTime	back to summary
public long predictedDisplayTime() Returns:long the value of the `XrFrameState#predictedDisplayTime` field. Annotations @NativeType:XrTime

predictedDisplayTime	back to summary
public XrFrameState.Buffer predictedDisplayTime(long value) Sets the specified value to the `XrFrameState#predictedDisplayTime` field.

self

back to summary

protected XrFrameState.Buffer self()

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

Annotations

@Override

shouldRender	back to summary
public boolean shouldRender() Returns:boolean the value of the `XrFrameState#shouldRender` field. Annotations @NativeType:XrBool32

shouldRender	back to summary
public XrFrameState.Buffer shouldRender(boolean value) Sets the specified value to the `XrFrameState#shouldRender` field.

type	back to summary
public int type() Returns:int the value of the `XrFrameState#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrFrameState.Buffer type(int value) Sets the specified value to the `XrFrameState#type` field.

type$Default	back to summary
public XrFrameState.Buffer type$Default() Sets the `TYPE_FRAME_STATE` value to the `XrFrameState#type` field.

public Class XrFrameState

Description

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XrFrameState.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail