.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Image::LibRSVG 3pm"
.TH Image::LibRSVG 3pm 2024-03-07 "perl v5.38.2" "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
Image::LibRSVG \- Perl extension for librsvg
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Image::LibRSVG;
\&  
\&  ## static Methods
\&  my $known_formats = Image::LibRSVG\->getKnownFormats();
\&  my $formats       = Image::LibRSVG\->getSupportedFormats();
\&  my $isSupported   = Image::LibRSVG\->isFormatSupported("tiff");
\&  
\&  my $rsvg = new Image::LibRSVG();
\&  
\&  $rsvg\->convert("my.svg", "my.png" );
\&  $rsvg\->convertAtZoom("my.svg", "my.png", 1.5, 1.5 );
\&  $rsvg\->convertAtMaxSize("my.svg", "my.png", 200, 300 );
\&  $rsvg\->convertAtSize("my.svg", "my.png", 200, 300 );
\&  $rsvg\->convertAtZoomWithMax("my.svg", "my.png", 1.5, 1.5, 200, 300 );
\&  
\&  $formats     = $rsvg\->getSupportedFormats();
\&  $isSupported = $rsvg\->isFormatSupported("tiff");
\&  
\&  $rsvg\->loadImage( "my.svg" );
\&  
\&  open( SVGFILE, "< my.svg" );
\&  local( $/ ) ;
\&  $rsvg\->loadImageFromString( <SVGFILE> );
\&  close SVGFILE;
\&  
\&  $rsvg\->saveAs( "my.png" );
\&  $rsvg\->saveAs( "my.jpg", "jpeg" );
\&  
\&  $rsvg\->loadImage( "my.svg", 0, { zoom => [ 1.5, 1.5 ] } );
\&  $rsvg\->saveAs( "zoomed.png" );
\&  
\&  my $bitmap = $rsvg\->getImageBitmap();
.Ve
.SH ABSTRACT
.IX Header "ABSTRACT"
.Vb 2
\&  This module provides an Perl\-Interface towards the gnome\-lib
\&  librsvg\-2.
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides an Perl-Interface towards the gnome-lib
librsvg\-2 which is able to convert SVG(Scaleable Vector Graphics)
into bitmapformats like (PNG,JPG,...). To which formats you can convert
the svg-files depends on your gdk-pixbuf configuration. Still at least
PNG and JPG should be available.
.SS EXPORT
.IX Subsection "EXPORT"
None by default.
.SS Methods
.IX Subsection "Methods"
\fIConstructor\fR
.IX Subsection "Constructor"
.IP \(bu 4
\&\fBnew()\fR
.PP
\fIstatic methods\fR
.IX Subsection "static methods"
.IP \(bu 4
\&\fBArrayRef\fR \fBgetKnownFormats()\fR
.Sp
returns all formats known to gdk-pixbuf
.IP \(bu 4
\&\fBArrayRef\fR \fBgetSupportedFormats()\fR
.Sp
returns all formats you can store your svg image into
.IP \(bu 4
\&\fBbool\fR isFormatSupported( String format )
.Sp
returns true if you can store your image in this format else false
.PP
\fImember methods\fR
.IX Subsection "member methods"
.IP \(bu 4
\&\fBbool\fR loadImage( \fBString\fR svgfile[, \fBint\fR dpi=0, \fBHashRef\fR args] )
.Sp
This is function provides a common call mechanism to for all 
functions below, the args-variable can hold the following values:
.RS 4
.IP "Case 1( = loadFromFile ):" 4
.IX Item "Case 1( = loadFromFile ):"
.Vb 1
\&    undef
.Ve
.IP "Case 2( = loadFromFile ):" 4
.IX Item "Case 2( = loadFromFile ):"
.Vb 1
\&    empty hashref
.Ve
.IP "Case 3( = loadFromFileAtZoom )" 4
.IX Item "Case 3( = loadFromFileAtZoom )"
.Vb 2
\&    zoom\->[0] ... x_zoom
\&    zoom\->[1] ... y_zoom
.Ve
.IP "Case 4( = loadFromFileAtMaxSize ):" 4
.IX Item "Case 4( = loadFromFileAtMaxSize ):"
.Vb 2
\&    dimension\->[0] ... x\-size
\&    dimension\->[1] ... y\-size
.Ve
.IP "Case 5( = loadFromFileAtSize ):" 4
.IX Item "Case 5( = loadFromFileAtSize ):"
.Vb 3
\&    dimension\->[0] ... x\-size
\&    dimension\->[1] ... y\-size
\&    dimension\->[2] ... max\-size\-flag
.Ve
.IP "Case 6( = loadFromFileAtZoomWithMax ):" 4
.IX Item "Case 6( = loadFromFileAtZoomWithMax ):"
.Vb 4
\&    zoom\->[0] ........ x_zoom
\&    zoom\->[1] ........ y_zoom
\&    dimension\->[0] ... x\-size
\&    dimension\->[1] ... y\-size
.Ve
.RE
.RS 4
.RE
.IP \(bu 4
\&\fBbool\fR loadImageFromString( \fBString\fR svgfile[, \fBint\fR dpi=0, \fBHashRef\fR args] )
.Sp
Loads the image from an String containing a plain SVG. For information about args see loadImage.
.IP \(bu 4
\&\fBbool\fR loadFromFile(\fBString\fR svgfile,[\fBint\fR dpi=0])
.IP \(bu 4
\&\fBbool\fR loadFromFileAtZoom( \fBString\fR svgfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromFileAtMaxSize( \fBString\fR svgfile, \fBint\fR width, \fBint height\fR[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromFileAtSize( \fBString\fR svgfile, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromFileAtZoomWithMax( \fBString\fR svgfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromString(\fBString\fR svgfile,[\fBint\fR dpi=0])
.IP \(bu 4
\&\fBbool\fR loadFromStringAtZoom( \fBString\fR svgfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromStringAtMaxSize( \fBString\fR svgfile, \fBint\fR width, \fBint height\fR[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromStringAtSize( \fBString\fR svgfile, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR loadFromStringAtZoomWithMax( \fBString\fR svgfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0] )
.IP \(bu 4
\&\fBbool\fR convert( \fBString\fR svgfile, \fBString\fR bitmapfile[, \fBint\fR dpi=0, \fBString\fR format="png", \fBint\fR quality=100] )
.IP \(bu 4
\&\fBbool\fR convertAtZoom( \fBString\fR svgfile, \fBString\fR bitmapfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom[, \fBint\fR dpi=0, \fBString\fR format="png", \fBint\fR quality=100] )
.IP \(bu 4
\&\fBbool\fR convertAtMaxSize( \fBString\fR svgfile, \fBString\fR bitmapfile, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0, \fBString\fR format="png", \fBint\fR quality=100] )
.IP \(bu 4
\&\fBbool\fR convertAtSize( \fBString\fR svgfile, \fBString\fR bitmapfile, \fBint\fR width, \fBint\fR  height[, \fBint\fR dpi=0, \fBString\fR format="png", \fBint\fR quality=100] )
.IP \(bu 4
\&\fBbool\fR convertAtZoomWithMax( \fBString\fR svgfile, \fBString\fR bitmapfile, \fBdouble\fR x_zoom, \fBdouble\fR y_zoom, \fBint\fR width, \fBint\fR height[, \fBint\fR dpi=0, \fBString\fR format="png", \fBint\fR quality=100] )
.IP \(bu 4
\&\fBbool\fR saveAs( \fBString\fR filename, [ \fBString\fR type, \fBString\fR quality ] )
.Sp
Saves the image to a file
.IP \(bu 4
\&\fBSV\fR getBitmap( [ \fBString\fR type, \fBString\fR quality ] )
.Sp
Saves the image to a scalar which can be passed on to other applications. This only return a useful
value if you have compiled it with a gdk-pixbuf greater than or equal to 2.4
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://librsvg.sf.net
.SH AUTHOR
.IX Header "AUTHOR"
Tom Schindl, <tom.schindl@bestsolution.at>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2004 by Tom Schindl and bestsolution Systemhaus GmbH
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.