Struct SDL_HapticEffectType 

#[repr(transparent)]
pub struct SDL_HapticEffectType(pub Uint16);

• Type of haptic effect.

Known values (sdl3-sys)

Associated constant	Global constant	Description
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_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_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_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_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_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_HAPTIC_RAMP	Ramp effect supported. Ramp haptic effect. \since This macro is available since SDL 3.2.0. \sa SDL_HapticRamp
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_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_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_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_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_HAPTIC_RESERVED1	Reserved for future use. \since This macro is available since SDL 3.2.0.
RESERVED2	SDL_HAPTIC_RESERVED2	Reserved for future use. \since This macro is available since SDL 3.2.0.
RESERVED3	SDL_HAPTIC_RESERVED3	Reserved for future use. \since This macro is available since SDL 3.2.0.
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_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_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_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_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

Tuple Fields

0: Uint16

Implementations

impl SDL_HapticEffectType

pub const CONSTANT: Self

Constant effect supported.

Constant haptic effect.

Availability

This macro is available since SDL 3.2.0.

See also

• SDL_HapticCondition

pub const SINE: Self

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 SQUARE: Self

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 TRIANGLE: Self

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 SAWTOOTHUP: Self

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 SAWTOOTHDOWN: Self

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 RAMP: Self

Ramp effect supported.

Ramp haptic effect.

Availability

This macro is available since SDL 3.2.0.

See also

• SDL_HapticRamp

pub const SPRING: Self

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 DAMPER: Self

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 INERTIA: Self

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 FRICTION: Self

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 LEFTRIGHT: Self

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 RESERVED1: Self

Reserved for future use.

Availability

This macro is available since SDL 3.2.0.

pub const RESERVED2: Self

Reserved for future use.

Availability

This macro is available since SDL 3.2.0.

pub const RESERVED3: Self

Reserved for future use.

Availability

This macro is available since SDL 3.2.0.

pub const CUSTOM: Self

Custom effect is supported.

User defined custom haptic effect.

Availability

This macro is available since SDL 3.2.0.

pub const GAIN: Self

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 AUTOCENTER: Self

Device can set autocenter.

Device supports setting autocenter.

Availability

This macro is available since SDL 3.2.0.

See also

• SDL_SetHapticAutocenter

pub const STATUS: Self

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 PAUSE: Self

Device can be paused.

Devices supports being paused.

Availability

This macro is available since SDL 3.2.0.

See also

• SDL_PauseHaptic
• SDL_ResumeHaptic

Trait Implementations

impl BitAnd for SDL_HapticEffectType

type Output = SDL_HapticEffectType

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for SDL_HapticEffectType

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for SDL_HapticEffectType

type Output = SDL_HapticEffectType

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for SDL_HapticEffectType

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for SDL_HapticEffectType

type Output = SDL_HapticEffectType

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for SDL_HapticEffectType

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for SDL_HapticEffectType

fn clone(&self) -> SDL_HapticEffectType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_HapticEffectType

Available on crate feature debug-impls only.

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

Formats the value using the given formatter.

impl Default for SDL_HapticEffectType

fn default() -> SDL_HapticEffectType

Returns the “default value” for a type.

impl From<SDL_HapticEffectType> for Uint16

fn from(value: SDL_HapticEffectType) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_HapticEffectType

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_HapticEffectType

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 Not for SDL_HapticEffectType

type Output = SDL_HapticEffectType

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<SDL_HapticEffectType> for Uint16

fn eq(&self, other: &SDL_HapticEffectType) -> 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 PartialEq<u16> for SDL_HapticEffectType

fn eq(&self, other: &Uint16) -> 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 PartialEq for SDL_HapticEffectType

fn eq(&self, other: &SDL_HapticEffectType) -> 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_HapticEffectType

impl Eq for SDL_HapticEffectType

impl StructuralPartialEq for SDL_HapticEffectType