Class XrFrameState
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrFrameState
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrFrameState extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceFrame prediction structure.Description
XrFrameStatedescribes the time at which the next frame will be displayed to the user.predictedDisplayTimemust refer to the midpoint of the interval during which the frame is displayed. The runtime may report a differentpredictedDisplayPeriodfrom the hardware’s refresh cycle.For any frame where
shouldRenderisFALSE, 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 callingEndFramewith all layers omitted.Valid Usage (Implicit)
typemust beTYPE_FRAME_STATEnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrSecondaryViewConfigurationFrameStateMSFT
See Also
Layout
struct XrFrameState { XrStructureTypetype(); void *next(); XrTimepredictedDisplayTime(); XrDurationpredictedDisplayPeriod(); XrBool32shouldRender(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrFrameState.BufferAn array ofXrFrameStatestructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intNEXT
PREDICTEDDISPLAYPERIOD
PREDICTEDDISPLAYTIME
SHOULDRENDERThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrFrameState(java.nio.ByteBuffer container)Creates aXrFrameStateinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrFrameStatecalloc()Returns a newXrFrameStateinstance allocated withmemCalloc.static XrFrameState.Buffercalloc(int capacity)Returns a newXrFrameState.Bufferinstance allocated withmemCalloc.static XrFrameState.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrFrameState.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrFrameStatecalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrFrameStateinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrFrameStatecreate()Returns a newXrFrameStateinstance allocated withBufferUtils.static XrFrameState.Buffercreate(int capacity)Returns a newXrFrameState.Bufferinstance allocated withBufferUtils.static XrFrameStatecreate(long address)Returns a newXrFrameStateinstance for the specified memory address.static XrFrameState.Buffercreate(long address, int capacity)Create aXrFrameState.Bufferinstance at the specified memory.static XrFrameStatecreateSafe(long address)static XrFrameState.BuffercreateSafe(long address, int capacity)static XrFrameStatemalloc()Returns a newXrFrameStateinstance allocated withmemAlloc.static XrFrameState.Buffermalloc(int capacity)Returns a newXrFrameState.Bufferinstance allocated withmemAlloc.static XrFrameState.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrFrameState.Bufferinstance allocated on the specifiedMemoryStack.static XrFrameStatemalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrFrameStateinstance allocated on the specifiedMemoryStack.longnext()NULLor a pointer to the next structure in a structure chain.XrFrameStatenext(long value)Sets the specified value to thenext()field.XrFrameStatenext(XrSecondaryViewConfigurationFrameStateMSFT value)Prepends the specifiedXrSecondaryViewConfigurationFrameStateMSFTvalue to thenextchain.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static longnpredictedDisplayPeriod(long struct)Unsafe version ofpredictedDisplayPeriod().static voidnpredictedDisplayPeriod(long struct, long value)Unsafe version ofpredictedDisplayPeriod.static longnpredictedDisplayTime(long struct)Unsafe version ofpredictedDisplayTime().static voidnpredictedDisplayTime(long struct, long value)Unsafe version ofpredictedDisplayTime.static intnshouldRender(long struct)Unsafe version ofshouldRender().static voidnshouldRender(long struct, int value)Unsafe version ofshouldRender.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.longpredictedDisplayPeriod()theXrDurationof the display period for the next application-generated frame, for use in predicting display times beyond the next one.XrFrameStatepredictedDisplayPeriod(long value)Sets the specified value to thepredictedDisplayPeriod()field.longpredictedDisplayTime()the anticipated displayXrTimefor the next application-generated frame.XrFrameStatepredictedDisplayTime(long value)Sets the specified value to thepredictedDisplayTime()field.XrFrameStateset(int type, long next, long predictedDisplayTime, long predictedDisplayPeriod, boolean shouldRender)Initializes this struct with the specified values.XrFrameStateset(XrFrameState src)Copies the specified struct data to this struct.booleanshouldRender()XrFrameStateshouldRender(boolean value)Sets the specified value to theshouldRender()field.intsizeof()inttype()theXrStructureTypeof this structure.XrFrameStatetype(int value)Sets the specified value to thetype()field.XrFrameStatetype$Default()Sets theTYPE_FRAME_STATEvalue to thetype()field.
-
-
-
Constructor Detail
-
XrFrameState
public XrFrameState(java.nio.ByteBuffer container)
Creates aXrFrameStateinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
predictedDisplayTime
public long predictedDisplayTime()
the anticipated displayXrTimefor the next application-generated frame.
-
predictedDisplayPeriod
public long predictedDisplayPeriod()
theXrDurationof the display period for the next application-generated frame, for use in predicting display times beyond the next one.
-
shouldRender
public boolean shouldRender()
-
type
public XrFrameState type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrFrameState type$Default()
Sets theTYPE_FRAME_STATEvalue to thetype()field.
-
next
public XrFrameState next(long value)
Sets the specified value to thenext()field.
-
next
public XrFrameState next(XrSecondaryViewConfigurationFrameStateMSFT value)
Prepends the specifiedXrSecondaryViewConfigurationFrameStateMSFTvalue to thenextchain.
-
predictedDisplayTime
public XrFrameState predictedDisplayTime(long value)
Sets the specified value to thepredictedDisplayTime()field.
-
predictedDisplayPeriod
public XrFrameState predictedDisplayPeriod(long value)
Sets the specified value to thepredictedDisplayPeriod()field.
-
shouldRender
public XrFrameState shouldRender(boolean value)
Sets the specified value to theshouldRender()field.
-
set
public XrFrameState set(int type, long next, long predictedDisplayTime, long predictedDisplayPeriod, boolean shouldRender)
Initializes this struct with the specified values.
-
set
public XrFrameState set(XrFrameState src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrFrameState malloc()
Returns a newXrFrameStateinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrFrameState calloc()
Returns a newXrFrameStateinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrFrameState create()
Returns a newXrFrameStateinstance allocated withBufferUtils.
-
create
public static XrFrameState create(long address)
Returns a newXrFrameStateinstance for the specified memory address.
-
createSafe
@Nullable public static XrFrameState createSafe(long address)
-
malloc
public static XrFrameState.Buffer malloc(int capacity)
Returns a newXrFrameState.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrFrameState.Buffer calloc(int capacity)
Returns a newXrFrameState.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrFrameState.Buffer create(int capacity)
Returns a newXrFrameState.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrFrameState.Buffer create(long address, int capacity)
Create aXrFrameState.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrFrameState.Buffer createSafe(long address, int capacity)
-
malloc
public static XrFrameState malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameStateinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrFrameState calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameStateinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrFrameState.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameState.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrFrameState.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameState.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
npredictedDisplayTime
public static long npredictedDisplayTime(long struct)
Unsafe version ofpredictedDisplayTime().
-
npredictedDisplayPeriod
public static long npredictedDisplayPeriod(long struct)
Unsafe version ofpredictedDisplayPeriod().
-
nshouldRender
public static int nshouldRender(long struct)
Unsafe version ofshouldRender().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
npredictedDisplayTime
public static void npredictedDisplayTime(long struct, long value)Unsafe version ofpredictedDisplayTime.
-
npredictedDisplayPeriod
public static void npredictedDisplayPeriod(long struct, long value)Unsafe version ofpredictedDisplayPeriod.
-
nshouldRender
public static void nshouldRender(long struct, int value)Unsafe version ofshouldRender.
-
-