Package org.lwjgl.openxr
Class XrFrameEndInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrFrameEndInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrFrameEndInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceEnd frame information.Valid Usage (Implicit)
typemust beTYPE_FRAME_END_INFOnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrSecondaryViewConfigurationFrameEndInfoMSFTenvironmentBlendModemust be a validXrEnvironmentBlendModevalue- If
layerCountis not 0,layersmust be a pointer to an array oflayerCountvalidXrCompositionLayerBaseHeader-based structures. See also:XrCompositionLayerCubeKHR,XrCompositionLayerCylinderKHR,XrCompositionLayerEquirect2KHR,XrCompositionLayerEquirectKHR,XrCompositionLayerProjection,XrCompositionLayerQuad
See Also
XrCompositionLayerBaseHeader,EndFrameLayout
struct XrFrameEndInfo { XrStructureTypetype(); void const *next(); XrTimedisplayTime(); XrEnvironmentBlendModeenvironmentBlendMode(); uint32_tlayerCount();XrCompositionLayerBaseHeaderconst * const *layers(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrFrameEndInfo.BufferAn array ofXrFrameEndInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDISPLAYTIME
ENVIRONMENTBLENDMODE
LAYERCOUNT
LAYERS
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrFrameEndInfo(java.nio.ByteBuffer container)Creates aXrFrameEndInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static XrFrameEndInfocalloc()Returns a newXrFrameEndInfoinstance allocated withmemCalloc.static XrFrameEndInfo.Buffercalloc(int capacity)Returns a newXrFrameEndInfo.Bufferinstance allocated withmemCalloc.static XrFrameEndInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrFrameEndInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrFrameEndInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrFrameEndInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrFrameEndInfocreate()Returns a newXrFrameEndInfoinstance allocated withBufferUtils.static XrFrameEndInfo.Buffercreate(int capacity)Returns a newXrFrameEndInfo.Bufferinstance allocated withBufferUtils.static XrFrameEndInfocreate(long address)Returns a newXrFrameEndInfoinstance for the specified memory address.static XrFrameEndInfo.Buffercreate(long address, int capacity)Create aXrFrameEndInfo.Bufferinstance at the specified memory.static XrFrameEndInfocreateSafe(long address)static XrFrameEndInfo.BuffercreateSafe(long address, int capacity)longdisplayTime()theXrTimeat which this frame should be displayed.XrFrameEndInfodisplayTime(long value)Sets the specified value to thedisplayTime()field.intenvironmentBlendMode()theXrEnvironmentBlendModevalue representing the desired environment blend mode for this frame.XrFrameEndInfoenvironmentBlendMode(int value)Sets the specified value to theenvironmentBlendMode()field.intlayerCount()the number of composition layers in this frame.XrFrameEndInfolayerCount(int value)Sets the specified value to thelayerCount()field.org.lwjgl.PointerBufferlayers()a pointer to an array ofXrCompositionLayerBaseHeaderpointers.XrFrameEndInfolayers(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto thelayers()field.static XrFrameEndInfomalloc()Returns a newXrFrameEndInfoinstance allocated withmemAlloc.static XrFrameEndInfo.Buffermalloc(int capacity)Returns a newXrFrameEndInfo.Bufferinstance allocated withmemAlloc.static XrFrameEndInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrFrameEndInfo.Bufferinstance allocated on the specifiedMemoryStack.static XrFrameEndInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrFrameEndInfoinstance allocated on the specifiedMemoryStack.static longndisplayTime(long struct)Unsafe version ofdisplayTime().static voidndisplayTime(long struct, long value)Unsafe version ofdisplayTime.static intnenvironmentBlendMode(long struct)Unsafe version ofenvironmentBlendMode().static voidnenvironmentBlendMode(long struct, int value)Unsafe version ofenvironmentBlendMode.longnext()NULLor a pointer to the next structure in a structure chain.XrFrameEndInfonext(long value)Sets the specified value to thenext()field.XrFrameEndInfonext(XrSecondaryViewConfigurationFrameEndInfoMSFT value)Prepends the specifiedXrSecondaryViewConfigurationFrameEndInfoMSFTvalue to thenextchain.static intnlayerCount(long struct)Unsafe version oflayerCount().static voidnlayerCount(long struct, int value)Sets the specified value to thelayerCountfield of the specifiedstruct.static org.lwjgl.PointerBuffernlayers(long struct)Unsafe version oflayers.static voidnlayers(long struct, org.lwjgl.PointerBuffer value)Unsafe version oflayers.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrFrameEndInfoset(int type, long next, long displayTime, int environmentBlendMode, int layerCount, org.lwjgl.PointerBuffer layers)Initializes this struct with the specified values.XrFrameEndInfoset(XrFrameEndInfo src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrFrameEndInfotype(int value)Sets the specified value to thetype()field.XrFrameEndInfotype$Default()Sets theTYPE_FRAME_END_INFOvalue to thetype()field.
-
-
-
Constructor Detail
-
XrFrameEndInfo
public XrFrameEndInfo(java.nio.ByteBuffer container)
Creates aXrFrameEndInfoinstance 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.
-
displayTime
public long displayTime()
theXrTimeat which this frame should be displayed.
-
environmentBlendMode
public int environmentBlendMode()
theXrEnvironmentBlendModevalue representing the desired environment blend mode for this frame.
-
layerCount
public int layerCount()
the number of composition layers in this frame. The maximum supported layer count is identified byXrSystemGraphicsProperties::maxLayerCount. If layerCount is greater than the maximum supported layer count thenERROR_LAYER_LIMIT_EXCEEDEDmust be returned.
-
layers
@Nullable public org.lwjgl.PointerBuffer layers()
a pointer to an array ofXrCompositionLayerBaseHeaderpointers.
-
type
public XrFrameEndInfo type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrFrameEndInfo type$Default()
Sets theTYPE_FRAME_END_INFOvalue to thetype()field.
-
next
public XrFrameEndInfo next(long value)
Sets the specified value to thenext()field.
-
next
public XrFrameEndInfo next(XrSecondaryViewConfigurationFrameEndInfoMSFT value)
Prepends the specifiedXrSecondaryViewConfigurationFrameEndInfoMSFTvalue to thenextchain.
-
displayTime
public XrFrameEndInfo displayTime(long value)
Sets the specified value to thedisplayTime()field.
-
environmentBlendMode
public XrFrameEndInfo environmentBlendMode(int value)
Sets the specified value to theenvironmentBlendMode()field.
-
layerCount
public XrFrameEndInfo layerCount(int value)
Sets the specified value to thelayerCount()field.
-
layers
public XrFrameEndInfo layers(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto thelayers()field.
-
set
public XrFrameEndInfo set(int type, long next, long displayTime, int environmentBlendMode, int layerCount, @Nullable org.lwjgl.PointerBuffer layers)
Initializes this struct with the specified values.
-
set
public XrFrameEndInfo set(XrFrameEndInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrFrameEndInfo malloc()
Returns a newXrFrameEndInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrFrameEndInfo calloc()
Returns a newXrFrameEndInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrFrameEndInfo create()
Returns a newXrFrameEndInfoinstance allocated withBufferUtils.
-
create
public static XrFrameEndInfo create(long address)
Returns a newXrFrameEndInfoinstance for the specified memory address.
-
createSafe
@Nullable public static XrFrameEndInfo createSafe(long address)
-
malloc
public static XrFrameEndInfo.Buffer malloc(int capacity)
Returns a newXrFrameEndInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrFrameEndInfo.Buffer calloc(int capacity)
Returns a newXrFrameEndInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrFrameEndInfo.Buffer create(int capacity)
Returns a newXrFrameEndInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrFrameEndInfo.Buffer create(long address, int capacity)
Create aXrFrameEndInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrFrameEndInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static XrFrameEndInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameEndInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrFrameEndInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameEndInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrFrameEndInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameEndInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrFrameEndInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrFrameEndInfo.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().
-
ndisplayTime
public static long ndisplayTime(long struct)
Unsafe version ofdisplayTime().
-
nenvironmentBlendMode
public static int nenvironmentBlendMode(long struct)
Unsafe version ofenvironmentBlendMode().
-
nlayerCount
public static int nlayerCount(long struct)
Unsafe version oflayerCount().
-
nlayers
@Nullable public static org.lwjgl.PointerBuffer nlayers(long struct)
Unsafe version oflayers.
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
ndisplayTime
public static void ndisplayTime(long struct, long value)Unsafe version ofdisplayTime.
-
nenvironmentBlendMode
public static void nenvironmentBlendMode(long struct, int value)Unsafe version ofenvironmentBlendMode.
-
nlayerCount
public static void nlayerCount(long struct, int value)Sets the specified value to thelayerCountfield of the specifiedstruct.
-
nlayers
public static void nlayers(long struct, @Nullable org.lwjgl.PointerBuffer value)Unsafe version oflayers.
-
-