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

SDL_HapticOpen

Open a haptic device for use.

Header File

Syntax

SDL_Haptic* SDL_HapticOpen(int device_index);

Function Parameters

int

device_index

index of the device to open.

Return Value

(SDL_Haptic *) Returns the device identifier or NULL on failure; call SDL_GetError() for more information.

Remarks

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_HapticSetGain() and SDL_HapticSetAutocenter().

Version

This function is available since SDL 2.0.0.