.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "pods::SDL::Time 3pm"
.TH pods::SDL::Time 3pm 2024-03-28 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SDL::Time \- An SDL Perl extension for managing timers
.SH CATEGORY
.IX Header "CATEGORY"
Core
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use warnings;
\& use strict;
\& 
\& use threads;
\& use threads::shared;
\&
\& use SDL::Time;
\&
\& package foo;
\&
\& use SDL \*(Aq:all\*(Aq;
\&
\& SDL::init(SDL_INIT_TIMER);
\&
\& my $tick :shared = 0;
\& sub ticker { $tick++; warn $tick; return 100; }
\&
\& package main;
\&
\& my $id = SDL::Time::add_timer(100, \*(Aqfoo::ticker\*(Aq);
\&
\& sleep(2);
\&
\& SDL::Time::remove_timer($id);
.Ve
.SH METHODS
.IX Header "METHODS"
.SS add_timer
.IX Subsection "add_timer"
.Vb 1
\& my $id = SDL::Timer::add_timer( $ms_interval, $callback );
.Ve
.PP
This runs in a separate thread and a cloned Perl thread.
\&\f(CW\*(C`threads\*(C'\fR and \f(CW\*(C`threads::shared\*(C'\fR must be used to share any variables the timer uses.
.PP
The \f(CW$callback\fR function, specified with a string of the function's name, will be called after the milliseconds of \f(CW$interval\fR have elapsed.
The actual delay may be longer than specified depending on the underlying OS.
The callback function is passed the current timer interval as well as the \f(CW$interval\fR parameter and should return the next timer interval.
If the return value from the callback is 0, the timer is cancelled; otherwise, the timer will continue to run.
.PP
The timer callback function may run in a different thread to your main program, so it shouldn't call any functions from within itself.
You may call SDL::push_event, however.
.PP
\&\f(CW\*(C`SDL::Time::add_timer\*(C'\fR returns the identifier value of the generated timer or undef on error.
.PP
\&\fBNote:\fR You must initialize (\f(CW\*(C`SDL::init\*(C'\fR) the timer subsystem to use this function.
.SS remove_timer
.IX Subsection "remove_timer"
.Vb 1
\& SDL::Timer::remove_timer( $id );
.Ve
.PP
The other way to cancel a timer is to use \f(CW\*(C`SDL::Time::remove_timer\*(C'\fR on the \f(CW$id\fR of a timer.
This ID is the return value of the \f(CW\*(C`SDL::Time::add_timer\*(C'\fR function.
.PP
\&\f(CW\*(C`SDL::Time::remove_timer\*(C'\fR returns \f(CW0\fR on success or \f(CW\-1\fR on error.
.SH AUTHORS
.IX Header "AUTHORS"
See "AUTHORS" in SDL.