table of contents
other versions
- experimental 3.1.0+ds-1
SDL_GetPenStatus(3) | SDL3 FUNCTIONS | SDL_GetPenStatus(3) |
NAME¶
SDL_GetPenStatus - Retrieves the pen's current status.
SYNOPSIS¶
#include "SDL3/SDL.h"
Uint32 SDL_GetPenStatus(SDL_PenID instance_id, float *x, float *y, float *axes, size_t num_axes);
DESCRIPTION¶
If the pen is detached (cf. :: SDL_PenConnected ), this operation may return default values.
FUNCTION PARAMETERS¶
- instance_id
- The pen to query.
- x
- Out-mode parameter for pen x coordinate. May be NULL.
- y
- Out-mode parameter for pen y coordinate. May be NULL.
- axes
- Out-mode parameter for axis information. May be null. The axes are in the same order as :: SDL_PenAxis .
- num_axes
- Maximum number of axes to write to "axes".
RETURN VALUE¶
Returns a bit mask with the current pen button states (::
SDL_BUTTON_LMASK
etc.), possibly :: SDL_PEN_DOWN_MASK , and exactly one of ::
SDL_PEN_INK_MASK
or :: SDL_PEN_ERASER_MASK
, or 0 on error (see :: SDL_GetError ()).
AVAILABILITY¶
This function is available since SDL 3.0.0
SDL 3.1.0 | SDL |