.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 >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 "Imager::Inline 3pm" .TH Imager::Inline 3pm "2020-11-08" "perl v5.32.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" Imager::Inline \- using Imager with Inline::C. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 8 \& use Inline with => \*(AqImager\*(Aq; \& use Inline C => <<\*(AqEOS\*(Aq; \& Imager some_func(Imager::Color c, Imager::Fill f) { \& Imager img = i_img_8_new(200, 200, 3); \& /* fill with color */ \& i_box_filled(img, 0, 0, 199, 199, c); \& /* inner area with fill */ \& i_box_cfill(img, 50, 50, 149, 149, f); \& \& return img; \& } \& EOS .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Imager hooks into Inline's \f(CW\*(C`with\*(C'\fR syntax to make it easier to write Inline::C code that works with Imager, you can call Imager functions without having to include headers or perform initialization. .PP Imager's Inline \f(CW\*(C`with\*(C'\fR support does the following: .IP "\(bu" 4 add the installed Imager include directory to \s-1INC\s0 .IP "\(bu" 4 add the Imager typemap to \s-1TYPEMAPS\s0 .IP "\(bu" 4 include the headers needed by Imager C extension modules. .IP "\(bu" 4 declare and initialize the Imager \s-1API\s0 function table pointer .IP "\(bu" 4 filter the supplied code to replace Imager's class names with those that Inline::C can handle. .SH "LIMITATIONS" .IX Header "LIMITATIONS" The filtering mechanism is global, it will replace the class names even inside string constants. If you need a string matching the name of one of Imager's classes, like \f(CW"Imager::Color"\fR you will need to split it into 2 to use C's string pasting mechanism, for example: \&\f(CW"Imager:" ":Color"\fR. .SH "AUTHOR" .IX Header "AUTHOR" Tony Cook .SH "REVISION" .IX Header "REVISION" \&\f(CW$Revision\fR$ .SH "SEE ALSO" .IX Header "SEE ALSO" Imager, Imager::ExtUtils, Imager::API, Imager::APIRef, samples/inline_replace_color.pl