Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrViewState

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

Struct containing additional view state.
Description

The XrViewState contains additional view state from LocateViews common to all views of the active view configuration.

Valid Usage (Implicit)
See Also

XrView, LocateViews

Layout


struct XrViewState {
    XrStructureType type;
    void * next;
    XrViewStateFlags viewStateFlags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrViewState.Buffer

An array of XrViewState structs.

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.

public static final int
VIEWSTATEFLAGS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrViewState(long address, ByteBuffer container)

public
XrViewState(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrViewState
calloc()

Returns a new XrViewState instance allocated with memCalloc.

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

Returns a new XrViewState.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrViewState instance allocated with BufferUtils.

public static XrViewState
create(long address)

Returns a new XrViewState instance for the specified memory address.

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

Returns a new XrViewState.Buffer instance allocated with BufferUtils.

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

Create a XrViewState.Buffer instance at the specified memory.

public static XrViewState
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrViewState
malloc()

Returns a new XrViewState instance allocated with memAlloc.

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

Returns a new XrViewState.Buffer instance allocated with memAlloc.

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

Returns a new XrViewState instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrViewState
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 static long
nviewStateFlags(long struct)

Unsafe version of viewStateFlags.

public static void
nviewStateFlags(long struct, long value)

Unsafe version of viewStateFlags.

public XrViewState
set(int type, long next, long viewStateFlags)

Initializes this struct with the specified values.

public XrViewState

Returns:

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

Sets the specified value to the type field.

public XrViewState
type$Default()

Sets the TYPE_VIEW_STATE value to the type field.

public long
viewStateFlags()

a bitmask of XrViewStateFlagBits indicating state for all views.

public XrViewState
viewStateFlags(long value)

Sets the specified value to the viewStateFlags 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.

VIEWSTATEFLAGSback to summary
public static final int VIEWSTATEFLAGS

The struct member offsets.

Constructor Detail

XrViewStateback to summary
protected XrViewState(long address, ByteBuffer container)
XrViewStateback to summary
public XrViewState(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrViewState calloc(MemoryStack stack)

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

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

Returns a new XrViewState instance allocated with BufferUtils.

createback to summary
public static XrViewState create(long address)

Returns a new XrViewState instance for the specified memory address.

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

Returns a new XrViewState.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrViewState.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrViewState createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrViewState malloc(MemoryStack stack)

Returns a new XrViewState instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrViewState.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 *
nextback to summary
public XrViewState 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.

nviewStateFlagsback to summary
public static long nviewStateFlags(long struct)

Unsafe version of viewStateFlags.

nviewStateFlagsback to summary
public static void nviewStateFlags(long struct, long value)

Unsafe version of viewStateFlags.

setback to summary
public XrViewState set(int type, long next, long viewStateFlags)

Initializes this struct with the specified values.

setback to summary
public XrViewState set(XrViewState src)

Copies the specified struct data to this struct.

Parameters
src:XrViewState

the source struct

Returns:XrViewState

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

Sets the specified value to the type field.

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

Sets the TYPE_VIEW_STATE value to the type field.

viewStateFlagsback to summary
public long viewStateFlags()

a bitmask of XrViewStateFlagBits indicating state for all views.

Annotations
@NativeType:XrViewStateFlags
viewStateFlagsback to summary
public XrViewState viewStateFlags(long value)

Sets the specified value to the viewStateFlags field.

org.lwjgl.openxr back to summary

public Class XrViewState.Buffer

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

An array of XrViewState structs.

Field Summary

Modifier and TypeField and Description
private static final XrViewState

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrViewState.Buffer
next(long value)

Sets the specified value to the XrViewState#next field.

protected XrViewState.Buffer
public int

Returns:

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

public XrViewState.Buffer
type(int value)

Sets the specified value to the XrViewState#type field.

public XrViewState.Buffer
type$Default()

Sets the TYPE_VIEW_STATE value to the XrViewState#type field.

public long

Returns:

the value of the XrViewState#viewStateFlags field.
viewStateFlags
()

public XrViewState.Buffer
viewStateFlags(long value)

Sets the specified value to the XrViewState#viewStateFlags field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrViewState ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrViewState.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 XrViewState#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 XrViewState getElementFactory()

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

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

the value of the XrViewState#next field.

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

Sets the specified value to the XrViewState#next field.

selfback to summary
protected XrViewState.Buffer self()

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

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

the value of the XrViewState#type field.

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

Sets the specified value to the XrViewState#type field.

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

Sets the TYPE_VIEW_STATE value to the XrViewState#type field.

viewStateFlagsback to summary
public long viewStateFlags()
Returns:long

the value of the XrViewState#viewStateFlags field.

Annotations
@NativeType:XrViewStateFlags
viewStateFlagsback to summary
public XrViewState.Buffer viewStateFlags(long value)

Sets the specified value to the XrViewState#viewStateFlags field.