Donner
C++20 SVG rendering library
Loading...
Searching...
No Matches
donner::svg::Renderer Class Reference

Backend-agnostic renderer that resolves to the active build backend. More...

#include "donner/svg/renderer/Renderer.h"

Public Member Functions

 Renderer (bool verbose=false)
 Creates a renderer for the active backend.
 ~Renderer ()
 Destructor.
 Renderer (Renderer &&) noexcept
 Move constructor.
Rendereroperator= (Renderer &&) noexcept
 Move assignment operator.
 Renderer (const Renderer &)=delete
Rendereroperator= (const Renderer &)=delete
void draw (SVGDocument &document)
 Draws the SVG document using the active backend.
RendererBitmap takeSnapshot () const
 Captures a CPU-readable snapshot of the current frame.
bool save (const char *filename)
 Saves the last rendered frame to a PNG file.
int width () const
 Returns the rendered width in pixels.
int height () const
 Returns the rendered height in pixels.

Detailed Description

Backend-agnostic renderer that resolves to the active build backend.

Clients should prefer this type when they do not need backend-specific APIs.

Examples
svg_to_png.cc.

Constructor & Destructor Documentation

◆ Renderer()

donner::svg::Renderer::Renderer ( bool verbose = false)
explicit

Creates a renderer for the active backend.

Parameters
verboseIf true, enables backend-specific verbose logging.

Member Function Documentation

◆ draw()

void donner::svg::Renderer::draw ( SVGDocument & document)

Draws the SVG document using the active backend.

Parameters
documentThe SVG document to render.
Examples
svg_to_png.cc.

◆ height()

int donner::svg::Renderer::height ( ) const
nodiscard

Returns the rendered height in pixels.

Returns
The rendered height.
Examples
svg_to_png.cc.

◆ save()

bool donner::svg::Renderer::save ( const char * filename)

Saves the last rendered frame to a PNG file.

Parameters
filenameThe output PNG filename.
Returns
True if the file was written.
Examples
svg_to_png.cc.

◆ takeSnapshot()

RendererBitmap donner::svg::Renderer::takeSnapshot ( ) const
nodiscard

Captures a CPU-readable snapshot of the current frame.

Returns
A snapshot of the rendered frame.

◆ width()

int donner::svg::Renderer::width ( ) const
nodiscard

Returns the rendered width in pixels.

Returns
The rendered width.
Examples
svg_to_png.cc.

The documentation for this class was generated from the following files:
  • donner/svg/renderer/Renderer.h
  • donner/svg/renderer/Renderer.cc