OpenXR.Core10.Input

Documentation

getActionStateBoolean

Arguments

:: forall io. MonadIO io

=> Session

session is the Session to query.

session must be a valid Session handle

-> ActionStateGetInfo

getInfo is a pointer to ActionStateGetInfo to provide action and subaction paths information.

getInfo must be a pointer to a valid ActionStateGetInfo structure

-> io (Result, ActionStateBoolean)

xrGetActionStateBoolean - Gets boolean action state

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

ActionStateBoolean, ActionStateGetInfo, Session, createAction

getActionStateFloat

Arguments

:: forall io. MonadIO io

=> Session

session is the Session to query.

session must be a valid Session handle

-> ActionStateGetInfo

getInfo is a pointer to ActionStateGetInfo to provide action and subaction paths information.

getInfo must be a pointer to a valid ActionStateGetInfo structure

-> io (Result, ActionStateFloat)

xrGetActionStateFloat - Gets a floating point action state

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

ActionStateFloat, ActionStateGetInfo, Session, createAction

getActionStateVector2f

Arguments

:: forall io. MonadIO io

=> Session

session is the Session to query.

session must be a valid Session handle

-> ActionStateGetInfo

getInfo is a pointer to ActionStateGetInfo to provide action and subaction paths information.

getInfo must be a pointer to a valid ActionStateGetInfo structure

-> io (Result, ActionStateVector2f)

xrGetActionStateVector2f - Gets 2D float vector action state

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

ActionStateGetInfo, ActionStateVector2f, Session, createAction

getActionStatePose

Arguments

:: forall io. MonadIO io

=> Session

session is the Session to query.

session must be a valid Session handle

-> ActionStateGetInfo

getInfo is a pointer to ActionStateGetInfo to provide action and subaction paths information.

getInfo must be a pointer to a valid ActionStateGetInfo structure

-> io (Result, ActionStatePose)

xrGetActionStatePose - Gets metadata from a pose action

Parameter Descriptions

Description

getActionStatePose returns information about the binding and active state for the specified action. To determine the pose of this action at a historical or predicted time, the application can create an action space using createActionSpace. Then, after each sync, the application can locate the pose of this action space within a base space using locateSpace.

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

ActionStateGetInfo, ActionStatePose, Session, createAction, createActionSpace

createActionSet

Arguments

:: forall io. MonadIO io

=> Instance

instance is a handle to an Instance.

instance must be a valid Instance handle

-> ActionSetCreateInfo

createInfo is a pointer to a valid ActionSetCreateInfo structure that defines the action set being created.

createInfo must be a pointer to a valid ActionSetCreateInfo structure

-> io ActionSet

xrCreateActionSet - Creates an XrActionSet

Parameter Descriptions

Description

The createActionSet function creates an action set and returns a handle to the created action set.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_LIMIT_REACHED
• ERROR_HANDLE_INVALID
• ERROR_OUT_OF_MEMORY
• ERROR_VALIDATION_FAILURE
• ERROR_NAME_DUPLICATED
• ERROR_LOCALIZED_NAME_DUPLICATED
• ERROR_NAME_INVALID
• ERROR_LOCALIZED_NAME_INVALID
• ERROR_PATH_FORMAT_INVALID

See Also

ActionSet, ActionSetCreateInfo, Instance, destroyActionSet

withActionSet :: forall io r. MonadIO io => Instance -> ActionSetCreateInfo -> (io ActionSet -> (ActionSet -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createActionSet and destroyActionSet

To ensure that destroyActionSet is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyActionSet

Arguments

:: forall io. MonadIO io

=> ActionSet

actionSet is the action set to destroy.

-> io ()

xrDestroyActionSet - Destroys an XrActionSet

Parameter Descriptions

Description

Action set handles can be destroyed by calling destroyActionSet. When an action set handle is destroyed, all handles of actions in that action set are also destroyed.

The implementation must not free underlying resources for the action set while there are other valid handles that refer to those resources. The implementation may release resources for an action set when all of the action spaces for actions in that action set have been destroyed. See Action Spaces Lifetime for details.

Resources for all action sets in an instance must be freed when the instance containing those actions sets is destroyed.

Valid Usage (Implicit)

• actionSet must be a valid ActionSet handle

Thread Safety

• Access to actionSet, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID

See Also

ActionSet, createActionSet

createAction

Arguments

:: forall io. MonadIO io

=> ActionSet

actionSet is a handle to an ActionSet.

actionSet must be a valid ActionSet handle

-> ActionCreateInfo

createInfo is a pointer to a valid ActionCreateInfo structure that defines the action being created.

createInfo must be a pointer to a valid ActionCreateInfo structure

-> io Action

xrCreateAction - Creates an XrAction

Parameter Descriptions

Description

createAction creates an action and returns its handle.

If actionSet has been included in a call to attachSessionActionSets, the implementation must return ERROR_ACTIONSETS_ALREADY_ATTACHED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_ACTIONSETS_ALREADY_ATTACHED
• ERROR_LIMIT_REACHED
• ERROR_HANDLE_INVALID
• ERROR_OUT_OF_MEMORY
• ERROR_PATH_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_NAME_DUPLICATED
• ERROR_LOCALIZED_NAME_DUPLICATED
• ERROR_NAME_INVALID
• ERROR_LOCALIZED_NAME_INVALID
• ERROR_PATH_FORMAT_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

Action, ActionCreateInfo, ActionSet, ActionType, destroyAction

withAction :: forall io r. MonadIO io => ActionSet -> ActionCreateInfo -> (io Action -> (Action -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createAction and destroyAction

To ensure that destroyAction is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroyAction

Arguments

:: forall io. MonadIO io

=> Action

action is the action to destroy.

-> io ()

xrDestroyAction - Destroys an XrAction

Parameter Descriptions

Description

Action handles can be destroyed by calling destroyAction. Handles for actions that are part of an action set are automatically destroyed when the action set’s handle is destroyed.

The implementation must not destroy the underlying resources for an action when destroyAction is called. Those resources are still used to make action spaces locatable and when processing action priority in syncActions. Destroying the action handle removes the application’s access to these resources, but has no other change on actions.

Resources for all actions in an instance must be freed when the instance containing those actions sets is destroyed.

Valid Usage (Implicit)

• action must be a valid Action handle

Thread Safety

• Access to action, and any child handles, must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID

See Also

Action, createAction

suggestInteractionProfileBindings

Arguments

:: forall a io. (Extendss InteractionProfileSuggestedBinding a, PokeChain a, MonadIO io)

=> Instance

instance is the Instance for which the application would like to set suggested bindings

instance must be a valid Instance handle

-> ("suggestedBindings" ::: InteractionProfileSuggestedBinding a)

suggestedBindings is the InteractionProfileSuggestedBinding that the application would like to set

suggestedBindings must be a pointer to a valid InteractionProfileSuggestedBinding structure

-> io ()

xrSuggestInteractionProfileBindings - Sets the application-suggested bindings for the interaction profile

Parameter Descriptions

Description

suggestInteractionProfileBindings sets an interaction profile for which the application can provide default bindings. The application can call suggestInteractionProfileBindings once per interaction profile that it supports.

The application can provide any number of bindings for each action.

If the application successfully calls suggestInteractionProfileBindings more than once for an interaction profile, the runtime must discard the previous suggested bindings and replace them with the new suggested bindings for that profile.

If the interaction profile path does not follow the structure defined in Interaction Profiles or suggested bindings contain paths that do not follow the format defined in Device input subpaths, the runtime must return ERROR_PATH_UNSUPPORTED. If the interaction profile or input source for any of the suggested bindings does not exist in the allowlist defined in Interaction Profile Paths, the runtime must return ERROR_PATH_UNSUPPORTED. A runtime must accept every valid binding in the allowlist though it is free to ignore any of them.

If the action set for any action referenced in the suggestedBindings parameter has been included in a call to attachSessionActionSets, the implementation must return ERROR_ACTIONSETS_ALREADY_ATTACHED.

Return Codes

Success

• SUCCESS

Failure

• ERROR_INSTANCE_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_ACTIONSETS_ALREADY_ATTACHED
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_UNSUPPORTED
• ERROR_PATH_INVALID

See Also

Instance, InteractionProfileSuggestedBinding

attachSessionActionSets

Arguments

:: forall io. MonadIO io

=> Session

session is the Session to attach the action sets to.

session must be a valid Session handle

-> SessionActionSetsAttachInfo

attachInfo is the SessionActionSetsAttachInfo to provide information to attach action sets to the session.

attachInfo must be a pointer to a valid SessionActionSetsAttachInfo structure

-> io Result

xrAttachSessionActionSets - Attaches action sets to a given session

Parameter Descriptions

Description

attachSessionActionSets attaches the ActionSet handles in attachInfo.actionSets to the session. Action sets must be attached in order to be synchronized with syncActions.

When an action set is attached to a session, that action set becomes immutable. See createAction and suggestInteractionProfileBindings for details.

The runtime must return ERROR_ACTIONSETS_ALREADY_ATTACHED if attachSessionActionSets is called more than once for a given session. The runtime must return ERROR_ACTIONSET_NOT_ATTACHED for any action created after attachSessionActionSets is called for a given session if that handle is used with any call for the same session.

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_ACTIONSETS_ALREADY_ATTACHED

See Also

Session, SessionActionSetsAttachInfo

getCurrentInteractionProfile

Arguments

:: forall io. MonadIO io

=> Session

session is the Session for which the application would like to retrieve the current interaction profile.

session must be a valid Session handle

-> ("topLevelUserPath" ::: Path)

topLevelUserPath is the top level user path the application would like to retrieve the interaction profile for.

-> io (Result, InteractionProfileState)

xrGetCurrentInteractionProfile - Gets the current interaction profile for a top level user paths

Parameter Descriptions

Description

getCurrentInteractionProfile asks the runtime for the active interaction profiles for a top level user path.

The runtime must return only interaction profiles for which the application has provided bindings with suggestInteractionProfileBindings. The runtime may return interaction profiles that do not represent physically present hardware, for example if the runtime is using a known interaction profile to bind to hardware that the application is not aware of. The runtime may return the last-known interaction profile in the event that no controllers are active.

If attachSessionActionSets has not yet been called for the session, the runtime must return ERROR_ACTIONSET_NOT_ATTACHED. If topLevelUserPath is not one of the device input subpaths described in section /user paths, the runtime must return ERROR_PATH_UNSUPPORTED.

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_UNSUPPORTED
• ERROR_PATH_INVALID

See Also

InteractionProfileState, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, Session

syncActions

Arguments

:: forall io. MonadIO io

=> Session

session is a handle to the Session that all provided action set handles belong to.

session must be a valid Session handle

-> ActionsSyncInfo

syncInfo is an ActionsSyncInfo providing information to synchronize action states.

syncInfo must be a pointer to a valid ActionsSyncInfo structure

-> io Result

xrSyncActions - Updates the current state of input actions

Parameter Descriptions

Description

syncActions updates the current state of input actions. Repeated input action state queries between subsequent synchronization calls must return the same values. The ActionSet structures referenced in the syncInfo.activeActionSets must have been previously attached to the session via attachSessionActionSets. If any action sets not attached to this session are passed to syncActions it must return ERROR_ACTIONSET_NOT_ATTACHED. Subsets of the bound action sets can be synchronized in order to control which actions are seen as active.

If session is not focused, the runtime must return SESSION_NOT_FOCUSED, and all action states in the session must be inactive.

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING
• SESSION_NOT_FOCUSED

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED

See Also

ActionSet, ActionsSyncInfo, ActiveActionSet, Session

enumerateBoundSourcesForAction :: forall io. MonadIO io => Session -> BoundSourcesForActionEnumerateInfo -> io (Result, "sources" ::: Vector Path)

xrEnumerateBoundSourcesForAction - Queries the bound input sources for an action

Parameter Descriptions

• session is the Session being queried.

• enumerateInfo is an BoundSourcesForActionEnumerateInfo providing the query information.
• sourceCapacityInput is the capacity of the array, or 0 to indicate a request to retrieve the required capacity.
• sourceCountOutput is a pointer to the count of sources, or a pointer to the required capacity in the case that sourceCapacityInput is 0.
• sources is a pointer to an application-allocated array that will be filled with the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath values for all sources. It can be NULL if sourceCapacityInput is 0.
• See Buffer Size Parameters chapter for a detailed description of retrieving the required sources size.

Description

If an action is unbound, enumerateBoundSourcesForAction must assign 0 to the value pointed-to by sourceCountOutput and not modify the array.

enumerateBoundSourcesForAction must return ERROR_ACTIONSET_NOT_ATTACHED if passed an action in an action set never attached to the session with attachSessionActionSets.

Valid Usage (Implicit)

• session must be a valid Session handle

• enumerateInfo must be a pointer to a valid BoundSourcesForActionEnumerateInfo structure
• sourceCountOutput must be a pointer to a uint32_t value
• If sourceCapacityInput is not 0, sources must be a pointer to an array of sourceCapacityInput https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath values

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_ACTIONSET_NOT_ATTACHED
• ERROR_SIZE_INSUFFICIENT
• ERROR_VALIDATION_FAILURE
• ERROR_PATH_INVALID

See Also

Action, BoundSourcesForActionEnumerateInfo, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, Session

getInputSourceLocalizedName :: forall io. MonadIO io => Session -> InputSourceLocalizedNameGetInfo -> io (Result, "buffer" ::: ByteString)

xrGetInputSourceLocalizedName - Gets a localized source name

Parameter Descriptions

• session is a handle to the Session associated with the action that reported this source.

• getInfo is an InputSourceLocalizedNameGetInfo providing the query information.
• bufferCapacityInput is the capacity of the buffer, or 0 to indicate a request to retrieve the required capacity.
• bufferCountOutput is a pointer to the count of name characters written (including the terminating \0), or a pointer to the required capacity in the case that bufferCapacityInput is 0.
• buffer is a pointer to an application-allocated buffer that will be filled with the source name. It can be NULL if bufferCapacityInput is 0.
• See Buffer Size Parameters chapter for a detailed description of retrieving the required buffer size.

Description

getInputSourceLocalizedName returns a string for the input source in the current system locale.

If attachSessionActionSets has not yet been called for the session, the runtime must return ERROR_ACTIONSET_NOT_ATTACHED.

Valid Usage (Implicit)

• session must be a valid Session handle

• getInfo must be a pointer to a valid InputSourceLocalizedNameGetInfo structure
• bufferCountOutput must be a pointer to a uint32_t value
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput char values

Return Codes

Success

• SUCCESS
• SESSION_LOSS_PENDING

Failure

• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_VALIDATION_FAILURE
• ERROR_SIZE_INSUFFICIENT
• ERROR_PATH_INVALID
• ERROR_PATH_UNSUPPORTED
• ERROR_ACTIONSET_NOT_ATTACHED

See Also

Action, InputSourceLocalizedNameGetInfo, Session

data Vector2f

XrVector2f - Two-dimensional vector

Member Descriptions

Description

If used to represent physical distances (rather than e.g. normalized direction) and not otherwise specified, values must be in meters.

See Also

ActionStateVector2f, CompositionLayerEquirectKHR, Posef, Quaternionf, Vector3f, Vector4f, VisibilityMaskKHR, xrSetInputDeviceStateVector2fEXT

Constructors

Vector2f

Fields

• x :: Float

  x is the x coordinate of the vector.

• y :: Float

  y is the y coordinate of the vector.

Instances

Eq Vector2f

Defined in OpenXR.Core10.Input

Methods

(==) :: Vector2f -> Vector2f -> Bool

(/=) :: Vector2f -> Vector2f -> Bool

Show Vector2f

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> Vector2f -> ShowS

show :: Vector2f -> String

showList :: [Vector2f] -> ShowS

Storable Vector2f

Defined in OpenXR.Core10.Input

Methods

sizeOf :: Vector2f -> Int

alignment :: Vector2f -> Int

peekElemOff :: Ptr Vector2f -> Int -> IO Vector2f

pokeElemOff :: Ptr Vector2f -> Int -> Vector2f -> IO ()

peekByteOff :: Ptr b -> Int -> IO Vector2f

pokeByteOff :: Ptr b -> Int -> Vector2f -> IO ()

peek :: Ptr Vector2f -> IO Vector2f

poke :: Ptr Vector2f -> Vector2f -> IO ()

Zero Vector2f

Defined in OpenXR.Core10.Input

Methods

zero :: Vector2f

ToCStruct Vector2f

Defined in OpenXR.Core10.Input

Methods

withCStruct :: Vector2f -> (Ptr Vector2f -> IO b) -> IO b

pokeCStruct :: Ptr Vector2f -> Vector2f -> IO b -> IO b

withZeroCStruct :: (Ptr Vector2f -> IO b) -> IO b

pokeZeroCStruct :: Ptr Vector2f -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct Vector2f

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr Vector2f -> IO Vector2f

data ActionStateBoolean

XrActionStateBoolean - Boolean action state

Member Descriptions

Description

When multiple input sources are bound to this action, the currentState follows the previously defined rule to resolve ambiguity.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, getActionStateBoolean

Constructors

ActionStateBoolean

Fields

• currentState :: Bool

  currentState is the current state of the action.

• changedSinceLastSync :: Bool

  changedSinceLastSync is TRUE if the value of currentState is different than it was before the most recent call to syncActions. This parameter can be combined with currentState to detect rising and falling edges since the previous call to syncActions. E.g. if both changedSinceLastSync and currentState are TRUE then a rising edge (FALSE to TRUE) has taken place.

• lastChangeTime :: Time

  lastChangeTime is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime when this action’s value last changed.

• isActive :: Bool

  isActive is TRUE if and only if there exists an input source that is contributing to the current state of this action.

Instances

Eq ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

(==) :: ActionStateBoolean -> ActionStateBoolean -> Bool

(/=) :: ActionStateBoolean -> ActionStateBoolean -> Bool

Show ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionStateBoolean -> ShowS

show :: ActionStateBoolean -> String

showList :: [ActionStateBoolean] -> ShowS

Storable ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionStateBoolean -> Int

alignment :: ActionStateBoolean -> Int

peekElemOff :: Ptr ActionStateBoolean -> Int -> IO ActionStateBoolean

pokeElemOff :: Ptr ActionStateBoolean -> Int -> ActionStateBoolean -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionStateBoolean

pokeByteOff :: Ptr b -> Int -> ActionStateBoolean -> IO ()

peek :: Ptr ActionStateBoolean -> IO ActionStateBoolean

poke :: Ptr ActionStateBoolean -> ActionStateBoolean -> IO ()

Zero ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

zero :: ActionStateBoolean

ToCStruct ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionStateBoolean -> (Ptr ActionStateBoolean -> IO b) -> IO b

pokeCStruct :: Ptr ActionStateBoolean -> ActionStateBoolean -> IO b -> IO b

withZeroCStruct :: (Ptr ActionStateBoolean -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionStateBoolean -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionStateBoolean

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionStateBoolean -> IO ActionStateBoolean

data ActionStateFloat

XrActionStateFloat - Floating point action state

Member Descriptions

Description

When multiple input sources are bound to this action, the currentState follows the previously defined rule to resolve ambiguity.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, getActionStateFloat

Constructors

ActionStateFloat

Fields

• currentState :: Float

  currentState is the current state of the Action.

• changedSinceLastSync :: Bool

  changedSinceLastSync is TRUE if the value of currentState is different than it was before the most recent call to syncActions.

• lastChangeTime :: Time

  lastChangeTime is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime in nanoseconds since this action’s value last changed.

• isActive :: Bool

  isActive is TRUE if and only if there exists an input source that is contributing to the current state of this action.

Instances

Eq ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

(==) :: ActionStateFloat -> ActionStateFloat -> Bool

(/=) :: ActionStateFloat -> ActionStateFloat -> Bool

Show ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionStateFloat -> ShowS

show :: ActionStateFloat -> String

showList :: [ActionStateFloat] -> ShowS

Storable ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionStateFloat -> Int

alignment :: ActionStateFloat -> Int

peekElemOff :: Ptr ActionStateFloat -> Int -> IO ActionStateFloat

pokeElemOff :: Ptr ActionStateFloat -> Int -> ActionStateFloat -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionStateFloat

pokeByteOff :: Ptr b -> Int -> ActionStateFloat -> IO ()

peek :: Ptr ActionStateFloat -> IO ActionStateFloat

poke :: Ptr ActionStateFloat -> ActionStateFloat -> IO ()

Zero ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

zero :: ActionStateFloat

ToCStruct ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionStateFloat -> (Ptr ActionStateFloat -> IO b) -> IO b

pokeCStruct :: Ptr ActionStateFloat -> ActionStateFloat -> IO b -> IO b

withZeroCStruct :: (Ptr ActionStateFloat -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionStateFloat -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionStateFloat

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionStateFloat -> IO ActionStateFloat

data ActionStateVector2f

XrActionStateVector2f - 2D float vector action state

Member Descriptions

Description

When multiple input sources are bound to this action, the currentState follows the previously defined rule to resolve ambiguity.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, Vector2f, getActionStateVector2f

Constructors

ActionStateVector2f

Fields

• currentState :: Vector2f

  currentState is the current Vector2f state of the Action.

• changedSinceLastSync :: Bool

  changedSinceLastSync is TRUE if the value of currentState is different than it was before the most recent call to syncActions.

• lastChangeTime :: Time

  lastChangeTime is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime in nanoseconds since this action’s value last changed.

• isActive :: Bool

  isActive is TRUE if and only if there exists an input source that is contributing to the current state of this action.

Instances

Show ActionStateVector2f

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionStateVector2f -> ShowS

show :: ActionStateVector2f -> String

showList :: [ActionStateVector2f] -> ShowS

Storable ActionStateVector2f

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionStateVector2f -> Int

alignment :: ActionStateVector2f -> Int

peekElemOff :: Ptr ActionStateVector2f -> Int -> IO ActionStateVector2f

pokeElemOff :: Ptr ActionStateVector2f -> Int -> ActionStateVector2f -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionStateVector2f

pokeByteOff :: Ptr b -> Int -> ActionStateVector2f -> IO ()

peek :: Ptr ActionStateVector2f -> IO ActionStateVector2f

poke :: Ptr ActionStateVector2f -> ActionStateVector2f -> IO ()

Zero ActionStateVector2f

Defined in OpenXR.Core10.Input

Methods

zero :: ActionStateVector2f

ToCStruct ActionStateVector2f

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionStateVector2f -> (Ptr ActionStateVector2f -> IO b) -> IO b

pokeCStruct :: Ptr ActionStateVector2f -> ActionStateVector2f -> IO b -> IO b

withZeroCStruct :: (Ptr ActionStateVector2f -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionStateVector2f -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionStateVector2f

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionStateVector2f -> IO ActionStateVector2f

data ActionStatePose

XrActionStatePose - Pose action metadata

Member Descriptions

Description

A pose action must not be bound to multiple input sources, according to the previously defined rule.

Valid Usage (Implicit)

See Also

https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrBool32, StructureType, getActionStatePose

Constructors

ActionStatePose

Fields

• isActive :: Bool

  isActive is TRUE if and only if there exists an input source that is being tracked by this pose action.

Instances

Eq ActionStatePose

Defined in OpenXR.Core10.Input

Methods

(==) :: ActionStatePose -> ActionStatePose -> Bool

(/=) :: ActionStatePose -> ActionStatePose -> Bool

Show ActionStatePose

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionStatePose -> ShowS

show :: ActionStatePose -> String

showList :: [ActionStatePose] -> ShowS

Storable ActionStatePose

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionStatePose -> Int

alignment :: ActionStatePose -> Int

peekElemOff :: Ptr ActionStatePose -> Int -> IO ActionStatePose

pokeElemOff :: Ptr ActionStatePose -> Int -> ActionStatePose -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionStatePose

pokeByteOff :: Ptr b -> Int -> ActionStatePose -> IO ()

peek :: Ptr ActionStatePose -> IO ActionStatePose

poke :: Ptr ActionStatePose -> ActionStatePose -> IO ()

Zero ActionStatePose

Defined in OpenXR.Core10.Input

Methods

zero :: ActionStatePose

ToCStruct ActionStatePose

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionStatePose -> (Ptr ActionStatePose -> IO b) -> IO b

pokeCStruct :: Ptr ActionStatePose -> ActionStatePose -> IO b -> IO b

withZeroCStruct :: (Ptr ActionStatePose -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionStatePose -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionStatePose

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionStatePose -> IO ActionStatePose

data ActionStateGetInfo

XrActionStateGetInfo - Information to get action state

Member Descriptions

Description

See ActionCreateInfo for a description of subaction paths, and the restrictions on their use.

Valid Usage (Implicit)

See Also

Action, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, StructureType, getActionStateBoolean, getActionStateFloat, getActionStatePose, getActionStateVector2f

Constructors

ActionStateGetInfo

Fields

• action :: Ptr Action_T

  action is the Action being queried.

  action must be a valid Action handle

• subactionPath :: Path

  subactionPath is the subaction path https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath to query data from, or NULL_PATH to specify all subaction paths. If the subaction path is specified, it is one of the subaction paths that were specified when the action was created. If the subaction path was not specified when the action was created, the runtime must return ERROR_PATH_UNSUPPORTED. If this parameter is specified, the runtime must return data that originates only from the subaction paths specified.

Instances

Eq ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

(==) :: ActionStateGetInfo -> ActionStateGetInfo -> Bool

(/=) :: ActionStateGetInfo -> ActionStateGetInfo -> Bool

Show ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionStateGetInfo -> ShowS

show :: ActionStateGetInfo -> String

showList :: [ActionStateGetInfo] -> ShowS

Storable ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionStateGetInfo -> Int

alignment :: ActionStateGetInfo -> Int

peekElemOff :: Ptr ActionStateGetInfo -> Int -> IO ActionStateGetInfo

pokeElemOff :: Ptr ActionStateGetInfo -> Int -> ActionStateGetInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionStateGetInfo

pokeByteOff :: Ptr b -> Int -> ActionStateGetInfo -> IO ()

peek :: Ptr ActionStateGetInfo -> IO ActionStateGetInfo

poke :: Ptr ActionStateGetInfo -> ActionStateGetInfo -> IO ()

Zero ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

zero :: ActionStateGetInfo

ToCStruct ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionStateGetInfo -> (Ptr ActionStateGetInfo -> IO b) -> IO b

pokeCStruct :: Ptr ActionStateGetInfo -> ActionStateGetInfo -> IO b -> IO b

withZeroCStruct :: (Ptr ActionStateGetInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionStateGetInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionStateGetInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionStateGetInfo -> IO ActionStateGetInfo

data ActionSetCreateInfo

XrActionSetCreateInfo - XrActionSet creation info

Member Descriptions

Description

When multiple actions are bound to the same input source, the priority of each action set determines which bindings are suppressed. Runtimes must ignore input sources from action sets with a lower priority number if those specific input sources are also present in active actions within a higher priority action set. If multiple action sets with the same priority are bound to the same input source and that is the highest priority number, runtimes must process all those bindings at the same time.

Two actions are considered to be bound to the same input source if they use the same identifier and optional location path segments, even if they have different component segments.

When runtimes are ignoring bindings because of priority, they must treat the binding to that input source as though they do not exist. That means the isActive field must be FALSE when retrieving action data, and that the runtime must not provide any visual, haptic, or other feedback related to the binding of that action to that input source. Other actions in the same action set which are bound to input sources that do not collide are not affected and are processed as normal.

If actionSetName or localizedActionSetName are empty strings, the runtime must return ERROR_NAME_INVALID or ERROR_LOCALIZED_NAME_INVALID respectively. If actionSetName or localizedActionSetName are duplicates of the corresponding field for any existing action set in the specified instance, the runtime must return ERROR_NAME_DUPLICATED or ERROR_LOCALIZED_NAME_DUPLICATED respectively. If the conflicting action set is destroyed, the conflicting field is no longer considered duplicated. If actionSetName contains characters which are not allowed in a single level of a well-formed path string, the runtime must return ERROR_PATH_FORMAT_INVALID.

Valid Usage (Implicit)

See Also

ActionSet, StructureType, createActionSet

Constructors

ActionSetCreateInfo

Fields

• actionSetName :: ByteString

  actionSetName is an array containing a NULL terminated non-empty string with the name of this action set.

  actionSetName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_ACTION_SET_NAME_SIZE

• localizedActionSetName :: ByteString

  localizedActionSetName is an array containing a NULL terminated UTF-8 string that can be presented to the user as a description of the action set. This string should be presented in the system’s current active locale.

  localizedActionSetName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_LOCALIZED_ACTION_SET_NAME_SIZE

• priority :: Word32

  priority defines which action sets' actions are active on a given input source when actions on multiple active action sets are bound to the same input source. Larger priority numbers take precedence over smaller priority numbers.

Instances

Show ActionSetCreateInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionSetCreateInfo -> ShowS

show :: ActionSetCreateInfo -> String

showList :: [ActionSetCreateInfo] -> ShowS

Storable ActionSetCreateInfo

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionSetCreateInfo -> Int

alignment :: ActionSetCreateInfo -> Int

peekElemOff :: Ptr ActionSetCreateInfo -> Int -> IO ActionSetCreateInfo

pokeElemOff :: Ptr ActionSetCreateInfo -> Int -> ActionSetCreateInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionSetCreateInfo

pokeByteOff :: Ptr b -> Int -> ActionSetCreateInfo -> IO ()

peek :: Ptr ActionSetCreateInfo -> IO ActionSetCreateInfo

poke :: Ptr ActionSetCreateInfo -> ActionSetCreateInfo -> IO ()

Zero ActionSetCreateInfo

Defined in OpenXR.Core10.Input

Methods

zero :: ActionSetCreateInfo

ToCStruct ActionSetCreateInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionSetCreateInfo -> (Ptr ActionSetCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr ActionSetCreateInfo -> ActionSetCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr ActionSetCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionSetCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionSetCreateInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionSetCreateInfo -> IO ActionSetCreateInfo

data ActionSuggestedBinding

XrActionSuggestedBinding - Suggested binding for a single action

Valid Usage (Implicit)

See Also

Action, InteractionProfileSuggestedBinding, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, suggestInteractionProfileBindings

Constructors

ActionSuggestedBinding

Fields

• action :: Ptr Action_T

  action is the Action handle for an action

  action must be a valid Action handle

• binding :: Path

  binding is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath of a binding for the action specified in action. This path is any top level user path plus input source path, for example /user/hand/right/input/trigger/click. See suggested bindings for more details.

Instances

Eq ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

(==) :: ActionSuggestedBinding -> ActionSuggestedBinding -> Bool

(/=) :: ActionSuggestedBinding -> ActionSuggestedBinding -> Bool

Show ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionSuggestedBinding -> ShowS

show :: ActionSuggestedBinding -> String

showList :: [ActionSuggestedBinding] -> ShowS

Storable ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActionSuggestedBinding -> Int

alignment :: ActionSuggestedBinding -> Int

peekElemOff :: Ptr ActionSuggestedBinding -> Int -> IO ActionSuggestedBinding

pokeElemOff :: Ptr ActionSuggestedBinding -> Int -> ActionSuggestedBinding -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActionSuggestedBinding

pokeByteOff :: Ptr b -> Int -> ActionSuggestedBinding -> IO ()

peek :: Ptr ActionSuggestedBinding -> IO ActionSuggestedBinding

poke :: Ptr ActionSuggestedBinding -> ActionSuggestedBinding -> IO ()

Zero ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

zero :: ActionSuggestedBinding

ToCStruct ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionSuggestedBinding -> (Ptr ActionSuggestedBinding -> IO b) -> IO b

pokeCStruct :: Ptr ActionSuggestedBinding -> ActionSuggestedBinding -> IO b -> IO b

withZeroCStruct :: (Ptr ActionSuggestedBinding -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionSuggestedBinding -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionSuggestedBinding -> IO ActionSuggestedBinding

data InteractionProfileSuggestedBinding (es :: [Type])

XrInteractionProfileSuggestedBinding - Suggested bindings for a interaction profile

Valid Usage (Implicit)

• type must be TYPE_INTERACTION_PROFILE_SUGGESTED_BINDING

• next must be NULL or a valid pointer to the next structure in a structure chain. See also: BindingModificationsKHR, InteractionProfileAnalogThresholdVALVE
• suggestedBindings must be a pointer to an array of countSuggestedBindings valid ActionSuggestedBinding structures
• The countSuggestedBindings parameter must be greater than 0

See Also

ActionSuggestedBinding, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, StructureType, suggestInteractionProfileBindings

Constructors

InteractionProfileSuggestedBinding

Fields

• next :: Chain es

  next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.

• interactionProfile :: Path

  interactionProfile is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath of an interaction profile.

• suggestedBindings :: Vector ActionSuggestedBinding

  suggestedBindings is a pointer to an array of ActionSuggestedBinding structures that define all of the application’s suggested bindings for the specified interaction profile.

Instances

Extensible InteractionProfileSuggestedBinding

Defined in OpenXR.Core10.Input

Methods

extensibleTypeName :: String

getNext :: forall (es :: [Type]). InteractionProfileSuggestedBinding es -> Chain es

setNext :: forall (ds :: [Type]) (es :: [Type]). InteractionProfileSuggestedBinding ds -> Chain es -> InteractionProfileSuggestedBinding es

extends :: forall e b proxy. Typeable e => proxy e -> (Extends InteractionProfileSuggestedBinding e => b) -> Maybe b

Show (Chain es) => Show (InteractionProfileSuggestedBinding es)

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> InteractionProfileSuggestedBinding es -> ShowS

show :: InteractionProfileSuggestedBinding es -> String

showList :: [InteractionProfileSuggestedBinding es] -> ShowS

es ~ ('[] :: [Type]) => Zero (InteractionProfileSuggestedBinding es)

Defined in OpenXR.Core10.Input

Methods

zero :: InteractionProfileSuggestedBinding es

(Extendss InteractionProfileSuggestedBinding es, PokeChain es) => ToCStruct (InteractionProfileSuggestedBinding es)

Defined in OpenXR.Core10.Input

Methods

withCStruct :: InteractionProfileSuggestedBinding es -> (Ptr (InteractionProfileSuggestedBinding es) -> IO b) -> IO b

pokeCStruct :: Ptr (InteractionProfileSuggestedBinding es) -> InteractionProfileSuggestedBinding es -> IO b -> IO b

withZeroCStruct :: (Ptr (InteractionProfileSuggestedBinding es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (InteractionProfileSuggestedBinding es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

(Extendss InteractionProfileSuggestedBinding es, PeekChain es) => FromCStruct (InteractionProfileSuggestedBinding es)

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr (InteractionProfileSuggestedBinding es) -> IO (InteractionProfileSuggestedBinding es)

data ActiveActionSet

XrActiveActionSet - Describes an active action set

Member Descriptions

Description

This structure defines a single active action set and subaction path combination. Applications can provide a list of these structures to the syncActions function.

Valid Usage (Implicit)

See Also

ActionSet, ActionsSyncInfo, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, syncActions

Constructors

ActiveActionSet

Fields

• actionSet :: Ptr ActionSet_T

  actionSet is the handle of the action set to activate.

  actionSet must be a valid ActionSet handle

• subactionPath :: Path

  subactionPath is a subaction path that was declared when one or more actions in the action set was created or NULL_PATH. If the application wants to activate the action set on more than one subaction path, it can include additional ActiveActionSet structs with the other subactionPath values. Using NULL_PATH as the value for subactionPath, acts as a wildcard for all subaction paths on the actions in the action set. If the subaction path was not specified on any of the actions in the actionSet when that action was created, the runtime must return ERROR_PATH_UNSUPPORTED.

Instances

Eq ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

(==) :: ActiveActionSet -> ActiveActionSet -> Bool

(/=) :: ActiveActionSet -> ActiveActionSet -> Bool

Show ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActiveActionSet -> ShowS

show :: ActiveActionSet -> String

showList :: [ActiveActionSet] -> ShowS

Storable ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

sizeOf :: ActiveActionSet -> Int

alignment :: ActiveActionSet -> Int

peekElemOff :: Ptr ActiveActionSet -> Int -> IO ActiveActionSet

pokeElemOff :: Ptr ActiveActionSet -> Int -> ActiveActionSet -> IO ()

peekByteOff :: Ptr b -> Int -> IO ActiveActionSet

pokeByteOff :: Ptr b -> Int -> ActiveActionSet -> IO ()

peek :: Ptr ActiveActionSet -> IO ActiveActionSet

poke :: Ptr ActiveActionSet -> ActiveActionSet -> IO ()

Zero ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

zero :: ActiveActionSet

ToCStruct ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActiveActionSet -> (Ptr ActiveActionSet -> IO b) -> IO b

pokeCStruct :: Ptr ActiveActionSet -> ActiveActionSet -> IO b -> IO b

withZeroCStruct :: (Ptr ActiveActionSet -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActiveActionSet -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActiveActionSet

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActiveActionSet -> IO ActiveActionSet

data SessionActionSetsAttachInfo

XrSessionActionSetsAttachInfo - Information to attach action sets to a session

Valid Usage (Implicit)

• type must be TYPE_SESSION_ACTION_SETS_ATTACH_INFO

• next must be NULL or a valid pointer to the next structure in a structure chain
• actionSets must be a pointer to an array of countActionSets valid ActionSet handles
• The countActionSets parameter must be greater than 0

See Also

ActionSet, StructureType, attachSessionActionSets

Constructors

SessionActionSetsAttachInfo

Fields

• actionSets :: Vector (Ptr ActionSet_T)

  actionSets is a pointer to an array of one or more ActionSet handles to be attached to the session.

Instances

Show SessionActionSetsAttachInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> SessionActionSetsAttachInfo -> ShowS

show :: SessionActionSetsAttachInfo -> String

showList :: [SessionActionSetsAttachInfo] -> ShowS

Zero SessionActionSetsAttachInfo

Defined in OpenXR.Core10.Input

Methods

zero :: SessionActionSetsAttachInfo

ToCStruct SessionActionSetsAttachInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: SessionActionSetsAttachInfo -> (Ptr SessionActionSetsAttachInfo -> IO b) -> IO b

pokeCStruct :: Ptr SessionActionSetsAttachInfo -> SessionActionSetsAttachInfo -> IO b -> IO b

withZeroCStruct :: (Ptr SessionActionSetsAttachInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr SessionActionSetsAttachInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SessionActionSetsAttachInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr SessionActionSetsAttachInfo -> IO SessionActionSetsAttachInfo

data ActionsSyncInfo

XrActionsSyncInfo - Information to sync actions

Valid Usage (Implicit)

• type must be TYPE_ACTIONS_SYNC_INFO

• next must be NULL or a valid pointer to the next structure in a structure chain
• If countActiveActionSets is not 0, activeActionSets must be a pointer to an array of countActiveActionSets valid ActiveActionSet structures

See Also

ActiveActionSet, StructureType, syncActions

Constructors

ActionsSyncInfo

Fields

• countActiveActionSets :: Word32

  countActiveActionSets is an integer specifying the number of valid elements in the activeActionSets array.

• activeActionSets :: Vector ActiveActionSet

  activeActionSets is NULL or a pointer to an array of one or more ActiveActionSet structures that should be synchronized.

Instances

Show ActionsSyncInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionsSyncInfo -> ShowS

show :: ActionsSyncInfo -> String

showList :: [ActionsSyncInfo] -> ShowS

Zero ActionsSyncInfo

Defined in OpenXR.Core10.Input

Methods

zero :: ActionsSyncInfo

ToCStruct ActionsSyncInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionsSyncInfo -> (Ptr ActionsSyncInfo -> IO b) -> IO b

pokeCStruct :: Ptr ActionsSyncInfo -> ActionsSyncInfo -> IO b -> IO b

withZeroCStruct :: (Ptr ActionsSyncInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionsSyncInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionsSyncInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionsSyncInfo -> IO ActionsSyncInfo

data BoundSourcesForActionEnumerateInfo

XrBoundSourcesForActionEnumerateInfo - Information to query the bound input sources for an action

Valid Usage (Implicit)

See Also

Action, StructureType, enumerateBoundSourcesForAction

Constructors

BoundSourcesForActionEnumerateInfo

Fields

• action :: Ptr Action_T

  action is the handle of the action to query.

  action must be a valid Action handle

Instances

Eq BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

(==) :: BoundSourcesForActionEnumerateInfo -> BoundSourcesForActionEnumerateInfo -> Bool

(/=) :: BoundSourcesForActionEnumerateInfo -> BoundSourcesForActionEnumerateInfo -> Bool

Show BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> BoundSourcesForActionEnumerateInfo -> ShowS

show :: BoundSourcesForActionEnumerateInfo -> String

showList :: [BoundSourcesForActionEnumerateInfo] -> ShowS

Storable BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

sizeOf :: BoundSourcesForActionEnumerateInfo -> Int

alignment :: BoundSourcesForActionEnumerateInfo -> Int

peekElemOff :: Ptr BoundSourcesForActionEnumerateInfo -> Int -> IO BoundSourcesForActionEnumerateInfo

pokeElemOff :: Ptr BoundSourcesForActionEnumerateInfo -> Int -> BoundSourcesForActionEnumerateInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO BoundSourcesForActionEnumerateInfo

pokeByteOff :: Ptr b -> Int -> BoundSourcesForActionEnumerateInfo -> IO ()

peek :: Ptr BoundSourcesForActionEnumerateInfo -> IO BoundSourcesForActionEnumerateInfo

poke :: Ptr BoundSourcesForActionEnumerateInfo -> BoundSourcesForActionEnumerateInfo -> IO ()

Zero BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

zero :: BoundSourcesForActionEnumerateInfo

ToCStruct BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: BoundSourcesForActionEnumerateInfo -> (Ptr BoundSourcesForActionEnumerateInfo -> IO b) -> IO b

pokeCStruct :: Ptr BoundSourcesForActionEnumerateInfo -> BoundSourcesForActionEnumerateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr BoundSourcesForActionEnumerateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr BoundSourcesForActionEnumerateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct BoundSourcesForActionEnumerateInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr BoundSourcesForActionEnumerateInfo -> IO BoundSourcesForActionEnumerateInfo

data InputSourceLocalizedNameGetInfo

XrInputSourceLocalizedNameGetInfo - Information to query the bound input sources for an action

Valid Usage (Implicit)

See Also

InputSourceLocalizedNameFlags, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, StructureType, enumerateBoundSourcesForAction, getInputSourceLocalizedName

Constructors

InputSourceLocalizedNameGetInfo

Fields

• sourcePath :: Path
• whichComponents :: InputSourceLocalizedNameFlags

  whichComponents is any set of flags from XrInputSourceLocalizedNameFlagBits.

  whichComponents must be a valid combination of XrInputSourceLocalizedNameFlagBits values

  whichComponents must not be 0

Instances

Eq InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

(==) :: InputSourceLocalizedNameGetInfo -> InputSourceLocalizedNameGetInfo -> Bool

(/=) :: InputSourceLocalizedNameGetInfo -> InputSourceLocalizedNameGetInfo -> Bool

Show InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> InputSourceLocalizedNameGetInfo -> ShowS

show :: InputSourceLocalizedNameGetInfo -> String

showList :: [InputSourceLocalizedNameGetInfo] -> ShowS

Storable InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

sizeOf :: InputSourceLocalizedNameGetInfo -> Int

alignment :: InputSourceLocalizedNameGetInfo -> Int

peekElemOff :: Ptr InputSourceLocalizedNameGetInfo -> Int -> IO InputSourceLocalizedNameGetInfo

pokeElemOff :: Ptr InputSourceLocalizedNameGetInfo -> Int -> InputSourceLocalizedNameGetInfo -> IO ()

peekByteOff :: Ptr b -> Int -> IO InputSourceLocalizedNameGetInfo

pokeByteOff :: Ptr b -> Int -> InputSourceLocalizedNameGetInfo -> IO ()

peek :: Ptr InputSourceLocalizedNameGetInfo -> IO InputSourceLocalizedNameGetInfo

poke :: Ptr InputSourceLocalizedNameGetInfo -> InputSourceLocalizedNameGetInfo -> IO ()

Zero InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

zero :: InputSourceLocalizedNameGetInfo

ToCStruct InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: InputSourceLocalizedNameGetInfo -> (Ptr InputSourceLocalizedNameGetInfo -> IO b) -> IO b

pokeCStruct :: Ptr InputSourceLocalizedNameGetInfo -> InputSourceLocalizedNameGetInfo -> IO b -> IO b

withZeroCStruct :: (Ptr InputSourceLocalizedNameGetInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr InputSourceLocalizedNameGetInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct InputSourceLocalizedNameGetInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr InputSourceLocalizedNameGetInfo -> IO InputSourceLocalizedNameGetInfo

data InteractionProfileState

XrInteractionProfileState - Receives active interaction profile for a top level path

Member Descriptions

Description

The runtime must only include interaction profiles that the application has provided bindings for via suggestInteractionProfileBindings or NULL_PATH. If the runtime is rebinding an interaction profile provided by the application to a device that the application did not provide bindings for, it must return the interaction profile path that it is emulating. If the runtime is unable to provide input because it cannot emulate any of the application-provided interaction profiles, it must return NULL_PATH.

Valid Usage (Implicit)

See Also

ActionSuggestedBinding, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, StructureType, getCurrentInteractionProfile, suggestInteractionProfileBindings

Constructors

InteractionProfileState

Fields

• interactionProfile :: Path

  interactionProfile is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath of the interaction profile path for the topLevelUserPath used to retrieve this state, or NULL_PATH if there is no active interaction profile at that top level user path.

Instances

Eq InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

(==) :: InteractionProfileState -> InteractionProfileState -> Bool

(/=) :: InteractionProfileState -> InteractionProfileState -> Bool

Show InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> InteractionProfileState -> ShowS

show :: InteractionProfileState -> String

showList :: [InteractionProfileState] -> ShowS

Storable InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

sizeOf :: InteractionProfileState -> Int

alignment :: InteractionProfileState -> Int

peekElemOff :: Ptr InteractionProfileState -> Int -> IO InteractionProfileState

pokeElemOff :: Ptr InteractionProfileState -> Int -> InteractionProfileState -> IO ()

peekByteOff :: Ptr b -> Int -> IO InteractionProfileState

pokeByteOff :: Ptr b -> Int -> InteractionProfileState -> IO ()

peek :: Ptr InteractionProfileState -> IO InteractionProfileState

poke :: Ptr InteractionProfileState -> InteractionProfileState -> IO ()

Zero InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

zero :: InteractionProfileState

ToCStruct InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

withCStruct :: InteractionProfileState -> (Ptr InteractionProfileState -> IO b) -> IO b

pokeCStruct :: Ptr InteractionProfileState -> InteractionProfileState -> IO b -> IO b

withZeroCStruct :: (Ptr InteractionProfileState -> IO b) -> IO b

pokeZeroCStruct :: Ptr InteractionProfileState -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct InteractionProfileState

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr InteractionProfileState -> IO InteractionProfileState

data ActionCreateInfo

XrActionCreateInfo - XrAction creation info

Member Descriptions

Description

Subaction paths are a mechanism that enables applications to use the same action name and handle on multiple devices. Applications can query action state using subaction paths that differentiate data coming from each device. This allows the runtime to group logically equivalent actions together in system UI. For instance, an application could create a single pick_up action with the /user/hand/left and /user/hand/right subaction paths and use the subaction paths to independently query the state of pick_up_with_left_hand and pick_up_with_right_hand.

Applications can create actions with or without the subactionPaths set to a list of paths. If this list of paths is omitted (i.e. subactionPaths is set to NULL, and countSubactionPaths is set to 0), the application is opting out of filtering action results by subaction paths and any call to get action data must also omit subaction paths.

If subactionPaths is specified and any of the following conditions are not satisfied, the runtime must return ERROR_PATH_UNSUPPORTED:

• Each path provided is one of:

  • /user/head
  • /user/hand/left
  • /user/hand/right
  • /user/gamepad
• No path appears in the list more than once

Extensions may append additional top level user paths to the above list.

Note

Earlier revisions of the spec mentioned /user but it could not be implemented as specified and was removed as errata.

The runtime must return ERROR_PATH_UNSUPPORTED in the following circumstances:

• The application specified subaction paths at action creation and the application called xrGetActionState* or a haptic function with an empty subaction path array.
• The application called xrGetActionState* or a haptic function with a subaction path that was not specified when the action was created.

If actionName or localizedActionName are empty strings, the runtime must return ERROR_NAME_INVALID or ERROR_LOCALIZED_NAME_INVALID respectively. If actionName or localizedActionName are duplicates of the corresponding field for any existing action in the specified action set, the runtime must return ERROR_NAME_DUPLICATED or ERROR_LOCALIZED_NAME_DUPLICATED respectively. If the conflicting action is destroyed, the conflicting field is no longer considered duplicated. If actionName contains characters which are not allowed in a single level of a well-formed path string, the runtime must return ERROR_PATH_FORMAT_INVALID.

Valid Usage (Implicit)

• type must be TYPE_ACTION_CREATE_INFO

• next must be NULL or a valid pointer to the next structure in a structure chain
• actionName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_ACTION_NAME_SIZE
• actionType must be a valid ActionType value
• If countSubactionPaths is not 0, subactionPaths must be a pointer to an array of countSubactionPaths valid https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath values
• localizedActionName must be a null-terminated UTF-8 string whose length is less than or equal to MAX_LOCALIZED_ACTION_NAME_SIZE

See Also

Action, ActionType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath, StructureType, createAction, createActionSet

Constructors

ActionCreateInfo

Fields

• actionName :: ByteString

  actionName is an array containing a NULL terminated string with the name of this action.

• actionType :: ActionType

  actionType is the ActionType of the action to be created.

• countSubactionPaths :: Word32

  countSubactionPaths is the number of elements in the subactionPaths array. If subactionPaths is NULL, this parameter must be 0.

• subactionPaths :: Vector Path

  subactionPaths is an array of https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrPath or NULL. If this array is specified, it contains one or more subaction paths that the application intends to query action state for.

• localizedActionName :: ByteString

  localizedActionName is an array containing a NULL terminated UTF-8 string that can be presented to the user as a description of the action. This string should be in the system’s current active locale.

Instances

Show ActionCreateInfo

Defined in OpenXR.Core10.Input

Methods

showsPrec :: Int -> ActionCreateInfo -> ShowS

show :: ActionCreateInfo -> String

showList :: [ActionCreateInfo] -> ShowS

Zero ActionCreateInfo

Defined in OpenXR.Core10.Input

Methods

zero :: ActionCreateInfo

ToCStruct ActionCreateInfo

Defined in OpenXR.Core10.Input

Methods

withCStruct :: ActionCreateInfo -> (Ptr ActionCreateInfo -> IO b) -> IO b

pokeCStruct :: Ptr ActionCreateInfo -> ActionCreateInfo -> IO b -> IO b

withZeroCStruct :: (Ptr ActionCreateInfo -> IO b) -> IO b

pokeZeroCStruct :: Ptr ActionCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct ActionCreateInfo

Defined in OpenXR.Core10.Input

Methods

peekCStruct :: Ptr ActionCreateInfo -> IO ActionCreateInfo