Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHandTrackingScaleFB

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

The information to query and modify hand joint overall scale.
Valid Usage (Implicit)

Layout


struct XrHandTrackingScaleFB {
    XrStructureType type;
    void * next;
    float sensorOutput;
    float currentOutput;
    XrBool32 overrideHandScale;
    float overrideValueInput;
}

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
CURRENTOUTPUT

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
OVERRIDEHANDSCALE

The struct member offsets.

public static final int
OVERRIDEVALUEINPUT

The struct member offsets.

public static final int
SENSOROUTPUT

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
XrHandTrackingScaleFB(long address, ByteBuffer container)

public
XrHandTrackingScaleFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrHandTrackingScaleFB
calloc()

Returns a new XrHandTrackingScaleFB instance allocated with memCalloc.

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

Returns a new XrHandTrackingScaleFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHandTrackingScaleFB instance allocated with BufferUtils.

public static XrHandTrackingScaleFB
create(long address)

Returns a new XrHandTrackingScaleFB instance for the specified memory address.

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

Returns a new XrHandTrackingScaleFB.Buffer instance allocated with BufferUtils.

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

Create a XrHandTrackingScaleFB.Buffer instance at the specified memory.

public static XrHandTrackingScaleFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
currentOutput()

an output value: the effective output that the bind skeleton is getting on the current call, which may be subject to filtering, scaling, or validation.

public static XrHandTrackingScaleFB
malloc()

Returns a new XrHandTrackingScaleFB instance allocated with memAlloc.

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

Returns a new XrHandTrackingScaleFB.Buffer instance allocated with memAlloc.

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

Returns a new XrHandTrackingScaleFB instance allocated on the specified MemoryStack.

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

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

public static float
ncurrentOutput(long struct)

Unsafe version of currentOutput.

public long
next()

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

public XrHandTrackingScaleFB
next(long value)

Sets the specified value to the next field.

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
noverrideHandScale(long struct)

Unsafe version of overrideHandScale.

public static float
noverrideValueInput(long struct)

Unsafe version of overrideValueInput.

public static float
nsensorOutput(long struct)

Unsafe version of sensorOutput.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public boolean
overrideHandScale()

indicates whether the runtime should scale the output of this LocateHandJointsEXT call according to overrideValueInput

public float
overrideValueInput()

an optional input value, enabled only when the overrideHandScale parameter is set.

public float
sensorOutput()

an output value: the currently measured scale as would be applied without passing this structure.

public XrHandTrackingScaleFB
set(int type, long next)

Initializes this struct with the specified values.

public XrHandTrackingScaleFB

Returns:

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

Sets the specified value to the type field.

public XrHandTrackingScaleFB
type$Default()

Sets the TYPE_HAND_TRACKING_SCALE_FB value to the type field.

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.

CURRENTOUTPUTback to summary
public static final int CURRENTOUTPUT

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

OVERRIDEHANDSCALEback to summary
public static final int OVERRIDEHANDSCALE

The struct member offsets.

OVERRIDEVALUEINPUTback to summary
public static final int OVERRIDEVALUEINPUT

The struct member offsets.

SENSOROUTPUTback to summary
public static final int SENSOROUTPUT

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

XrHandTrackingScaleFBback to summary
protected XrHandTrackingScaleFB(long address, ByteBuffer container)
XrHandTrackingScaleFBback to summary
public XrHandTrackingScaleFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHandTrackingScaleFB calloc(MemoryStack stack)

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

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

Returns a new XrHandTrackingScaleFB instance allocated with BufferUtils.

createback to summary
public static XrHandTrackingScaleFB create(long address)

Returns a new XrHandTrackingScaleFB instance for the specified memory address.

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

Returns a new XrHandTrackingScaleFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHandTrackingScaleFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHandTrackingScaleFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
currentOutputback to summary
public float currentOutput()

an output value: the effective output that the bind skeleton is getting on the current call, which may be subject to filtering, scaling, or validation.

mallocback to summary
public static XrHandTrackingScaleFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHandTrackingScaleFB malloc(MemoryStack stack)

Returns a new XrHandTrackingScaleFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncurrentOutputback to summary
public static float ncurrentOutput(long struct)

Unsafe version of currentOutput.

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 *
nextback to summary
public XrHandTrackingScaleFB next(long value)

Sets the specified value to the next field.

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.

noverrideHandScaleback to summary
public static int noverrideHandScale(long struct)

Unsafe version of overrideHandScale.

noverrideValueInputback to summary
public static float noverrideValueInput(long struct)

Unsafe version of overrideValueInput.

nsensorOutputback to summary
public static float nsensorOutput(long struct)

Unsafe version of sensorOutput.

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.

overrideHandScaleback to summary
public boolean overrideHandScale()

indicates whether the runtime should scale the output of this LocateHandJointsEXT call according to overrideValueInput

Annotations
@NativeType:XrBool32
overrideValueInputback to summary
public float overrideValueInput()

an optional input value, enabled only when the overrideHandScale parameter is set. Setting this to 1.0 and setting overrideHandScale to true will give the joints in mesh binding scale.

sensorOutputback to summary
public float sensorOutput()

an output value: the currently measured scale as would be applied without passing this structure.

setback to summary
public XrHandTrackingScaleFB set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrHandTrackingScaleFB set(XrHandTrackingScaleFB src)

Copies the specified struct data to this struct.

Parameters
src:XrHandTrackingScaleFB

the source struct

Returns:XrHandTrackingScaleFB

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 XrHandTrackingScaleFB type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_HAND_TRACKING_SCALE_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrHandTrackingScaleFB.Buffer

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

An array of XrHandTrackingScaleFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrHandTrackingScaleFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHandTrackingScaleFB.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 float

Returns:

the value of the XrHandTrackingScaleFB#currentOutput field.
currentOutput
()

protected XrHandTrackingScaleFB
public long

Returns:

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

public XrHandTrackingScaleFB.Buffer
next(long value)

Sets the specified value to the XrHandTrackingScaleFB#next field.

public boolean
public float
protected XrHandTrackingScaleFB.Buffer
public float

Returns:

the value of the XrHandTrackingScaleFB#sensorOutput field.
sensorOutput
()

public int

Returns:

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

public XrHandTrackingScaleFB.Buffer
type(int value)

Sets the specified value to the XrHandTrackingScaleFB#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHandTrackingScaleFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

currentOutputback to summary
public float currentOutput()
Returns:float

the value of the XrHandTrackingScaleFB#currentOutput field.

getElementFactoryback to summary
protected XrHandTrackingScaleFB getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrHandTrackingScaleFB#next field.

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

Sets the specified value to the XrHandTrackingScaleFB#next field.

overrideHandScaleback to summary
public boolean overrideHandScale()
Returns:boolean

the value of the XrHandTrackingScaleFB#overrideHandScale field.

Annotations
@NativeType:XrBool32
overrideValueInputback to summary
public float overrideValueInput()
Returns:float

the value of the XrHandTrackingScaleFB#overrideValueInput field.

selfback to summary
protected XrHandTrackingScaleFB.Buffer self()

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

Annotations
@Override
sensorOutputback to summary
public float sensorOutput()
Returns:float

the value of the XrHandTrackingScaleFB#sensorOutput field.

typeback to summary
public int type()
Returns:int

the value of the XrHandTrackingScaleFB#type field.

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

Sets the specified value to the XrHandTrackingScaleFB#type field.

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

Sets the TYPE_HAND_TRACKING_SCALE_FB value to the XrHandTrackingScaleFB#type field.