Class XrInteractionProfileAnalogThresholdVALVE
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrInteractionProfileAnalogThresholdVALVE
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrInteractionProfileAnalogThresholdVALVE extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceInteraction profile dpad binding.Description
Applications can also chain a single
XrInteractionProfileAnalogThresholdVALVEstructure on the next chain of anySuggestInteractionProfileBindingscall. Runtimes must support this kind of chaining. This method of specifying analog thresholds is deprecated however, and should not be used by any new applications.If a threshold struct is present for a given conversion, the runtime must use those thresholds instead of applying its own whenever it is using the binding suggested by the application.
onThresholdandoffThresholdpermit allow the application to specify that it wants hysteresis to be applied to the threshold operation. IfonThresholdis smaller thanoffThreshold, the runtime must returnERROR_VALIDATION_FAILURE.onHapticandoffHapticallow the application to specify that it wants automatic haptic feedback to be generated when the boolean output of the threshold operation changes from false to true or vice versa. If these fields are not NULL, the runtime must trigger a haptic output with the specified characteristics. If the device has multiple haptic outputs, the runtime should use the haptic output that is most appropriate for the specified input path.If a suggested binding with
actionandbindingis not in the binding list for this interaction profile, the runtime must returnERROR_PATH_UNSUPPORTED.Valid Usage (Implicit)
- The
XR_VALVE_analog_thresholdextension must be enabled prior to usingXrInteractionProfileAnalogThresholdVALVE typemust beTYPE_INTERACTION_PROFILE_ANALOG_THRESHOLD_VALVEnextmust beNULLor a valid pointer to the next structure in a structure chainactionmust be a validXrActionhandle- If
onHapticis notNULL,onHapticmust be a pointer to a validXrHapticBaseHeader-based structure. See also:XrHapticVibration - If
offHapticis notNULL,offHapticmust be a pointer to a validXrHapticBaseHeader-based structure. See also:XrHapticVibration
See Also
Layout
struct XrInteractionProfileAnalogThresholdVALVE { XrStructureTypetype(); void const *next(); XrActionaction(); XrPathbinding(); floatonThreshold(); floatoffThreshold();XrHapticBaseHeaderconst *onHaptic();XrHapticBaseHeaderconst *offHaptic(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrInteractionProfileAnalogThresholdVALVE.BufferAn array ofXrInteractionProfileAnalogThresholdVALVEstructs.
-
Field Summary
Fields Modifier and Type Field Description static intACTIONThe struct member offsets.static intALIGNOFThe struct alignment in bytes.static intBINDING
NEXT
OFFHAPTIC
OFFTHRESHOLD
ONHAPTIC
ONTHRESHOLDThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrInteractionProfileAnalogThresholdVALVE(java.nio.ByteBuffer container)Creates aXrInteractionProfileAnalogThresholdVALVEinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description longaction()the handle of an action in the suggested binding list.XrInteractionProfileAnalogThresholdVALVEaction(XrAction value)Sets the specified value to theaction()field.longbinding()the input path used for the specified action in the suggested binding list.XrInteractionProfileAnalogThresholdVALVEbinding(long value)Sets the specified value to thebinding()field.static XrInteractionProfileAnalogThresholdVALVEcalloc()Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withmemCalloc.static XrInteractionProfileAnalogThresholdVALVE.Buffercalloc(int capacity)Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withmemCalloc.static XrInteractionProfileAnalogThresholdVALVE.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrInteractionProfileAnalogThresholdVALVEcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrInteractionProfileAnalogThresholdVALVEcreate()Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withBufferUtils.static XrInteractionProfileAnalogThresholdVALVE.Buffercreate(int capacity)Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withBufferUtils.static XrInteractionProfileAnalogThresholdVALVEcreate(long address)Returns a newXrInteractionProfileAnalogThresholdVALVEinstance for the specified memory address.static XrInteractionProfileAnalogThresholdVALVE.Buffercreate(long address, int capacity)Create aXrInteractionProfileAnalogThresholdVALVE.Bufferinstance at the specified memory.static XrInteractionProfileAnalogThresholdVALVEcreate(XrBindingModificationBaseHeaderKHR value)Downcasts the specifiedXrBindingModificationBaseHeaderKHRinstance toXrInteractionProfileAnalogThresholdVALVE.static XrInteractionProfileAnalogThresholdVALVE.Buffercreate(XrBindingModificationBaseHeaderKHR.Buffer value)Downcasts the specifiedXrBindingModificationBaseHeaderKHR.Bufferinstance toXrInteractionProfileAnalogThresholdVALVE.Buffer.static XrInteractionProfileAnalogThresholdVALVEcreateSafe(long address)static XrInteractionProfileAnalogThresholdVALVE.BuffercreateSafe(long address, int capacity)static XrInteractionProfileAnalogThresholdVALVEmalloc()Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withmemAlloc.static XrInteractionProfileAnalogThresholdVALVE.Buffermalloc(int capacity)Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withmemAlloc.static XrInteractionProfileAnalogThresholdVALVE.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated on the specifiedMemoryStack.static XrInteractionProfileAnalogThresholdVALVEmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated on the specifiedMemoryStack.static longnaction(long struct)Unsafe version ofaction().static voidnaction(long struct, XrAction value)Unsafe version ofaction.static longnbinding(long struct)Unsafe version ofbinding().static voidnbinding(long struct, long value)Unsafe version ofbinding.longnext()NULLor a pointer to the next structure in a structure chain.XrInteractionProfileAnalogThresholdVALVEnext(long value)Sets the specified value to thenext()field.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static XrHapticBaseHeadernoffHaptic(long struct)Unsafe version ofoffHaptic().static voidnoffHaptic(long struct, XrHapticBaseHeader value)Unsafe version ofoffHaptic.static floatnoffThreshold(long struct)Unsafe version ofoffThreshold().static voidnoffThreshold(long struct, float value)Unsafe version ofoffThreshold.static XrHapticBaseHeadernonHaptic(long struct)Unsafe version ofonHaptic().static voidnonHaptic(long struct, XrHapticBaseHeader value)Unsafe version ofonHaptic.static floatnonThreshold(long struct)Unsafe version ofonThreshold().static voidnonThreshold(long struct, float value)Unsafe version ofonThreshold.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrHapticBaseHeaderoffHaptic()the haptic output that the runtime must trigger when the binding changes from true to false.XrInteractionProfileAnalogThresholdVALVEoffHaptic(XrHapticBaseHeader value)Sets the address of the specifiedXrHapticBaseHeaderto theoffHaptic()field.floatoffThreshold()the value between 0.0 and 1.0 at which the runtime must consider the binding to be false if it was previous true.XrInteractionProfileAnalogThresholdVALVEoffThreshold(float value)Sets the specified value to theoffThreshold()field.XrHapticBaseHeaderonHaptic()the haptic output that the runtime must trigger when the binding changes from false to true.XrInteractionProfileAnalogThresholdVALVEonHaptic(XrHapticBaseHeader value)Sets the address of the specifiedXrHapticBaseHeaderto theonHaptic()field.floatonThreshold()the value between 0.0 and 1.0 at which the runtime must consider the binding to be true.XrInteractionProfileAnalogThresholdVALVEonThreshold(float value)Sets the specified value to theonThreshold()field.XrInteractionProfileAnalogThresholdVALVEset(int type, long next, XrAction action, long binding, float onThreshold, float offThreshold, XrHapticBaseHeader onHaptic, XrHapticBaseHeader offHaptic)Initializes this struct with the specified values.XrInteractionProfileAnalogThresholdVALVEset(XrInteractionProfileAnalogThresholdVALVE src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrInteractionProfileAnalogThresholdVALVEtype(int value)Sets the specified value to thetype()field.XrInteractionProfileAnalogThresholdVALVEtype$Default()Sets theTYPE_INTERACTION_PROFILE_ANALOG_THRESHOLD_VALVEvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrInteractionProfileAnalogThresholdVALVE
public XrInteractionProfileAnalogThresholdVALVE(java.nio.ByteBuffer container)
Creates aXrInteractionProfileAnalogThresholdVALVEinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.
-
action
public long action()
the handle of an action in the suggested binding list.
-
binding
public long binding()
the input path used for the specified action in the suggested binding list.
-
onThreshold
public float onThreshold()
the value between 0.0 and 1.0 at which the runtime must consider the binding to be true. The binding must remain true until the input analog value falls belowoffThreshold.
-
offThreshold
public float offThreshold()
the value between 0.0 and 1.0 at which the runtime must consider the binding to be false if it was previous true.
-
onHaptic
@Nullable public XrHapticBaseHeader onHaptic()
the haptic output that the runtime must trigger when the binding changes from false to true. If this field is NULL, the runtime must not trigger any haptic output on the threshold. This field can point to any supported sub-type ofXrHapticBaseHeader.
-
offHaptic
@Nullable public XrHapticBaseHeader offHaptic()
the haptic output that the runtime must trigger when the binding changes from true to false. If this field is NULL, the runtime must not trigger any haptic output on the threshold. This field can point to any supported sub-type ofXrHapticBaseHeader.
-
type
public XrInteractionProfileAnalogThresholdVALVE type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrInteractionProfileAnalogThresholdVALVE type$Default()
Sets theTYPE_INTERACTION_PROFILE_ANALOG_THRESHOLD_VALVEvalue to thetype()field.
-
next
public XrInteractionProfileAnalogThresholdVALVE next(long value)
Sets the specified value to thenext()field.
-
action
public XrInteractionProfileAnalogThresholdVALVE action(XrAction value)
Sets the specified value to theaction()field.
-
binding
public XrInteractionProfileAnalogThresholdVALVE binding(long value)
Sets the specified value to thebinding()field.
-
onThreshold
public XrInteractionProfileAnalogThresholdVALVE onThreshold(float value)
Sets the specified value to theonThreshold()field.
-
offThreshold
public XrInteractionProfileAnalogThresholdVALVE offThreshold(float value)
Sets the specified value to theoffThreshold()field.
-
onHaptic
public XrInteractionProfileAnalogThresholdVALVE onHaptic(@Nullable XrHapticBaseHeader value)
Sets the address of the specifiedXrHapticBaseHeaderto theonHaptic()field.
-
offHaptic
public XrInteractionProfileAnalogThresholdVALVE offHaptic(@Nullable XrHapticBaseHeader value)
Sets the address of the specifiedXrHapticBaseHeaderto theoffHaptic()field.
-
set
public XrInteractionProfileAnalogThresholdVALVE set(int type, long next, XrAction action, long binding, float onThreshold, float offThreshold, @Nullable XrHapticBaseHeader onHaptic, @Nullable XrHapticBaseHeader offHaptic)
Initializes this struct with the specified values.
-
set
public XrInteractionProfileAnalogThresholdVALVE set(XrInteractionProfileAnalogThresholdVALVE src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrInteractionProfileAnalogThresholdVALVE malloc()
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrInteractionProfileAnalogThresholdVALVE calloc()
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrInteractionProfileAnalogThresholdVALVE create()
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated withBufferUtils.
-
create
public static XrInteractionProfileAnalogThresholdVALVE create(long address)
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance for the specified memory address.
-
createSafe
@Nullable public static XrInteractionProfileAnalogThresholdVALVE createSafe(long address)
-
create
public static XrInteractionProfileAnalogThresholdVALVE create(XrBindingModificationBaseHeaderKHR value)
Downcasts the specifiedXrBindingModificationBaseHeaderKHRinstance toXrInteractionProfileAnalogThresholdVALVE.
-
malloc
public static XrInteractionProfileAnalogThresholdVALVE.Buffer malloc(int capacity)
Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrInteractionProfileAnalogThresholdVALVE.Buffer calloc(int capacity)
Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrInteractionProfileAnalogThresholdVALVE.Buffer create(int capacity)
Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrInteractionProfileAnalogThresholdVALVE.Buffer create(long address, int capacity)
Create aXrInteractionProfileAnalogThresholdVALVE.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrInteractionProfileAnalogThresholdVALVE.Buffer createSafe(long address, int capacity)
-
create
public static XrInteractionProfileAnalogThresholdVALVE.Buffer create(XrBindingModificationBaseHeaderKHR.Buffer value)
Downcasts the specifiedXrBindingModificationBaseHeaderKHR.Bufferinstance toXrInteractionProfileAnalogThresholdVALVE.Buffer.
-
malloc
public static XrInteractionProfileAnalogThresholdVALVE malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrInteractionProfileAnalogThresholdVALVE calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrInteractionProfileAnalogThresholdVALVEinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrInteractionProfileAnalogThresholdVALVE.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrInteractionProfileAnalogThresholdVALVE.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrInteractionProfileAnalogThresholdVALVE.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
naction
public static long naction(long struct)
Unsafe version ofaction().
-
nbinding
public static long nbinding(long struct)
Unsafe version ofbinding().
-
nonThreshold
public static float nonThreshold(long struct)
Unsafe version ofonThreshold().
-
noffThreshold
public static float noffThreshold(long struct)
Unsafe version ofoffThreshold().
-
nonHaptic
@Nullable public static XrHapticBaseHeader nonHaptic(long struct)
Unsafe version ofonHaptic().
-
noffHaptic
@Nullable public static XrHapticBaseHeader noffHaptic(long struct)
Unsafe version ofoffHaptic().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nbinding
public static void nbinding(long struct, long value)Unsafe version ofbinding.
-
nonThreshold
public static void nonThreshold(long struct, float value)Unsafe version ofonThreshold.
-
noffThreshold
public static void noffThreshold(long struct, float value)Unsafe version ofoffThreshold.
-
nonHaptic
public static void nonHaptic(long struct, @Nullable XrHapticBaseHeader value)Unsafe version ofonHaptic.
-
noffHaptic
public static void noffHaptic(long struct, @Nullable XrHapticBaseHeader value)Unsafe version ofoffHaptic.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-