package tsdl

  1. Overview
  2. Docs

Module Sdl.HapticSource

Sourceval infinity : uint32

Features

Sourcetype feature = int
Sourceval gain : feature
Sourceval autocenter : feature
Sourceval status : feature
Sourceval pause : feature

Directions

Sourcetype direction_type = int
Sourceval cartesian : direction_type
Sourceval spherical : direction_type
Sourcemodule Direction : sig ... end

Effects

Sourcetype effect_type = int
Sourcetype 'a field

The type for effect fields.

Sourceval create_effect : unit -> haptic_effect

create_effect () is an uninitialized haptic effect

Sourceval get : haptic_effect -> 'a field -> 'a

get e f gets the field f of e.

Sourceval set : haptic_effect -> 'a field -> 'a -> unit

set e f v sets the field f of e to v.

Constant effect

Sourceval constant : effect_type

SDL_HapticConstant fields

Sourceval constant_type : effect_type field
Sourceval constant_direction : Direction.t field
Sourceval constant_length : uint32 field
Sourceval constant_delay : uint16 field
Sourceval constant_button : uint16 field
Sourceval constant_interval : uint16 field
Sourceval constant_level : int16 field
Sourceval constant_attack_length : uint16 field
Sourceval constant_attack_level : uint16 field
Sourceval constant_fade_length : uint16 field
Sourceval constant_fade_level : uint16 field

Periodic effect

Sourceval left_right : effect_type
Sourceval triangle : effect_type
Sourceval sawtooth_up : effect_type
Sourceval sawtooth_down : effect_type

SDL_HapticPeriodic fields

Sourceval periodic_type : effect_type field
Sourceval periodic_direction : Direction.t field
Sourceval periodic_length : uint32 field
Sourceval periodic_delay : uint16 field
Sourceval periodic_button : uint16 field
Sourceval periodic_interval : uint16 field
Sourceval periodic_period : uint16 field
Sourceval periodic_magnitude : int16 field
Sourceval periodic_offset : int16 field
Sourceval periodic_phase : uint16 field
Sourceval periodic_attack_length : uint16 field
Sourceval periodic_attack_level : uint16 field
Sourceval periodic_fade_length : uint16 field
Sourceval periodic_fade_level : uint16 field

Condition effect

Sourceval spring : effect_type
Sourceval damper : effect_type
Sourceval inertia : effect_type
Sourceval friction : effect_type

SDL_HapticCondition fields

Sourceval condition_type : effect_type field
Sourceval condition_direction : Direction.t field
Sourceval condition_length : uint32 field
Sourceval condition_delay : uint16 field
Sourceval condition_button : uint16 field
Sourceval condition_interval : uint16 field
Sourceval condition_right_sat_0 : uint16 field
Sourceval condition_right_sat_1 : uint16 field
Sourceval condition_right_sat_2 : uint16 field
Sourceval condition_left_sat_0 : uint16 field
Sourceval condition_left_sat_1 : uint16 field
Sourceval condition_left_sat_2 : uint16 field
Sourceval condition_right_coeff_0 : int16 field
Sourceval condition_right_coeff_1 : int16 field
Sourceval condition_right_coeff_2 : int16 field
Sourceval condition_left_coeff_0 : int16 field
Sourceval condition_left_coeff_1 : int16 field
Sourceval condition_left_coeff_2 : int16 field
Sourceval condition_deadband_0 : uint16 field
Sourceval condition_deadband_1 : uint16 field
Sourceval condition_deadband_2 : uint16 field
Sourceval condition_center_0 : int16 field
Sourceval condition_center_1 : int16 field
Sourceval condition_center_2 : int16 field

Ramp effect

SDL_HapticRamp fields

Sourceval ramp_type : effect_type field
Sourceval ramp_direction : Direction.t field
Sourceval ramp_length : uint32 field
Sourceval ramp_delay : uint16 field
Sourceval ramp_button : uint16 field
Sourceval ramp_interval : uint16 field
Sourceval ramp_start : int16 field
Sourceval ramp_end : int16 field
Sourceval ramp_attack_length : uint16 field
Sourceval ramp_attack_level : uint16 field
Sourceval ramp_fade_length : uint16 field
Sourceval ramp_fade_level : uint16 field

Left right effect

For left_right.

SDL_HapticLeftRight fields

Sourceval left_right_type : effect_type field
Sourceval left_right_length : uint32 field
Sourceval left_right_large_magnitude : uint16 field
Sourceval left_right_small_magnitude : uint16 field

Custom effect

Sourceval custom : effect_type

SDL_HapticCustom fields

Sourceval custom_type : effect_type field
Sourceval custom_direction : Direction.t field
Sourceval custom_length : uint32 field
Sourceval custom_delay : uint16 field
Sourceval custom_button : uint16 field
Sourceval custom_interval : uint16 field
Sourceval custom_channels : uint8 field
Sourceval custom_period : uint16 field
Sourceval custom_samples : uint16 field
Sourceval custom_data : uint16 list field

Note. Only setable.

Sourceval custom_attack_length : uint16 field
Sourceval custom_attack_level : uint16 field
Sourceval custom_fade_length : uint16 field
Sourceval custom_fade_level : uint16 field