Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFrameEndInfo

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

End frame information.
Valid Usage (Implicit)
See Also

XrCompositionLayerBaseHeader, EndFrame

Layout


struct XrFrameEndInfo {
    XrStructureType type;
    void const * next;
    XrTime displayTime;
    XrEnvironmentBlendMode environmentBlendMode;
    uint32_t layerCount;
    XrCompositionLayerBaseHeader const * const * layers;
}

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
DISPLAYTIME

The struct member offsets.

public static final int
ENVIRONMENTBLENDMODE

The struct member offsets.

public static final int
LAYERCOUNT

The struct member offsets.

public static final int
LAYERS

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
XrFrameEndInfo(long address, ByteBuffer container)

public
XrFrameEndInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrFrameEndInfo
calloc()

Returns a new XrFrameEndInfo instance allocated with memCalloc.

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

Returns a new XrFrameEndInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrFrameEndInfo instance allocated with BufferUtils.

public static XrFrameEndInfo
create(long address)

Returns a new XrFrameEndInfo instance for the specified memory address.

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

Returns a new XrFrameEndInfo.Buffer instance allocated with BufferUtils.

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

Create a XrFrameEndInfo.Buffer instance at the specified memory.

public static XrFrameEndInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
displayTime()

the XrTime at which this frame should be displayed.

public XrFrameEndInfo
displayTime(long value)

Sets the specified value to the displayTime field.

public int
environmentBlendMode()

the XrEnvironmentBlendMode value representing the desired environment blend mode for this frame.

public XrFrameEndInfo
environmentBlendMode(int value)

Sets the specified value to the environmentBlendMode field.

public int
layerCount()

the number of composition layers in this frame.

public XrFrameEndInfo
layerCount(int value)

Sets the specified value to the layerCount field.

public PointerBuffer
layers()

a pointer to an array of XrCompositionLayerBaseHeader pointers.

public XrFrameEndInfo
layers(PointerBuffer value)

Sets the address of the specified PointerBuffer to the layers field.

public static XrFrameEndInfo
malloc()

Returns a new XrFrameEndInfo instance allocated with memAlloc.

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

Returns a new XrFrameEndInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrFrameEndInfo instance allocated on the specified MemoryStack.

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

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

public static long
ndisplayTime(long struct)

Unsafe version of displayTime.

public static void
ndisplayTime(long struct, long value)

Unsafe version of displayTime.

public static int
nenvironmentBlendMode(long struct)

Unsafe version of environmentBlendMode.

public static void
nenvironmentBlendMode(long struct, int value)

Unsafe version of environmentBlendMode.

public long
next()

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

public XrFrameEndInfo
next(long value)

Sets the specified value to the next field.

public XrFrameEndInfo
next(XrFrameEndInfoML value)

Prepends the specified XrFrameEndInfoML value to the next chain.

public XrFrameEndInfo
next(XrGlobalDimmerFrameEndInfoML value)

Prepends the specified XrGlobalDimmerFrameEndInfoML value to the next chain.

public XrFrameEndInfo
next(XrLocalDimmingFrameEndInfoMETA value)

Prepends the specified XrLocalDimmingFrameEndInfoMETA value to the next chain.

public XrFrameEndInfo
public static int
nlayerCount(long struct)

Unsafe version of layerCount.

public static void
nlayerCount(long struct, int value)

Sets the specified value to the layerCount field of the specified struct.

public static PointerBuffer
nlayers(long struct)

Unsafe version of layers.

public static void
nlayers(long struct, PointerBuffer value)

Unsafe version of layers.

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 XrFrameEndInfo
set(int type, long next, long displayTime, int environmentBlendMode, int layerCount, PointerBuffer layers)

Initializes this struct with the specified values.

public XrFrameEndInfo

Returns:

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

Sets the specified value to the type field.

public XrFrameEndInfo
type$Default()

Sets the TYPE_FRAME_END_INFO value to the type 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.

DISPLAYTIMEback to summary
public static final int DISPLAYTIME

The struct member offsets.

ENVIRONMENTBLENDMODEback to summary
public static final int ENVIRONMENTBLENDMODE

The struct member offsets.

LAYERCOUNTback to summary
public static final int LAYERCOUNT

The struct member offsets.

LAYERSback to summary
public static final int LAYERS

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

XrFrameEndInfoback to summary
protected XrFrameEndInfo(long address, ByteBuffer container)
XrFrameEndInfoback to summary
public XrFrameEndInfo(ByteBuffer container)

Creates a XrFrameEndInfo 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 XrFrameEndInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFrameEndInfo calloc(MemoryStack stack)

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

Returns a new XrFrameEndInfo.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 XrFrameEndInfo 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 XrFrameEndInfo create()

Returns a new XrFrameEndInfo instance allocated with BufferUtils.

createback to summary
public static XrFrameEndInfo create(long address)

Returns a new XrFrameEndInfo instance for the specified memory address.

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

Returns a new XrFrameEndInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFrameEndInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFrameEndInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
displayTimeback to summary
public long displayTime()

the XrTime at which this frame should be displayed.

Annotations
@NativeType:XrTime
displayTimeback to summary
public XrFrameEndInfo displayTime(long value)

Sets the specified value to the displayTime field.

environmentBlendModeback to summary
public int environmentBlendMode()

the XrEnvironmentBlendMode value representing the desired environment blend mode for this frame.

Annotations
@NativeType:XrEnvironmentBlendMode
environmentBlendModeback to summary
public XrFrameEndInfo environmentBlendMode(int value)

Sets the specified value to the environmentBlendMode field.

layerCountback to summary
public int layerCount()

the number of composition layers in this frame. The maximum supported layer count is identified by XrSystemGraphicsProperties::maxLayerCount. If layerCount is greater than the maximum supported layer count then ERROR_LAYER_LIMIT_EXCEEDED must be returned.

Annotations
@NativeType:uint32_t
layerCountback to summary
public XrFrameEndInfo layerCount(int value)

Sets the specified value to the layerCount field.

layersback to summary
public PointerBuffer layers()

a pointer to an array of XrCompositionLayerBaseHeader pointers.

Annotations
@Nullable
@NativeType:XrCompositionLayerBaseHeader const * const *
layersback to summary
public XrFrameEndInfo layers(PointerBuffer value)

Sets the address of the specified PointerBuffer to the layers field.

mallocback to summary
public static XrFrameEndInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFrameEndInfo malloc(MemoryStack stack)

Returns a new XrFrameEndInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndisplayTimeback to summary
public static long ndisplayTime(long struct)

Unsafe version of displayTime.

ndisplayTimeback to summary
public static void ndisplayTime(long struct, long value)

Unsafe version of displayTime.

nenvironmentBlendModeback to summary
public static int nenvironmentBlendMode(long struct)

Unsafe version of environmentBlendMode.

nenvironmentBlendModeback to summary
public static void nenvironmentBlendMode(long struct, int value)

Unsafe version of environmentBlendMode.

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.

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

Sets the specified value to the next field.

nextback to summary
public XrFrameEndInfo next(XrFrameEndInfoML value)

Prepends the specified XrFrameEndInfoML value to the next chain.

nextback to summary
public XrFrameEndInfo next(XrGlobalDimmerFrameEndInfoML value)

Prepends the specified XrGlobalDimmerFrameEndInfoML value to the next chain.

nextback to summary
public XrFrameEndInfo next(XrLocalDimmingFrameEndInfoMETA value)

Prepends the specified XrLocalDimmingFrameEndInfoMETA value to the next chain.

nextback to summary
public XrFrameEndInfo next(XrSecondaryViewConfigurationFrameEndInfoMSFT value)

Prepends the specified XrSecondaryViewConfigurationFrameEndInfoMSFT value to the next chain.

nlayerCountback to summary
public static int nlayerCount(long struct)

Unsafe version of layerCount.

nlayerCountback to summary
public static void nlayerCount(long struct, int value)

Sets the specified value to the layerCount field of the specified struct.

nlayersback to summary
public static PointerBuffer nlayers(long struct)

Unsafe version of layers.

Annotations
@Nullable
nlayersback to summary
public static void nlayers(long struct, PointerBuffer value)

Unsafe version of layers.

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 XrFrameEndInfo set(int type, long next, long displayTime, int environmentBlendMode, int layerCount, PointerBuffer layers)

Initializes this struct with the specified values.

setback to summary
public XrFrameEndInfo set(XrFrameEndInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrFrameEndInfo

the source struct

Returns:XrFrameEndInfo

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

Sets the specified value to the type field.

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

Sets the TYPE_FRAME_END_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrFrameEndInfo.Buffer

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

An array of XrFrameEndInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrFrameEndInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the XrFrameEndInfo#displayTime field.
displayTime
()

public XrFrameEndInfo.Buffer
displayTime(long value)

Sets the specified value to the XrFrameEndInfo#displayTime field.

public int
public XrFrameEndInfo.Buffer
environmentBlendMode(int value)

Sets the specified value to the XrFrameEndInfo#environmentBlendMode field.

protected XrFrameEndInfo
public int

Returns:

the value of the XrFrameEndInfo#layerCount field.
layerCount
()

public XrFrameEndInfo.Buffer
layerCount(int value)

Sets the specified value to the XrFrameEndInfo#layerCount field.

public PointerBuffer

Returns:

a PointerBuffer view of the data pointed to by the XrFrameEndInfo#layers field.
layers
()

public XrFrameEndInfo.Buffer
layers(PointerBuffer value)

Sets the address of the specified PointerBuffer to the XrFrameEndInfo#layers field.

public long

Returns:

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

public XrFrameEndInfo.Buffer
next(long value)

Sets the specified value to the XrFrameEndInfo#next field.

public XrFrameEndInfo.Buffer
next(XrFrameEndInfoML value)

Prepends the specified XrFrameEndInfoML value to the next chain.

public XrFrameEndInfo.Buffer
next(XrGlobalDimmerFrameEndInfoML value)

Prepends the specified XrGlobalDimmerFrameEndInfoML value to the next chain.

public XrFrameEndInfo.Buffer
next(XrLocalDimmingFrameEndInfoMETA value)

Prepends the specified XrLocalDimmingFrameEndInfoMETA value to the next chain.

public XrFrameEndInfo.Buffer
protected XrFrameEndInfo.Buffer
public int

Returns:

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

public XrFrameEndInfo.Buffer
type(int value)

Sets the specified value to the XrFrameEndInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFrameEndInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

displayTimeback to summary
public long displayTime()
Returns:long

the value of the XrFrameEndInfo#displayTime field.

Annotations
@NativeType:XrTime
displayTimeback to summary
public XrFrameEndInfo.Buffer displayTime(long value)

Sets the specified value to the XrFrameEndInfo#displayTime field.

environmentBlendModeback to summary
public int environmentBlendMode()
Returns:int

the value of the XrFrameEndInfo#environmentBlendMode field.

Annotations
@NativeType:XrEnvironmentBlendMode
environmentBlendModeback to summary
public XrFrameEndInfo.Buffer environmentBlendMode(int value)

Sets the specified value to the XrFrameEndInfo#environmentBlendMode field.

getElementFactoryback to summary
protected XrFrameEndInfo getElementFactory()

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

Annotations
@Override
layerCountback to summary
public int layerCount()
Returns:int

the value of the XrFrameEndInfo#layerCount field.

Annotations
@NativeType:uint32_t
layerCountback to summary
public XrFrameEndInfo.Buffer layerCount(int value)

Sets the specified value to the XrFrameEndInfo#layerCount field.

layersback to summary
public PointerBuffer layers()
Returns:PointerBuffer

a PointerBuffer view of the data pointed to by the XrFrameEndInfo#layers field.

Annotations
@Nullable
@NativeType:XrCompositionLayerBaseHeader const * const *
layersback to summary
public XrFrameEndInfo.Buffer layers(PointerBuffer value)

Sets the address of the specified PointerBuffer to the XrFrameEndInfo#layers field.

nextback to summary
public long next()
Returns:long

the value of the XrFrameEndInfo#next field.

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

Sets the specified value to the XrFrameEndInfo#next field.

nextback to summary
public XrFrameEndInfo.Buffer next(XrFrameEndInfoML value)

Prepends the specified XrFrameEndInfoML value to the next chain.

nextback to summary
public XrFrameEndInfo.Buffer next(XrGlobalDimmerFrameEndInfoML value)

Prepends the specified XrGlobalDimmerFrameEndInfoML value to the next chain.

nextback to summary
public XrFrameEndInfo.Buffer next(XrLocalDimmingFrameEndInfoMETA value)

Prepends the specified XrLocalDimmingFrameEndInfoMETA value to the next chain.

nextback to summary
public XrFrameEndInfo.Buffer next(XrSecondaryViewConfigurationFrameEndInfoMSFT value)

Prepends the specified XrSecondaryViewConfigurationFrameEndInfoMSFT value to the next chain.

selfback to summary
protected XrFrameEndInfo.Buffer self()

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

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

the value of the XrFrameEndInfo#type field.

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

Sets the specified value to the XrFrameEndInfo#type field.

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

Sets the TYPE_FRAME_END_INFO value to the XrFrameEndInfo#type field.