SDL_OpenHaptic(3)

SDL_OpenHaptic3

Open a haptic device for use.

Usage

#include "SDL3/SDL.h"

SDL_Haptic * SDL_OpenHaptic(SDL_HapticID instance_id);

Header file

Defined in SDL3/SDL_haptic.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.