Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrFrameWaitInfo

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

Wait frame information structure.
Description

Because this structure only exists to support extension-specific structures, WaitFrame must accept a NULL argument for frameWaitInfo for applications that are not using any relevant extensions.

Valid Usage (Implicit)
See Also

XrFrameState, WaitFrame

Layout


struct XrFrameWaitInfo {
    XrStructureType type;
    void const * next;
}

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

public
XrFrameWaitInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrFrameWaitInfo
calloc()

Returns a new XrFrameWaitInfo instance allocated with memCalloc.

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

Returns a new XrFrameWaitInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrFrameWaitInfo instance allocated with BufferUtils.

public static XrFrameWaitInfo
create(long address)

Returns a new XrFrameWaitInfo instance for the specified memory address.

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

Returns a new XrFrameWaitInfo.Buffer instance allocated with BufferUtils.

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

Create a XrFrameWaitInfo.Buffer instance at the specified memory.

public static XrFrameWaitInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrFrameWaitInfo
malloc()

Returns a new XrFrameWaitInfo instance allocated with memAlloc.

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

Returns a new XrFrameWaitInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrFrameWaitInfo instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrFrameWaitInfo
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 XrFrameWaitInfo
set(int type, long next)

Initializes this struct with the specified values.

public XrFrameWaitInfo

Returns:

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

Sets the specified value to the type field.

public XrFrameWaitInfo
type$Default()

Sets the TYPE_FRAME_WAIT_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.

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

XrFrameWaitInfoback to summary
protected XrFrameWaitInfo(long address, ByteBuffer container)
XrFrameWaitInfoback to summary
public XrFrameWaitInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrFrameWaitInfo calloc(MemoryStack stack)

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

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

Returns a new XrFrameWaitInfo instance allocated with BufferUtils.

createback to summary
public static XrFrameWaitInfo create(long address)

Returns a new XrFrameWaitInfo instance for the specified memory address.

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

Returns a new XrFrameWaitInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrFrameWaitInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrFrameWaitInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrFrameWaitInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrFrameWaitInfo malloc(MemoryStack stack)

Returns a new XrFrameWaitInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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

Initializes this struct with the specified values.

setback to summary
public XrFrameWaitInfo set(XrFrameWaitInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrFrameWaitInfo

the source struct

Returns:XrFrameWaitInfo

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

Sets the specified value to the type field.

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

Sets the TYPE_FRAME_WAIT_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrFrameWaitInfo.Buffer

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

An array of XrFrameWaitInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrFrameWaitInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrFrameWaitInfo.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
protected XrFrameWaitInfo
public long

Returns:

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

public XrFrameWaitInfo.Buffer
next(long value)

Sets the specified value to the XrFrameWaitInfo#next field.

protected XrFrameWaitInfo.Buffer
public int

Returns:

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

public XrFrameWaitInfo.Buffer
type(int value)

Sets the specified value to the XrFrameWaitInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrFrameWaitInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected XrFrameWaitInfo getElementFactory()

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

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

the value of the XrFrameWaitInfo#next field.

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

Sets the specified value to the XrFrameWaitInfo#next field.

selfback to summary
protected XrFrameWaitInfo.Buffer self()

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

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

the value of the XrFrameWaitInfo#type field.

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

Sets the specified value to the XrFrameWaitInfo#type field.

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

Sets the TYPE_FRAME_WAIT_INFO value to the XrFrameWaitInfo#type field.