###### (This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)
# SDL_HapticNewEffect

Create a new haptic effect on a specified device.

## Header File

Defined in [SDL_haptic.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_haptic.h)

## Syntax

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

## Function Parameters

|                                        |            |                                                                                                      |
| -------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------- |
| [SDL_Haptic](SDL_Haptic) *             | **haptic** | an [SDL_Haptic](SDL_Haptic) device to create the effect on.                                          |
| [SDL_HapticEffect](SDL_HapticEffect) * | **effect** | an [SDL_HapticEffect](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](SDL_GetError)() for more information.

## Version

This function is available since SDL 2.0.0.

## See Also

- [SDL_HapticDestroyEffect](SDL_HapticDestroyEffect)
- [SDL_HapticRunEffect](SDL_HapticRunEffect)
- [SDL_HapticUpdateEffect](SDL_HapticUpdateEffect)

----
[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction), [CategoryHaptic](CategoryHaptic)