|
Size: 1188
Comment: create page, add content (Rev 5321)
|
Size: 1212
Comment: Added Version section.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
| #pragma disable-camelcase | #pragma camelcase off |
| Line 6: | Line 6: |
| Use this function to open a __H__aptic device for ,,usage,, ^use^ from a Joystick device. | Use this function to open a haptic device for use from a joystick device. |
| Line 16: | Line 16: |
| ||'''joystick'''||^a pointer to a^ joystick to create a haptic device from|| | ||'''joystick'''||^the^ SDL_Joystick to create a haptic device from|| |
| Line 19: | Line 19: |
| Returns valid haptic device identifier on success, or NULL on error; call [[SDL_GetError]]() for more information. | Returns a valid haptic device identifier on success or NULL on failure; call [[SDL_GetError]]() for more information. |
| Line 27: | Line 27: |
| You must still close the haptic device seperately. It will not be closed with the joystick. | You must still close the haptic device separately. It will not be closed with the joystick. |
| Line 29: | Line 29: |
| When ,,opening,, ^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. | 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 2.0.0. |
DRAFT |
SDL_HapticOpenFromJoystick
Use this function to open a haptic device for use from a joystick device.
Contents
Syntax
SDL_Haptic* SDL_HapticOpenFromJoystick(SDL_Joystick* joystick)
Function Parameters
joystick |
the SDL_Joystick to create a haptic device from |
Return Value
Returns a valid haptic device identifier on success or NULL on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
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 2.0.0.
