mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-12-17 11:55:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync wiki -> headers.

Browse Source
This commit is contained in:
Ryan C. Gordon
2023-11-13 15:46:29 -05:00
parent 91460fc13d
commit dd8ab67bd9
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/SDL3/SDL_pen.h
View File

@@ -151,8 +151,8 @@ typedef enum
* throughout a session. To track pens across sessions (program restart), use * throughout a session. To track pens across sessions (program restart), use
* ::SDL_GUID . * ::SDL_GUID .
* *
* \param count The number of pens in the array (number of array elements minus 1, i.e., not * \param count The number of pens in the array (number of array elements
* counting the terminator 0). * minus 1, i.e., not counting the terminator 0).
* \returns A 0 terminated array of ::SDL_PenID values, or NULL on error. The * \returns A 0 terminated array of ::SDL_PenID values, or NULL on error. The
* array must be freed with ::SDL_free(). On a NULL return, * array must be freed with ::SDL_free(). On a NULL return,
* ::SDL_GetError() is set. * ::SDL_GetError() is set.
@@ -170,7 +170,8 @@ extern DECLSPEC SDL_PenID *SDLCALL SDL_GetPens(int *count);
* \param instance_id The pen to query. * \param instance_id The pen to query.
* \param x Out-mode parameter for pen x coordinate. May be NULL. * \param x Out-mode parameter for pen x coordinate. May be NULL.
* \param y Out-mode parameter for pen y coordinate. May be NULL. * \param y Out-mode parameter for pen y coordinate. May be NULL.
* \param axes Out-mode parameter for axis information. May be null. The axes are in the same order as ::SDL_PenAxis. * \param axes Out-mode parameter for axis information. May be null. The axes
* are in the same order as ::SDL_PenAxis.
* \param num_axes Maximum number of axes to write to "axes". * \param num_axes Maximum number of axes to write to "axes".
* \returns a bit mask with the current pen button states (::SDL_BUTTON_LMASK * \returns a bit mask with the current pen button states (::SDL_BUTTON_LMASK
* etc.), possibly ::SDL_PEN_DOWN_MASK, and exactly one of * etc.), possibly ::SDL_PEN_DOWN_MASK, and exactly one of
@@ -251,7 +252,8 @@ typedef struct SDL_PenCapabilityInfo
* Retrieves capability flags for a given ::SDL_PenID. * Retrieves capability flags for a given ::SDL_PenID.
* *
* \param instance_id The pen to query. * \param instance_id The pen to query.
* \param capabilities Detail information about pen capabilities, such as the number of buttons * \param capabilities Detail information about pen capabilities, such as the
* number of buttons
* \returns a set of capability flags, cf. SDL_PEN_CAPABILITIES * \returns a set of capability flags, cf. SDL_PEN_CAPABILITIES
* *
* \since This function is available since SDL 3.0.0 * \since This function is available since SDL 3.0.0