Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrReferenceSpaceCreateInfo

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

Creation info for a reference space.
Valid Usage (Implicit)
See Also

XrPosef, CreateReferenceSpace

Layout


struct XrReferenceSpaceCreateInfo {
    XrStructureType type;
    void const * next;
    XrReferenceSpaceType referenceSpaceType;
    XrPosef poseInReferenceSpace;
}

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
POSEINREFERENCESPACE

The struct member offsets.

public static final int
REFERENCESPACETYPE

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

public
XrReferenceSpaceCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrReferenceSpaceCreateInfo
calloc()

Returns a new XrReferenceSpaceCreateInfo instance allocated with memCalloc.

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

Returns a new XrReferenceSpaceCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrReferenceSpaceCreateInfo instance allocated with BufferUtils.

public static XrReferenceSpaceCreateInfo
create(long address)

Returns a new XrReferenceSpaceCreateInfo instance for the specified memory address.

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

Returns a new XrReferenceSpaceCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a XrReferenceSpaceCreateInfo.Buffer instance at the specified memory.

public static XrReferenceSpaceCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrReferenceSpaceCreateInfo
malloc()

Returns a new XrReferenceSpaceCreateInfo instance allocated with memAlloc.

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

Returns a new XrReferenceSpaceCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrReferenceSpaceCreateInfo instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrReferenceSpaceCreateInfo
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 XrPosef
nposeInReferenceSpace(long struct)

Unsafe version of poseInReferenceSpace.

public static void
nposeInReferenceSpace(long struct, XrPosef value)

Unsafe version of poseInReferenceSpace.

public static int
nreferenceSpaceType(long struct)

Unsafe version of referenceSpaceType.

public static void
nreferenceSpaceType(long struct, int value)

Unsafe version of referenceSpaceType.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPosef
poseInReferenceSpace()

an XrPosef defining the position and orientation of the new space’s origin within the natural reference frame of the reference space.

public XrReferenceSpaceCreateInfo
poseInReferenceSpace(XrPosef value)

Copies the specified XrPosef to the poseInReferenceSpace field.

public XrReferenceSpaceCreateInfo
poseInReferenceSpace(Consumer<XrPosef> consumer)

Passes the poseInReferenceSpace field to the specified Consumer.

public int
referenceSpaceType()

the chosen XrReferenceSpaceType.

public XrReferenceSpaceCreateInfo
referenceSpaceType(int value)

Sets the specified value to the referenceSpaceType field.

public XrReferenceSpaceCreateInfo
set(int type, long next, int referenceSpaceType, XrPosef poseInReferenceSpace)

Initializes this struct with the specified values.

public XrReferenceSpaceCreateInfo

Returns:

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

Sets the specified value to the type field.

public XrReferenceSpaceCreateInfo
type$Default()

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

POSEINREFERENCESPACEback to summary
public static final int POSEINREFERENCESPACE

The struct member offsets.

REFERENCESPACETYPEback to summary
public static final int REFERENCESPACETYPE

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

XrReferenceSpaceCreateInfoback to summary
protected XrReferenceSpaceCreateInfo(long address, ByteBuffer container)
XrReferenceSpaceCreateInfoback to summary
public XrReferenceSpaceCreateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrReferenceSpaceCreateInfo calloc(MemoryStack stack)

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

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

Returns a new XrReferenceSpaceCreateInfo instance allocated with BufferUtils.

createback to summary
public static XrReferenceSpaceCreateInfo create(long address)

Returns a new XrReferenceSpaceCreateInfo instance for the specified memory address.

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

Returns a new XrReferenceSpaceCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrReferenceSpaceCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrReferenceSpaceCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrReferenceSpaceCreateInfo malloc(MemoryStack stack)

Returns a new XrReferenceSpaceCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrReferenceSpaceCreateInfo.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 XrReferenceSpaceCreateInfo 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.

nposeInReferenceSpaceback to summary
public static XrPosef nposeInReferenceSpace(long struct)

Unsafe version of poseInReferenceSpace.

nposeInReferenceSpaceback to summary
public static void nposeInReferenceSpace(long struct, XrPosef value)

Unsafe version of poseInReferenceSpace.

nreferenceSpaceTypeback to summary
public static int nreferenceSpaceType(long struct)

Unsafe version of referenceSpaceType.

nreferenceSpaceTypeback to summary
public static void nreferenceSpaceType(long struct, int value)

Unsafe version of referenceSpaceType.

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.

poseInReferenceSpaceback to summary
public XrPosef poseInReferenceSpace()

an XrPosef defining the position and orientation of the new space’s origin within the natural reference frame of the reference space.

poseInReferenceSpaceback to summary
public XrReferenceSpaceCreateInfo poseInReferenceSpace(XrPosef value)

Copies the specified XrPosef to the poseInReferenceSpace field.

poseInReferenceSpaceback to summary
public XrReferenceSpaceCreateInfo poseInReferenceSpace(Consumer<XrPosef> consumer)

Passes the poseInReferenceSpace field to the specified Consumer.

referenceSpaceTypeback to summary
public int referenceSpaceType()

the chosen XrReferenceSpaceType.

Annotations
@NativeType:XrReferenceSpaceType
referenceSpaceTypeback to summary
public XrReferenceSpaceCreateInfo referenceSpaceType(int value)

Sets the specified value to the referenceSpaceType field.

setback to summary
public XrReferenceSpaceCreateInfo set(int type, long next, int referenceSpaceType, XrPosef poseInReferenceSpace)

Initializes this struct with the specified values.

setback to summary
public XrReferenceSpaceCreateInfo set(XrReferenceSpaceCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrReferenceSpaceCreateInfo

the source struct

Returns:XrReferenceSpaceCreateInfo

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

Sets the specified value to the type field.

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

Sets the TYPE_REFERENCE_SPACE_CREATE_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrReferenceSpaceCreateInfo.Buffer

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

An array of XrReferenceSpaceCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrReferenceSpaceCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrReferenceSpaceCreateInfo.Buffer
next(long value)

Sets the specified value to the XrReferenceSpaceCreateInfo#next field.

public XrPosef
public XrReferenceSpaceCreateInfo.Buffer
public XrReferenceSpaceCreateInfo.Buffer
public int
public XrReferenceSpaceCreateInfo.Buffer
referenceSpaceType(int value)

Sets the specified value to the XrReferenceSpaceCreateInfo#referenceSpaceType field.

protected XrReferenceSpaceCreateInfo.Buffer
public int

Returns:

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

public XrReferenceSpaceCreateInfo.Buffer
type(int value)

Sets the specified value to the XrReferenceSpaceCreateInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrReferenceSpaceCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the XrReferenceSpaceCreateInfo#next field.

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

Sets the specified value to the XrReferenceSpaceCreateInfo#next field.

poseInReferenceSpaceback to summary
public XrPosef poseInReferenceSpace()
Returns:XrPosef

a XrPosef view of the XrReferenceSpaceCreateInfo#poseInReferenceSpace field.

poseInReferenceSpaceback to summary
public XrReferenceSpaceCreateInfo.Buffer poseInReferenceSpace(XrPosef value)

Copies the specified XrPosef to the XrReferenceSpaceCreateInfo#poseInReferenceSpace field.

poseInReferenceSpaceback to summary
public XrReferenceSpaceCreateInfo.Buffer poseInReferenceSpace(Consumer<XrPosef> consumer)

Passes the XrReferenceSpaceCreateInfo#poseInReferenceSpace field to the specified Consumer.

referenceSpaceTypeback to summary
public int referenceSpaceType()
Returns:int

the value of the XrReferenceSpaceCreateInfo#referenceSpaceType field.

Annotations
@NativeType:XrReferenceSpaceType
referenceSpaceTypeback to summary
public XrReferenceSpaceCreateInfo.Buffer referenceSpaceType(int value)

Sets the specified value to the XrReferenceSpaceCreateInfo#referenceSpaceType field.

selfback to summary
protected XrReferenceSpaceCreateInfo.Buffer self()

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

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

the value of the XrReferenceSpaceCreateInfo#type field.

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

Sets the specified value to the XrReferenceSpaceCreateInfo#type field.

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

Sets the TYPE_REFERENCE_SPACE_CREATE_INFO value to the XrReferenceSpaceCreateInfo#type field.