SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)


Create a new haptic effect on a specified device.

Header File

Defined in SDL_haptic.h


int SDL_HapticNewEffect(SDL_Haptic * haptic,
                    SDL_HapticEffect * effect);

Function Parameters

SDL_Haptic * haptic an SDL_Haptic device to create the effect on.
SDL_HapticEffect * effect an SDL_HapticEffect structure containing the properties of the effect to create.

Return Value

(int) Returns the ID of the effect on success or a negative error code on failure; call SDL_GetError() for more information.


This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.