Struct SDL_HapticCondition 

#[repr(C)]
pub struct SDL_HapticCondition {
    pub type: SDL_HapticEffectType,
    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],
}

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.

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_HapticDirection
• SDL_HAPTIC_SPRING
• SDL_HAPTIC_DAMPER
• SDL_HAPTIC_INERTIA
• SDL_HAPTIC_FRICTION
• SDL_HapticEffect

Fields

type: SDL_HapticEffectType

SDL_HAPTIC_SPRING, SDL_HAPTIC_DAMPER, SDL_HAPTIC_INERTIA or SDL_HAPTIC_FRICTION

direction: SDL_HapticDirection

Direction of the effect.

length: Uint32

Duration of the effect.

delay: Uint16

Delay before starting the effect.

button: Uint16

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.

Trait Implementations

impl Clone for SDL_HapticCondition

fn clone(&self) -> SDL_HapticCondition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDL_HapticCondition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SDL_HapticCondition

fn default() -> SDL_HapticCondition

Returns the “default value” for a type.

impl Hash for SDL_HapticCondition

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SDL_HapticCondition

fn eq(&self, other: &SDL_HapticCondition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SDL_HapticCondition

impl Eq for SDL_HapticCondition

impl StructuralPartialEq for SDL_HapticCondition