table of contents
- experimental 3.1.0+ds-1
SDL_OpenHaptic(3) | SDL3 FUNCTIONS | SDL_OpenHaptic(3) |
NAME¶
SDL_OpenHaptic - Open a haptic device for use.
SYNOPSIS¶
#include "SDL3/SDL.h"
SDL_Haptic* SDL_OpenHaptic(SDL_HapticID instance_id);
DESCRIPTION¶
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_SetHapticGain () and
SDL_SetHapticAutocenter ().
FUNCTION PARAMETERS¶
- instance_id
- the haptic device instance ID
RETURN VALUE¶
Returns the device identifier or NULL on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL_CloseHaptic(3), SDL_GetHaptics(3), SDL_OpenHapticFromJoystick(3), SDL_OpenHapticFromMouse(3), SDL_SetHapticAutocenter(3), SDL_SetHapticGain(3)
SDL 3.1.0 | SDL |