Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrEventDataVirtualKeyboardCommitTextMETA

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

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)
See Also

PollEvent

Layout


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

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
KEYBOARD

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TEXT

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

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

Method Summary

Modifier and TypeMethod and Description
public static XrEventDataVirtualKeyboardCommitTextMETA
calloc()

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with memCalloc.

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with BufferUtils.

public static XrEventDataVirtualKeyboardCommitTextMETA
create(long address)

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance for the specified memory address.

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with BufferUtils.

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

Create a XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance at the specified memory.

public static XrEventDataVirtualKeyboardCommitTextMETA
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
keyboard()

the XrVirtualKeyboardMETA this event belongs to.

public XrEventDataVirtualKeyboardCommitTextMETA
keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard field.

public static XrEventDataVirtualKeyboardCommitTextMETA
malloc()

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with memAlloc.

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with memAlloc.

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrEventDataVirtualKeyboardCommitTextMETA
next(long value)

Sets the specified value to the next field.

public static long
nkeyboard(long struct)

Unsafe version of keyboard.

public static void
nkeyboard(long struct, XrVirtualKeyboardMETA value)

Unsafe version of keyboard.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static ByteBuffer
ntext(long struct)

Unsafe version of text.

public static void
ntext(long struct, ByteBuffer value)

Unsafe version of text.

public static String
ntextString(long struct)

Unsafe version of textString.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrEventDataVirtualKeyboardCommitTextMETA

Returns:

this struct
set
(XrEventDataVirtualKeyboardCommitTextMETA
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 ByteBuffer
text()

the text string input by the keyboard.

public XrEventDataVirtualKeyboardCommitTextMETA
text(ByteBuffer value)

Copies the specified encoded string to the text field.

public String
textString()

the text string input by the keyboard.

public int
type()

the XrStructureType of this structure.

public XrEventDataVirtualKeyboardCommitTextMETA
type(int value)

Sets the specified value to the type field.

public XrEventDataVirtualKeyboardCommitTextMETA
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.

KEYBOARDback to summary
public static final int KEYBOARD

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TEXTback to summary
public static final int TEXT

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrEventDataVirtualKeyboardCommitTextMETAback to summary
protected XrEventDataVirtualKeyboardCommitTextMETA(long address, ByteBuffer container)
XrEventDataVirtualKeyboardCommitTextMETAback to summary
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 Detail

callocback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA calloc(MemoryStack stack)

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

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated with BufferUtils.

createback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA create(long address)

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance for the specified memory address.

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

Returns a new XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrEventDataVirtualKeyboardCommitTextMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
keyboardback to summary
public long keyboard()

the XrVirtualKeyboardMETA this event belongs to.

Annotations
@NativeType:XrVirtualKeyboardMETA
keyboardback to summary
public XrEventDataVirtualKeyboardCommitTextMETA keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard field.

mallocback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrEventDataVirtualKeyboardCommitTextMETA malloc(MemoryStack stack)

Returns a new XrEventDataVirtualKeyboardCommitTextMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Sets the specified value to the next field.

nkeyboardback to summary
public static long nkeyboard(long struct)

Unsafe version of keyboard.

nkeyboardback to summary
public static void nkeyboard(long struct, XrVirtualKeyboardMETA value)

Unsafe version of keyboard.

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.

ntextback to summary
public static ByteBuffer ntext(long struct)

Unsafe version of text.

ntextback to summary
public static void ntext(long struct, ByteBuffer value)

Unsafe version of text.

ntextStringback to summary
public static String ntextString(long struct)

Unsafe version of textString.

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.

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

Initializes this struct with the specified values.

setback to summary
public XrEventDataVirtualKeyboardCommitTextMETA set(XrEventDataVirtualKeyboardCommitTextMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrEventDataVirtualKeyboardCommitTextMETA

the source struct

Returns:XrEventDataVirtualKeyboardCommitTextMETA

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
textback to summary
public ByteBuffer text()

the text string input by the keyboard.

Annotations
@NativeType:char[XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META]
textback to summary
public XrEventDataVirtualKeyboardCommitTextMETA text(ByteBuffer value)

Copies the specified encoded string to the text field.

textStringback to summary
public String textString()

the text string input by the keyboard.

Annotations
@NativeType:char[XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META]
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_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 XrEventDataVirtualKeyboardCommitTextMETA.Buffer

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

An array of XrEventDataVirtualKeyboardCommitTextMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrEventDataVirtualKeyboardCommitTextMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

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

public XrEventDataVirtualKeyboardCommitTextMETA.Buffer
next(long value)

Sets the specified value to the XrEventDataVirtualKeyboardCommitTextMETA#next field.

protected XrEventDataVirtualKeyboardCommitTextMETA.Buffer
public ByteBuffer
public XrEventDataVirtualKeyboardCommitTextMETA.Buffer
text(ByteBuffer value)

Copies the specified encoded string to the XrEventDataVirtualKeyboardCommitTextMETA#text field.

public String

Returns:

the null-terminated string stored in the XrEventDataVirtualKeyboardCommitTextMETA#text field.
textString
()

public int

Returns:

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

public XrEventDataVirtualKeyboardCommitTextMETA.Buffer
type(int value)

Sets the specified value to the XrEventDataVirtualKeyboardCommitTextMETA#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrEventDataVirtualKeyboardCommitTextMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
keyboardback to summary
public long keyboard()
Returns:long

the value of the XrEventDataVirtualKeyboardCommitTextMETA#keyboard field.

Annotations
@NativeType:XrVirtualKeyboardMETA
keyboardback to summary
public XrEventDataVirtualKeyboardCommitTextMETA.Buffer keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the XrEventDataVirtualKeyboardCommitTextMETA#keyboard field.

nextback to summary
public long next()
Returns:long

the value of the XrEventDataVirtualKeyboardCommitTextMETA#next field.

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

Sets the specified value to the XrEventDataVirtualKeyboardCommitTextMETA#next field.

selfback to summary
protected XrEventDataVirtualKeyboardCommitTextMETA.Buffer self()

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

Annotations
@Override
textback to summary
public ByteBuffer text()
Returns:ByteBuffer

a ByteBuffer view of the XrEventDataVirtualKeyboardCommitTextMETA#text field.

Annotations
@NativeType:char[XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META]
textback to summary
public XrEventDataVirtualKeyboardCommitTextMETA.Buffer text(ByteBuffer value)

Copies the specified encoded string to the XrEventDataVirtualKeyboardCommitTextMETA#text field.

textStringback to summary
public String textString()
Returns:String

the null-terminated string stored in the XrEventDataVirtualKeyboardCommitTextMETA#text field.

Annotations
@NativeType:char[XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META]
typeback to summary
public int type()
Returns:int

the value of the XrEventDataVirtualKeyboardCommitTextMETA#type field.

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

Sets the specified value to the XrEventDataVirtualKeyboardCommitTextMETA#type field.

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

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META value to the XrEventDataVirtualKeyboardCommitTextMETA#type field.