.\" 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_NSTimerCallback:
.\"   https://wiki.libsdl.org/SDL_NSTimerCallback
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision release-3.2.8-0-gf6864924f
.\" 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_NSTimerCallback
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_NSTimerCallback 3type "SDL 3.2.8" "Simple Directmedia Layer" "SDL3 DATATYPES"
.SH NAME
SDL_NSTimerCallback \- Function prototype for the nanosecond timer callback function\[char46]
.SH HEADER FILE
Defined in SDL3/SDL_timer\[char46]h

.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "typedef Uint64 (SDLCALL *SDL_NSTimerCallback)(void *userdata, SDL_TimerID timerID, Uint64 interval);
.fi
.SH DESCRIPTION
The callback function is passed the current timer interval and returns the
next timer interval, in nanoseconds\[char46] If the returned value is the same as
the one passed in, the periodic alarm continues, otherwise a new alarm is
scheduled\[char46] If the callback returns 0, the periodic alarm is canceled and
will be removed\[char46]

.SH FUNCTION PARAMETERS
.TP
.I userdata
an arbitrary pointer provided by the app through 
.BR SDL_AddTimer
, for its own use\[char46]
.TP
.I timerID
the current timer being processed\[char46]
.TP
.I interval
the current callback time interval\[char46]
.SH RETURN VALUE
Returns the new callback time interval, or 0 to disable further runs of the
callback\[char46]

.SH THREAD SAFETY
SDL may call this callback at any time from a background thread; the
application is responsible for locking resources the callback touches that
need to be protected\[char46]

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

.SH SEE ALSO
.BR \(bu (3),
.BR SDL_AddTimerNS (3)