Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrVirtualKeyboardSpaceCreateInfoMETA

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

Virtual keyboard space creation info.
Description

If locationType is set to VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META, the runtime must use the value poseInSpace set by the application. Otherwise, the runtime must provide a default pose and ignore poseInSpace. In all cases, the runtime must default the scale to 1.0.

Valid Usage (Implicit)
See Also

XrPosef, CreateVirtualKeyboardSpaceMETA

Layout


struct XrVirtualKeyboardSpaceCreateInfoMETA {
    XrStructureType type;
    void const * next;
    XrVirtualKeyboardLocationTypeMETA locationType;
    XrSpace space;
    XrPosef poseInSpace;
}

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
LOCATIONTYPE

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
POSEINSPACE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPACE

The struct member offsets.

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
public
XrVirtualKeyboardSpaceCreateInfoMETA(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrVirtualKeyboardSpaceCreateInfoMETA
calloc()

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated with memCalloc.

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated with BufferUtils.

public static XrVirtualKeyboardSpaceCreateInfoMETA
create(long address)

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance for the specified memory address.

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance allocated with BufferUtils.

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

Create a XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance at the specified memory.

public static XrVirtualKeyboardSpaceCreateInfoMETA
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
locationType()

an XrVirtualKeyboardLocationTypeMETA enum providing the location type.

public XrVirtualKeyboardSpaceCreateInfoMETA
locationType(int value)

Sets the specified value to the locationType field.

public static XrVirtualKeyboardSpaceCreateInfoMETA
malloc()

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated with memAlloc.

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance allocated with memAlloc.

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrVirtualKeyboardSpaceCreateInfoMETA
next(long value)

Sets the specified value to the next field.

public static int
nlocationType(long struct)

Unsafe version of locationType.

public static void
nlocationType(long struct, int value)

Unsafe version of locationType.

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
nposeInSpace(long struct)

Unsafe version of poseInSpace.

public static void
nposeInSpace(long struct, XrPosef value)

Unsafe version of poseInSpace.

public static long
nspace(long struct)

Unsafe version of space.

public static void
nspace(long struct, XrSpace value)

Unsafe version of space.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPosef
poseInSpace()

the desired pose if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.

public XrVirtualKeyboardSpaceCreateInfoMETA
poseInSpace(XrPosef value)

Copies the specified XrPosef to the poseInSpace field.

public XrVirtualKeyboardSpaceCreateInfoMETA
poseInSpace(Consumer<XrPosef> consumer)

Passes the poseInSpace field to the specified Consumer.

public XrVirtualKeyboardSpaceCreateInfoMETA
set(int type, long next, int locationType, XrSpace space, XrPosef poseInSpace)

Initializes this struct with the specified values.

public XrVirtualKeyboardSpaceCreateInfoMETA

Returns:

this struct
set
(XrVirtualKeyboardSpaceCreateInfoMETA
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 long
space()

an XrSpace previously created by a function such as CreateReferenceSpace.

public XrVirtualKeyboardSpaceCreateInfoMETA
space(XrSpace value)

Sets the specified value to the space field.

public int
type()

the XrStructureType of this structure.

public XrVirtualKeyboardSpaceCreateInfoMETA
type(int value)

Sets the specified value to the type field.

public XrVirtualKeyboardSpaceCreateInfoMETA
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

LOCATIONTYPEback to summary
public static final int LOCATIONTYPE

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

POSEINSPACEback to summary
public static final int POSEINSPACE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPACEback to summary
public static final int SPACE

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrVirtualKeyboardSpaceCreateInfoMETAback to summary
protected XrVirtualKeyboardSpaceCreateInfoMETA(long address, ByteBuffer container)
XrVirtualKeyboardSpaceCreateInfoMETAback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrVirtualKeyboardSpaceCreateInfoMETA calloc(MemoryStack stack)

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

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated with BufferUtils.

createback to summary
public static XrVirtualKeyboardSpaceCreateInfoMETA create(long address)

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance for the specified memory address.

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrVirtualKeyboardSpaceCreateInfoMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrVirtualKeyboardSpaceCreateInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
locationTypeback to summary
public int locationType()

an XrVirtualKeyboardLocationTypeMETA enum providing the location type.

Annotations
@NativeType:XrVirtualKeyboardLocationTypeMETA
locationTypeback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA locationType(int value)

Sets the specified value to the locationType field.

mallocback to summary
public static XrVirtualKeyboardSpaceCreateInfoMETA malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrVirtualKeyboardSpaceCreateInfoMETA malloc(MemoryStack stack)

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrVirtualKeyboardSpaceCreateInfoMETA.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 or this extension.

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

Sets the specified value to the next field.

nlocationTypeback to summary
public static int nlocationType(long struct)

Unsafe version of locationType.

nlocationTypeback to summary
public static void nlocationType(long struct, int value)

Unsafe version of locationType.

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.

nposeInSpaceback to summary
public static XrPosef nposeInSpace(long struct)

Unsafe version of poseInSpace.

nposeInSpaceback to summary
public static void nposeInSpace(long struct, XrPosef value)

Unsafe version of poseInSpace.

nspaceback to summary
public static long nspace(long struct)

Unsafe version of space.

nspaceback to summary
public static void nspace(long struct, XrSpace value)

Unsafe version of space.

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.

poseInSpaceback to summary
public XrPosef poseInSpace()

the desired pose if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.

poseInSpaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA poseInSpace(XrPosef value)

Copies the specified XrPosef to the poseInSpace field.

poseInSpaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA poseInSpace(Consumer<XrPosef> consumer)

Passes the poseInSpace field to the specified Consumer.

setback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA set(int type, long next, int locationType, XrSpace space, XrPosef poseInSpace)

Initializes this struct with the specified values.

setback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA set(XrVirtualKeyboardSpaceCreateInfoMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrVirtualKeyboardSpaceCreateInfoMETA

the source struct

Returns:XrVirtualKeyboardSpaceCreateInfoMETA

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
spaceback to summary
public long space()

an XrSpace previously created by a function such as CreateReferenceSpace.

Annotations
@NativeType:XrSpace
spaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA space(XrSpace value)

Sets the specified value to the space field.

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_META value to the type field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrVirtualKeyboardSpaceCreateInfoMETA.Buffer

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

An array of XrVirtualKeyboardSpaceCreateInfoMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrVirtualKeyboardSpaceCreateInfoMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrVirtualKeyboardSpaceCreateInfoMETA.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 XrVirtualKeyboardSpaceCreateInfoMETA
public int
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
locationType(int value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#locationType field.

public long

Returns:

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

public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
next(long value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#next field.

public XrPosef
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
protected XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
public long

Returns:

the value of the XrVirtualKeyboardSpaceCreateInfoMETA#space field.
space
()

public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
space(XrSpace value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#space field.

public int

Returns:

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

public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer
type(int value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrVirtualKeyboardSpaceCreateInfoMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
locationTypeback to summary
public int locationType()
Returns:int

the value of the XrVirtualKeyboardSpaceCreateInfoMETA#locationType field.

Annotations
@NativeType:XrVirtualKeyboardLocationTypeMETA
locationTypeback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer locationType(int value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#locationType field.

nextback to summary
public long next()
Returns:long

the value of the XrVirtualKeyboardSpaceCreateInfoMETA#next field.

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

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#next field.

poseInSpaceback to summary
public XrPosef poseInSpace()
Returns:XrPosef

a XrPosef view of the XrVirtualKeyboardSpaceCreateInfoMETA#poseInSpace field.

poseInSpaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer poseInSpace(XrPosef value)

Copies the specified XrPosef to the XrVirtualKeyboardSpaceCreateInfoMETA#poseInSpace field.

poseInSpaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer poseInSpace(Consumer<XrPosef> consumer)

Passes the XrVirtualKeyboardSpaceCreateInfoMETA#poseInSpace field to the specified Consumer.

selfback to summary
protected XrVirtualKeyboardSpaceCreateInfoMETA.Buffer self()

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

Annotations
@Override
spaceback to summary
public long space()
Returns:long

the value of the XrVirtualKeyboardSpaceCreateInfoMETA#space field.

Annotations
@NativeType:XrSpace
spaceback to summary
public XrVirtualKeyboardSpaceCreateInfoMETA.Buffer space(XrSpace value)

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#space field.

typeback to summary
public int type()
Returns:int

the value of the XrVirtualKeyboardSpaceCreateInfoMETA#type field.

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

Sets the specified value to the XrVirtualKeyboardSpaceCreateInfoMETA#type field.

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

Sets the TYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_META value to the XrVirtualKeyboardSpaceCreateInfoMETA#type field.