Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrView

extends Struct<XrView>
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 view projection state.
Description

The XrView structure contains view pose and projection state necessary to render a single projection view in the view configuration.

Valid Usage (Implicit)
See Also

XrFovf, XrPosef, XrViewLocateInfo, XrViewState, LocateViews

Layout


struct XrView {
    XrStructureType type;
    void * next;
    XrPosef pose;
    XrFovf fov;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrView.Buffer

An array of XrView structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FOV

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
POSE

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

public
XrView(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrView
calloc()

Returns a new XrView instance allocated with memCalloc.

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

Returns a new XrView.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrView instance allocated with BufferUtils.

public static XrView
create(long address)

Returns a new XrView instance for the specified memory address.

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

Returns a new XrView.Buffer instance allocated with BufferUtils.

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

Create a XrView.Buffer instance at the specified memory.

public static XrView
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrFovf
fov()

the XrFovf for the four sides of the projection.

public XrView
fov(XrFovf value)

Copies the specified XrFovf to the fov field.

public XrView
fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

public static XrView
malloc()

Returns a new XrView instance allocated with memAlloc.

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

Returns a new XrView.Buffer instance allocated with memAlloc.

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

Returns a new XrView instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrView
next(long value)

Sets the specified value to the next field.

public static XrFovf
nfov(long struct)

Unsafe version of fov.

public static void
nfov(long struct, XrFovf value)

Unsafe version of fov.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static XrPosef
npose(long struct)

Unsafe version of pose.

public static void
npose(long struct, XrPosef value)

Unsafe version of pose.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPosef
pose()

an XrPosef defining the location and orientation of the view in the space specified by the LocateViews function.

public XrView
pose(XrPosef value)

Copies the specified XrPosef to the pose field.

public XrView
pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

public XrView
set(int type, long next, XrPosef pose, XrFovf fov)

Initializes this struct with the specified values.

public XrView

Returns:

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

Sets the specified value to the type field.

public XrView
type$Default()

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

FOVback to summary
public static final int FOV

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

POSEback to summary
public static final int POSE

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

XrViewback to summary
protected XrView(long address, ByteBuffer container)
XrViewback to summary
public XrView(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrView calloc(MemoryStack stack)

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

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

Returns a new XrView instance allocated with BufferUtils.

createback to summary
public static XrView create(long address)

Returns a new XrView instance for the specified memory address.

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

Returns a new XrView.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrView.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrView createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
fovback to summary
public XrFovf fov()

the XrFovf for the four sides of the projection.

fovback to summary
public XrView fov(XrFovf value)

Copies the specified XrFovf to the fov field.

fovback to summary
public XrView fov(Consumer<XrFovf> consumer)

Passes the fov field to the specified Consumer.

mallocback to summary
public static XrView malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrView malloc(MemoryStack stack)

Returns a new XrView instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrView.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 XrView next(long value)

Sets the specified value to the next field.

nfovback to summary
public static XrFovf nfov(long struct)

Unsafe version of fov.

nfovback to summary
public static void nfov(long struct, XrFovf value)

Unsafe version of fov.

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.

nposeback to summary
public static XrPosef npose(long struct)

Unsafe version of pose.

nposeback to summary
public static void npose(long struct, XrPosef value)

Unsafe version of pose.

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.

poseback to summary
public XrPosef pose()

an XrPosef defining the location and orientation of the view in the space specified by the LocateViews function.

poseback to summary
public XrView pose(XrPosef value)

Copies the specified XrPosef to the pose field.

poseback to summary
public XrView pose(Consumer<XrPosef> consumer)

Passes the pose field to the specified Consumer.

setback to summary
public XrView set(int type, long next, XrPosef pose, XrFovf fov)

Initializes this struct with the specified values.

setback to summary
public XrView set(XrView src)

Copies the specified struct data to this struct.

Parameters
src:XrView

the source struct

Returns:XrView

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

Sets the specified value to the type field.

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

Sets the TYPE_VIEW value to the type field.

org.lwjgl.openxr back to summary

public Class XrView.Buffer

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

An array of XrView structs.

Field Summary

Modifier and TypeField and Description
private static final XrView

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a XrFovf view of the XrView#fov field.
fov
()

public XrView.Buffer
fov(XrFovf value)

Copies the specified XrFovf to the XrView#fov field.

public XrView.Buffer
fov(Consumer<XrFovf> consumer)

Passes the XrView#fov field to the specified Consumer.

protected XrView
public long

Returns:

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

public XrView.Buffer
next(long value)

Sets the specified value to the XrView#next field.

public XrPosef

Returns:

a XrPosef view of the XrView#pose field.
pose
()

public XrView.Buffer
pose(XrPosef value)

Copies the specified XrPosef to the XrView#pose field.

public XrView.Buffer
pose(Consumer<XrPosef> consumer)

Passes the XrView#pose field to the specified Consumer.

protected XrView.Buffer
public int

Returns:

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

public XrView.Buffer
type(int value)

Sets the specified value to the XrView#type field.

public XrView.Buffer
type$Default()

Sets the TYPE_VIEW value to the XrView#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrView ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

fovback to summary
public XrFovf fov()
Returns:XrFovf

a XrFovf view of the XrView#fov field.

fovback to summary
public XrView.Buffer fov(XrFovf value)

Copies the specified XrFovf to the XrView#fov field.

fovback to summary
public XrView.Buffer fov(Consumer<XrFovf> consumer)

Passes the XrView#fov field to the specified Consumer.

getElementFactoryback to summary
protected XrView getElementFactory()

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

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

the value of the XrView#next field.

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

Sets the specified value to the XrView#next field.

poseback to summary
public XrPosef pose()
Returns:XrPosef

a XrPosef view of the XrView#pose field.

poseback to summary
public XrView.Buffer pose(XrPosef value)

Copies the specified XrPosef to the XrView#pose field.

poseback to summary
public XrView.Buffer pose(Consumer<XrPosef> consumer)

Passes the XrView#pose field to the specified Consumer.

selfback to summary
protected XrView.Buffer self()

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

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

the value of the XrView#type field.

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

Sets the specified value to the XrView#type field.

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

Sets the TYPE_VIEW value to the XrView#type field.