.\" -*- 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 "Imager::Threads 3pm"
.TH Imager::Threads 3pm 2024-04-13 "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
Imager::Threads \- Imager and threads
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  use Imager;
\&  use threads;
\&  Imager\->preload;
\&
\&  threads\->create(...);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Starting from version 0.94 Imager attempts to work safely with perl's
\&\f(CW\*(C`ithreads\*(C'\fR.
.PP
Previous versions stored some state in global variables, in particular
the internal error stack.
.PP
However there are some limitations:
.IP \(bu 4
Imager's debug malloc isn't thread safe and will never be.  Imager's
debug malloc is disabled by default.
.IP \(bu 4
\&\f(CW\*(C`libtiff\*(C'\fR, which Imager uses for TIFF file support is not thread
safe, \f(CW\*(C`Imager::File::TIFF\*(C'\fR works around this by single-threading its
access to \f(CW\*(C`libtiff\*(C'\fR.
.IP \(bu 4
\&\f(CW\*(C`giflib\*(C'\fR, which Imager uses for GIF support is not thread safe before
version 5.  \f(CW\*(C`Imager::File::GIF\*(C'\fR works around this by single threading
its access to \f(CW\*(C`giflib\*(C'\fR.
.IP \(bu 4
\&\f(CW\*(C`T1Lib\*(C'\fR, used by one of Imager's font drivers, is not thread safe.
\&\f(CW\*(C`Imager::Font::T1\*(C'\fR works around this by single threading access.
.IP \(bu 4
killing a thread reading or writing TIFF or GIF files, or using T1
fonts through \f(CW\*(C`Imager::Font::T1\*(C'\fR may deadlock other threads when they
attempt to read or write TIFF or GIF files, or work with Type 1 fonts.
.IP \(bu 4
Fill, font, color or I/O layer objects created in one thread are not
valid for use in child threads.  If you manage to duplicate such an
object in another thread, you get to keep both pieces when it breaks.
.PP
Note that if you have another module using \f(CW\*(C`libtiff\*(C'\fR, \f(CW\*(C`giflib\*(C'\fR or
\&\f(CW\*(C`t1lib\*(C'\fR it may interact with Imager's use of those libraries in a
threaded environment, since there's no way to co-ordinate access to
the global information \f(CW\*(C`libtiff\*(C'\fR, \f(CW\*(C`giflib\*(C'\fR and \f(CW\*(C`t1lib\*(C'\fR maintain.
.PP
Imager currently doesn't use threads itself, except for testing its
threads support.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Imager, \f(CW\*(C`threads\*(C'\fR
.SH AUTHOR
.IX Header "AUTHOR"
Tony Cook <tony@cpan.org>