Package org.lwjgl.openxr

Class XrEventDataVirtualKeyboardEnterMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataVirtualKeyboardEnterMETA>

org.lwjgl.openxr.XrEventDataVirtualKeyboardEnterMETA

All Implemented Interfaces:

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

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

Enter key event.

Description

The XrEventDataVirtualKeyboardEnterMETA event must be sent by the runtime when the [Enter] key is pressed. The application should respond accordingly (e.g. newline, accept, etc).

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrEventDataVirtualKeyboardEnterMETA
• type must be TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• keyboard must be a valid XrVirtualKeyboardMETA handle

See Also

PollEvent

Layout

 struct XrEventDataVirtualKeyboardEnterMETA {
     XrStructureType type();
     void const * next();
     XrVirtualKeyboardMETA keyboard();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrEventDataVirtualKeyboardEnterMETA.Buffer	An array of XrEventDataVirtualKeyboardEnterMETA 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	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
XrEventDataVirtualKeyboardEnterMETA(ByteBuffer container)	Creates a XrEventDataVirtualKeyboardEnterMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrEventDataVirtualKeyboardEnterMETA	calloc()	Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated with memCalloc.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	calloc(int capacity)	Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated with memCalloc.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataVirtualKeyboardEnterMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataVirtualKeyboardEnterMETA	create()	Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated with BufferUtils.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	create(int capacity)	Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated with BufferUtils.
static XrEventDataVirtualKeyboardEnterMETA	create(long address)	Returns a new XrEventDataVirtualKeyboardEnterMETA instance for the specified memory address.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	create(long address, int capacity)	Create a XrEventDataVirtualKeyboardEnterMETA.Buffer instance at the specified memory.
static @Nullable XrEventDataVirtualKeyboardEnterMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataVirtualKeyboardEnterMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	keyboard()	the XrVirtualKeyboardMETA this event belongs to.
XrEventDataVirtualKeyboardEnterMETA	keyboard(XrVirtualKeyboardMETA value)	Sets the specified value to the keyboard() field.
static XrEventDataVirtualKeyboardEnterMETA	malloc()	Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated with memAlloc.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	malloc(int capacity)	Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated with memAlloc.
static XrEventDataVirtualKeyboardEnterMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated on the specified MemoryStack.
static XrEventDataVirtualKeyboardEnterMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataVirtualKeyboardEnterMETA	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 int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrEventDataVirtualKeyboardEnterMETA	set(int type, long next, XrVirtualKeyboardMETA keyboard)	Initializes this struct with the specified values.
XrEventDataVirtualKeyboardEnterMETA	set(XrEventDataVirtualKeyboardEnterMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataVirtualKeyboardEnterMETA	type(int value)	Sets the specified value to the type() field.
XrEventDataVirtualKeyboardEnterMETA	type$Default()	Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_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.

Constructor Details

XrEventDataVirtualKeyboardEnterMETA

public XrEventDataVirtualKeyboardEnterMETA(ByteBuffer container)

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

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.

type

public XrEventDataVirtualKeyboardEnterMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataVirtualKeyboardEnterMETA type$Default()

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_META value to the type() field.

next

public XrEventDataVirtualKeyboardEnterMETA next(long value)

Sets the specified value to the next() field.

keyboard

public XrEventDataVirtualKeyboardEnterMETA keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard() field.

set

public XrEventDataVirtualKeyboardEnterMETA set(int type,
 long next,
 XrVirtualKeyboardMETA keyboard)

Initializes this struct with the specified values.

set

public XrEventDataVirtualKeyboardEnterMETA set(XrEventDataVirtualKeyboardEnterMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataVirtualKeyboardEnterMETA malloc()

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

calloc

public static XrEventDataVirtualKeyboardEnterMETA calloc()

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

create

public static XrEventDataVirtualKeyboardEnterMETA create()

Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated with BufferUtils.

create

public static XrEventDataVirtualKeyboardEnterMETA create(long address)

Returns a new XrEventDataVirtualKeyboardEnterMETA instance for the specified memory address.

createSafe

public static @Nullable XrEventDataVirtualKeyboardEnterMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataVirtualKeyboardEnterMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataVirtualKeyboardEnterMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataVirtualKeyboardEnterMETA.Buffer create(int capacity)

Returns a new XrEventDataVirtualKeyboardEnterMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataVirtualKeyboardEnterMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataVirtualKeyboardEnterMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate