Package org.lwjgl.openxr

Class XrEventDataVirtualKeyboardCommitTextMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataVirtualKeyboardCommitTextMETA>

org.lwjgl.openxr.XrEventDataVirtualKeyboardCommitTextMETA

All Implemented Interfaces:

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

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

Commit text event.

Description

The XrEventDataVirtualKeyboardCommitTextMETA event must be sent by the runtime when a character or string is input by the keyboard. The application should append to the text field that the keyboard is editing.

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrEventDataVirtualKeyboardCommitTextMETA
• type must be TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• keyboard must be a valid XrVirtualKeyboardMETA handle
• text must be a null-terminated UTF-8 string whose length is less than or equal to MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META

See Also

PollEvent

Layout

 struct XrEventDataVirtualKeyboardCommitTextMETA {
     XrStructureType type();
     void const * next();
     XrVirtualKeyboardMETA keyboard();
     char text()[XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrEventDataVirtualKeyboardCommitTextMETA.Buffer	An array of XrEventDataVirtualKeyboardCommitTextMETA 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	KEYBOARD	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TEXT	The struct member offsets.
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
XrEventDataVirtualKeyboardCommitTextMETA(ByteBuffer container)	Creates a XrEventDataVirtualKeyboardCommitTextMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrEventDataVirtualKeyboardCommitTextMETA	calloc()	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with memCalloc.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with memCalloc.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataVirtualKeyboardCommitTextMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataVirtualKeyboardCommitTextMETA	create()	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with BufferUtils.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	create(int capacity)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with BufferUtils.
static XrEventDataVirtualKeyboardCommitTextMETA	create(long address)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance for the specified memory address.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	create(long address, int capacity)	Create a XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataVirtualKeyboardCommitTextMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataVirtualKeyboardCommitTextMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	keyboard()	the XrVirtualKeyboardMETA this event belongs to.
XrEventDataVirtualKeyboardCommitTextMETA	keyboard(XrVirtualKeyboardMETA value)	Sets the specified value to the keyboard() field.
static XrEventDataVirtualKeyboardCommitTextMETA	malloc()	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with memAlloc.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with memAlloc.
static XrEventDataVirtualKeyboardCommitTextMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataVirtualKeyboardCommitTextMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataVirtualKeyboardCommitTextMETA	next(long value)	Sets the specified value to the next() field.
static long	nkeyboard(long struct)	Unsafe version of keyboard().
static void	nkeyboard(long struct, XrVirtualKeyboardMETA value)	Unsafe version of keyboard.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static ByteBuffer	ntext(long struct)	Unsafe version of text().
static void	ntext(long struct, ByteBuffer value)	Unsafe version of text.
static String	ntextString(long struct)	Unsafe version of textString().
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrEventDataVirtualKeyboardCommitTextMETA	set(int type, long next, XrVirtualKeyboardMETA keyboard, ByteBuffer text)	Initializes this struct with the specified values.
XrEventDataVirtualKeyboardCommitTextMETA	set(XrEventDataVirtualKeyboardCommitTextMETA src)	Copies the specified struct data to this struct.
int	sizeof()
ByteBuffer	text()	the text string input by the keyboard.
XrEventDataVirtualKeyboardCommitTextMETA	text(ByteBuffer value)	Copies the specified encoded string to the text() field.
String	textString()	the text string input by the keyboard.
int	type()	the XrStructureType of this structure.
XrEventDataVirtualKeyboardCommitTextMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataVirtualKeyboardCommitTextMETA	type$Default()	Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META value to the type() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

KEYBOARD

public static final int KEYBOARD

The struct member offsets.

TEXT

public static final int TEXT

The struct member offsets.

Constructor Details

XrEventDataVirtualKeyboardCommitTextMETA

public XrEventDataVirtualKeyboardCommitTextMETA(ByteBuffer container)

Creates a XrEventDataVirtualKeyboardCommitTextMETA 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<XrEventDataVirtualKeyboardCommitTextMETA>

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.

keyboard

public long keyboard()

the XrVirtualKeyboardMETA this event belongs to.

text

public ByteBuffer text()

the text string input by the keyboard.

textString

public String textString()

the text string input by the keyboard.

type

public XrEventDataVirtualKeyboardCommitTextMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataVirtualKeyboardCommitTextMETA type$Default()

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META value to the type() field.

next

public XrEventDataVirtualKeyboardCommitTextMETA next(long value)

Sets the specified value to the next() field.

keyboard

public XrEventDataVirtualKeyboardCommitTextMETA keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard() field.

text

public XrEventDataVirtualKeyboardCommitTextMETA text(ByteBuffer value)

Copies the specified encoded string to the text() field.

set

public XrEventDataVirtualKeyboardCommitTextMETA set(int type,
 long next,
 XrVirtualKeyboardMETA keyboard,
 ByteBuffer text)

Initializes this struct with the specified values.

set

public XrEventDataVirtualKeyboardCommitTextMETA set(XrEventDataVirtualKeyboardCommitTextMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataVirtualKeyboardCommitTextMETA malloc()

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

calloc

public static XrEventDataVirtualKeyboardCommitTextMETA calloc()

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

create

public static XrEventDataVirtualKeyboardCommitTextMETA create()

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with BufferUtils.

create

public static XrEventDataVirtualKeyboardCommitTextMETA create(long address)

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataVirtualKeyboardCommitTextMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataVirtualKeyboardCommitTextMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataVirtualKeyboardCommitTextMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataVirtualKeyboardCommitTextMETA.Buffer create(int capacity)

Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nkeyboard

public static long nkeyboard(long struct)

Unsafe version of keyboard().

ntext

public static ByteBuffer ntext(long struct)

Unsafe version of text().

ntextString

public static String ntextString(long struct)

Unsafe version of textString().

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.

nkeyboard

public static void nkeyboard(long struct,
 XrVirtualKeyboardMETA value)

Unsafe version of keyboard.

ntext

public static void ntext(long struct,
 ByteBuffer value)

Unsafe version of text.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate