Package org.lwjgl.openxr

Class XrPassthroughKeyboardHandsIntensityFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrPassthroughKeyboardHandsIntensityFB>

org.lwjgl.openxr.XrPassthroughKeyboardHandsIntensityFB

All Implemented Interfaces:

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

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

A struct for setting the level of intensity for hands in the passthrough layer.

Description

XrPassthroughKeyboardHandsIntensityFB describes intensities of passthrough hands, and is used as a parameter to PassthroughLayerSetKeyboardHandsIntensityFB.

Each of the intensity values leftHandIntensity and rightHandIntensity must be in the range [0.0, 1.0]. The hand intensity value represents the level of visibility of rendered hand, the minimal value of the intensity 0.0 represents the fully transparent hand (not visible), the maximal value of 1.0 represented fully opaque hands (maximal visibility).

If either leftHandIntensity or rightHandIntensity is outside the range [0.0, 1.0], the runtime must return ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

• The XR_FB_passthrough_keyboard_hands extension must be enabled prior to using XrPassthroughKeyboardHandsIntensityFB
• type must be TYPE_PASSTHROUGH_KEYBOARD_HANDS_INTENSITY_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

PassthroughLayerSetKeyboardHandsIntensityFB

Layout

 struct XrPassthroughKeyboardHandsIntensityFB {
     XrStructureType type();
     void const * next();
     float leftHandIntensity();
     float rightHandIntensity();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrPassthroughKeyboardHandsIntensityFB.Buffer	An array of XrPassthroughKeyboardHandsIntensityFB 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	LEFTHANDINTENSITY	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	RIGHTHANDINTENSITY	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
XrPassthroughKeyboardHandsIntensityFB(ByteBuffer container)	Creates a XrPassthroughKeyboardHandsIntensityFB instance at the current position of the specified ByteBuffer container.

Method Summary

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

LEFTHANDINTENSITY

public static final int LEFTHANDINTENSITY

The struct member offsets.

RIGHTHANDINTENSITY

public static final int RIGHTHANDINTENSITY

The struct member offsets.

Constructor Details

XrPassthroughKeyboardHandsIntensityFB

public XrPassthroughKeyboardHandsIntensityFB(ByteBuffer container)

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

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.

leftHandIntensity

public float leftHandIntensity()

defines an intensity for the left tracked hand.

rightHandIntensity

public float rightHandIntensity()

defines an intensity for the right tracked hand.

type

public XrPassthroughKeyboardHandsIntensityFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrPassthroughKeyboardHandsIntensityFB type$Default()

Sets the TYPE_PASSTHROUGH_KEYBOARD_HANDS_INTENSITY_FB value to the type() field.

next

public XrPassthroughKeyboardHandsIntensityFB next(long value)

Sets the specified value to the next() field.

leftHandIntensity

public XrPassthroughKeyboardHandsIntensityFB leftHandIntensity(float value)

Sets the specified value to the leftHandIntensity() field.

rightHandIntensity

public XrPassthroughKeyboardHandsIntensityFB rightHandIntensity(float value)

Sets the specified value to the rightHandIntensity() field.

set

public XrPassthroughKeyboardHandsIntensityFB set(int type,
 long next,
 float leftHandIntensity,
 float rightHandIntensity)

Initializes this struct with the specified values.

set

public XrPassthroughKeyboardHandsIntensityFB set(XrPassthroughKeyboardHandsIntensityFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrPassthroughKeyboardHandsIntensityFB malloc()

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

calloc

public static XrPassthroughKeyboardHandsIntensityFB calloc()

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

create

public static XrPassthroughKeyboardHandsIntensityFB create()

Returns a new XrPassthroughKeyboardHandsIntensityFB instance allocated with BufferUtils.

create

public static XrPassthroughKeyboardHandsIntensityFB create(long address)

Returns a new XrPassthroughKeyboardHandsIntensityFB instance for the specified memory address.

createSafe

public static @Nullable XrPassthroughKeyboardHandsIntensityFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrPassthroughKeyboardHandsIntensityFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrPassthroughKeyboardHandsIntensityFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrPassthroughKeyboardHandsIntensityFB.Buffer create(int capacity)

Returns a new XrPassthroughKeyboardHandsIntensityFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrPassthroughKeyboardHandsIntensityFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrPassthroughKeyboardHandsIntensityFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nleftHandIntensity

public static float nleftHandIntensity(long struct)

Unsafe version of leftHandIntensity().

nrightHandIntensity

public static float nrightHandIntensity(long struct)

Unsafe version of rightHandIntensity().

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.

nleftHandIntensity

public static void nleftHandIntensity(long struct,
 float value)

Unsafe version of leftHandIntensity.

nrightHandIntensity

public static void nrightHandIntensity(long struct,
 float value)

Unsafe version of rightHandIntensity.