eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-05 15:03:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

pen: Corrected some documentation.

Browse source 
Fixes #10863.
This commit is contained in:
Ryan C. Gordon 2024-10-01 10:24:17 -04:00
parent e3dbd74fe7
commit b4fcd1f345
No known key found for this signature in database
GPG key ID: FA148B892AB48044
2 changed files with 10 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/SDL3/SDL_events.h
View file

@ -746,8 +746,8 @@ typedef struct SDL_PenMotionEvent
SDL_WindowID windowID; /**< The window with mouse focus, if any */ SDL_WindowID windowID; /**< The window with mouse focus, if any */
SDL_PenID which; /**< The pen instance id */ SDL_PenID which; /**< The pen instance id */
SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */ SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */
float x; /**< X position of pen on tablet */ float x; /**< X coordinate, relative to window */
float y; /**< Y position of pen on tablet */ float y; /**< Y coordinate, relative to window */
} SDL_PenMotionEvent; } SDL_PenMotionEvent;
/** /**
@ -766,8 +766,8 @@ typedef struct SDL_PenTouchEvent
SDL_WindowID windowID; /**< The window with pen focus, if any */ SDL_WindowID windowID; /**< The window with pen focus, if any */
SDL_PenID which; /**< The pen instance id */ SDL_PenID which; /**< The pen instance id */
SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */ SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */
float x; /**< X position of pen on tablet */ float x; /**< X coordinate, relative to window */
float y; /**< Y position of pen on tablet */ float y; /**< Y coordinate, relative to window */
bool eraser; /**< true if eraser end is used (not all pens support this). */ bool eraser; /**< true if eraser end is used (not all pens support this). */
bool down; /**< true if the pen is touching or false if the pen is lifted off */ bool down; /**< true if the pen is touching or false if the pen is lifted off */
} SDL_PenTouchEvent; } SDL_PenTouchEvent;
@ -788,8 +788,8 @@ typedef struct SDL_PenButtonEvent
SDL_WindowID windowID; /**< The window with mouse focus, if any */ SDL_WindowID windowID; /**< The window with mouse focus, if any */
SDL_PenID which; /**< The pen instance id */ SDL_PenID which; /**< The pen instance id */
SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */ SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */
float x; /**< X position of pen on tablet */ float x; /**< X coordinate, relative to window */
float y; /**< Y position of pen on tablet */ float y; /**< Y coordinate, relative to window */
Uint8 button; /**< The pen button index (first button is 1). */ Uint8 button; /**< The pen button index (first button is 1). */
bool down; /**< true if the button is pressed */ bool down; /**< true if the button is pressed */
} SDL_PenButtonEvent; } SDL_PenButtonEvent;
@ -810,8 +810,8 @@ typedef struct SDL_PenAxisEvent
SDL_WindowID windowID; /**< The window with pen focus, if any */ SDL_WindowID windowID; /**< The window with pen focus, if any */
SDL_PenID which; /**< The pen instance id */ SDL_PenID which; /**< The pen instance id */
SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */ SDL_PenInputFlags pen_state; /**< Complete pen input state at time of event */
float x; /**< X position of pen on tablet */ float x; /**< X coordinate, relative to window */
float y; /**< Y position of pen on tablet */ float y; /**< Y coordinate, relative to window */
SDL_PenAxis axis; /**< Axis that has changed */ SDL_PenAxis axis; /**< Axis that has changed */
float value; /**< New value of axis */ float value; /**< New value of axis */
} SDL_PenAxisEvent; } SDL_PenAxisEvent;

6
include/SDL3/SDL_pen.h
View file

@ -93,10 +93,8 @@ typedef Uint32 SDL_PenInputFlags;
typedef enum SDL_PenAxis typedef enum SDL_PenAxis
{ {
SDL_PEN_AXIS_PRESSURE, /**< Pen pressure. Unidirectional: 0 to 1.0 */ SDL_PEN_AXIS_PRESSURE, /**< Pen pressure. Unidirectional: 0 to 1.0 */
SDL_PEN_AXIS_XTILT, /**< Pen horizontal tilt angle. Bidirectional: -90.0 to 90.0 (left-to-right). SDL_PEN_AXIS_XTILT, /**< Pen horizontal tilt angle. Bidirectional: -90.0 to 90.0 (left-to-right). */
The physical max/min tilt may be smaller than -90.0 / 90.0, check SDL_PenCapabilityInfo */ SDL_PEN_AXIS_YTILT, /**< Pen vertical tilt angle. Bidirectional: -90.0 to 90.0 (top-to-down). */
SDL_PEN_AXIS_YTILT, /**< Pen vertical tilt angle. Bidirectional: -90.0 to 90.0 (top-to-down).
The physical max/min tilt may be smaller than -90.0 / 90.0 check SDL_PenCapabilityInfo */
SDL_PEN_AXIS_DISTANCE, /**< Pen distance to drawing surface. Unidirectional: 0.0 to 1.0 */ SDL_PEN_AXIS_DISTANCE, /**< Pen distance to drawing surface. Unidirectional: 0.0 to 1.0 */
SDL_PEN_AXIS_ROTATION, /**< Pen barrel rotation. Bidirectional: -180 to 179.9 (clockwise, 0 is facing up, -180.0 is facing down). */ SDL_PEN_AXIS_ROTATION, /**< Pen barrel rotation. Bidirectional: -180 to 179.9 (clockwise, 0 is facing up, -180.0 is facing down). */
SDL_PEN_AXIS_SLIDER, /**< Pen finger wheel or slider (e.g., Airbrush Pen). Unidirectional: 0 to 1.0 */ SDL_PEN_AXIS_SLIDER, /**< Pen finger wheel or slider (e.g., Airbrush Pen). Unidirectional: 0 to 1.0 */