cpp-sdl2
C++ header-only SDL2 wrapper
sdl::Haptic::Effect Union Reference

Effect defintion. More...

#include <haptic.hpp>

Public Member Functions

 operator SDL_HapticEffect * () const
 Custom effect. More...
 
 Effect ()
 Construct the effect. Fill it with zeroes. More...
 

Public Attributes

Uint16 type
 
SDL_HapticConstant constant
 Effect type. More...
 
SDL_HapticPeriodic periodic
 Constant effect. More...
 
SDL_HapticCondition condition
 Periodic effect. More...
 
SDL_HapticRamp ramp
 Condition effect. More...
 
SDL_HapticLeftRight leftright
 Ramp effect. More...
 
SDL_HapticCustom custom
 Left/Right effect. More...
 

Detailed Description

Effect defintion.

Definition at line 81 of file haptic.hpp.

Constructor & Destructor Documentation

◆ Effect()

sdl::Haptic::Effect::Effect ( )
inline

Construct the effect. Fill it with zeroes.

Definition at line 103 of file haptic.hpp.

References type.

Member Function Documentation

◆ operator SDL_HapticEffect *()

sdl::Haptic::Effect::operator SDL_HapticEffect * ( ) const
inline

Custom effect.

this permit to treat an sdl::haptic::effect instance as if it was an SDL_HapticEffect pointer

Definition at line 96 of file haptic.hpp.

Member Data Documentation

◆ condition

SDL_HapticCondition sdl::Haptic::Effect::condition

Periodic effect.

Definition at line 90 of file haptic.hpp.

◆ constant

SDL_HapticConstant sdl::Haptic::Effect::constant

Effect type.

Definition at line 88 of file haptic.hpp.

◆ custom

SDL_HapticCustom sdl::Haptic::Effect::custom

Left/Right effect.

Definition at line 93 of file haptic.hpp.

◆ leftright

SDL_HapticLeftRight sdl::Haptic::Effect::leftright

Ramp effect.

Definition at line 92 of file haptic.hpp.

◆ periodic

SDL_HapticPeriodic sdl::Haptic::Effect::periodic

Constant effect.

Definition at line 89 of file haptic.hpp.

◆ ramp

SDL_HapticRamp sdl::Haptic::Effect::ramp

Condition effect.

Definition at line 91 of file haptic.hpp.

◆ type

Uint16 sdl::Haptic::Effect::type

Definition at line 87 of file haptic.hpp.

Referenced by Effect(), sdl::Haptic::is_effect_compatible(), and sdl::Haptic::new_effect().


The documentation for this union was generated from the following file: