---
name: "Tirex::Renderer"
section: "3pm"
platform: "linux"
package: "tirex"
version: "0.7.1-3+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Tirex::Renderer"
---

# Tirex::Renderer(3pm)

A Tirex renderer config

## NAME

Tirex::Renderer - A Tirex renderer config

## SYNOPSIS

my `$r` = Tirex::Renderer-\>new( ... );

## DESCRIPTION

Tirex can work with several rendering backends such as Mapnik or WMS.  A backend can be started with different configurations, for the Mapnik backend you need to configure the font directory for instance. This class defines methods for reading the config files (/etc/tirex/renderer/\*.conf) describing the backend configurations and managing those renderers.

See the class Tirex::Backend and its subclasses for the actual code of some backends.

## METHODS

### Tirex::Renderer-\>read\_config\_dir($dir)

Read all renderer configs in given config directory.

### Tirex::Renderer-\>get('foo')

Get renderer by name.

### Tirex::Renderer-\>all();

Return sorted (by name) list of all configured renderers.

### Tirex::Renderer-\>clear();

Clear list of renderers.

### Tirex::Renderer-\>enabled();

Return sorted (by name) list of all enabled renderers.

### Tirex::Renderer-\>new( name =\> 'foo', path =\> '/path/to/exec', port =\> 1234, procs =\> 3, ... )

Create new renderer config.

Every renderer has at least these general options: name, path, port, and procs. Will croak if they are not all present.

In addition it can have zero or more options specific to this renderer.

Will croak if a renderer configuration already exists under the same name.

### Tirex::Renderer-\>new\_from\_configfile($filename)

Create new renderer config from a file.

Croaks if the file does not exist.

### $rend-\>read\_map\_config()

Read all map configs for this renderer.

### $rend-\>get\_maps()

Get array of map configs for this renderer.

### $rend-\>get\_config()

Return hash with renderer-specific configuration.

### $rend-\>get\_name();

Get name of this renderer.

### $rend-\>get\_debug();

Get debug flag of this renderer.

### $rend-\>get\_path();

Get path of this renderer.

### $rend-\>get\_port();

Get port of this renderer.

### $rend-\>get\_procs();

Get procs of this renderer.

### $rend-\>get\_syslog\_facility();

Get syslog facility of this renderer.

### $rend-\>is\_enabled()

Is this renderer enabled?

### $rend-\>disable();

Disable this renderer.

### $rend-\>enable();

Enable this renderer.

### $rend-\>to\_s();

Return human readable description of this renderer.

### $rend-\>to\_hash();

Return parameters of this renderer as hash.

### Tirex::Renderer-\>status();

Return status of all configured renderers.

### $rend-\>add\_worker($pid);

Add process id to list of currently running workers.

### $rend-\>remove\_worker($pid);

Remove process id from list of currently running workers.

### $rend-\>num\_workers();

Return number of currently running workers.