Package org.lwjgl.openxr

Class XrVirtualKeyboardLocationInfoMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVirtualKeyboardLocationInfoMETA>

org.lwjgl.openxr.XrVirtualKeyboardLocationInfoMETA

All Implemented Interfaces:

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

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

Virtual keyboard location info.

Description

If locationType is set to VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META, the runtime must use the values poseInSpace and scale set by the application. Otherwise, the runtime must provide a default pose and scale and ignore poseInSpace and scale.

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrVirtualKeyboardLocationInfoMETA
• type must be TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• locationType must be a valid XrVirtualKeyboardLocationTypeMETA value
• space must be a valid XrSpace handle

See Also

XrPosef, SuggestVirtualKeyboardLocationMETA

Layout

 struct XrVirtualKeyboardLocationInfoMETA {
     XrStructureType type();
     void const * next();
     XrVirtualKeyboardLocationTypeMETA locationType();
     XrSpace space();
     XrPosef poseInSpace();
     float scale();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrVirtualKeyboardLocationInfoMETA	calloc()	Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated with memCalloc.
static XrVirtualKeyboardLocationInfoMETA.Buffer	calloc(int capacity)	Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated with memCalloc.
static XrVirtualKeyboardLocationInfoMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardLocationInfoMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardLocationInfoMETA	create()	Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated with BufferUtils.
static XrVirtualKeyboardLocationInfoMETA.Buffer	create(int capacity)	Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated with BufferUtils.
static XrVirtualKeyboardLocationInfoMETA	create(long address)	Returns a new XrVirtualKeyboardLocationInfoMETA instance for the specified memory address.
static XrVirtualKeyboardLocationInfoMETA.Buffer	create(long address, int capacity)	Create a XrVirtualKeyboardLocationInfoMETA.Buffer instance at the specified memory.
static @Nullable XrVirtualKeyboardLocationInfoMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVirtualKeyboardLocationInfoMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	locationType()	an XrVirtualKeyboardLocationTypeMETA enum providing the location type.
XrVirtualKeyboardLocationInfoMETA	locationType(int value)	Sets the specified value to the locationType() field.
static XrVirtualKeyboardLocationInfoMETA	malloc()	Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated with memAlloc.
static XrVirtualKeyboardLocationInfoMETA.Buffer	malloc(int capacity)	Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated with memAlloc.
static XrVirtualKeyboardLocationInfoMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated on the specified MemoryStack.
static XrVirtualKeyboardLocationInfoMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVirtualKeyboardLocationInfoMETA	next(long value)	Sets the specified value to the next() field.
static int	nlocationType(long struct)	Unsafe version of locationType().
static void	nlocationType(long struct, int value)	Unsafe version of locationType.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static XrPosef	nposeInSpace(long struct)	Unsafe version of poseInSpace().
static void	nposeInSpace(long struct, XrPosef value)	Unsafe version of poseInSpace.
static float	nscale(long struct)	Unsafe version of scale().
static void	nscale(long struct, float value)	Unsafe version of scale.
static long	nspace(long struct)	Unsafe version of space().
static void	nspace(long struct, XrSpace value)	Unsafe version of space.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrPosef	poseInSpace()	the desired pose if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.
XrVirtualKeyboardLocationInfoMETA	poseInSpace(Consumer<XrPosef> consumer)	Passes the poseInSpace() field to the specified Consumer.
XrVirtualKeyboardLocationInfoMETA	poseInSpace(XrPosef value)	Copies the specified XrPosef to the poseInSpace() field.
float	scale()	a float value of the desired multiplicative scale between 0.0 and 1.0 if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.
XrVirtualKeyboardLocationInfoMETA	scale(float value)	Sets the specified value to the scale() field.
XrVirtualKeyboardLocationInfoMETA	set(int type, long next, int locationType, XrSpace space, XrPosef poseInSpace, float scale)	Initializes this struct with the specified values.
XrVirtualKeyboardLocationInfoMETA	set(XrVirtualKeyboardLocationInfoMETA src)	Copies the specified struct data to this struct.
int	sizeof()
long	space()	an XrSpace previously created by a function such as CreateReferenceSpace.
XrVirtualKeyboardLocationInfoMETA	space(XrSpace value)	Sets the specified value to the space() field.
int	type()	the XrStructureType of this structure.
XrVirtualKeyboardLocationInfoMETA	type(int value)	Sets the specified value to the type() field.
XrVirtualKeyboardLocationInfoMETA	type$Default()	Sets the TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_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.

LOCATIONTYPE

public static final int LOCATIONTYPE

The struct member offsets.

SPACE

public static final int SPACE

The struct member offsets.

POSEINSPACE

public static final int POSEINSPACE

The struct member offsets.

SCALE

public static final int SCALE

The struct member offsets.

Constructor Details

XrVirtualKeyboardLocationInfoMETA

public XrVirtualKeyboardLocationInfoMETA(ByteBuffer container)

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

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.

locationType

public int locationType()

an XrVirtualKeyboardLocationTypeMETA enum providing the location type.

space

public long space()

an XrSpace previously created by a function such as CreateReferenceSpace.

poseInSpace

public XrPosef poseInSpace()

the desired pose if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.

scale

public float scale()

a float value of the desired multiplicative scale between 0.0 and 1.0 if locationType is VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META.

type

public XrVirtualKeyboardLocationInfoMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrVirtualKeyboardLocationInfoMETA type$Default()

Sets the TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_META value to the type() field.

next

public XrVirtualKeyboardLocationInfoMETA next(long value)

Sets the specified value to the next() field.

locationType

public XrVirtualKeyboardLocationInfoMETA locationType(int value)

Sets the specified value to the locationType() field.

space

public XrVirtualKeyboardLocationInfoMETA space(XrSpace value)

Sets the specified value to the space() field.

poseInSpace

public XrVirtualKeyboardLocationInfoMETA poseInSpace(XrPosef value)

Copies the specified XrPosef to the poseInSpace() field.

poseInSpace

public XrVirtualKeyboardLocationInfoMETA poseInSpace(Consumer<XrPosef> consumer)

Passes the poseInSpace() field to the specified Consumer.

scale

public XrVirtualKeyboardLocationInfoMETA scale(float value)

Sets the specified value to the scale() field.

set

public XrVirtualKeyboardLocationInfoMETA set(int type,
 long next,
 int locationType,
 XrSpace space,
 XrPosef poseInSpace,
 float scale)

Initializes this struct with the specified values.

set

public XrVirtualKeyboardLocationInfoMETA set(XrVirtualKeyboardLocationInfoMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVirtualKeyboardLocationInfoMETA malloc()

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

calloc

public static XrVirtualKeyboardLocationInfoMETA calloc()

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

create

public static XrVirtualKeyboardLocationInfoMETA create()

Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated with BufferUtils.

create

public static XrVirtualKeyboardLocationInfoMETA create(long address)

Returns a new XrVirtualKeyboardLocationInfoMETA instance for the specified memory address.

createSafe

public static @Nullable XrVirtualKeyboardLocationInfoMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVirtualKeyboardLocationInfoMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVirtualKeyboardLocationInfoMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVirtualKeyboardLocationInfoMETA.Buffer create(int capacity)

Returns a new XrVirtualKeyboardLocationInfoMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVirtualKeyboardLocationInfoMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrVirtualKeyboardLocationInfoMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlocationType

public static int nlocationType(long struct)

Unsafe version of locationType().

nspace

public static long nspace(long struct)

Unsafe version of space().

nposeInSpace

public static XrPosef nposeInSpace(long struct)

Unsafe version of poseInSpace().

nscale

public static float nscale(long struct)

Unsafe version of scale().

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.

nlocationType

public static void nlocationType(long struct,
 int value)

Unsafe version of locationType.

nspace

public static void nspace(long struct,
 XrSpace value)

Unsafe version of space.

nposeInSpace

public static void nposeInSpace(long struct,
 XrPosef value)

Unsafe version of poseInSpace.

nscale

public static void nscale(long struct,
 float value)

Unsafe version of scale.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate