Struct sdl2_sys::SDL_HapticCondition
[−]
[src]
#[repr(C)]pub struct SDL_HapticCondition { pub type_: Uint16, pub direction: SDL_HapticDirection, pub length: Uint32, pub delay: Uint16, pub button: Uint16, pub interval: Uint16, pub right_sat: [Uint16; 3], pub left_sat: [Uint16; 3], pub right_coeff: [Sint16; 3], pub left_coeff: [Sint16; 3], pub deadband: [Uint16; 3], pub center: [Sint16; 3], }
\brief A structure containing a template for a Condition effect.
The struct handles the following effects: - ::SDL_HAPTIC_SPRING: Effect based on axes position. - ::SDL_HAPTIC_DAMPER: Effect based on axes velocity. - ::SDL_HAPTIC_INERTIA: Effect based on axes acceleration. - ::SDL_HAPTIC_FRICTION: Effect based on axes movement.
Direction is handled by condition internals instead of a direction member. The condition effect specific members have three parameters. The first refers to the X axis, the second refers to the Y axis and the third refers to the Z axis. The right terms refer to the positive side of the axis and the left terms refer to the negative side of the axis. Please refer to the ::SDL_HapticDirection diagram for which side is positive and which is negative.
\sa SDL_HapticDirection \sa SDL_HAPTIC_SPRING \sa SDL_HAPTIC_DAMPER \sa SDL_HAPTIC_INERTIA \sa SDL_HAPTIC_FRICTION \sa SDL_HapticEffect
Fields
type_: Uint16
< ::SDL_HAPTIC_SPRING, ::SDL_HAPTIC_DAMPER, ::SDL_HAPTIC_INERTIA or ::SDL_HAPTIC_FRICTION
direction: SDL_HapticDirection
< Direction of the effect - Not used ATM.
length: Uint32
< Duration of the effect.
delay: Uint16
< Delay before starting the effect.
< Button that triggers the effect.
interval: Uint16
< How soon it can be triggered again after button.
right_sat: [Uint16; 3]
< Level when joystick is to the positive side; max 0xFFFF.
left_sat: [Uint16; 3]
< Level when joystick is to the negative side; max 0xFFFF.
right_coeff: [Sint16; 3]
< How fast to increase the force towards the positive side.
left_coeff: [Sint16; 3]
< How fast to increase the force towards the negative side.
deadband: [Uint16; 3]
< Size of the dead zone; max 0xFFFF: whole axis-range when 0-centered.
center: [Sint16; 3]
< Position of the dead zone.