Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrKeyboardTrackingDescriptionFB

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

Description of a trackable keyboard.
Description

XrKeyboardTrackingDescriptionFB describes a trackable keyboard and its associated metadata.

Valid Usage (Implicit)
See Also

XrVector3f, QuerySystemTrackedKeyboardFB

Layout


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

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
FLAGS

The struct member offsets.

public static final int
NAME

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TRACKEDKEYBOARDID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrKeyboardTrackingDescriptionFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrKeyboardTrackingDescriptionFB
calloc()

Returns a new XrKeyboardTrackingDescriptionFB instance allocated with memCalloc.

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

Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrKeyboardTrackingDescriptionFB instance allocated with BufferUtils.

public static XrKeyboardTrackingDescriptionFB
create(long address)

Returns a new XrKeyboardTrackingDescriptionFB instance for the specified memory address.

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

Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with BufferUtils.

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

Create a XrKeyboardTrackingDescriptionFB.Buffer instance at the specified memory.

public static XrKeyboardTrackingDescriptionFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

additional information on the type of keyboard available.

public static XrKeyboardTrackingDescriptionFB
malloc()

Returns a new XrKeyboardTrackingDescriptionFB instance allocated with memAlloc.

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

Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with memAlloc.

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

Returns a new XrKeyboardTrackingDescriptionFB instance allocated on the specified MemoryStack.

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

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

public ByteBuffer
name()

human readable keyboard identifier.

public String
nameString()

human readable keyboard identifier.

public static long
nflags(long struct)

Unsafe version of flags.

public static ByteBuffer
nname(long struct)

Unsafe version of name.

public static String
nnameString(long struct)

Unsafe version of nameString.

public static XrVector3f
nsize(long struct)

Unsafe version of size.

public static long
ntrackedKeyboardId(long struct)

Unsafe version of trackedKeyboardId.

public XrVector3f
size()

bounding box.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
trackedKeyboardId()

abstract identifier describing the type of keyboard.

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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TRACKEDKEYBOARDIDback to summary
public static final int TRACKEDKEYBOARDID

The struct member offsets.

Constructor Detail

XrKeyboardTrackingDescriptionFBback to summary
protected XrKeyboardTrackingDescriptionFB(long address, ByteBuffer container)
XrKeyboardTrackingDescriptionFBback to summary
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 Detail

callocback to summary
public static XrKeyboardTrackingDescriptionFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrKeyboardTrackingDescriptionFB calloc(MemoryStack stack)

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

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

Returns a new XrKeyboardTrackingDescriptionFB instance allocated with BufferUtils.

createback to summary
public static XrKeyboardTrackingDescriptionFB create(long address)

Returns a new XrKeyboardTrackingDescriptionFB instance for the specified memory address.

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

Returns a new XrKeyboardTrackingDescriptionFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrKeyboardTrackingDescriptionFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrKeyboardTrackingDescriptionFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrKeyboardTrackingDescriptionFB.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()

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

Annotations
@NativeType:XrKeyboardTrackingFlagsFB
mallocback to summary
public static XrKeyboardTrackingDescriptionFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrKeyboardTrackingDescriptionFB malloc(MemoryStack stack)

Returns a new XrKeyboardTrackingDescriptionFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nameback to summary
public ByteBuffer name()

human readable keyboard identifier.

Annotations
@NativeType:char[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB]
nameStringback to summary
public String nameString()

human readable keyboard identifier.

Annotations
@NativeType:char[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB]
nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nnameback to summary
public static ByteBuffer nname(long struct)

Unsafe version of name.

nnameStringback to summary
public static String nnameString(long struct)

Unsafe version of nameString.

nsizeback to summary
public static XrVector3f nsize(long struct)

Unsafe version of size.

ntrackedKeyboardIdback to summary
public static long ntrackedKeyboardId(long struct)

Unsafe version of trackedKeyboardId.

sizeback to summary
public XrVector3f size()

bounding box.

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
trackedKeyboardIdback to summary
public long trackedKeyboardId()

abstract identifier describing the type of keyboard.

Annotations
@NativeType:uint64_t
org.lwjgl.openxr back to summary

public Class XrKeyboardTrackingDescriptionFB.Buffer

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

An array of XrKeyboardTrackingDescriptionFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrKeyboardTrackingDescriptionFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the XrKeyboardTrackingDescriptionFB#flags field.
flags
()

protected XrKeyboardTrackingDescriptionFB
public ByteBuffer

Returns:

a ByteBuffer view of the XrKeyboardTrackingDescriptionFB#name field.
name
()

public String

Returns:

the null-terminated string stored in the XrKeyboardTrackingDescriptionFB#name field.
nameString
()

protected XrKeyboardTrackingDescriptionFB.Buffer
public XrVector3f

Returns:

a XrVector3f view of the XrKeyboardTrackingDescriptionFB#size field.
size
()

public long
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrKeyboardTrackingDescriptionFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public long flags()
Returns:long

the value of the XrKeyboardTrackingDescriptionFB#flags field.

Annotations
@NativeType:XrKeyboardTrackingFlagsFB
getElementFactoryback to summary
protected XrKeyboardTrackingDescriptionFB getElementFactory()

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

Annotations
@Override
nameback to summary
public ByteBuffer name()
Returns:ByteBuffer

a ByteBuffer view of the XrKeyboardTrackingDescriptionFB#name field.

Annotations
@NativeType:char[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB]
nameStringback to summary
public String nameString()
Returns:String

the null-terminated string stored in the XrKeyboardTrackingDescriptionFB#name field.

Annotations
@NativeType:char[XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB]
selfback to summary
protected XrKeyboardTrackingDescriptionFB.Buffer self()

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

Annotations
@Override
sizeback to summary
public XrVector3f size()
Returns:XrVector3f

a XrVector3f view of the XrKeyboardTrackingDescriptionFB#size field.

trackedKeyboardIdback to summary
public long trackedKeyboardId()
Returns:long

the value of the XrKeyboardTrackingDescriptionFB#trackedKeyboardId field.

Annotations
@NativeType:uint64_t