SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_OpenHapticFromJoystick

Open a haptic device for use from a joystick device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

SDL_Haptic* SDL_OpenHapticFromJoystick(SDL_Joystick *joystick);

Function Parameters

SDL_Joystick * joystick the SDL_Joystick to create a haptic device from.

Return Value

(SDL_Haptic *) Returns a valid haptic device identifier on success or NULL on failure; call SDL_GetError() for more information.

Remarks

You must still close the haptic device separately. It will not be closed with the joystick.

When opened from a joystick you should first close the haptic device before closing the joystick device. If not, on some implementations the haptic device will also get unallocated and you'll be unable to use force feedback on that device.

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryHaptic


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.