Cairo::SvgSurface Class Reference

Inheritance diagram for Cairo::SvgSurface:[legend]List of all members.

---

Detailed Description

A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from cairo.

This surface is not rendered to the screen but instead renders the drawing to an SVG file on disk.

Note:

For this Surface to be available, cairo must have been compiled with SVG support

Warning:

This is an experimental surface. It is not yet marked as a fully supported surface by the cairo library

Public Member Functions
void	set_dpi (double x_dpi, double y_dpi)
	Sets the resolution of the image in dots per inch.
	SvgSurface (cairo_surface_t *cobject, bool has_reference=false)
	Create a C++ wrapper for the C instance.
virtual	~SvgSurface ()
Static Public Member Functions
static RefPtr< SvgSurface >	create (cairo_write_func_t write_func, void *closure, double width_in_points, double height_in_points)
	Creates a SvgSurface with a specified dimensions that will be written to the given write function instead of saved directly to disk.
static RefPtr< SvgSurface >	create (std::string filename, double width_in_points, double height_in_points)
	Creates a SvgSurface with a specified dimensions that will be saved as the given filename.

---

Constructor & Destructor Documentation

Cairo::SvgSurface::SvgSurface	(	cairo_surface_t *	cobject,
		bool	has_reference = false
	)			[explicit]

Create a C++ wrapper for the C instance.

This C++ instance should then be given to a RefPtr.

Parameters:

	cobject	The C instance.
	has_reference	whether we already have a reference. Otherwise, the constructor will take an extra reference.

virtual Cairo::SvgSurface::~SvgSurface

(

)

[virtual]

---

Member Function Documentation

static RefPtr<SvgSurface> Cairo::SvgSurface::create	(	cairo_write_func_t	write_func,
		void *	closure,
		double	width_in_points,
		double	height_in_points
	)			[static]

Creates a SvgSurface with a specified dimensions that will be written to the given write function instead of saved directly to disk.

Parameters:

	write_func	The function to be called when the backend needs to write data to an output stream
	closure	closure data for the write function
	width_in_points	The width of the SVG document in points
	height_in_points	The height of the SVG document in points

static RefPtr<SvgSurface> Cairo::SvgSurface::create	(	std::string	filename,
		double	width_in_points,
		double	height_in_points
	)			[static]

Creates a SvgSurface with a specified dimensions that will be saved as the given filename.

Parameters:

	filename	The name of the SVG file to save the surface to
	width_in_points	The width of the SVG document in points
	height_in_points	The height of the SVG document in points

void Cairo::SvgSurface::set_dpi	(	double	x_dpi,
		double	y_dpi
	)

Sets the resolution of the image in dots per inch.

Parameters:

	x_dpi	The dpi in the x direction
	y_dpi	The dpi in the y direction

---

The documentation for this class was generated from the following file:

• surface.h

---