Package org.lwjgl.openxr

Class XrKeyboardTrackingDescriptionFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrKeyboardTrackingDescriptionFB>

org.lwjgl.openxr.XrKeyboardTrackingDescriptionFB

All Implemented Interfaces:

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

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

Description of a trackable keyboard.

Description

XrKeyboardTrackingDescriptionFB describes a trackable keyboard and its associated metadata.

Valid Usage (Implicit)

• The XR_FB_keyboard_tracking extension must be enabled prior to using XrKeyboardTrackingDescriptionFB

See Also

XrVector3f, QuerySystemTrackedKeyboardFB

Layout

 struct XrKeyboardTrackingDescriptionFB {
     uint64_t trackedKeyboardId();
     XrVector3f size();
     XrKeyboardTrackingFlagsFB flags();
     char name()[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrKeyboardTrackingDescriptionFB.Buffer	An array of XrKeyboardTrackingDescriptionFB 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	FLAGS	The struct member offsets.
static final int	NAME	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TRACKEDKEYBOARDID	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
XrKeyboardTrackingDescriptionFB(ByteBuffer container)	Creates a XrKeyboardTrackingDescriptionFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrKeyboardTrackingDescriptionFB	calloc()	Returns a new XrKeyboardTrackingDescriptionFB instance allocated with memCalloc.
static XrKeyboardTrackingDescriptionFB.Buffer	calloc(int capacity)	Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with memCalloc.
static XrKeyboardTrackingDescriptionFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrKeyboardTrackingDescriptionFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrKeyboardTrackingDescriptionFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrKeyboardTrackingDescriptionFB	create()	Returns a new XrKeyboardTrackingDescriptionFB instance allocated with BufferUtils.
static XrKeyboardTrackingDescriptionFB.Buffer	create(int capacity)	Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with BufferUtils.
static XrKeyboardTrackingDescriptionFB	create(long address)	Returns a new XrKeyboardTrackingDescriptionFB instance for the specified memory address.
static XrKeyboardTrackingDescriptionFB.Buffer	create(long address, int capacity)	Create a XrKeyboardTrackingDescriptionFB.Buffer instance at the specified memory.
static @Nullable XrKeyboardTrackingDescriptionFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrKeyboardTrackingDescriptionFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	flags()	additional information on the type of keyboard available.
static XrKeyboardTrackingDescriptionFB	malloc()	Returns a new XrKeyboardTrackingDescriptionFB instance allocated with memAlloc.
static XrKeyboardTrackingDescriptionFB.Buffer	malloc(int capacity)	Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with memAlloc.
static XrKeyboardTrackingDescriptionFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated on the specified MemoryStack.
static XrKeyboardTrackingDescriptionFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrKeyboardTrackingDescriptionFB instance allocated on the specified MemoryStack.
ByteBuffer	name()	human readable keyboard identifier.
String	nameString()	human readable keyboard identifier.
static long	nflags(long struct)	Unsafe version of flags().
static ByteBuffer	nname(long struct)	Unsafe version of name().
static String	nnameString(long struct)	Unsafe version of nameString().
static XrVector3f	nsize(long struct)	Unsafe version of size().
static long	ntrackedKeyboardId(long struct)	Unsafe version of trackedKeyboardId().
XrVector3f	size()	bounding box.
int	sizeof()
long	trackedKeyboardId()	abstract identifier describing the type of keyboard.

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.

TRACKEDKEYBOARDID

public static final int TRACKEDKEYBOARDID

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

NAME

public static final int NAME

The struct member offsets.

Constructor Details

XrKeyboardTrackingDescriptionFB

public XrKeyboardTrackingDescriptionFB(ByteBuffer container)

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

trackedKeyboardId

public long trackedKeyboardId()

abstract identifier describing the type of keyboard.

size

public XrVector3f size()

bounding box.

flags

public long flags()

additional information on the type of keyboard available. If KEYBOARD_TRACKING_EXISTS_BIT_FB is not set there is no keyboard.

name

public ByteBuffer name()

human readable keyboard identifier.

nameString

public String nameString()

human readable keyboard identifier.

malloc

public static XrKeyboardTrackingDescriptionFB malloc()

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

calloc

public static XrKeyboardTrackingDescriptionFB calloc()

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

create

public static XrKeyboardTrackingDescriptionFB create()

Returns a new XrKeyboardTrackingDescriptionFB instance allocated with BufferUtils.

create

public static XrKeyboardTrackingDescriptionFB create(long address)

Returns a new XrKeyboardTrackingDescriptionFB instance for the specified memory address.

createSafe

public static @Nullable XrKeyboardTrackingDescriptionFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrKeyboardTrackingDescriptionFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrKeyboardTrackingDescriptionFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrKeyboardTrackingDescriptionFB.Buffer create(int capacity)

Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrKeyboardTrackingDescriptionFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrKeyboardTrackingDescriptionFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntrackedKeyboardId

public static long ntrackedKeyboardId(long struct)

Unsafe version of trackedKeyboardId().

nsize

public static XrVector3f nsize(long struct)

Unsafe version of size().

nflags

public static long nflags(long struct)

Unsafe version of flags().

nname

public static ByteBuffer nname(long struct)

Unsafe version of name().

nnameString

public static String nnameString(long struct)

Unsafe version of nameString().