.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetPenStatus:
.\"   https://wiki.libsdl.org/SDL_GetPenStatus
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetPenStatus
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetPenStatus 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetPenStatus \- Retrieves the pen's current status\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "Uint32 SDL_GetPenStatus(SDL_PenID instance_id, float *x, float *y, float *axes, size_t num_axes);
.fi
.SH DESCRIPTION
If the pen is detached (cf\[char46] ::
.BR SDL_PenConnected
), this
operation may return default values\[char46]

.SH FUNCTION PARAMETERS
.TP
.I instance_id
The pen to query\[char46]
.TP
.I x
Out-mode parameter for pen x coordinate\[char46] May be NULL\[char46]
.TP
.I y
Out-mode parameter for pen y coordinate\[char46] May be NULL\[char46]
.TP
.I axes
Out-mode parameter for axis information\[char46] May be null\[char46] The axes are in the same order as ::
.BR SDL_PenAxis
\[char46]
.TP
.I num_axes
Maximum number of axes to write to "axes"\[char46]
.SH RETURN VALUE
Returns a bit mask with the current pen button states
(::
.BR SDL_BUTTON_LMASK
 etc\[char46]), possibly
::
.BR SDL_PEN_DOWN_MASK
, and exactly one of
::
.BR SDL_PEN_INK_MASK
 or
::
.BR SDL_PEN_ERASER_MASK
 , or 0 on error (see
::
.BR SDL_GetError
())\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0