.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 turned on, 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Image::LibRSVG 3pm" .TH Image::LibRSVG 3pm "2014-08-15" "perl v5.20.0" "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( ); \& 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 \s-1SVG\s0(Scaleable Vector Graphics) into bitmapformats like (\s-1PNG,JPG,...\s0). To which formats you can convert the svg-files depends on your gdk-pixbuf configuration. Still at least \&\s-1PNG\s0 and \s-1JPG\s0 should be available. .SS "\s-1EXPORT\s0" .IX Subsection "EXPORT" None by default. .SS "Methods" .IX Subsection "Methods" \fIConstructor\fR .IX Subsection "Constructor" .IP "\(bu" 4 \&\fInew()\fR .PP \fIstatic methods\fR .IX Subsection "static methods" .IP "\(bu" 4 \&\fBArrayRef\fR \fIgetKnownFormats()\fR .Sp returns all formats known to gdk-pixbuf .IP "\(bu" 4 \&\fBArrayRef\fR \fIgetSupportedFormats()\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 \s-1SVG.\s0 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=\*(L"png\*(R", \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=\*(L"png\*(R", \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=\*(L"png\*(R", \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=\*(L"png\*(R", \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=\*(L"png\*(R", \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 \&\fB\s-1SV\s0\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, .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.