.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Tirex::Backend 3pm"
.TH Tirex::Backend 3pm "2023-04-11" "perl v5.36.0" "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"
Tirex::Backend \- Generic Tirex rendering backend
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use Tirex::Backend::Test;
\& my $backend = Tirex::Backend::Test\->new();
\& $backend\->main();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a parent class for rendering backends written in Perl. To use it create
a subclass (such as Tirex::Backend::Test).
.SH "METHODS"
.IX Header "METHODS"
.SS "Tirex::Backend\->new($name)"
.IX Subsection "Tirex::Backend->new($name)"
This class should not be instantiated. Create instances of a subclass instead.
.ie n .SS "$backend\->check_map_config($map)"
.el .SS "\f(CW$backend\fP\->check_map_config($map)"
.IX Subsection "$backend->check_map_config($map)"
Check a map config for this backend for syntactic and other validity.
Should croak if it fails.
.PP
Overwrite this in the subclass.
.ie n .SS "$backend\->set_status('text')"
.el .SS "\f(CW$backend\fP\->set_status('text')"
.IX Subsection "$backend->set_status('text')"
Set status text which is shown on the ps output.
.ie n .SS "$backend\->\fBmain()\fP"
.el .SS "\f(CW$backend\fP\->\fBmain()\fP"
.IX Subsection "$backend->main()"
Core backend method. Call this directly after creating a subclass with \fBnew()\fR.
It will parse the config file(s), set everything up and then wait for rendering
requests and fulfill them by calling \fBcreate_metatile()\fR.
.ie n .SS "$backend\->create_metatile($map, $metatile)"
.el .SS "\f(CW$backend\fP\->create_metatile($map, \f(CW$metatile\fP)"
.IX Subsection "$backend->create_metatile($map, $metatile)"
Create a metatile.
.PP
This method has to be overwritten in subclasses.
.ie n .SS "$backend\->write_metatile($image, $filename, $metatile)"
.el .SS "\f(CW$backend\fP\->write_metatile($image, \f(CW$filename\fP, \f(CW$metatile\fP)"
.IX Subsection "$backend->write_metatile($image, $filename, $metatile)"
Takes a single image the size of a metatile, cuts it into tiles and then
re-assembles those tiles into a metatile and write it to disk.
.ie n .SS "$backend\->create_error_image($map, $metatile)"
.el .SS "\f(CW$backend\fP\->create_error_image($map, \f(CW$metatile\fP)"
.IX Subsection "$backend->create_error_image($map, $metatile)"
Create an error image in case a renderer didn't work. The error image is a
black/yellow checkerboard pattern.
.PP
This method can be overwritten in subclasses.