Package org.lwjgl.openxr

Class XrVirtualKeyboardInputInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVirtualKeyboardInputInfoMETA>

org.lwjgl.openxr.XrVirtualKeyboardInputInfoMETA

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrVirtualKeyboardInputInfoMETA
extends org.lwjgl.system.Struct<XrVirtualKeyboardInputInfoMETA>
implements org.lwjgl.system.NativeResource

Virtual keyboard input info.

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrVirtualKeyboardInputInfoMETA
• type must be TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• inputSource must be a valid XrVirtualKeyboardInputSourceMETA value
• If inputSpace is not NULL_HANDLE, inputSpace must be a valid XrSpace handle
• inputState must be 0 or a valid combination of XrVirtualKeyboardInputStateFlagBitsMETA values

See Also

XrPosef, SendVirtualKeyboardInputMETA

Layout

 struct XrVirtualKeyboardInputInfoMETA {
     XrStructureType type();
     void const * next();
     XrVirtualKeyboardInputSourceMETA inputSource();
     XrSpace inputSpace();
     XrPosef inputPoseInSpace();
     XrVirtualKeyboardInputStateFlagsMETA inputState();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVirtualKeyboardInputInfoMETA.Buffer	An array of XrVirtualKeyboardInputInfoMETA structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	INPUTPOSEINSPACE	The struct member offsets.
static final int	INPUTSOURCE	The struct member offsets.
static final int	INPUTSPACE	The struct member offsets.
static final int	INPUTSTATE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrVirtualKeyboardInputInfoMETA(ByteBuffer container)	Creates a XrVirtualKeyboardInputInfoMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrVirtualKeyboardInputInfoMETA	calloc()	Returns a new XrVirtualKeyboardInputInfoMETA instance allocated with memCalloc.
static XrVirtualKeyboardInputInfoMETA.Buffer	calloc(int capacity)	Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated with memCalloc.
static XrVirtualKeyboardInputInfoMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardInputInfoMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardInputInfoMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardInputInfoMETA	create()	Returns a new XrVirtualKeyboardInputInfoMETA instance allocated with BufferUtils.
static XrVirtualKeyboardInputInfoMETA.Buffer	create(int capacity)	Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated with BufferUtils.
static XrVirtualKeyboardInputInfoMETA	create(long address)	Returns a new XrVirtualKeyboardInputInfoMETA instance for the specified memory address.
static XrVirtualKeyboardInputInfoMETA.Buffer	create(long address, int capacity)	Create a XrVirtualKeyboardInputInfoMETA.Buffer instance at the specified memory.
static @Nullable XrVirtualKeyboardInputInfoMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVirtualKeyboardInputInfoMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
XrPosef	inputPoseInSpace()	an XrPosef defining the position and orientation of the input’s source pose within the natural reference frame of the input space.
XrVirtualKeyboardInputInfoMETA	inputPoseInSpace(Consumer<XrPosef> consumer)	Passes the inputPoseInSpace() field to the specified Consumer.
XrVirtualKeyboardInputInfoMETA	inputPoseInSpace(XrPosef value)	Copies the specified XrPosef to the inputPoseInSpace() field.
int	inputSource()	an enum of XrVirtualKeyboardInputSourceMETA describing the source device and input mode type.
XrVirtualKeyboardInputInfoMETA	inputSource(int value)	Sets the specified value to the inputSource() field.
@org.jspecify.annotations.Nullable long	inputSpace()	an XrSpace previously created by a function such as CreateReferenceSpace.
XrVirtualKeyboardInputInfoMETA	inputSpace(@Nullable XrSpace value)	Sets the specified value to the inputSpace() field.
long	inputState()	a bitmask of XrVirtualKeyboardInputStateFlagsMETA describing the button or pinch state of the inputSource.
XrVirtualKeyboardInputInfoMETA	inputState(long value)	Sets the specified value to the inputState() field.
static XrVirtualKeyboardInputInfoMETA	malloc()	Returns a new XrVirtualKeyboardInputInfoMETA instance allocated with memAlloc.
static XrVirtualKeyboardInputInfoMETA.Buffer	malloc(int capacity)	Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated with memAlloc.
static XrVirtualKeyboardInputInfoMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated on the specified MemoryStack.
static XrVirtualKeyboardInputInfoMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardInputInfoMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVirtualKeyboardInputInfoMETA	next(long value)	Sets the specified value to the next() field.
static XrPosef	ninputPoseInSpace(long struct)	Unsafe version of inputPoseInSpace().
static void	ninputPoseInSpace(long struct, XrPosef value)	Unsafe version of inputPoseInSpace.
static int	ninputSource(long struct)	Unsafe version of inputSource().
static void	ninputSource(long struct, int value)	Unsafe version of inputSource.
static long	ninputSpace(long struct)	Unsafe version of inputSpace().
static void	ninputSpace(long struct, @Nullable XrSpace value)	Unsafe version of inputSpace.
static long	ninputState(long struct)	Unsafe version of inputState().
static void	ninputState(long struct, long value)	Unsafe version of inputState.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrVirtualKeyboardInputInfoMETA	set(int type, long next, int inputSource, XrSpace inputSpace, XrPosef inputPoseInSpace, long inputState)	Initializes this struct with the specified values.
XrVirtualKeyboardInputInfoMETA	set(XrVirtualKeyboardInputInfoMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrVirtualKeyboardInputInfoMETA	type(int value)	Sets the specified value to the type() field.
XrVirtualKeyboardInputInfoMETA	type$Default()	Sets the TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_META value to the type() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

INPUTSOURCE

public static final int INPUTSOURCE

The struct member offsets.

INPUTSPACE

public static final int INPUTSPACE

The struct member offsets.

INPUTPOSEINSPACE

public static final int INPUTPOSEINSPACE

The struct member offsets.

INPUTSTATE

public static final int INPUTSTATE

The struct member offsets.

Constructor Details

XrVirtualKeyboardInputInfoMETA

public XrVirtualKeyboardInputInfoMETA(ByteBuffer container)

Creates a XrVirtualKeyboardInputInfoMETA 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrVirtualKeyboardInputInfoMETA>

type

public int type()

the XrStructureType of this structure.

next

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.

inputSource

public int inputSource()

an enum of XrVirtualKeyboardInputSourceMETA describing the source device and input mode type.

inputSpace

public @org.jspecify.annotations.Nullable long inputSpace()

an XrSpace previously created by a function such as CreateReferenceSpace.

inputPoseInSpace

public XrPosef inputPoseInSpace()

an XrPosef defining the position and orientation of the input’s source pose within the natural reference frame of the input space.

inputState

public long inputState()

a bitmask of XrVirtualKeyboardInputStateFlagsMETA describing the button or pinch state of the inputSource.

type

public XrVirtualKeyboardInputInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrVirtualKeyboardInputInfoMETA type$Default()

Sets the TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_META value to the type() field.

next

public XrVirtualKeyboardInputInfoMETA next(long value)

Sets the specified value to the next() field.

inputSource

public XrVirtualKeyboardInputInfoMETA inputSource(int value)

Sets the specified value to the inputSource() field.

inputSpace

public XrVirtualKeyboardInputInfoMETA inputSpace(@Nullable XrSpace value)

Sets the specified value to the inputSpace() field.

inputPoseInSpace

public XrVirtualKeyboardInputInfoMETA inputPoseInSpace(XrPosef value)

Copies the specified XrPosef to the inputPoseInSpace() field.

inputPoseInSpace

public XrVirtualKeyboardInputInfoMETA inputPoseInSpace(Consumer<XrPosef> consumer)

Passes the inputPoseInSpace() field to the specified Consumer.

inputState

public XrVirtualKeyboardInputInfoMETA inputState(long value)

Sets the specified value to the inputState() field.

set

public XrVirtualKeyboardInputInfoMETA set(int type,
 long next,
 int inputSource,
 XrSpace inputSpace,
 XrPosef inputPoseInSpace,
 long inputState)

Initializes this struct with the specified values.

set

public XrVirtualKeyboardInputInfoMETA set(XrVirtualKeyboardInputInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVirtualKeyboardInputInfoMETA malloc()

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

calloc

public static XrVirtualKeyboardInputInfoMETA calloc()

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

create

public static XrVirtualKeyboardInputInfoMETA create()

Returns a new XrVirtualKeyboardInputInfoMETA instance allocated with BufferUtils.

create

public static XrVirtualKeyboardInputInfoMETA create(long address)

Returns a new XrVirtualKeyboardInputInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrVirtualKeyboardInputInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVirtualKeyboardInputInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVirtualKeyboardInputInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVirtualKeyboardInputInfoMETA.Buffer create(int capacity)

Returns a new XrVirtualKeyboardInputInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrVirtualKeyboardInputInfoMETA.Buffer create(long address,
 int capacity)

Create a XrVirtualKeyboardInputInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrVirtualKeyboardInputInfoMETA.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static XrVirtualKeyboardInputInfoMETA malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrVirtualKeyboardInputInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrVirtualKeyboardInputInfoMETA calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrVirtualKeyboardInputInfoMETA.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrVirtualKeyboardInputInfoMETA.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

ninputSource

public static int ninputSource(long struct)

Unsafe version of inputSource().

ninputSpace

public static long ninputSpace(long struct)

Unsafe version of inputSpace().

ninputPoseInSpace

public static XrPosef ninputPoseInSpace(long struct)

Unsafe version of inputPoseInSpace().

ninputState

public static long ninputState(long struct)

Unsafe version of inputState().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

ninputSource

public static void ninputSource(long struct,
 int value)

Unsafe version of inputSource.

ninputSpace

public static void ninputSpace(long struct,
 @Nullable XrSpace value)

Unsafe version of inputSpace.

ninputPoseInSpace

public static void ninputPoseInSpace(long struct,
 XrPosef value)

Unsafe version of inputPoseInSpace.

ninputState

public static void ninputState(long struct,
 long value)

Unsafe version of inputState.