Package org.lwjgl.openxr

Class XrVirtualKeyboardCreateInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVirtualKeyboardCreateInfoMETA>

org.lwjgl.openxr.XrVirtualKeyboardCreateInfoMETA

All Implemented Interfaces:

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

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

Virtual keyboard creation info.

Description

The struct is used for keyboard creation. Empty with the intention of future extension.

The runtime must return ERROR_FEATURE_UNSUPPORTED if XrSystemVirtualKeyboardPropertiesMETA::supportsVirtualKeyboard is FALSE when checking the device compatibility.

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrVirtualKeyboardCreateInfoMETA
• type must be TYPE_VIRTUAL_KEYBOARD_CREATE_INFO_META
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

CreateVirtualKeyboardMETA

Layout

 struct XrVirtualKeyboardCreateInfoMETA {
     XrStructureType type();
     void const * next();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

Constructor Details

XrVirtualKeyboardCreateInfoMETA

public XrVirtualKeyboardCreateInfoMETA(ByteBuffer container)

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

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.

type

public XrVirtualKeyboardCreateInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrVirtualKeyboardCreateInfoMETA type$Default()

Sets the TYPE_VIRTUAL_KEYBOARD_CREATE_INFO_META value to the type() field.

next

public XrVirtualKeyboardCreateInfoMETA next(long value)

Sets the specified value to the next() field.

set

public XrVirtualKeyboardCreateInfoMETA set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrVirtualKeyboardCreateInfoMETA set(XrVirtualKeyboardCreateInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVirtualKeyboardCreateInfoMETA malloc()

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

calloc

public static XrVirtualKeyboardCreateInfoMETA calloc()

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

create

public static XrVirtualKeyboardCreateInfoMETA create()

Returns a new XrVirtualKeyboardCreateInfoMETA instance allocated with BufferUtils.

create

public static XrVirtualKeyboardCreateInfoMETA create(long address)

Returns a new XrVirtualKeyboardCreateInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrVirtualKeyboardCreateInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVirtualKeyboardCreateInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVirtualKeyboardCreateInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVirtualKeyboardCreateInfoMETA.Buffer create(int capacity)

Returns a new XrVirtualKeyboardCreateInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVirtualKeyboardCreateInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrVirtualKeyboardCreateInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.