Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / b341237fb71f29c7aa591c924742b4693f132593 / . / user_guide / libraries / image_lib.html
blob: 8dddcf0abfef259a5d841f2b0226bbc8a3620a55 [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
Derek Allard404e35d2007-08-07 01:00:45 +0000[diff] [blame]5<title>CodeIgniter User Guide : Image Manipulation Class</title>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]10<script type="text/javascript" src="../nav/nav.js"></script>
admin2296fc32006-09-27 21:07:02 +0000[diff] [blame]11<script type="text/javascript" src="../nav/prototype.lite.js"></script>
admin17a890d2006-09-27 20:42:42 +0000[diff] [blame]12<script type="text/javascript" src="../nav/moo.fx.js"></script>
Derek Allardb3412372007-10-25 12:15:16 +0000[diff] [blame^]13<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]14
15<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='Rick Ellis' />
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]20<meta name='description' content='CodeIgniter User Guide' />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Allard60ca9b72007-07-12 19:53:27 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.5.4</h1></td>
adminc0d5d522006-10-30 19:40:35 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]43<a href="http://www.codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Image Manipulation Class
46</td>
Derek Allardbc030912007-06-24 18:25:29 +0000[diff] [blame]47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58
59<h1>Image Manipulation Class</h1>
60
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]61<p>CodeIgniter's Image Manipulation class lets you perform the following actions:</p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]62
63<ul>
64<li>Image Resizing</li>
65<li>Thumbnail Creation</li>
66<li>Image Cropping</li>
67<li>Image Rotating</li>
68<li>Image Watermarking</li>
69</ul>
70
71<p>All three major image libraries are supported: GD/GD2, NetPBM, and ImageMagick</p>
72
admine334c472006-10-21 19:44:22 +0000[diff] [blame]73<p class="important"><strong>Note:</strong> Watermarking is only available using the GD/GD2 library.
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]74In addition, even though other libraries are supported, GD is required in
admine334c472006-10-21 19:44:22 +0000[diff] [blame]75order for the script to calculate the image properties. The image processing, however, will be performed with the
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]76library you specify.</p>
77
78
79<h2>Initializing the Class</h2>
80
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]81<p>Like most other classes in CodeIgniter, the image class is initialized in your controller
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]82using the <dfn>$this->load_library</dfn> function:</p>
83<code>$this->load->library('image_lib');</code>
84
85<p>Once the library is loaded it will be ready for use. The image library object you will use to call all functions is: <dfn>$this->image_lib</dfn></p>
86
87
88<h2>Processing an Image</h2>
89
90<p>Regardless of the type of processing you would like to perform (resizing, cropping, rotation, or watermarking), the general process is
91identical. You will set some preferences corresponding to the action you intend to perform, then
92call one of four available processing functions. For example, to create an image thumbnail you'll do this:</p>
93
94<code>$config['image_library'] = 'GD';<br />
95$config['source_image'] = '/path/to/image/mypic.jpg';<br />
96$config['create_thumb'] = TRUE;<br />
97$config['maintain_ratio'] = TRUE;<br />
98$config['width'] = 75;<br />
99$config['height'] = 50;<br />
100<br />
admin1b90c272006-10-31 18:22:29 +0000[diff] [blame]101$this->load->library('image_lib', $config);
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]102<br />
103<br />
104$this->image_lib->resize();</code>
105
106<p>The above code tells the <dfn>image_resize</dfn> function to look for an image called <em>mypic.jpg</em>
107located in the <dfn>source_image</dfn> folder, then create a thumbnail that is 75 X 50 pixels using the GD2 <dfn>image_library</dfn>.
admine334c472006-10-21 19:44:22 +0000[diff] [blame]108Since the <dfn>maintain_ratio</dfn> option is enabled, the thumb will be as close to the target <dfn>width</dfn> and
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]109<dfn>height</dfn> as possible while preserving the original aspect ratio. The thumbnail will be called <em>mypic_thumb.jpg</em>
110</p>
111
112<p class="important"><strong>Note:</strong> In order for the image class to be allowed to do any processing, the
113folder containing the image files must have file permissions of 777.</p>
114
115
116<h2>Processing Functions</h2>
117
118<p>There are four available processing functions:</p>
119
120<ul>
121<li>$this->image_lib->resize()</li>
122<li>$this->image_lib->crop()</li>
123<li>$this->image_lib->rotate()</li>
124<li>$this->image_lib->watermark()</li>
125</ul>
126
127<p>These functions return boolean TRUE upon success and FALSE for failure. If they fail you can retrieve the
128error message using this function:</p>
129
130<code>echo $this->image_lib->display_errors();</code>
131
132<p>A good practice is use the processing function conditionally, showing an error upon failure, like this:</p>
133
134<code>if ( ! $this->image_lib->resize())<br />
135{<br />
136&nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
137}</code>
138
139<p>Note: You can optionally specify the HTML formatting to be applied to the errors, by submitting the opening/closing
140tags in the function, like this:</p>
141
142<code>$this->image_lib->display_errors('<var>&lt;p></var>', '<var>&lt;/p></var>');</code>
143
144
145<h2>Preferences</h2>
146
147<p>The 14 available preferences described below allow you to tailor the image processing to suit your needs.</p>
148
149<p>Note that not all preferences are available for every
150function. For example, the x/y axis preferences are only available for image cropping. Likewise, the width and height
151preferences have no effect on cropping. The "availability" column indicates which functions support a given preference.</p>
152
153<p>Availability Legend:</p>
154
155<ul>
156<li><var>R</var> - Image Resizing</li>
157<li><var>C</var> - Image Cropping</li>
158<li><var>X</var> - Image Rotation</li>
159<li><var>W</var> - Image Watermarking</li>
160
161</ul>
162
163
164
165
166
167<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
168<tr>
169<th>Preference</th>
170<th>Default&nbsp;Value</th>
171<th>Options</th>
172<th>Description</th>
173<th>Availability</th>
174</tr>
175
176<tr>
177<td class="td"><strong>image_library</strong></td>
178<td class="td">GD2</td>
179<td class="td">GD, GD2, ImageMagick, NetPBM</td>
180<td class="td">Sets the image library to be used.</td>
181<td class="td">R, C, X, W</td>
182</tr>
183
184<tr>
185<td class="td"><strong>library_path</strong></td>
186<td class="td">None</td>
187<td class="td">None</td>
188<td class="td">Sets the server path to your ImageMagick or NetPBM library. If you use either of those libraries you must supply the path.</td>
189<td class="td">R, C, X</td>
190</tr>
191
192<tr>
193<td class="td"><strong>source_image</strong></td>
194<td class="td">None</td>
195<td class="td">None</td>
196<td class="td">Sets the source image name/path. The path must be a relative or absolute server path, not a URL.</td>
197<td class="td">R, C, S, W</td>
198</tr>
199
200<tr>
201<td class="td"><strong>dynamic_output</strong></td>
202<td class="td">FALSE</td>
203<td class="td">TRUE/FALSE (boolean)</td>
204<td class="td">Determines whether the new image file should be written to disk or generated dynamically. Note: If you choose the dynamic setting, only one image can be shown at a time, and it can't be positioned on the page. It simply outputs the raw image dynamically to your browser, along with image headers.</td>
205<td class="td">R, C, X, W</td>
206</tr>
207
208
209<tr>
210<td class="td"><strong>quality</strong></td>
211<td class="td">90%</td>
212<td class="td">1 - 100%</td>
213<td class="td">Sets the quality of the image. The higher the quality the larger the file size.</td>
214<td class="td">R, C, X, W</td>
215</tr>
216
217
218<tr>
219<td class="td"><strong>new_image</strong></td>
220<td class="td">None</td>
221<td class="td">None</td>
222<td class="td">Sets the destination image name/path. You'll use this preference when creating an image copy. The path must be a relative or absolute server path, not a URL.</td>
223<td class="td">R</td>
224</tr>
225
226<tr>
227<td class="td"><strong>width</strong></td>
228<td class="td">None</td>
229<td class="td">None</td>
230<td class="td">Sets the width you would like the image set to.</td>
Derek Allardf99f00a2007-07-12 00:06:01 +0000[diff] [blame]231<td class="td">R, C </td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]232</tr>
233
234<tr>
235<td class="td"><strong>height</strong></td>
236<td class="td">None</td>
237<td class="td">None</td>
238<td class="td">Sets the height you would like the image set to.</td>
Derek Allardf99f00a2007-07-12 00:06:01 +0000[diff] [blame]239<td class="td">R, C </td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]240</tr>
241
242<tr>
243<td class="td"><strong>create_thumb</strong></td>
244<td class="td">FALSE</td>
245<td class="td">TRUE/FALSE (boolean)</td>
246<td class="td">Tells the image processing function to create a thumb.</td>
247<td class="td">R</td>
248</tr>
249
250<tr>
251<td class="td"><strong>thumb_marker</strong></td>
252<td class="td">_thumb</td>
253<td class="td">None</td>
254<td class="td">Specifies the thumbnail indicator. It will be inserted just before the file extension, so mypic.jpg would become mypic_thumb.jpg</td>
255<td class="td">R</td>
256</tr>
257
258<tr>
259<td class="td"><strong>maintain_ratio</strong></td>
260<td class="td">TRUE</td>
261<td class="td">TRUE/FALSE (boolean)</td>
262<td class="td">Specifies whether to maintain the original aspect ratio when resizing or use hard values.</td>
263<td class="td">R</td>
264</tr>
265
266
267<tr>
268<td class="td"><strong>master_dim</strong></td>
269<td class="td">auto</td>
270<td class="td">auto, width, height</td>
271<td class="td">Specifies what to use as the master axis when resizing or creating thumbs. For example, let's say you want to resize an image to 100 X 75 pixels. If the source image size does not allow perfect resizing to those dimensions, this setting determines which axis should be used as the hard value. "auto" sets the axis automatically based on whether the image is taller then wider, or vice versa.</td>
272<td class="td">R</td>
273</tr>
274
275
276
277
278<tr>
279<td class="td"><strong>rotation_angle</strong></td>
280<td class="td">None</td>
281<td class="td">90, 180, 270, vrt, hor</td>
282<td class="td">Specifies the angle of rotation when rotating images. Note that PHP rotates counter-clockwise, so a 90 degree rotation to the right must be specified as 270.</td>
283<td class="td">X</td>
284</tr>
285
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]286<tr>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]287<td class="td"><strong>x_axis</strong></td>
288<td class="td">None</td>
289<td class="td">None</td>
290<td class="td">Sets the X coordinate in pixels for image cropping. For example, a setting of 30 will crop an image 30 pixels from the left.</td>
291<td class="td">C</td>
292</tr>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]293<tr>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]294<td class="td"><strong>y_axis</strong></td>
295<td class="td">None</td>
296<td class="td">None</td>
297<td class="td">Sets the Y coordinate in pixels for image cropping. For example, a setting of 30 will crop an image 30 pixels from the top.</td>
298<td class="td">C</td>
299</tr>
300
301</table>
302
303
304<h2>Setting preferences in a config file</h2>
305
306<p>If you prefer not to set preferences using the above method, you can instead put them into a config file.
307Simply create a new file called the <var>image_lib.php</var>, add the <var>$config</var>
308array in that file. Then save the file in: <var>config/image_lib.php</var> and it will be used automatically. You
309will NOT need to use the <dfn>$this->image_lib->initialize</dfn> function if you save your preferences in a config file.</p>
310
311
312<h2>$this->image_lib->resize()</h2>
313
admine334c472006-10-21 19:44:22 +0000[diff] [blame]314<p>The image resizing function lets you resize the original image, create a copy (with or without resizing),
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]315or create a thumbnail image.</p>
316
317<p>For practical purposes there is no difference between creating a copy and creating
318a thumbnail except a thumb will have the thumbnail marker as part of the name (ie, mypic_thumb.jpg).</p>
319
320<p>All preferences listed in the table above are available for this function except these three: rotation, x_axis, and y_axis.</p>
321
322<h3>Creating a Thumbnail</h3>
323
324<p>The resizing function will create a thumbnail file (and preserve the original) if you set this preference so TRUE:</p>
325
326<code>$config['create_thumb'] = TRUE;</code>
327
328<p>This single preference determines whether a thumbnail is created or not.</p>
329
330<h3>Creating a Copy</h3>
331
332<p>The resizing function will create a copy of the image file (and preserve the original) if you set
333a path and/or a new filename using this preference:</p>
334
335<code>$config['new_image'] = '/path/to/new_image.jpg';</code>
336
337<p>Notes regarding this preference:</p>
338<ul>
339<li>If only the new image name is specified it will be placed in the same folder as the original</li>
340<li>If only the path is specified, the new image will be placed in the destination with the same name as the original.</li>
341<li>If both the path and image name are specified it will placed in its own destination and given the new name.</li>
342</ul>
343
344
345<h3>Resizing the Original Image</h3>
346
347<p>If neither of the two preferences listed above (create_thumb, and new_image) are used, the resizing function will instead
348target the original image for processing.</p>
349
350
351<h2>$this->image_lib->crop()</h2>
352
admine334c472006-10-21 19:44:22 +0000[diff] [blame]353<p>The cropping function works nearly identically to the resizing function except it requires that you set
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]354preferences for the X and Y axis (in pixels) specifying where to crop, like this:</p>
355
356<code>$config['x_axis'] = '100';<br />
Rick Ellis8ec66912007-06-13 22:07:35 +0000[diff] [blame]357$config['y_axis'] = '40';</code>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]358
359<p>All preferences listed in the table above are available for this function except these: rotation, width, height, create_thumb, new_image.</p>
360
361<p>Here's an example showing how you might crop an image:</p>
362
363<code>$config['image_library'] = 'imagemagick';<br />
364$config['library_path'] = '/usr/X11R6/bin/';<br />
365$config['source_image'] = '/path/to/image/mypic.jpg';<br />
366$config['x_axis'] = '100';<br />
367$config['y_axis'] = '60';<br />
368<br />
369$this->image_lib->initialize($config);
370<br />
371<br />
372if ( ! $this->image_lib->crop())<br />
373{<br />
374&nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
375}</code>
376
377
admine334c472006-10-21 19:44:22 +0000[diff] [blame]378<p>Note: Without a visual interface it is difficult to crop images, so this function is not very useful
379unless you intend to build such an interface. That's exactly what we did using for the photo
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]380gallery module in ExpressionEngine, the CMS we develop. We added a JavaScript UI that lets the cropping
381area be selected.</p>
382
383<h2>$this->image_lib->rotate()</h2>
384
385<p>The image rotation function requires that the angle of rotation be set via its preference:</p>
386
387<code>$config['rotation_angle'] = '90';</code>
388
389<p>There are 5 rotation options:</p>
390
391<ol>
392<li>90 - rotates counter-clockwise by 90 degrees.</li>
393<li>180 - rotates counter-clockwise by 180 degrees.</li>
394<li>270 - rotates counter-clockwise by 270 degrees.</li>
395<li>hor - flips the image horizontally.</li>
396<li>vrt - flips the image vertically.</li>
397</ol>
398
399<p>Here's an example showing how you might rotate an image:</p>
400
401<code>$config['image_library'] = 'netpbm';<br />
402$config['library_path'] = '/usr/bin/';<br />
403$config['source_image'] = '/path/to/image/mypic.jpg';<br />
404$config['rotation_angle'] = 'hor';<br />
405<br />
406$this->image_lib->initialize($config);
407<br />
408<br />
409if ( ! $this->image_lib->rotate())<br />
410{<br />
411&nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
412}</code>
413
414
415
416<p>&nbsp;</p>
417<h1>Image Watermarking</h1>
418
419<p>The Watermarking feature requires the GD/GD2 library.</p>
420
421
422<h2>Two Types of Watermarking</h2>
423
424<p>There are two types of watermarking that you can use:</p>
425
426<ul>
427<li><strong>Text</strong>: The watermark message will be generating using text, either with a True Type font that you specify, or
admine334c472006-10-21 19:44:22 +0000[diff] [blame]428using the native text output that the GD library supports. If you use the True Type version your GD installation
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]429must be compiled with True Type support (most are, but not all).</li>
430
431<li><strong>Overlay</strong>: The watermark message will be generated by overlaying an image (usually a transparent PNG or GIF)
432containing your watermark over the source image.</li>
433
434</ul>
435
436
437<h2>Watermarking an Image</h2>
438
439<p>Just as with the other function (resizing, cropping, and rotating) the general process for watermarking
440involves setting the preferences corresponding to the action you intend to perform, then
441calling the watermark function. Here is an example:</p>
442
443<code>
444$config['source_image'] = '/path/to/image/mypic.jpg';<br />
445$config['wm_text'] = 'Copyright 2006 - John Doe';<br />
446$config['wm_type'] = 'text';<br />
447$config['wm_font_path'] = './system/fonts/texb.ttf';<br />
448$config['wm_font_size'] = '16';<br />
Derek Allarde8256b62007-07-08 17:05:09 +0000[diff] [blame]449$config['wm_font_color'] = 'ffffff';<br />
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]450$config['wm_vrt_alignment'] = 'bottom';<br />
451$config['wm_hor_alignment'] = 'center';<br />
452$config['wm_padding'] = '20';<br />
453<br />
454$this->image_lib->initialize($config);
455<br />
456<br />
457$this->image_lib->watermark();</code>
458
459
460<p>The above example will use a 16 pixel True Type font to create the text "Copyright 2006 - John Doe". The watermark
461will be positioned at the bottom/center of the image, 20 pixels from the bottom of the image.</p>
462
463<p class="important"><strong>Note:</strong> In order for the image class to be allowed to do any processing, the image file must have file permissions of 777.</p>
464
465
466<h2>Watermarking Preferences</h2>
467
468<p>This table shown the preferences that are available for both types of watermarking (text or overlay)</p>
469
470<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
471<tr>
472<th>Preference</th>
473<th>Default&nbsp;Value</th>
474<th>Options</th>
475<th>Description</th>
476</tr>
477
478<tr>
479<td class="td"><strong>wm_type</strong></td>
480<td class="td">text</td>
481<td class="td">type, overlay</td>
482<td class="td">Sets the type of watermarking that should be used.</td>
483</tr>
484
485<tr>
486<td class="td"><strong>source_image</strong></td>
487<td class="td">None</td>
488<td class="td">None</td>
489<td class="td">Sets the source image name/path. The path must be a relative or absolute server path, not a URL.</td>
490</tr>
491
492<tr>
493<td class="td"><strong>dynamic_output</strong></td>
494<td class="td">FALSE</td>
495<td class="td">TRUE/FALSE (boolean)</td>
496<td class="td">Determines whether the new image file should be written to disk or generated dynamically. Note: If you choose the dynamic setting, only one image can be shown at a time, and it can't be positioned on the page. It simply outputs the raw image dynamically to your browser, along with image headers.</td>
497</tr>
498
499<tr>
500<td class="td"><strong>quality</strong></td>
501<td class="td">90%</td>
502<td class="td">1 - 100%</td>
503<td class="td">Sets the quality of the image. The higher the quality the larger the file size.</td>
504</tr>
505
506<tr>
507<td class="td"><strong>padding</strong></td>
508<td class="td">None</td>
509<td class="td">A number</td>
510<td class="td">The amount of padding, set in pixels, that will be applied to the watermark to set it away from the edge of your images.</td>
511</tr>
512
513<tr>
514<td class="td"><strong>wm_vrt_alignment</strong></td>
515<td class="td">bottom</td>
516<td class="td">top, middle, bottom</td>
517<td class="td">Sets the vertical alignment for the watermark image.</td>
518</tr>
519
520<tr>
521<td class="td"><strong>wm_hor_alignment</strong></td>
522<td class="td">center</td>
523<td class="td">left, center, right</td>
524<td class="td">Sets the horizontal alignment for the watermark image.</td>
525</tr>
526
527<tr>
528<td class="td"><strong>wm_vrt_offset</strong></td>
529<td class="td">None</td>
530<td class="td">None</td>
531<td class="td">You may specify a horizontal offset (in pixels) to apply to the watermark position. The offset normally moves the watermark to the right, except if you have your alignment set to "right" then your offset value will move the watermark toward the left of the image.</td>
532</tr>
533
534<tr>
535<td class="td"><strong>wm_hor_offset</strong></td>
536<td class="td">None</td>
537<td class="td">None</td>
538<td class="td">You may specify a horizontal offset (in pixels) to apply to the watermark position. The offset normally moves the watermark down, except if you have your alignment set to "bottom" then your offset value will move the watermark toward the top of the image.</td>
539</tr>
540
541</table>
542
543
544
545<h3>Text Preferences</h3>
546<p>This table shown the preferences that are available for the text type of watermarking.</p>
547
548
549<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
550<tr>
551<th>Preference</th>
552<th>Default&nbsp;Value</th>
553<th>Options</th>
554<th>Description</th>
555</tr>
556
557<tr>
558<td class="td"><strong>wm_text</strong></td>
559<td class="td">None</td>
560<td class="td">None</td>
561<td class="td">The text you would like shown as the watermark. Typically this will be a copyright notice.</td>
562</tr>
563
564<tr>
565<td class="td"><strong>wm_font_path</strong></td>
566<td class="td">None</td>
567<td class="td">None</td>
Rick Ellis573b66a2007-08-04 02:09:01 +0000[diff] [blame]568<td class="td">The server path to the True Type Font you would like to use. If you do not use this option, the native GD font will be used.</td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]569</tr>
570
571<tr>
572<td class="td"><strong>wm_font_size</strong></td>
573<td class="td">16</td>
574<td class="td">None</td>
575<td class="td">The size of the text. Note: If you are not using the True Type option above, the number is set using a range of 1 - 5. Otherwise, you can use any valid pixel size for the font you're using.</td>
576</tr>
577
578<tr>
579<td class="td"><strong>wm_font_color</strong></td>
580<td class="td">ffffff</td>
581<td class="td">None</td>
582<td class="td">The font color, specified in hex. Note, you must use the full 6 character hex value (ie, 993300), rather than the three character abbreviated version (ie fff).</td>
583</tr>
584
585
586<tr>
587<td class="td"><strong>wm_shadow_color</strong></td>
588<td class="td">None</td>
589<td class="td">None</td>
590<td class="td">The color of the drop shadow, specified in hex. If you leave this blank a drop shadow will not be used. Note, you must use the full 6 character hex value (ie, 993300), rather than the three character abbreviated version (ie fff).</td>
591</tr>
592
593<tr>
594<td class="td"><strong>wm_shadow_distance</strong></td>
595<td class="td">3</td>
596<td class="td">None</td>
597<td class="td">The distance (in pixels) from the font that the drop shadow should appear.</td>
598</tr>
599
600</table>
601
602
603
604
605<h3>Overlay Preferences</h3>
606<p>This table shown the preferences that are available for the overlay type of watermarking.</p>
607
608
609<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
610<tr>
611<th>Preference</th>
612<th>Default&nbsp;Value</th>
613<th>Options</th>
614<th>Description</th>
615</tr>
616
617<tr>
618<td class="td"><strong>wm_overlay_path</strong></td>
619<td class="td">None</td>
620<td class="td">None</td>
621<td class="td">The server path to the image you wish to use as your watermark. Required only if you are using the overlay method.</td>
622</tr>
623
624<tr>
625<td class="td"><strong>wm_opacity</strong></td>
626<td class="td">50</td>
627<td class="td">1 - 100</td>
628<td class="td">Image opacity. You may specify the opacity (i.e. transparency) of your watermark image. This allows the watermark to be faint and not completely obscure the details from the original image behind it. A 50% opacity is typical.</td>
629</tr>
630
631<tr>
632<td class="td"><strong>wm_x_transp</strong></td>
633<td class="td">4</td>
634<td class="td">A number</td>
635<td class="td">If your watermark image is a PNG or GIF image, you may specify a color on the image to be "transparent". This setting (along with the next) will allow you to specify that color. This works by specifying the "X" and "Y" coordinate pixel (measured from the upper left) within the image that corresponds to a pixel representative of the color you want to be transparent.</td>
636</tr>
637
638<tr>
639<td class="td"><strong>wm_y_transp</strong></td>
640<td class="td">4</td>
641<td class="td">A number</td>
642<td class="td">Along with the previous setting, this allows you to specify the coordinate to a pixel representative of the color you want to be transparent.</td>
643</tr>
644</table>
645
646
647
648</div>
649<!-- END CONTENT -->
650
651
652<div id="footer">
653<p>
admin40037182006-10-11 19:16:58 +0000[diff] [blame]654Previous Topic:&nbsp;&nbsp;<a href="table.html">HTML Table Class</a>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]655&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
656<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
657<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
658Next Topic:&nbsp;&nbsp;<a href="input.html">Input Class</a>
Derek Allardc6441282007-07-04 23:54:32 +0000[diff] [blame]659</p>
Derek Allardd2df9bc2007-04-15 17:41:17 +0000[diff] [blame]660<p><a href="http://www.codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2007 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]661</div>
662
663</body>
664</html>