gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

wikiheaders: bridge wiki Category docs to the headers!

Browse Source 
Did an initial cleanup on the headers and wrote a few pieces of documentation,
but this needs more work to fill out the documentation.
This commit is contained in:
Ryan C. Gordon
2024-05-16 10:44:37 -04:00
parent 558630d59c
commit 5e6d85b8f0
68 changed files with 617 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
include/SDL3/SDL_gamepad.h
View File

@@ -20,9 +20,37 @@
*/
/**
* \file SDL_gamepad.h
* # CategoryGamepad
*
* Include file for SDL gamepad event handling
* SDL provides a low-level joystick API, which just treats joysticks as an
* arbitrary pile of buttons, axes, and hat switches. If you're planning to
* write your own control configuration screen, this can give you a lot of
* flexibility, but that's a lot of work, and most things that we consider
* "joysticks" now are actually console-style gamepads. So SDL provides the
* gamepad API on top of the lower-level joystick functionality.
*
* The difference betweena joystick and a gamepad is that a gamepad tells you
* _where_ a button or axis is on the device. You don't speak to gamepads in
* terms of arbitrary numbers like "button 3" or "axis 2" but in standard
* locations: the d-pad, the shoulder buttons, triggers, A/B/X/Y (or
* X/O/Square/Triangle, if you will).
*
* One turns a joystick into a gamepad by providing a magic configuration
* string, which tells SDL the details of a specific device: when you see this
* specific hardware, if button 2 gets pressed, this is actually D-Pad Up,
* etc.
*
* SDL has many popular controllers configured out of the box, and users can
* add their own controller details through an environment variable if it's
* otherwise unknown to SDL.
*
* In order to use these functions, SDL_Init() must have been called with the
* SDL_INIT_GAMEPAD flag. This causes SDL to scan the system for gamepads, and
* load appropriate drivers.
*
* If you would like to receive gamepad updates while the application is in
* the background, you should set the following hint before calling
* SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
*/
#ifndef SDL_gamepad_h_
@@ -41,18 +69,6 @@
extern "C" {
#endif
/**
* \file SDL_gamepad.h
*
* In order to use these functions, SDL_Init() must have been called
* with the ::SDL_INIT_GAMEPAD flag. This causes SDL to scan the system
* for gamepads, and load appropriate drivers.
*
* If you would like to receive gamepad updates while the application
* is in the background, you should set the following hint before calling
* SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
*/
/**
* The structure used to identify an SDL gamepad
*