mirror of https://github.com/libsdl-org/SDL
114 lines
4.5 KiB
C
114 lines
4.5 KiB
C
/*
|
|
Simple DirectMedia Layer
|
|
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
/**
|
|
* # CategoryPen
|
|
*
|
|
* SDL pen event handling.
|
|
*
|
|
* SDL provides an API for pressure-sensitive pen (stylus and/or eraser)
|
|
* handling, e.g., for input and drawing tablets or suitably equipped mobile /
|
|
* tablet devices.
|
|
*
|
|
* To get started with pens, simply handle SDL_EVENT_PEN_* events. When a pen
|
|
* starts providing input, SDL will assign it a unique SDL_PenID, which will
|
|
* remain for the life of the process, as long as the pen stays connected.
|
|
*
|
|
* Pens may provide more than simple touch input; they might have other axes,
|
|
* such as pressure, tilt, rotation, etc.
|
|
*/
|
|
|
|
#ifndef SDL_pen_h_
|
|
#define SDL_pen_h_
|
|
|
|
#include <SDL3/SDL_stdinc.h>
|
|
|
|
/* Set up for C function definitions, even when using C++ */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* SDL pen instance IDs.
|
|
*
|
|
* Zero is used to signify an invalid/null device.
|
|
*
|
|
* These show up in pen events when SDL sees input from them. They remain
|
|
* consistent as long as SDL can recognize a tool to be the same pen; but if a
|
|
* pen physically leaves the area and returns, it might get a new ID.
|
|
*
|
|
* \since This datatype is available since SDL 3.0.0.
|
|
*/
|
|
typedef Uint32 SDL_PenID;
|
|
|
|
|
|
/**
|
|
* Pen input flags, as reported by various pen events' `pen_state` field.
|
|
*
|
|
* \since This datatype is available since SDL 3.0.0.
|
|
*/
|
|
typedef Uint32 SDL_PenInputFlags;
|
|
|
|
#define SDL_PEN_INPUT_DOWN (1u << 0) /**< pen is pressed down */
|
|
#define SDL_PEN_INPUT_BUTTON_1 (1u << 1) /**< button 1 is pressed */
|
|
#define SDL_PEN_INPUT_BUTTON_2 (1u << 2) /**< button 2 is pressed */
|
|
#define SDL_PEN_INPUT_BUTTON_3 (1u << 3) /**< button 3 is pressed */
|
|
#define SDL_PEN_INPUT_BUTTON_4 (1u << 4) /**< button 4 is pressed */
|
|
#define SDL_PEN_INPUT_BUTTON_5 (1u << 5) /**< button 5 is pressed */
|
|
#define SDL_PEN_INPUT_ERASER_TIP (1u << 30) /**< eraser tip is used */
|
|
|
|
/**
|
|
* Pen axis indices.
|
|
*
|
|
* These are the valid values for the `axis` field in SDL_PenAxisEvent. All
|
|
* axes are either normalised to 0..1 or report a (positive or negative) angle
|
|
* in degrees, with 0.0 representing the centre. Not all pens/backends support
|
|
* all axes: unsupported axes are always zero.
|
|
*
|
|
* To convert angles for tilt and rotation into vector representation, use
|
|
* SDL_sinf on the XTILT, YTILT, or ROTATION component, for example:
|
|
*
|
|
* `SDL_sinf(xtilt * SDL_PI_F / 180.0)`.
|
|
*
|
|
* \since This enum is available since SDL 3.0.0
|
|
*/
|
|
typedef enum SDL_PenAxis
|
|
{
|
|
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).
|
|
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).
|
|
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_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_TANGENTIAL_PRESSURE, /**< Pressure from squeezing the pen ("barrel pressure"). */
|
|
SDL_PEN_AXIS_COUNT /**< Total known pen axis types in this version of SDL. This number may grow in future releases! */
|
|
} SDL_PenAxis;
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SDL_pen_h_ */
|
|
|