sdl3_sys/generated/

haptic.rs

//! The SDL haptic subsystem manages haptic (force feedback) devices.
//!
//! The basic usage is as follows:
//!
//! - Initialize the subsystem ([`SDL_INIT_HAPTIC`]).
//! - Open a haptic device.
//! - [`SDL_OpenHaptic()`] to open from index.
//! - [`SDL_OpenHapticFromJoystick()`] to open from an existing joystick.
//! - Create an effect ([`SDL_HapticEffect`]).
//! - Upload the effect with [`SDL_CreateHapticEffect()`].
//! - Run the effect with [`SDL_RunHapticEffect()`].
//! - (optional) Free the effect with [`SDL_DestroyHapticEffect()`].
//! - Close the haptic device with [`SDL_CloseHaptic()`].
//!
//! Simple rumble example:
//!
//! ```c
//!    SDL_Haptic *haptic = NULL;
//!
//!    // Open the device
//!    SDL_HapticID *haptics = SDL_GetHaptics(NULL);
//!    if (haptics) {
//!        haptic = SDL_OpenHaptic(haptics[0]);
//!        SDL_free(haptics);
//!    }
//!    if (haptic == NULL)
//!       return;
//!
//!    // Initialize simple rumble
//!    if (!SDL_InitHapticRumble(haptic))
//!       return;
//!
//!    // Play effect at 50% strength for 2 seconds
//!    if (!SDL_PlayHapticRumble(haptic, 0.5, 2000))
//!       return;
//!    SDL_Delay(2000);
//!
//!    // Clean up
//!    SDL_CloseHaptic(haptic);
//! ```
//!
//! Complete example:
//!
//! ```c
//! bool test_haptic(SDL_Joystick *joystick)
//! {
//!    SDL_Haptic *haptic;
//!    SDL_HapticEffect effect;
//!    SDL_HapticEffectID effect_id;
//!
//!    // Open the device
//!    haptic = SDL_OpenHapticFromJoystick(joystick);
//!    if (haptic == NULL) return false; // Most likely joystick isn't haptic
//!
//!    // See if it can do sine waves
//!    if ((SDL_GetHapticFeatures(haptic) & SDL_HAPTIC_SINE)==0) {
//!       SDL_CloseHaptic(haptic); // No sine effect
//!       return false;
//!    }
//!
//!    // Create the effect
//!    SDL_memset(&effect, 0, sizeof(SDL_HapticEffect)); // 0 is safe default
//!    effect.type = SDL_HAPTIC_SINE;
//!    effect.periodic.direction.type = SDL_HAPTIC_POLAR; // Polar coordinates
//!    effect.periodic.direction.dir[0] = 18000; // Force comes from south
//!    effect.periodic.period = 1000; // 1000 ms
//!    effect.periodic.magnitude = 20000; // 20000/32767 strength
//!    effect.periodic.length = 5000; // 5 seconds long
//!    effect.periodic.attack_length = 1000; // Takes 1 second to get max strength
//!    effect.periodic.fade_length = 1000; // Takes 1 second to fade away
//!
//!    // Upload the effect
//!    effect_id = SDL_CreateHapticEffect(haptic, &effect);
//!
//!    // Test the effect
//!    SDL_RunHapticEffect(haptic, effect_id, 1);
//!    SDL_Delay(5000); // Wait for the effect to finish
//!
//!    // We destroy the effect, although closing the device also does this
//!    SDL_DestroyHapticEffect(haptic, effect_id);
//!
//!    // Close the device
//!    SDL_CloseHaptic(haptic);
//!
//!    return true; // Success
//! }
//! ```
//!
//! Note that the SDL haptic subsystem is not thread-safe.

use super::stdinc::*;

use super::error::*;

use super::joystick::*;

/// Used to play a device an infinite number of times.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_RunHapticEffect`]
pub const SDL_HAPTIC_INFINITY: ::core::primitive::u32 = 4294967295_u32;

/// * Type of haptic effect.
///
/// ## Known values (`sdl3-sys`)
/// | Associated constant | Global constant | Description |
/// | ------------------- | --------------- | ----------- |
/// | [`CONSTANT`](SDL_HapticEffectType::CONSTANT) | [`SDL_HAPTIC_CONSTANT`] | Constant effect supported.  Constant haptic effect.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticCondition`] |
/// | [`SINE`](SDL_HapticEffectType::SINE) | [`SDL_HAPTIC_SINE`] | Sine wave effect supported.  Periodic haptic effect that simulates sine waves.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticPeriodic`] |
/// | [`SQUARE`](SDL_HapticEffectType::SQUARE) | [`SDL_HAPTIC_SQUARE`] | Square wave effect supported.  Periodic haptic effect that simulates square waves.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticPeriodic`] |
/// | [`TRIANGLE`](SDL_HapticEffectType::TRIANGLE) | [`SDL_HAPTIC_TRIANGLE`] | Triangle wave effect supported.  Periodic haptic effect that simulates triangular waves.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticPeriodic`] |
/// | [`SAWTOOTHUP`](SDL_HapticEffectType::SAWTOOTHUP) | [`SDL_HAPTIC_SAWTOOTHUP`] | Sawtoothup wave effect supported.  Periodic haptic effect that simulates saw tooth up waves.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticPeriodic`] |
/// | [`SAWTOOTHDOWN`](SDL_HapticEffectType::SAWTOOTHDOWN) | [`SDL_HAPTIC_SAWTOOTHDOWN`] | Sawtoothdown wave effect supported.  Periodic haptic effect that simulates saw tooth down waves.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticPeriodic`] |
/// | [`RAMP`](SDL_HapticEffectType::RAMP) | [`SDL_HAPTIC_RAMP`] | Ramp effect supported.  Ramp haptic effect.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticRamp`] |
/// | [`SPRING`](SDL_HapticEffectType::SPRING) | [`SDL_HAPTIC_SPRING`] | Spring effect supported - uses axes position.  Condition haptic effect that simulates a spring. Effect is based on the axes position.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticCondition`] |
/// | [`DAMPER`](SDL_HapticEffectType::DAMPER) | [`SDL_HAPTIC_DAMPER`] | Damper effect supported - uses axes velocity.  Condition haptic effect that simulates dampening. Effect is based on the axes velocity.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticCondition`] |
/// | [`INERTIA`](SDL_HapticEffectType::INERTIA) | [`SDL_HAPTIC_INERTIA`] | Inertia effect supported - uses axes acceleration.  Condition haptic effect that simulates inertia. Effect is based on the axes acceleration.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticCondition`] |
/// | [`FRICTION`](SDL_HapticEffectType::FRICTION) | [`SDL_HAPTIC_FRICTION`] | Friction effect supported - uses axes movement.  Condition haptic effect that simulates friction. Effect is based on the axes movement.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticCondition`] |
/// | [`LEFTRIGHT`](SDL_HapticEffectType::LEFTRIGHT) | [`SDL_HAPTIC_LEFTRIGHT`] | Left/Right effect supported.  Haptic effect for direct control over high/low frequency motors.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticLeftRight`] |
/// | [`RESERVED1`](SDL_HapticEffectType::RESERVED1) | [`SDL_HAPTIC_RESERVED1`] | Reserved for future use.  \since This macro is available since SDL 3.2.0. |
/// | [`RESERVED2`](SDL_HapticEffectType::RESERVED2) | [`SDL_HAPTIC_RESERVED2`] | Reserved for future use.  \since This macro is available since SDL 3.2.0. |
/// | [`RESERVED3`](SDL_HapticEffectType::RESERVED3) | [`SDL_HAPTIC_RESERVED3`] | Reserved for future use.  \since This macro is available since SDL 3.2.0. |
/// | [`CUSTOM`](SDL_HapticEffectType::CUSTOM) | [`SDL_HAPTIC_CUSTOM`] | Custom effect is supported.  User defined custom haptic effect.  \since This macro is available since SDL 3.2.0. |
/// | [`GAIN`](SDL_HapticEffectType::GAIN) | [`SDL_HAPTIC_GAIN`] | Device can set global gain.  Device supports setting the global gain.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_SetHapticGain`] |
/// | [`AUTOCENTER`](SDL_HapticEffectType::AUTOCENTER) | [`SDL_HAPTIC_AUTOCENTER`] | Device can set autocenter.  Device supports setting autocenter.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_SetHapticAutocenter`] |
/// | [`STATUS`](SDL_HapticEffectType::STATUS) | [`SDL_HAPTIC_STATUS`] | Device can be queried for effect status.  Device supports querying effect status.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_GetHapticEffectStatus`] |
/// | [`PAUSE`](SDL_HapticEffectType::PAUSE) | [`SDL_HAPTIC_PAUSE`] | Device can be paused.  Devices supports being paused.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_PauseHaptic`] \sa [`SDL_ResumeHaptic`] |
#[repr(transparent)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
pub struct SDL_HapticEffectType(pub Uint16);

impl ::core::cmp::PartialEq<Uint16> for SDL_HapticEffectType {
    #[inline(always)]
    fn eq(&self, other: &Uint16) -> bool {
        &self.0 == other
    }
}

impl ::core::cmp::PartialEq<SDL_HapticEffectType> for Uint16 {
    #[inline(always)]
    fn eq(&self, other: &SDL_HapticEffectType) -> bool {
        self == &other.0
    }
}

impl From<SDL_HapticEffectType> for Uint16 {
    #[inline(always)]
    fn from(value: SDL_HapticEffectType) -> Self {
        value.0
    }
}

#[cfg(feature = "debug-impls")]
impl ::core::fmt::Debug for SDL_HapticEffectType {
    fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
        let mut first = true;
        let all_bits = 0;
        write!(f, "SDL_HapticEffectType(")?;
        let all_bits = all_bits | Self::CONSTANT.0;
        if (Self::CONSTANT != 0 || self.0 == 0) && *self & Self::CONSTANT == Self::CONSTANT {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "CONSTANT")?;
        }
        let all_bits = all_bits | Self::SINE.0;
        if (Self::SINE != 0 || self.0 == 0) && *self & Self::SINE == Self::SINE {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "SINE")?;
        }
        let all_bits = all_bits | Self::SQUARE.0;
        if (Self::SQUARE != 0 || self.0 == 0) && *self & Self::SQUARE == Self::SQUARE {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "SQUARE")?;
        }
        let all_bits = all_bits | Self::TRIANGLE.0;
        if (Self::TRIANGLE != 0 || self.0 == 0) && *self & Self::TRIANGLE == Self::TRIANGLE {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "TRIANGLE")?;
        }
        let all_bits = all_bits | Self::SAWTOOTHUP.0;
        if (Self::SAWTOOTHUP != 0 || self.0 == 0) && *self & Self::SAWTOOTHUP == Self::SAWTOOTHUP {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "SAWTOOTHUP")?;
        }
        let all_bits = all_bits | Self::SAWTOOTHDOWN.0;
        if (Self::SAWTOOTHDOWN != 0 || self.0 == 0)
            && *self & Self::SAWTOOTHDOWN == Self::SAWTOOTHDOWN
        {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "SAWTOOTHDOWN")?;
        }
        let all_bits = all_bits | Self::RAMP.0;
        if (Self::RAMP != 0 || self.0 == 0) && *self & Self::RAMP == Self::RAMP {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "RAMP")?;
        }
        let all_bits = all_bits | Self::SPRING.0;
        if (Self::SPRING != 0 || self.0 == 0) && *self & Self::SPRING == Self::SPRING {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "SPRING")?;
        }
        let all_bits = all_bits | Self::DAMPER.0;
        if (Self::DAMPER != 0 || self.0 == 0) && *self & Self::DAMPER == Self::DAMPER {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "DAMPER")?;
        }
        let all_bits = all_bits | Self::INERTIA.0;
        if (Self::INERTIA != 0 || self.0 == 0) && *self & Self::INERTIA == Self::INERTIA {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "INERTIA")?;
        }
        let all_bits = all_bits | Self::FRICTION.0;
        if (Self::FRICTION != 0 || self.0 == 0) && *self & Self::FRICTION == Self::FRICTION {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "FRICTION")?;
        }
        let all_bits = all_bits | Self::LEFTRIGHT.0;
        if (Self::LEFTRIGHT != 0 || self.0 == 0) && *self & Self::LEFTRIGHT == Self::LEFTRIGHT {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "LEFTRIGHT")?;
        }
        let all_bits = all_bits | Self::RESERVED1.0;
        if (Self::RESERVED1 != 0 || self.0 == 0) && *self & Self::RESERVED1 == Self::RESERVED1 {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "RESERVED1")?;
        }
        let all_bits = all_bits | Self::RESERVED2.0;
        if (Self::RESERVED2 != 0 || self.0 == 0) && *self & Self::RESERVED2 == Self::RESERVED2 {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "RESERVED2")?;
        }
        let all_bits = all_bits | Self::RESERVED3.0;
        if (Self::RESERVED3 != 0 || self.0 == 0) && *self & Self::RESERVED3 == Self::RESERVED3 {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "RESERVED3")?;
        }
        let all_bits = all_bits | Self::CUSTOM.0;
        if (Self::CUSTOM != 0 || self.0 == 0) && *self & Self::CUSTOM == Self::CUSTOM {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "CUSTOM")?;
        }
        let all_bits = all_bits | Self::GAIN.0;
        if (Self::GAIN != 0 || self.0 == 0) && *self & Self::GAIN == Self::GAIN {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "GAIN")?;
        }
        let all_bits = all_bits | Self::AUTOCENTER.0;
        if (Self::AUTOCENTER != 0 || self.0 == 0) && *self & Self::AUTOCENTER == Self::AUTOCENTER {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "AUTOCENTER")?;
        }
        let all_bits = all_bits | Self::STATUS.0;
        if (Self::STATUS != 0 || self.0 == 0) && *self & Self::STATUS == Self::STATUS {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "STATUS")?;
        }
        let all_bits = all_bits | Self::PAUSE.0;
        if (Self::PAUSE != 0 || self.0 == 0) && *self & Self::PAUSE == Self::PAUSE {
            if !first {
                write!(f, " | ")?;
            }
            first = false;
            write!(f, "PAUSE")?;
        }

        if self.0 & !all_bits != 0 {
            if !first {
                write!(f, " | ")?;
            }
            write!(f, "{:#x}", self.0)?;
        } else if first {
            write!(f, "0")?;
        }
        write!(f, ")")
    }
}

impl ::core::ops::BitAnd for SDL_HapticEffectType {
    type Output = Self;

    #[inline(always)]
    fn bitand(self, rhs: Self) -> Self::Output {
        Self(self.0 & rhs.0)
    }
}

impl ::core::ops::BitAndAssign for SDL_HapticEffectType {
    #[inline(always)]
    fn bitand_assign(&mut self, rhs: Self) {
        self.0 &= rhs.0;
    }
}

impl ::core::ops::BitOr for SDL_HapticEffectType {
    type Output = Self;

    #[inline(always)]
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl ::core::ops::BitOrAssign for SDL_HapticEffectType {
    #[inline(always)]
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0;
    }
}

impl ::core::ops::BitXor for SDL_HapticEffectType {
    type Output = Self;

    #[inline(always)]
    fn bitxor(self, rhs: Self) -> Self::Output {
        Self(self.0 ^ rhs.0)
    }
}

impl ::core::ops::BitXorAssign for SDL_HapticEffectType {
    #[inline(always)]
    fn bitxor_assign(&mut self, rhs: Self) {
        self.0 ^= rhs.0;
    }
}

impl ::core::ops::Not for SDL_HapticEffectType {
    type Output = Self;

    #[inline(always)]
    fn not(self) -> Self::Output {
        Self(!self.0)
    }
}

impl SDL_HapticEffectType {
    /// Constant effect supported.
    ///
    /// Constant haptic effect.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticCondition`]
    pub const CONSTANT: Self = Self((1_u32 as Uint16));
    /// Sine wave effect supported.
    ///
    /// Periodic haptic effect that simulates sine waves.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticPeriodic`]
    pub const SINE: Self = Self((2_u32 as Uint16));
    /// Square wave effect supported.
    ///
    /// Periodic haptic effect that simulates square waves.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticPeriodic`]
    pub const SQUARE: Self = Self((4_u32 as Uint16));
    /// Triangle wave effect supported.
    ///
    /// Periodic haptic effect that simulates triangular waves.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticPeriodic`]
    pub const TRIANGLE: Self = Self((8_u32 as Uint16));
    /// Sawtoothup wave effect supported.
    ///
    /// Periodic haptic effect that simulates saw tooth up waves.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticPeriodic`]
    pub const SAWTOOTHUP: Self = Self((16_u32 as Uint16));
    /// Sawtoothdown wave effect supported.
    ///
    /// Periodic haptic effect that simulates saw tooth down waves.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticPeriodic`]
    pub const SAWTOOTHDOWN: Self = Self((32_u32 as Uint16));
    /// Ramp effect supported.
    ///
    /// Ramp haptic effect.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticRamp`]
    pub const RAMP: Self = Self((64_u32 as Uint16));
    /// Spring effect supported - uses axes position.
    ///
    /// Condition haptic effect that simulates a spring. Effect is based on the
    /// axes position.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticCondition`]
    pub const SPRING: Self = Self((128_u32 as Uint16));
    /// Damper effect supported - uses axes velocity.
    ///
    /// Condition haptic effect that simulates dampening. Effect is based on the
    /// axes velocity.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticCondition`]
    pub const DAMPER: Self = Self((256_u32 as Uint16));
    /// Inertia effect supported - uses axes acceleration.
    ///
    /// Condition haptic effect that simulates inertia. Effect is based on the axes
    /// acceleration.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticCondition`]
    pub const INERTIA: Self = Self((512_u32 as Uint16));
    /// Friction effect supported - uses axes movement.
    ///
    /// Condition haptic effect that simulates friction. Effect is based on the
    /// axes movement.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticCondition`]
    pub const FRICTION: Self = Self((1024_u32 as Uint16));
    /// Left/Right effect supported.
    ///
    /// Haptic effect for direct control over high/low frequency motors.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticLeftRight`]
    pub const LEFTRIGHT: Self = Self((2048_u32 as Uint16));
    /// Reserved for future use.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    pub const RESERVED1: Self = Self((4096_u32 as Uint16));
    /// Reserved for future use.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    pub const RESERVED2: Self = Self((8192_u32 as Uint16));
    /// Reserved for future use.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    pub const RESERVED3: Self = Self((16384_u32 as Uint16));
    /// Custom effect is supported.
    ///
    /// User defined custom haptic effect.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    pub const CUSTOM: Self = Self((32768_u32 as Uint16));
    /// Device can set global gain.
    ///
    /// Device supports setting the global gain.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_SetHapticGain`]
    pub const GAIN: Self = Self((65536_u32 as Uint16));
    /// Device can set autocenter.
    ///
    /// Device supports setting autocenter.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_SetHapticAutocenter`]
    pub const AUTOCENTER: Self = Self((131072_u32 as Uint16));
    /// Device can be queried for effect status.
    ///
    /// Device supports querying effect status.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticEffectStatus`]
    pub const STATUS: Self = Self((262144_u32 as Uint16));
    /// Device can be paused.
    ///
    /// Devices supports being paused.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_PauseHaptic`]
    /// - [`SDL_ResumeHaptic`]
    pub const PAUSE: Self = Self((524288_u32 as Uint16));
}

/// Constant effect supported.
///
/// Constant haptic effect.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticCondition`]
pub const SDL_HAPTIC_CONSTANT: SDL_HapticEffectType = SDL_HapticEffectType::CONSTANT;
/// Sine wave effect supported.
///
/// Periodic haptic effect that simulates sine waves.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticPeriodic`]
pub const SDL_HAPTIC_SINE: SDL_HapticEffectType = SDL_HapticEffectType::SINE;
/// Square wave effect supported.
///
/// Periodic haptic effect that simulates square waves.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticPeriodic`]
pub const SDL_HAPTIC_SQUARE: SDL_HapticEffectType = SDL_HapticEffectType::SQUARE;
/// Triangle wave effect supported.
///
/// Periodic haptic effect that simulates triangular waves.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticPeriodic`]
pub const SDL_HAPTIC_TRIANGLE: SDL_HapticEffectType = SDL_HapticEffectType::TRIANGLE;
/// Sawtoothup wave effect supported.
///
/// Periodic haptic effect that simulates saw tooth up waves.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticPeriodic`]
pub const SDL_HAPTIC_SAWTOOTHUP: SDL_HapticEffectType = SDL_HapticEffectType::SAWTOOTHUP;
/// Sawtoothdown wave effect supported.
///
/// Periodic haptic effect that simulates saw tooth down waves.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticPeriodic`]
pub const SDL_HAPTIC_SAWTOOTHDOWN: SDL_HapticEffectType = SDL_HapticEffectType::SAWTOOTHDOWN;
/// Ramp effect supported.
///
/// Ramp haptic effect.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticRamp`]
pub const SDL_HAPTIC_RAMP: SDL_HapticEffectType = SDL_HapticEffectType::RAMP;
/// Spring effect supported - uses axes position.
///
/// Condition haptic effect that simulates a spring. Effect is based on the
/// axes position.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticCondition`]
pub const SDL_HAPTIC_SPRING: SDL_HapticEffectType = SDL_HapticEffectType::SPRING;
/// Damper effect supported - uses axes velocity.
///
/// Condition haptic effect that simulates dampening. Effect is based on the
/// axes velocity.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticCondition`]
pub const SDL_HAPTIC_DAMPER: SDL_HapticEffectType = SDL_HapticEffectType::DAMPER;
/// Inertia effect supported - uses axes acceleration.
///
/// Condition haptic effect that simulates inertia. Effect is based on the axes
/// acceleration.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticCondition`]
pub const SDL_HAPTIC_INERTIA: SDL_HapticEffectType = SDL_HapticEffectType::INERTIA;
/// Friction effect supported - uses axes movement.
///
/// Condition haptic effect that simulates friction. Effect is based on the
/// axes movement.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticCondition`]
pub const SDL_HAPTIC_FRICTION: SDL_HapticEffectType = SDL_HapticEffectType::FRICTION;
/// Left/Right effect supported.
///
/// Haptic effect for direct control over high/low frequency motors.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticLeftRight`]
pub const SDL_HAPTIC_LEFTRIGHT: SDL_HapticEffectType = SDL_HapticEffectType::LEFTRIGHT;
/// Reserved for future use.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
pub const SDL_HAPTIC_RESERVED1: SDL_HapticEffectType = SDL_HapticEffectType::RESERVED1;
/// Reserved for future use.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
pub const SDL_HAPTIC_RESERVED2: SDL_HapticEffectType = SDL_HapticEffectType::RESERVED2;
/// Reserved for future use.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
pub const SDL_HAPTIC_RESERVED3: SDL_HapticEffectType = SDL_HapticEffectType::RESERVED3;
/// Custom effect is supported.
///
/// User defined custom haptic effect.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
pub const SDL_HAPTIC_CUSTOM: SDL_HapticEffectType = SDL_HapticEffectType::CUSTOM;
/// Device can set global gain.
///
/// Device supports setting the global gain.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_SetHapticGain`]
pub const SDL_HAPTIC_GAIN: SDL_HapticEffectType = SDL_HapticEffectType::GAIN;
/// Device can set autocenter.
///
/// Device supports setting autocenter.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_SetHapticAutocenter`]
pub const SDL_HAPTIC_AUTOCENTER: SDL_HapticEffectType = SDL_HapticEffectType::AUTOCENTER;
/// Device can be queried for effect status.
///
/// Device supports querying effect status.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_GetHapticEffectStatus`]
pub const SDL_HAPTIC_STATUS: SDL_HapticEffectType = SDL_HapticEffectType::STATUS;
/// Device can be paused.
///
/// Devices supports being paused.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_PauseHaptic`]
/// - [`SDL_ResumeHaptic`]
pub const SDL_HAPTIC_PAUSE: SDL_HapticEffectType = SDL_HapticEffectType::PAUSE;

#[cfg(feature = "metadata")]
impl sdl3_sys::metadata::GroupMetadata for SDL_HapticEffectType {
    const GROUP_METADATA: &'static sdl3_sys::metadata::Group =
        &crate::metadata::haptic::METADATA_SDL_HapticEffectType;
}

/// * Type of coordinates used for haptic direction.
///
/// ## Known values (`sdl3-sys`)
/// | Associated constant | Global constant | Description |
/// | ------------------- | --------------- | ----------- |
/// | [`POLAR`](SDL_HapticDirectionType::POLAR) | [`SDL_HAPTIC_POLAR`] | Uses polar coordinates for the direction.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticDirection`] |
/// | [`CARTESIAN`](SDL_HapticDirectionType::CARTESIAN) | [`SDL_HAPTIC_CARTESIAN`] | Uses cartesian coordinates for the direction.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticDirection`] |
/// | [`SPHERICAL`](SDL_HapticDirectionType::SPHERICAL) | [`SDL_HAPTIC_SPHERICAL`] | Uses spherical coordinates for the direction.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticDirection`] |
/// | [`STEERING_AXIS`](SDL_HapticDirectionType::STEERING_AXIS) | [`SDL_HAPTIC_STEERING_AXIS`] | Use this value to play an effect on the steering wheel axis.  This provides better compatibility across platforms and devices as SDL will guess the correct axis.  \since This macro is available since SDL 3.2.0.  \sa [`SDL_HapticDirection`] |
#[repr(transparent)]
#[derive(Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct SDL_HapticDirectionType(pub Uint8);

impl ::core::cmp::PartialEq<Uint8> for SDL_HapticDirectionType {
    #[inline(always)]
    fn eq(&self, other: &Uint8) -> bool {
        &self.0 == other
    }
}

impl ::core::cmp::PartialEq<SDL_HapticDirectionType> for Uint8 {
    #[inline(always)]
    fn eq(&self, other: &SDL_HapticDirectionType) -> bool {
        self == &other.0
    }
}

impl From<SDL_HapticDirectionType> for Uint8 {
    #[inline(always)]
    fn from(value: SDL_HapticDirectionType) -> Self {
        value.0
    }
}

#[cfg(feature = "debug-impls")]
impl ::core::fmt::Debug for SDL_HapticDirectionType {
    fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
        #[allow(unreachable_patterns)]
        f.write_str(match *self {
            Self::POLAR => "SDL_HAPTIC_POLAR",
            Self::CARTESIAN => "SDL_HAPTIC_CARTESIAN",
            Self::SPHERICAL => "SDL_HAPTIC_SPHERICAL",
            Self::STEERING_AXIS => "SDL_HAPTIC_STEERING_AXIS",

            _ => return write!(f, "SDL_HapticDirectionType({})", self.0),
        })
    }
}

impl SDL_HapticDirectionType {
    /// Uses polar coordinates for the direction.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticDirection`]
    pub const POLAR: Self = Self((0 as Uint8));
    /// Uses cartesian coordinates for the direction.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticDirection`]
    pub const CARTESIAN: Self = Self((1 as Uint8));
    /// Uses spherical coordinates for the direction.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticDirection`]
    pub const SPHERICAL: Self = Self((2 as Uint8));
    /// Use this value to play an effect on the steering wheel axis.
    ///
    /// This provides better compatibility across platforms and devices as SDL will
    /// guess the correct axis.
    ///
    /// ## Availability
    /// This macro is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticDirection`]
    pub const STEERING_AXIS: Self = Self((3 as Uint8));
}

/// Uses polar coordinates for the direction.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticDirection`]
pub const SDL_HAPTIC_POLAR: SDL_HapticDirectionType = SDL_HapticDirectionType::POLAR;
/// Uses cartesian coordinates for the direction.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticDirection`]
pub const SDL_HAPTIC_CARTESIAN: SDL_HapticDirectionType = SDL_HapticDirectionType::CARTESIAN;
/// Uses spherical coordinates for the direction.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticDirection`]
pub const SDL_HAPTIC_SPHERICAL: SDL_HapticDirectionType = SDL_HapticDirectionType::SPHERICAL;
/// Use this value to play an effect on the steering wheel axis.
///
/// This provides better compatibility across platforms and devices as SDL will
/// guess the correct axis.
///
/// ## Availability
/// This macro is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticDirection`]
pub const SDL_HAPTIC_STEERING_AXIS: SDL_HapticDirectionType =
    SDL_HapticDirectionType::STEERING_AXIS;

#[cfg(feature = "metadata")]
impl sdl3_sys::metadata::GroupMetadata for SDL_HapticDirectionType {
    const GROUP_METADATA: &'static sdl3_sys::metadata::Group =
        &crate::metadata::haptic::METADATA_SDL_HapticDirectionType;
}

/// ID for haptic effects.
///
/// This is -1 if the ID is invalid.
///
/// ## See also
/// - [`SDL_CreateHapticEffect`]
#[repr(transparent)]
#[derive(Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticEffectID(pub ::core::ffi::c_int);

impl ::core::cmp::PartialEq<::core::ffi::c_int> for SDL_HapticEffectID {
    #[inline(always)]
    fn eq(&self, other: &::core::ffi::c_int) -> bool {
        &self.0 == other
    }
}

impl ::core::cmp::PartialEq<SDL_HapticEffectID> for ::core::ffi::c_int {
    #[inline(always)]
    fn eq(&self, other: &SDL_HapticEffectID) -> bool {
        self == &other.0
    }
}

impl From<SDL_HapticEffectID> for ::core::ffi::c_int {
    #[inline(always)]
    fn from(value: SDL_HapticEffectID) -> Self {
        value.0
    }
}

#[cfg(feature = "metadata")]
impl sdl3_sys::metadata::GroupMetadata for SDL_HapticEffectID {
    const GROUP_METADATA: &'static sdl3_sys::metadata::Group =
        &crate::metadata::haptic::METADATA_SDL_HapticEffectID;
}

/// Structure that represents a haptic direction.
///
/// This is the direction where the force comes from, instead of the direction
/// in which the force is exerted.
///
/// Directions can be specified by:
///
/// - [`SDL_HAPTIC_POLAR`] : Specified by polar coordinates.
/// - [`SDL_HAPTIC_CARTESIAN`] : Specified by cartesian coordinates.
/// - [`SDL_HAPTIC_SPHERICAL`] : Specified by spherical coordinates.
///
/// Cardinal directions of the haptic device are relative to the positioning of
/// the device. North is considered to be away from the user.
///
/// The following diagram represents the cardinal directions:
///
/// ```text
///                .--.
///                |__| .-------.
///                |=.| |.-----.|
///                |--| ||     ||
///                |  | |'-----'|
///                |__|~')_____('
///                  [ COMPUTER ]
///
///
///                    North (0,-1)
///                        ^
///                        |
///                        |
///  (-1,0)  West <----[ HAPTIC ]----> East (1,0)
///                        |
///                        |
///                        v
///                     South (0,1)
///
///
///                     [ USER ]
///                       \|||/
///                       (o o)
///                 ---ooO-(_)-Ooo---
/// ```
///
/// If type is [`SDL_HAPTIC_POLAR`], direction is encoded by hundredths of a degree
/// starting north and turning clockwise. [`SDL_HAPTIC_POLAR`] only uses the first
/// `dir` parameter. The cardinal directions would be:
///
/// - North: 0 (0 degrees)
/// - East: 9000 (90 degrees)
/// - South: 18000 (180 degrees)
/// - West: 27000 (270 degrees)
///
/// If type is [`SDL_HAPTIC_CARTESIAN`], direction is encoded by three positions (X
/// axis, Y axis and Z axis (with 3 axes)). [`SDL_HAPTIC_CARTESIAN`] uses the first
/// three `dir` parameters. The cardinal directions would be:
///
/// - North: 0,-1, 0
/// - East: 1, 0, 0
/// - South: 0, 1, 0
/// - West: -1, 0, 0
///
/// The Z axis represents the height of the effect if supported, otherwise it's
/// unused. In cartesian encoding (1, 2) would be the same as (2, 4), you can
/// use any multiple you want, only the direction matters.
///
/// If type is [`SDL_HAPTIC_SPHERICAL`], direction is encoded by two rotations. The
/// first two `dir` parameters are used. The `dir` parameters are as follows
/// (all values are in hundredths of degrees):
///
/// - Degrees from (1, 0) rotated towards (0, 1).
/// - Degrees towards (0, 0, 1) (device needs at least 3 axes).
///
/// Example of force coming from the south with all encodings (force coming
/// from the south means the user will have to pull the stick to counteract):
///
/// ```c
///  SDL_HapticDirection direction;
///
///  // Cartesian directions
///  direction.type = SDL_HAPTIC_CARTESIAN; // Using cartesian direction encoding.
///  direction.dir[0] = 0; // X position
///  direction.dir[1] = 1; // Y position
///  // Assuming the device has 2 axes, we don't need to specify third parameter.
///
///  // Polar directions
///  direction.type = SDL_HAPTIC_POLAR; // We'll be using polar direction encoding.
///  direction.dir[0] = 18000; // Polar only uses first parameter
///
///  // Spherical coordinates
///  direction.type = SDL_HAPTIC_SPHERICAL; // Spherical encoding
///  direction.dir[0] = 9000; // Since we only have two axes we don't need more parameters.
/// ```
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_POLAR`]
/// - [`SDL_HAPTIC_CARTESIAN`]
/// - [`SDL_HAPTIC_SPHERICAL`]
/// - [`SDL_HAPTIC_STEERING_AXIS`]
/// - [`SDL_HapticEffect`]
/// - [`SDL_GetNumHapticAxes`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticDirection {
    /// The type of encoding.
    pub r#type: SDL_HapticDirectionType,
    /// The encoded direction.
    pub dir: [Sint32; 3],
}

/// A structure containing a template for a Constant effect.
///
/// This struct is exclusively for the [`SDL_HAPTIC_CONSTANT`] effect.
///
/// A constant effect applies a constant force in the specified direction to
/// the joystick.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_CONSTANT`]
/// - [`SDL_HapticEffect`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticConstant {
    /// [`SDL_HAPTIC_CONSTANT`]
    pub r#type: SDL_HapticEffectType,
    /// Direction of the effect.
    pub direction: SDL_HapticDirection,
    /// Duration of the effect.
    pub length: Uint32,
    /// Delay before starting the effect.
    pub delay: Uint16,
    /// Button that triggers the effect.
    pub button: Uint16,
    /// How soon it can be triggered again after button.
    pub interval: Uint16,
    /// Strength of the constant effect.
    pub level: Sint16,
    /// Duration of the attack.
    pub attack_length: Uint16,
    /// Level at the start of the attack.
    pub attack_level: Uint16,
    /// Duration of the fade.
    pub fade_length: Uint16,
    /// Level at the end of the fade.
    pub fade_level: Uint16,
}

/// A structure containing a template for a Periodic effect.
///
/// The struct handles the following effects:
///
/// - [`SDL_HAPTIC_SINE`]
/// - [`SDL_HAPTIC_SQUARE`]
/// - [`SDL_HAPTIC_TRIANGLE`]
/// - [`SDL_HAPTIC_SAWTOOTHUP`]
/// - [`SDL_HAPTIC_SAWTOOTHDOWN`]
///
/// A periodic effect consists in a wave-shaped effect that repeats itself over
/// time. The type determines the shape of the wave and the parameters
/// determine the dimensions of the wave.
///
/// Phase is given by hundredth of a degree meaning that giving the phase a
/// value of 9000 will displace it 25% of its period. Here are sample values:
///
/// - 0: No phase displacement.
/// - 9000: Displaced 25% of its period.
/// - 18000: Displaced 50% of its period.
/// - 27000: Displaced 75% of its period.
/// - 36000: Displaced 100% of its period, same as 0, but 0 is preferred.
///
/// Examples:
///
/// ```text
///   SDL_HAPTIC_SINE
///     __      __      __      __
///    /  \    /  \    /  \    /
///   /    \__/    \__/    \__/
///
///   SDL_HAPTIC_SQUARE
///    __    __    __    __    __
///   |  |  |  |  |  |  |  |  |  |
///   |  |__|  |__|  |__|  |__|  |
///
///   SDL_HAPTIC_TRIANGLE
///     /\    /\    /\    /\    /\
///    /  \  /  \  /  \  /  \  /
///   /    \/    \/    \/    \/
///
///   SDL_HAPTIC_SAWTOOTHUP
///     /|  /|  /|  /|  /|  /|  /|
///    / | / | / | / | / | / | / |
///   /  |/  |/  |/  |/  |/  |/  |
///
///   SDL_HAPTIC_SAWTOOTHDOWN
///   \  |\  |\  |\  |\  |\  |\  |
///    \ | \ | \ | \ | \ | \ | \ |
///     \|  \|  \|  \|  \|  \|  \|
/// ```
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_SINE`]
/// - [`SDL_HAPTIC_SQUARE`]
/// - [`SDL_HAPTIC_TRIANGLE`]
/// - [`SDL_HAPTIC_SAWTOOTHUP`]
/// - [`SDL_HAPTIC_SAWTOOTHDOWN`]
/// - [`SDL_HapticEffect`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticPeriodic {
    /// [`SDL_HAPTIC_SINE`], [`SDL_HAPTIC_SQUARE`]
    /// [`SDL_HAPTIC_TRIANGLE`], [`SDL_HAPTIC_SAWTOOTHUP`] or
    /// [`SDL_HAPTIC_SAWTOOTHDOWN`]
    pub r#type: SDL_HapticEffectType,
    /// Direction of the effect.
    pub direction: SDL_HapticDirection,
    /// Duration of the effect.
    pub length: Uint32,
    /// Delay before starting the effect.
    pub delay: Uint16,
    /// Button that triggers the effect.
    pub button: Uint16,
    /// How soon it can be triggered again after button.
    pub interval: Uint16,
    /// Period of the wave.
    pub period: Uint16,
    /// Peak value; if negative, equivalent to 180 degrees extra phase shift.
    pub magnitude: Sint16,
    /// Mean value of the wave.
    pub offset: Sint16,
    /// Positive phase shift given by hundredth of a degree.
    pub phase: Uint16,
    /// Duration of the attack.
    pub attack_length: Uint16,
    /// Level at the start of the attack.
    pub attack_level: Uint16,
    /// Duration of the fade.
    pub fade_length: Uint16,
    /// Level at the end of the fade.
    pub fade_level: Uint16,
}

/// 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`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticCondition {
    /// [`SDL_HAPTIC_SPRING`], [`SDL_HAPTIC_DAMPER`],
    /// [`SDL_HAPTIC_INERTIA`] or [`SDL_HAPTIC_FRICTION`]
    pub r#type: SDL_HapticEffectType,
    /// Direction of the effect.
    pub direction: SDL_HapticDirection,
    /// Duration of the effect.
    pub length: Uint32,
    /// Delay before starting the effect.
    pub delay: Uint16,
    /// Button that triggers the effect.
    pub button: Uint16,
    /// How soon it can be triggered again after button.
    pub interval: Uint16,
    /// Level when joystick is to the positive side; max 0xFFFF.
    pub right_sat: [Uint16; 3],
    /// Level when joystick is to the negative side; max 0xFFFF.
    pub left_sat: [Uint16; 3],
    /// How fast to increase the force towards the positive side.
    pub right_coeff: [Sint16; 3],
    /// How fast to increase the force towards the negative side.
    pub left_coeff: [Sint16; 3],
    /// Size of the dead zone; max 0xFFFF: whole axis-range when 0-centered.
    pub deadband: [Uint16; 3],
    /// Position of the dead zone.
    pub center: [Sint16; 3],
}

/// A structure containing a template for a Ramp effect.
///
/// This struct is exclusively for the [`SDL_HAPTIC_RAMP`] effect.
///
/// The ramp effect starts at start strength and ends at end strength. It
/// augments in linear fashion. If you use attack and fade with a ramp the
/// effects get added to the ramp effect making the effect become quadratic
/// instead of linear.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_RAMP`]
/// - [`SDL_HapticEffect`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticRamp {
    /// [`SDL_HAPTIC_RAMP`]
    pub r#type: SDL_HapticEffectType,
    /// Direction of the effect.
    pub direction: SDL_HapticDirection,
    /// Duration of the effect.
    pub length: Uint32,
    /// Delay before starting the effect.
    pub delay: Uint16,
    /// Button that triggers the effect.
    pub button: Uint16,
    /// How soon it can be triggered again after button.
    pub interval: Uint16,
    /// Beginning strength level.
    pub start: Sint16,
    /// Ending strength level.
    pub end: Sint16,
    /// Duration of the attack.
    pub attack_length: Uint16,
    /// Level at the start of the attack.
    pub attack_level: Uint16,
    /// Duration of the fade.
    pub fade_length: Uint16,
    /// Level at the end of the fade.
    pub fade_level: Uint16,
}

/// A structure containing a template for a Left/Right effect.
///
/// This struct is exclusively for the [`SDL_HAPTIC_LEFTRIGHT`] effect.
///
/// The Left/Right effect is used to explicitly control the large and small
/// motors, commonly found in modern game controllers. The small (right) motor
/// is high frequency, and the large (left) motor is low frequency.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_LEFTRIGHT`]
/// - [`SDL_HapticEffect`]
#[repr(C)]
#[derive(Clone, Copy, Default, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticLeftRight {
    /// [`SDL_HAPTIC_LEFTRIGHT`]
    pub r#type: SDL_HapticEffectType,
    /// Duration of the effect in milliseconds.
    pub length: Uint32,
    /// Control of the large controller motor.
    pub large_magnitude: Uint16,
    /// Control of the small controller motor.
    pub small_magnitude: Uint16,
}

/// A structure containing a template for the [`SDL_HAPTIC_CUSTOM`] effect.
///
/// This struct is exclusively for the [`SDL_HAPTIC_CUSTOM`] effect.
///
/// A custom force feedback effect is much like a periodic effect, where the
/// application can define its exact shape. You will have to allocate the data
/// yourself. Data should consist of channels * samples Uint16 samples.
///
/// If channels is one, the effect is rotated using the defined direction.
/// Otherwise it uses the samples in data for the different axes.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HAPTIC_CUSTOM`]
/// - [`SDL_HapticEffect`]
#[repr(C)]
#[derive(Clone, Copy)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticCustom {
    /// [`SDL_HAPTIC_CUSTOM`]
    pub r#type: SDL_HapticEffectType,
    /// Direction of the effect.
    pub direction: SDL_HapticDirection,
    /// Duration of the effect.
    pub length: Uint32,
    /// Delay before starting the effect.
    pub delay: Uint16,
    /// Button that triggers the effect.
    pub button: Uint16,
    /// How soon it can be triggered again after button.
    pub interval: Uint16,
    /// Axes to use, minimum of one.
    pub channels: Uint8,
    /// Sample periods.
    pub period: Uint16,
    /// Amount of samples.
    pub samples: Uint16,
    /// Should contain channels*samples items.
    pub data: *mut Uint16,
    /// Duration of the attack.
    pub attack_length: Uint16,
    /// Level at the start of the attack.
    pub attack_level: Uint16,
    /// Duration of the fade.
    pub fade_length: Uint16,
    /// Level at the end of the fade.
    pub fade_level: Uint16,
}

impl ::core::default::Default for SDL_HapticCustom {
    /// Initialize all fields to zero
    #[inline(always)]
    fn default() -> Self {
        unsafe { ::core::mem::MaybeUninit::<Self>::zeroed().assume_init() }
    }
}

/// The generic template for any haptic effect.
///
/// All values max at 32767 (0x7FFF). Signed values also can be negative. Time
/// values unless specified otherwise are in milliseconds.
///
/// You can also pass [`SDL_HAPTIC_INFINITY`] to length instead of a 0-32767 value.
/// Neither delay, interval, attack_length nor fade_length support
/// [`SDL_HAPTIC_INFINITY`]. Fade will also not be used since effect never ends.
///
/// Additionally, the [`SDL_HAPTIC_RAMP`] effect does not support a duration of
/// [`SDL_HAPTIC_INFINITY`].
///
/// Button triggers may not be supported on all devices, it is advised to not
/// use them if possible. Buttons start at index 1 instead of index 0 like the
/// joystick.
///
/// If both attack_length and fade_level are 0, the envelope is not used,
/// otherwise both values are used.
///
/// Common parts:
///
/// ```c
///  // Replay - All effects have this
///  Uint32 length;        // Duration of effect (ms).
///  Uint16 delay;         // Delay before starting effect.
///
///  // Trigger - All effects have this
///  Uint16 button;        // Button that triggers effect.
///  Uint16 interval;      // How soon before effect can be triggered again.
///
///  // Envelope - All effects except condition effects have this
///  Uint16 attack_length; // Duration of the attack (ms).
///  Uint16 attack_level;  // Level at the start of the attack.
///  Uint16 fade_length;   // Duration of the fade out (ms).
///  Uint16 fade_level;    // Level at the end of the fade.
/// ```
///
/// Here we have an example of a constant effect evolution in time:
///
/// ```text
///  Strength
///  ^
///  |
///  |    effect level -->  _________________
///  |                     /                 \
///  |                    /                   \
///  |                   /                     \
///  |                  /                       \
///  | attack_level --> |                        \
///  |                  |                        |  <---  fade_level
///  |
///  +--------------------------------------------------> Time
///                     [--]                 [---]
///                     attack_length        fade_length
///
///  [------------------][-----------------------]
///  delay               length
/// ```
///
/// Note either the attack_level or the fade_level may be above the actual
/// effect level.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_HapticConstant`]
/// - [`SDL_HapticPeriodic`]
/// - [`SDL_HapticCondition`]
/// - [`SDL_HapticRamp`]
/// - [`SDL_HapticLeftRight`]
/// - [`SDL_HapticCustom`]
#[repr(C)]
#[derive(Clone, Copy)]
pub union SDL_HapticEffect {
    /// Effect type.
    pub r#type: SDL_HapticEffectType,
    /// Constant effect.
    pub constant: SDL_HapticConstant,
    /// Periodic effect.
    pub periodic: SDL_HapticPeriodic,
    /// Condition effect.
    pub condition: SDL_HapticCondition,
    /// Ramp effect.
    pub ramp: SDL_HapticRamp,
    /// Left/Right effect.
    pub leftright: SDL_HapticLeftRight,
    /// Custom effect.
    pub custom: SDL_HapticCustom,
}

impl ::core::default::Default for SDL_HapticEffect {
    /// Initialize all fields to zero
    #[inline(always)]
    fn default() -> Self {
        unsafe { ::core::mem::MaybeUninit::<Self>::zeroed().assume_init() }
    }
}

/// This is a unique ID for a haptic device for the time it is connected to the
/// system, and is never reused for the lifetime of the application.
///
/// If the haptic device is disconnected and reconnected, it will get a new ID.
///
/// The value 0 is an invalid ID.
///
/// ## Availability
/// This datatype is available since SDL 3.2.0.
#[repr(transparent)]
#[derive(Clone, Copy, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[cfg_attr(feature = "debug-impls", derive(Debug))]
pub struct SDL_HapticID(pub Uint32);

impl ::core::cmp::PartialEq<Uint32> for SDL_HapticID {
    #[inline(always)]
    fn eq(&self, other: &Uint32) -> bool {
        &self.0 == other
    }
}

impl ::core::cmp::PartialEq<SDL_HapticID> for Uint32 {
    #[inline(always)]
    fn eq(&self, other: &SDL_HapticID) -> bool {
        self == &other.0
    }
}

impl From<SDL_HapticID> for Uint32 {
    #[inline(always)]
    fn from(value: SDL_HapticID) -> Self {
        value.0
    }
}

#[cfg(feature = "metadata")]
impl sdl3_sys::metadata::GroupMetadata for SDL_HapticID {
    const GROUP_METADATA: &'static sdl3_sys::metadata::Group =
        &crate::metadata::haptic::METADATA_SDL_HapticID;
}

unsafe extern "C" {
    /// Get a list of currently connected haptic devices.
    ///
    /// ## Parameters
    /// - `count`: a pointer filled in with the number of haptic devices
    ///   returned, may be NULL.
    ///
    /// ## Return value
    /// Returns a 0 terminated array of haptic device instance IDs or NULL on
    ///   failure; call [`SDL_GetError()`] for more information. This should be
    ///   freed with [`SDL_free()`] when it is no longer needed.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_OpenHaptic`]
    pub fn SDL_GetHaptics(count: *mut ::core::ffi::c_int) -> *mut SDL_HapticID;
}

unsafe extern "C" {
    /// Get the implementation dependent name of a haptic device.
    ///
    /// This can be called before any haptic devices are opened.
    ///
    /// ## Parameters
    /// - `instance_id`: the haptic device instance ID.
    ///
    /// ## Return value
    /// Returns the name of the selected haptic device. If no name can be found,
    ///   this function returns NULL; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticName`]
    /// - [`SDL_OpenHaptic`]
    pub fn SDL_GetHapticNameForID(instance_id: SDL_HapticID) -> *const ::core::ffi::c_char;
}

unsafe extern "C" {
    /// Open a haptic device for use.
    ///
    /// The index passed as an argument refers to the N'th haptic device on this
    /// system.
    ///
    /// When opening a haptic device, its gain will be set to maximum and
    /// autocenter will be disabled. To modify these values use [`SDL_SetHapticGain()`]
    /// and [`SDL_SetHapticAutocenter()`].
    ///
    /// ## Parameters
    /// - `instance_id`: the haptic device instance ID.
    ///
    /// ## Return value
    /// Returns the device identifier or NULL on failure; call [`SDL_GetError()`] for
    ///   more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CloseHaptic`]
    /// - [`SDL_GetHaptics`]
    /// - [`SDL_OpenHapticFromJoystick`]
    /// - [`SDL_OpenHapticFromMouse`]
    /// - [`SDL_SetHapticAutocenter`]
    /// - [`SDL_SetHapticGain`]
    pub fn SDL_OpenHaptic(instance_id: SDL_HapticID) -> *mut SDL_Haptic;
}

unsafe extern "C" {
    /// Get the [`SDL_Haptic`] associated with an instance ID, if it has been opened.
    ///
    /// ## Parameters
    /// - `instance_id`: the instance ID to get the [`SDL_Haptic`] for.
    ///
    /// ## Return value
    /// Returns an [`SDL_Haptic`] on success or NULL on failure or if it hasn't been
    ///   opened yet; call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    pub fn SDL_GetHapticFromID(instance_id: SDL_HapticID) -> *mut SDL_Haptic;
}

unsafe extern "C" {
    /// Get the instance ID of an opened haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query.
    ///
    /// ## Return value
    /// Returns the instance ID of the specified haptic device on success or 0 on
    ///   failure; call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    pub fn SDL_GetHapticID(haptic: *mut SDL_Haptic) -> SDL_HapticID;
}

unsafe extern "C" {
    /// Get the implementation dependent name of a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] obtained from [`SDL_OpenJoystick()`].
    ///
    /// ## Return value
    /// Returns the name of the selected haptic device. If no name can be found,
    ///   this function returns NULL; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticNameForID`]
    pub fn SDL_GetHapticName(haptic: *mut SDL_Haptic) -> *const ::core::ffi::c_char;
}

unsafe extern "C" {
    /// Query whether or not the current mouse has haptic capabilities.
    ///
    /// ## Return value
    /// Returns true if the mouse is haptic or false if it isn't.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_OpenHapticFromMouse`]
    pub fn SDL_IsMouseHaptic() -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Try to open a haptic device from the current mouse.
    ///
    /// ## Return value
    /// Returns the haptic device identifier or NULL on failure; call
    ///   [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CloseHaptic`]
    /// - [`SDL_IsMouseHaptic`]
    pub fn SDL_OpenHapticFromMouse() -> *mut SDL_Haptic;
}

unsafe extern "C" {
    /// Query if a joystick has haptic features.
    ///
    /// ## Parameters
    /// - `joystick`: the [`SDL_Joystick`] to test for haptic capabilities.
    ///
    /// ## Return value
    /// Returns true if the joystick is haptic or false if it isn't.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_OpenHapticFromJoystick`]
    pub fn SDL_IsJoystickHaptic(joystick: *mut SDL_Joystick) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Open a haptic device for use from a joystick device.
    ///
    /// You must still close the haptic device separately. It will not be closed
    /// with the joystick.
    ///
    /// When opened from a joystick you should first close the haptic device before
    /// closing the joystick device. If not, on some implementations the haptic
    /// device will also get unallocated and you'll be unable to use force feedback
    /// on that device.
    ///
    /// ## Parameters
    /// - `joystick`: the [`SDL_Joystick`] to create a haptic device from.
    ///
    /// ## Return value
    /// Returns a valid haptic device identifier on success or NULL on failure;
    ///   call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CloseHaptic`]
    /// - [`SDL_IsJoystickHaptic`]
    pub fn SDL_OpenHapticFromJoystick(joystick: *mut SDL_Joystick) -> *mut SDL_Haptic;
}

unsafe extern "C" {
    /// Close a haptic device previously opened with [`SDL_OpenHaptic()`].
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to close.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_OpenHaptic`]
    pub fn SDL_CloseHaptic(haptic: *mut SDL_Haptic);
}

unsafe extern "C" {
    /// Get the number of effects a haptic device can store.
    ///
    /// On some platforms this isn't fully supported, and therefore is an
    /// approximation. Always check to see if your created effect was actually
    /// created and do not rely solely on [`SDL_GetMaxHapticEffects()`].
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query.
    ///
    /// ## Return value
    /// Returns the number of effects the haptic device can store or a negative
    ///   error code on failure; call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetMaxHapticEffectsPlaying`]
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_GetMaxHapticEffects(haptic: *mut SDL_Haptic) -> ::core::ffi::c_int;
}

unsafe extern "C" {
    /// Get the number of effects a haptic device can play at the same time.
    ///
    /// This is not supported on all platforms, but will always return a value.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query maximum playing effects.
    ///
    /// ## Return value
    /// Returns the number of effects the haptic device can play at the same time
    ///   or -1 on failure; call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetMaxHapticEffects`]
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_GetMaxHapticEffectsPlaying(haptic: *mut SDL_Haptic) -> ::core::ffi::c_int;
}

unsafe extern "C" {
    /// Get the haptic device's supported features in bitwise manner.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query.
    ///
    /// ## Return value
    /// Returns a list of supported haptic features in bitwise manner (OR'd), or 0
    ///   on failure; call [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_HapticEffectSupported`]
    /// - [`SDL_GetMaxHapticEffects`]
    pub fn SDL_GetHapticFeatures(haptic: *mut SDL_Haptic) -> Uint32;
}

unsafe extern "C" {
    /// Get the number of haptic axes the device has.
    ///
    /// The number of haptic axes might be useful if working with the
    /// [`SDL_HapticDirection`] effect.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query.
    ///
    /// ## Return value
    /// Returns the number of axes on success or -1 on failure; call
    ///   [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    pub fn SDL_GetNumHapticAxes(haptic: *mut SDL_Haptic) -> ::core::ffi::c_int;
}

unsafe extern "C" {
    /// Check to see if an effect is supported by a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query.
    /// - `effect`: the desired effect to query.
    ///
    /// ## Return value
    /// Returns true if the effect is supported or false if it isn't.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CreateHapticEffect`]
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_HapticEffectSupported(
        haptic: *mut SDL_Haptic,
        effect: *const SDL_HapticEffect,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Create a new haptic effect on a specified device.
    ///
    /// ## Parameters
    /// - `haptic`: an [`SDL_Haptic`] device to create the effect on.
    /// - `effect`: an [`SDL_HapticEffect`] structure containing the properties of
    ///   the effect to create.
    ///
    /// ## Return value
    /// Returns the ID of the effect on success or -1 on failure; call
    ///   [`SDL_GetError()`] for more information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_DestroyHapticEffect`]
    /// - [`SDL_RunHapticEffect`]
    /// - [`SDL_UpdateHapticEffect`]
    pub fn SDL_CreateHapticEffect(
        haptic: *mut SDL_Haptic,
        effect: *const SDL_HapticEffect,
    ) -> SDL_HapticEffectID;
}

unsafe extern "C" {
    /// Update the properties of an effect.
    ///
    /// Can be used dynamically, although behavior when dynamically changing
    /// direction may be strange. Specifically the effect may re-upload itself and
    /// start playing from the start. You also cannot change the type either when
    /// running [`SDL_UpdateHapticEffect()`].
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device that has the effect.
    /// - `effect`: the identifier of the effect to update.
    /// - `data`: an [`SDL_HapticEffect`] structure containing the new effect
    ///   properties to use.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CreateHapticEffect`]
    /// - [`SDL_RunHapticEffect`]
    pub fn SDL_UpdateHapticEffect(
        haptic: *mut SDL_Haptic,
        effect: SDL_HapticEffectID,
        data: *const SDL_HapticEffect,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Run the haptic effect on its associated haptic device.
    ///
    /// To repeat the effect over and over indefinitely, set `iterations` to
    /// [`SDL_HAPTIC_INFINITY`]. (Repeats the envelope - attack and fade.) To make
    /// one instance of the effect last indefinitely (so the effect does not fade),
    /// set the effect's `length` in its structure/union to [`SDL_HAPTIC_INFINITY`]
    /// instead.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to run the effect on.
    /// - `effect`: the ID of the haptic effect to run.
    /// - `iterations`: the number of iterations to run the effect; use
    ///   [`SDL_HAPTIC_INFINITY`] to repeat forever.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticEffectStatus`]
    /// - [`SDL_StopHapticEffect`]
    /// - [`SDL_StopHapticEffects`]
    pub fn SDL_RunHapticEffect(
        haptic: *mut SDL_Haptic,
        effect: SDL_HapticEffectID,
        iterations: Uint32,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Stop the haptic effect on its associated haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to stop the effect on.
    /// - `effect`: the ID of the haptic effect to stop.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_RunHapticEffect`]
    /// - [`SDL_StopHapticEffects`]
    pub fn SDL_StopHapticEffect(
        haptic: *mut SDL_Haptic,
        effect: SDL_HapticEffectID,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Destroy a haptic effect on the device.
    ///
    /// This will stop the effect if it's running. Effects are automatically
    /// destroyed when the device is closed.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to destroy the effect on.
    /// - `effect`: the ID of the haptic effect to destroy.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_CreateHapticEffect`]
    pub fn SDL_DestroyHapticEffect(haptic: *mut SDL_Haptic, effect: SDL_HapticEffectID);
}

unsafe extern "C" {
    /// Get the status of the current effect on the specified haptic device.
    ///
    /// Device must support the [`SDL_HAPTIC_STATUS`] feature.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to query for the effect status on.
    /// - `effect`: the ID of the haptic effect to query its status.
    ///
    /// ## Return value
    /// Returns true if it is playing, false if it isn't playing or haptic status
    ///   isn't supported.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_GetHapticEffectStatus(
        haptic: *mut SDL_Haptic,
        effect: SDL_HapticEffectID,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Set the global gain of the specified haptic device.
    ///
    /// Device must support the [`SDL_HAPTIC_GAIN`] feature.
    ///
    /// The user may specify the maximum gain by setting the environment variable
    /// `SDL_HAPTIC_GAIN_MAX` which should be between 0 and 100. All calls to
    /// [`SDL_SetHapticGain()`] will scale linearly using `SDL_HAPTIC_GAIN_MAX` as the
    /// maximum.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to set the gain on.
    /// - `gain`: value to set the gain to, should be between 0 and 100 (0 -
    ///   100).
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_SetHapticGain(
        haptic: *mut SDL_Haptic,
        gain: ::core::ffi::c_int,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Set the global autocenter of the device.
    ///
    /// Autocenter should be between 0 and 100. Setting it to 0 will disable
    /// autocentering.
    ///
    /// Device must support the [`SDL_HAPTIC_AUTOCENTER`] feature.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to set autocentering on.
    /// - `autocenter`: value to set autocenter to (0-100).
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_GetHapticFeatures`]
    pub fn SDL_SetHapticAutocenter(
        haptic: *mut SDL_Haptic,
        autocenter: ::core::ffi::c_int,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Pause a haptic device.
    ///
    /// Device must support the [`SDL_HAPTIC_PAUSE`] feature. Call [`SDL_ResumeHaptic()`]
    /// to resume playback.
    ///
    /// Do not modify the effects nor add new ones while the device is paused. That
    /// can cause all sorts of weird errors.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to pause.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_ResumeHaptic`]
    pub fn SDL_PauseHaptic(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Resume a haptic device.
    ///
    /// Call to unpause after [`SDL_PauseHaptic()`].
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to unpause.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_PauseHaptic`]
    pub fn SDL_ResumeHaptic(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Stop all the currently playing effects on a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the [`SDL_Haptic`] device to stop.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_RunHapticEffect`]
    /// - [`SDL_StopHapticEffects`]
    pub fn SDL_StopHapticEffects(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Check whether rumble is supported on a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: haptic device to check for rumble support.
    ///
    /// ## Return value
    /// Returns true if the effect is supported or false if it isn't.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_InitHapticRumble`]
    pub fn SDL_HapticRumbleSupported(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Initialize a haptic device for simple rumble playback.
    ///
    /// ## Parameters
    /// - `haptic`: the haptic device to initialize for simple rumble playback.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_PlayHapticRumble`]
    /// - [`SDL_StopHapticRumble`]
    /// - [`SDL_HapticRumbleSupported`]
    pub fn SDL_InitHapticRumble(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Run a simple rumble effect on a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the haptic device to play the rumble effect on.
    /// - `strength`: strength of the rumble to play as a 0-1 float value.
    /// - `length`: length of the rumble to play in milliseconds.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_InitHapticRumble`]
    /// - [`SDL_StopHapticRumble`]
    pub fn SDL_PlayHapticRumble(
        haptic: *mut SDL_Haptic,
        strength: ::core::ffi::c_float,
        length: Uint32,
    ) -> ::core::primitive::bool;
}

unsafe extern "C" {
    /// Stop the simple rumble on a haptic device.
    ///
    /// ## Parameters
    /// - `haptic`: the haptic device to stop the rumble effect on.
    ///
    /// ## Return value
    /// Returns true on success or false on failure; call [`SDL_GetError()`] for more
    ///   information.
    ///
    /// ## Availability
    /// This function is available since SDL 3.2.0.
    ///
    /// ## See also
    /// - [`SDL_PlayHapticRumble`]
    pub fn SDL_StopHapticRumble(haptic: *mut SDL_Haptic) -> ::core::primitive::bool;
}

/// The haptic structure used to identify an SDL haptic.
///
/// ## Availability
/// This struct is available since SDL 3.2.0.
///
/// ## See also
/// - [`SDL_OpenHaptic`]
/// - [`SDL_OpenHapticFromJoystick`]
/// - [`SDL_CloseHaptic`]
#[repr(C)]
pub struct SDL_Haptic {
    _opaque: [::core::primitive::u8; 0],
}

#[cfg(doc)]
use crate::everything::*;