Expand description
§Bindings to the CoreHaptics framework
See Apple’s docs and the general docs on framework crates for more information.
Structs§
- CHHaptic
Dynamic Parameter CHHapticParameter - A CHHapticDynamicParameter contains a CHHapticDynamicParameterID/value pair which will modify (modulate) the ongoing character of a haptic or audio event.
- CHHaptic
Engine CHHapticEngine - Represents the connection with the haptic server.
- CHHaptic
Engine Finished Action CHHapticEngine - Constants indicating what the engine should do in response to the finished handler being called.
- CHHaptic
Engine Stopped Reason CHHapticEngine - Constants indicating the reason why the CHHapticEngine has stopped.
- CHHaptic
Error Code CHHapticErrors - Apple’s documentation
- CHHaptic
Event CHHapticEvent - The description of a single haptic/audio event, plus optional Event parameters which modify the event.
- CHHaptic
Event Parameter CHHapticParameter - A CHHapticEventParameter contains a CHHapticEventParameterID/value pair which helps determine the initial character of a haptic or audio event.
- CHHaptic
Parameter Curve CHHapticParameter - A CHHapticParameterCurve is a set of CHHapticParameterCurveControlPoints which describe the control (inflection) points for the parameter values to be applied to the associated pattern.
- CHHaptic
Parameter Curve Control Point CHHapticParameter - A CHHapticParameterCurveControlPoint contains a time/value pair for a single control point within a CHHapticParameterCurve.
- CHHaptic
Pattern CHHapticPattern - A set of one or more haptic events and/or Dynamic parameters/parameter curves.
Constants§
- CHHaptic
Time Immediate CHHapticEngine - Apple’s documentation
Statics§
- CHHaptic
Audio ⚠Resource KeyLoop Enabled CHHapticEngine - Apple’s documentation
- CHHaptic
Audio ⚠Resource KeyUse Volume Envelope CHHapticEngine - Keys used to configure the playback behavior of a custom waveform.
- CHHaptic
Dynamic ⚠ParameterID Audio Attack Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio Brightness Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio Decay Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio PanControl CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio Pitch Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio Release Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Audio Volume Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Haptic Attack Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Haptic Decay Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Haptic Intensity Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Haptic Release Time Control CHHapticParameter - Apple’s documentation
- CHHaptic
Dynamic ⚠ParameterID Haptic Sharpness Control CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Attack Time CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Audio Brightness CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Audio Pan CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Audio Pitch CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Audio Volume CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Decay Time CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Haptic Intensity CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Haptic Sharpness CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Release Time CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠ParameterID Sustained CHHapticParameter - Apple’s documentation
- CHHaptic
Event ⚠Type Audio Continuous CHHapticEvent - Apple’s documentation
- CHHaptic
Event ⚠Type Audio Custom CHHapticEvent - Apple’s documentation
- CHHaptic
Event ⚠Type Haptic Continuous CHHapticEvent - Apple’s documentation
- CHHaptic
Event ⚠Type Haptic Transient CHHapticEvent - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Duration CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Parameters CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Type CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Waveform Loop Enabled CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Waveform Path CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyEvent Waveform UseVolume Envelope CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyParameter CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyParameter Curve CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyParameter Curve Control Points CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyParameterID CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyParameter Value CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyPattern CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyTime CHHapticPattern - Apple’s documentation
- CHHaptic
Pattern ⚠KeyVersion CHHapticPattern - Apple’s documentation
Traits§
- CHHaptic
Advanced Pattern Player CHHapticPatternPlayer - A protocol which defines operations for pausing, resuming, seeking, and sending parameters to a pattern player.
- CHHaptic
Device Capability CHHapticDeviceCapability - A protocol which defines properties describing haptics and audio capabilities for a particular device. These properties include limitations and ranges of parameters.
- CHHaptic
Parameter Attributes CHHapticDeviceCapability - A protocol for querying mininum, maximum, and default values for a CHHapticEventParameter or CHHapticDynamicParameter.
- CHHaptic
Pattern Player CHHapticPatternPlayer - A protocol which defines operations for starting, stopping, and sending parameters to a pattern player.
Type Aliases§
- CHHaptic
Advanced Pattern Player Completion Handler CHHapticPatternPlayerandblock2 - Block which is called asynchronously when a CHHapticAdvancedPatternPlayer finishes playing.
- CHHaptic
Audio ResourceID CHHapticEvent - Identifier for registered, client-loaded audio data which can be used as custom event types
(see
CHHapticEngine(registerAudioResource:options:error)). - CHHaptic
Audio Resource Key CHHapticEngine - Apple’s documentation
- CHHaptic
Completion Handler CHHapticEngineandblock2 - A block which is called asynchronously when a call to start or stop the haptic engine completes.
- CHHaptic
Dynamic ParameterID CHHapticParameter - Parameters used to dynamically modify all haptic or audio events within a pattern.
- CHHaptic
Engine Finished Handler CHHapticEngineandblock2 - A block which is called asynchronously when the engine detects that all active pattern players have finished. The
return value tells the system what action to take as a result of this (see
CHHapticEngineFinishedAction). - CHHaptic
Engine Reset Handler CHHapticEngineandblock2 - A block which is called asynchronously if the haptic engine has reset itself due a server failure.
- CHHaptic
Engine Stopped Handler CHHapticEngineandblock2 - A block which is called asynchronously when the engine has stopped due to external causes such as an audio session interruption or autoShutdown.
- CHHaptic
Event ParameterID CHHapticParameter - Parameters used to modify individual haptic and/or audio events.
- CHHaptic
Event Type CHHapticEvent - Types of haptic and audio events.
- CHHaptic
Pattern Key CHHapticPattern - Keys used to define a CHHapticPattern.