Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrEventDataVirtualKeyboardShownMETA

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

Keyboard shown event.
Description

The XrEventDataVirtualKeyboardShownMETA event must be sent when the runtime has shown the keyboard render model (via animation). The application should update its state accordingly (e.g. update UI, pause simulation, etc).

Valid Usage (Implicit)
See Also

PollEvent

Layout


struct XrEventDataVirtualKeyboardShownMETA {
    XrStructureType type;
    void const * next;
    XrVirtualKeyboardMETA keyboard;
}

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
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrEventDataVirtualKeyboardShownMETA(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrEventDataVirtualKeyboardShownMETA
calloc()

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated with memCalloc.

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

Returns a new XrEventDataVirtualKeyboardShownMETA.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated with BufferUtils.

public static XrEventDataVirtualKeyboardShownMETA
create(long address)

Returns a new XrEventDataVirtualKeyboardShownMETA instance for the specified memory address.

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

Returns a new XrEventDataVirtualKeyboardShownMETA.Buffer instance allocated with BufferUtils.

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

Create a XrEventDataVirtualKeyboardShownMETA.Buffer instance at the specified memory.

public static XrEventDataVirtualKeyboardShownMETA
createSafe(long address)

Like create, but returns null if address is NULL.

public static XrEventDataVirtualKeyboardShownMETA.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 XrEventDataVirtualKeyboardShownMETA
keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard field.

public static XrEventDataVirtualKeyboardShownMETA
malloc()

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated with memAlloc.

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

Returns a new XrEventDataVirtualKeyboardShownMETA.Buffer instance allocated with memAlloc.

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

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrEventDataVirtualKeyboardShownMETA
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 int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrEventDataVirtualKeyboardShownMETA

Returns:

this struct
set
(XrEventDataVirtualKeyboardShownMETA
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 int
type()

the XrStructureType of this structure.

public XrEventDataVirtualKeyboardShownMETA
type(int value)

Sets the specified value to the type field.

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

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrEventDataVirtualKeyboardShownMETAback to summary
protected XrEventDataVirtualKeyboardShownMETA(long address, ByteBuffer container)
XrEventDataVirtualKeyboardShownMETAback to summary
public XrEventDataVirtualKeyboardShownMETA(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrEventDataVirtualKeyboardShownMETA calloc(MemoryStack stack)

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

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

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated with BufferUtils.

createback to summary
public static XrEventDataVirtualKeyboardShownMETA create(long address)

Returns a new XrEventDataVirtualKeyboardShownMETA instance for the specified memory address.

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

Returns a new XrEventDataVirtualKeyboardShownMETA.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrEventDataVirtualKeyboardShownMETA.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrEventDataVirtualKeyboardShownMETA createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrEventDataVirtualKeyboardShownMETA.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 XrEventDataVirtualKeyboardShownMETA keyboard(XrVirtualKeyboardMETA value)

Sets the specified value to the keyboard field.

mallocback to summary
public static XrEventDataVirtualKeyboardShownMETA malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrEventDataVirtualKeyboardShownMETA malloc(MemoryStack stack)

Returns a new XrEventDataVirtualKeyboardShownMETA instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrEventDataVirtualKeyboardShownMETA.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 XrEventDataVirtualKeyboardShownMETA 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.

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 XrEventDataVirtualKeyboardShownMETA set(int type, long next, XrVirtualKeyboardMETA keyboard)

Initializes this struct with the specified values.

setback to summary
public XrEventDataVirtualKeyboardShownMETA set(XrEventDataVirtualKeyboardShownMETA src)

Copies the specified struct data to this struct.

Parameters
src:XrEventDataVirtualKeyboardShownMETA

the source struct

Returns:XrEventDataVirtualKeyboardShownMETA

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_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 XrEventDataVirtualKeyboardShownMETA.Buffer

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

An array of XrEventDataVirtualKeyboardShownMETA structs.

Field Summary

Modifier and TypeField and Description
private static final XrEventDataVirtualKeyboardShownMETA

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the XrEventDataVirtualKeyboardShownMETA#keyboard field.
keyboard
()

public XrEventDataVirtualKeyboardShownMETA.Buffer
public long

Returns:

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

public XrEventDataVirtualKeyboardShownMETA.Buffer
next(long value)

Sets the specified value to the XrEventDataVirtualKeyboardShownMETA#next field.

protected XrEventDataVirtualKeyboardShownMETA.Buffer
public int

Returns:

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

public XrEventDataVirtualKeyboardShownMETA.Buffer
type(int value)

Sets the specified value to the XrEventDataVirtualKeyboardShownMETA#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrEventDataVirtualKeyboardShownMETA ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the XrEventDataVirtualKeyboardShownMETA#keyboard field.

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

Sets the specified value to the XrEventDataVirtualKeyboardShownMETA#keyboard field.

nextback to summary
public long next()
Returns:long

the value of the XrEventDataVirtualKeyboardShownMETA#next field.

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

Sets the specified value to the XrEventDataVirtualKeyboardShownMETA#next field.

selfback to summary
protected XrEventDataVirtualKeyboardShownMETA.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrEventDataVirtualKeyboardShownMETA#type field.

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

Sets the specified value to the XrEventDataVirtualKeyboardShownMETA#type field.

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

Sets the TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_META value to the XrEventDataVirtualKeyboardShownMETA#type field.