Safe Haskell	None
Language	Haskell2010

OpenXR.Core10.Haptics

Synopsis

applyHapticFeedback :: forall a io. (ToCStruct a, MonadIO io) => Session -> HapticActionInfo -> ("hapticFeedback" ::: a) -> io Result
stopHapticFeedback :: forall io. MonadIO io => Session -> HapticActionInfo -> io Result
data HapticBaseHeader = HapticBaseHeader {
- type' :: StructureType
}
class ToCStruct a => IsHaptic a where
- toHapticBaseHeader :: a -> HapticBaseHeader
data HapticActionInfo = HapticActionInfo {
- action :: Ptr Action_T
- subactionPath :: Path
}

Documentation

applyHapticFeedback Source #

Arguments

:: forall a io. (ToCStruct a, MonadIO io)
=> Session	`session` is the `Session` to start outputting to. `session` must be a valid `Session` handle
-> HapticActionInfo	`hapticActionInfo` is a pointer to `HapticActionInfo` to provide action and subaction paths information. `hapticActionInfo` must be a pointer to a valid `HapticActionInfo` structure
-> ("hapticFeedback" ::: a)	`hapticFeedback` is a pointer to a haptic event structure which starts with an `HapticBaseHeader`. `hapticFeedback` must be a pointer to a valid `HapticBaseHeader`-based structure. See also: `HapticVibration`
-> io Result

xrApplyHapticFeedback - Apply haptic feedback

Parameter Descriptions

Description

Triggers a haptic event through the specified action of type TYPE_HAPTIC_VIBRATION. The runtime should deliver this request to the appropriate device, but exactly which device, if any, this event is sent to is up to the runtime to decide. If an appropriate device is unavailable the runtime may ignore this request for haptic feedback.

If another haptic event from this session is currently happening on the device bound to this action, the runtime must interrupt that other event and replace it with the new one.

Return Codes

Success

SUCCESS
SESSION_LOSS_PENDING

Failure

Description

If a haptic event from this Action is in progress, when this function is called the runtime must stop that event.

Return Codes

Success

SUCCESS
SESSION_LOSS_PENDING

Failure

Eq HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods (==) :: HapticBaseHeader -> HapticBaseHeader -> Bool # (/=) :: HapticBaseHeader -> HapticBaseHeader -> Bool #
Show HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods showsPrec :: Int -> HapticBaseHeader -> ShowS # show :: HapticBaseHeader -> String # showList :: [HapticBaseHeader] -> ShowS #
Storable HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods sizeOf :: HapticBaseHeader -> Int # alignment :: HapticBaseHeader -> Int # peekElemOff :: Ptr HapticBaseHeader -> Int -> IO HapticBaseHeader # pokeElemOff :: Ptr HapticBaseHeader -> Int -> HapticBaseHeader -> IO () # peekByteOff :: Ptr b -> Int -> IO HapticBaseHeader # pokeByteOff :: Ptr b -> Int -> HapticBaseHeader -> IO () # peek :: Ptr HapticBaseHeader -> IO HapticBaseHeader # poke :: Ptr HapticBaseHeader -> HapticBaseHeader -> IO () #
Zero HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods zero :: HapticBaseHeader #
ToCStruct HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods withCStruct :: HapticBaseHeader -> (Ptr HapticBaseHeader -> IO b) -> IO b # pokeCStruct :: Ptr HapticBaseHeader -> HapticBaseHeader -> IO b -> IO b # withZeroCStruct :: (Ptr HapticBaseHeader -> IO b) -> IO b # pokeZeroCStruct :: Ptr HapticBaseHeader -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods peekCStruct :: Ptr HapticBaseHeader -> IO HapticBaseHeader #
Inheritable HapticBaseHeader Source #
Instance details Defined in OpenXR.Core10.Haptics Methods peekSomeCChild :: Ptr (SomeChild HapticBaseHeader) -> IO (SomeChild HapticBaseHeader) Source #

class ToCStruct a => IsHaptic a where Source #

Methods

toHapticBaseHeader :: a -> HapticBaseHeader Source #

Instances

Instances details

IsHaptic HapticVibration Source #
Instance details Defined in OpenXR.Core10.OtherTypes Methods toHapticBaseHeader :: HapticVibration -> HapticBaseHeader Source #

data HapticActionInfo Source #

XrHapticActionInfo - Information to output haptic feedback

Member Descriptions

Description

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

Valid Usage (Implicit)

action :: Ptr Action_T
action is the Action handle for the desired output haptic action.
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 of the device to send the haptic event to, 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 trigger the haptic events only on the device from the subaction path.

Instances

Instances details

Eq HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods (==) :: HapticActionInfo -> HapticActionInfo -> Bool # (/=) :: HapticActionInfo -> HapticActionInfo -> Bool #
Show HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods showsPrec :: Int -> HapticActionInfo -> ShowS # show :: HapticActionInfo -> String # showList :: [HapticActionInfo] -> ShowS #
Storable HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods sizeOf :: HapticActionInfo -> Int # alignment :: HapticActionInfo -> Int # peekElemOff :: Ptr HapticActionInfo -> Int -> IO HapticActionInfo # pokeElemOff :: Ptr HapticActionInfo -> Int -> HapticActionInfo -> IO () # peekByteOff :: Ptr b -> Int -> IO HapticActionInfo # pokeByteOff :: Ptr b -> Int -> HapticActionInfo -> IO () # peek :: Ptr HapticActionInfo -> IO HapticActionInfo # poke :: Ptr HapticActionInfo -> HapticActionInfo -> IO () #
Zero HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods zero :: HapticActionInfo #
ToCStruct HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods withCStruct :: HapticActionInfo -> (Ptr HapticActionInfo -> IO b) -> IO b # pokeCStruct :: Ptr HapticActionInfo -> HapticActionInfo -> IO b -> IO b # withZeroCStruct :: (Ptr HapticActionInfo -> IO b) -> IO b # pokeZeroCStruct :: Ptr HapticActionInfo -> IO b -> IO b # cStructSize :: Int # cStructAlignment :: Int #
FromCStruct HapticActionInfo Source #
Instance details Defined in OpenXR.Core10.Haptics Methods peekCStruct :: Ptr HapticActionInfo -> IO HapticActionInfo #

Documentation

Parameter Descriptions

Description

Return Codes

See Also

Parameter Descriptions

Description

Return Codes

See Also

Valid Usage (Implicit)

See Also

Instances

Instances

Member Descriptions

Description

Valid Usage (Implicit)

See Also

Instances

:: forall io. MonadIO io
=> Session	`session` is the `Session` to stop outputting to. `session` must be a valid `Session` handle
-> HapticActionInfo	`hapticActionInfo` is a pointer to an `HapticActionInfo` to provide action and subaction path information. `hapticActionInfo` must be a pointer to a valid `HapticActionInfo` structure
-> io Result

HapticBaseHeader
Fields type' :: StructureType `type` is the `StructureType` of this structure. This base structure itself has no associated `StructureType` value. `type` must be `TYPE_HAPTIC_VIBRATION`