annotate GD/Image.pm @ 0:58111b3965b2 draft default tip

Uploaded
author dereeper
date Thu, 01 Nov 2012 09:35:05 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
1 # DO NOT EDIT! THIS FILE IS AUTOGENERATED BY GD/Image.pm.PLS
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
2 package GD::Image;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
3
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
4 use strict;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
5 use GD;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
6 use Symbol 'gensym','qualify_to_ref';
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
7 use vars '$VERSION';
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
8 $VERSION = '2.38';
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
9
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
10 =head1 NAME
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
11
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
12 GD::Image - Image class for the GD image library
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
13
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
14 =head1 SYNOPSIS
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
15
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
16 See L<GD>
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
17
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
18 =head1 DESCRIPTION
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
19
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
20 See L<GD>
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
21
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
22 =head1 AUTHOR
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
23
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
24 The GD.pm interface is copyright 1995-2005, Lincoln D. Stein. It is
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
25 distributed under the same terms as Perl itself. See the "Artistic
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
26 License" in the Perl source code distribution for licensing terms.
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
27
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
28 The latest versions of GD.pm are available on CPAN:
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
29
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
30 http://www.cpan.org
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
31
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
32 =head1 SEE ALSO
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
33
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
34 L<GD>
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
35 L<GD::Polyline>,
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
36 L<GD::SVG>,
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
37 L<GD::Simple>,
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
38 L<Image::Magick>
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
39
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
40 =cut
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
41
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
42 # Copyright 1995 Lincoln D. Stein. See accompanying README file for
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
43 # usage information
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
44
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
45 *stringTTF = \&GD::Image::stringFT;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
46
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
47 sub _make_filehandle {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
48 shift; # get rid of class
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
49 no strict 'refs';
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
50 my $thing = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
51 return $thing if defined(fileno $thing);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
52
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
53 # otherwise try qualifying it into caller's package
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
54 my $fh;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
55 {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
56 local $^W = 0; # to avoid uninitialized variable warning from Symbol.pm
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
57 $fh = qualify_to_ref($thing,caller(2));
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
58 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
59 return $fh if defined(fileno $fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
60
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
61 # otherwise treat it as a file to open
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
62 $fh = gensym;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
63 open($fh,$thing) || return;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
64 return $fh;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
65 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
66
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
67 sub new {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
68 my $pack = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
69 if (@_ == 1) {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
70 if (my $type = _image_type($_[0])) {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
71 my $method = "newFrom${type}Data";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
72 return unless $pack->can($method);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
73 return $pack->$method($_[0]);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
74 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
75 return unless my $fh = $pack->_make_filehandle($_[0]);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
76 my $magic;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
77 return unless read($fh,$magic,4);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
78 return unless my $type = _image_type($magic);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
79 seek($fh,0,0);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
80 my $method = "newFrom${type}";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
81 return $pack->$method($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
82 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
83 return $pack->_new(@_);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
84 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
85
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
86 sub newTrueColor {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
87 my $pack = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
88 return $pack->_new(@_, 1);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
89 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
90
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
91 sub newPalette {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
92 my $pack = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
93 return $pack->_new(@_, 0);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
94 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
95
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
96 sub newFromGd {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
97 croak("Usage: newFromGd(class,filehandle)") unless @_==2;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
98 my($class,$f) = @_;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
99 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
100 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
101 $class->_newFromGd($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
102 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
103
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
104 sub newFromGd2 {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
105 croak("Usage: newFromGd2(class,filehandle)") unless @_==2;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
106 my($class,$f) = @_;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
107 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
108 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
109 $class->_newFromGd2($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
110 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
111
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
112 sub newFromGd2Part {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
113 croak("Usage: newFromGd2(class,filehandle,srcX,srcY,width,height)") unless @_==6;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
114 my($class,$f) = splice(@_,0,2);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
115 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
116 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
117 $class->_newFromGd2Part($fh,@_);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
118 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
119
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
120 sub ellipse ($$$$$) {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
121 my ($self,$cx,$cy,$width,$height,$color) = @_;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
122 $self->arc($cx,$cy,$width,$height,0,360,$color);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
123 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
124
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
125 # draws closed polygon with the specified color
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
126 sub polygon {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
127 my $self = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
128 my($p,$c) = @_;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
129 $self->openPolygon($p, $c);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
130 $self->line( @{$p->{'points'}->[0]},
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
131 @{$p->{'points'}->[$p->{'length'}-1]}, $c);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
132 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
133
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
134 sub width {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
135 my $self = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
136 my @bounds = $self->getBounds;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
137 $bounds[0];
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
138 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
139
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
140 sub height {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
141 my $self = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
142 my @bounds = $self->getBounds;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
143 $bounds[1];
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
144 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
145
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
146 sub _image_type {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
147 my $data = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
148 my $magic = substr($data,0,4);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
149 return 'Png' if $magic eq "\x89PNG";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
150 return 'Jpeg' if $magic eq "\377\330\377\340";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
151 return 'Jpeg' if $magic eq "\377\330\377\341";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
152 return 'Jpeg' if $magic eq "\377\330\377\355";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
153 return 'Jpeg' if $magic eq "\377\330\377\356";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
154 return 'Gif' if $magic eq "GIF8";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
155 return 'Gd2' if $magic eq "gd2\000";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
156 return 'Xpm' if substr($data,0,9) eq "/* XPM */";
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
157 return;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
158 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
159
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
160
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
161 sub clone {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
162 croak("Usage: clone(\$image)") unless @_ == 1;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
163 my $self = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
164 my ($x,$y) = $self->getBounds;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
165 my $new = $self->new($x,$y);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
166 return unless $new;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
167 $new->copy($self,0,0,0,0,$x,$y);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
168 return $new;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
169 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
170
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
171 sub newFromPng {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
172 croak("Usage: newFromPng(class,filehandle,[truecolor])") unless @_>=2;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
173 my($class) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
174 my($f) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
175 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
176 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
177 $class->_newFromPng($fh,@_);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
178 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
179
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
180 sub newFromJpeg {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
181 croak("Usage: newFromJpeg(class,filehandle,[truecolor])") unless @_>=2;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
182 my($class) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
183 my($f) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
184 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
185 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
186 $class->_newFromJpeg($fh,@_);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
187 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
188
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
189 sub newFromGif {
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
190 croak("Usage: newFromGif(class,filehandle,[truecolor])") unless @_>=2;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
191 my($class) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
192 my($f) = shift;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
193 my $fh = $class->_make_filehandle($f);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
194 binmode($fh);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
195 $class->_newFromGif($fh,@_);
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
196 }
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
197
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
198 # Autoload methods go after __END__, and are processed by the autosplit program.
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
199 1;
58111b3965b2 Uploaded
dereeper
parents:
diff changeset
200 __END__