SDL_OpenHaptic - Man Page

Open a haptic device for use.

Header File

Defined in SDL3/SDL_haptic.h

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

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

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_CloseHaptic(3), ·(3), SDL_GetHaptics(3), ·(3), SDL_OpenHapticFromJoystick(3), ·(3), SDL_OpenHapticFromMouse(3), ·(3), SDL_SetHapticAutocenter(3), ·(3), SDL_SetHapticGain(3)

Referenced By

SDL_CloseHaptic(3), SDL_GetHapticNameForID(3), SDL_GetHaptics(3), SDL_Haptic.3type(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS