logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Tirex::Backend - Generic Tirex rendering backend

Description

       This is a parent class for rendering backends written in Perl. To use it create a subclass (such as
       Tirex::Backend::Test).

Methods

Tirex::Backend->new($name)
       This class should not be instantiated. Create instances of a subclass instead.

   $backend->check_map_config($map)
       Check a map config for this backend for syntactic and other validity.  Should croak if it fails.

       Overwrite this in the subclass.

   $backend->set_status('text')
       Set status text which is shown on the ps output.

   $backend->main()
       Core backend method. Call this directly after creating a subclass with new().  It will parse the config
       file(s), set everything up and then wait for rendering requests and fulfill them by calling
       create_metatile().

   $backend->create_metatile($map,$metatile)
       Create a metatile.

       This method has to be overwritten in subclasses.

   $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.

   $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.

       This method can be overwritten in subclasses.

perl v5.40.0                                       2024-11-08                                Tirex::Backend(3pm)

Name

       Tirex::Backend - Generic Tirex rendering backend

Synopsis

        use Tirex::Backend::Test;
        my $backend = Tirex::Backend::Test->new();
        $backend->main();

See Also