user_guide/libraries/image_lib.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   3 <head>
   4
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <title>Image Manipulation Class : CodeIgniter User Guide</title>
   7
   8 <style type='text/css' media='all'>@import url('../userguide.css');</style>
   9 <link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
  10
  11 <script type="text/javascript" src="../nav/nav.js"></script>
  12 <script type="text/javascript" src="../nav/prototype.lite.js"></script>
  13 <script type="text/javascript" src="../nav/moo.fx.js"></script>
  14 <script type="text/javascript" src="../nav/user_guide_menu.js"></script>
  15
  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='ExpressionEngine Dev Team' />
  20 <meta name='description' content='CodeIgniter User Guide' />
  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_darker.jpg" width="154" height="43" 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>
  31 <td><h1>CodeIgniter User Guide Version 2.0.2</h1></td>
  32 <td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
  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">
  43 <a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
  44 <a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
  45 Image Manipulation Class
  46 </td>
  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>
  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
  61 <p>CodeIgniter's Image Manipulation class lets you perform the following actions:</p>
  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
  73 <p class="important"><strong>Note:</strong> Watermarking is only available using the GD/GD2 library.
  74 In addition, even though other libraries are supported, GD is required in
  75 order for the script to calculate the image properties.  The image processing, however, will be performed with the
  76 library you specify.</p>
  77
  78
  79 <h2>Initializing the Class</h2>
  80
  81 <p>Like most other classes in CodeIgniter, the image class is initialized in your controller
  82 using the <dfn>$this->load-&gt;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
  91 identical. You will set some preferences corresponding to the action you intend to perform, then
  92 call one of four available processing functions.  For example, to create an image thumbnail you'll do this:</p>
  93
  94 <code>$config['image_library'] = 'gd2';<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 />
 101 $this->load->library('image_lib', $config);
 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>
 107 located in the <dfn>source_image</dfn> folder, then create a thumbnail that is 75 X 50 pixels using the GD2 <dfn>image_library</dfn>.
 108 Since the <dfn>maintain_ratio</dfn> option is enabled, the thumb will be as close to the target <dfn>width</dfn> and
 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
 113 folder containing the image files must have write permissions.</p>
 114
 115 <p class="important"><strong>Note:</strong> Image processing can require a considerable amount of server memory for some operations. If you are experiencing out of memory errors while processing images you may need to limit their maximum size, and/or adjust PHP memory limits.</p>
 116
 117 <h2>Processing Functions</h2>
 118
 119 <p>There are four available processing functions:</p>
 120
 121 <ul>
 122 <li>$this->image_lib->resize()</li>
 123 <li>$this->image_lib->crop()</li>
 124 <li>$this->image_lib->rotate()</li>
 125 <li>$this->image_lib->watermark()</li>
 126 <li>$this-&gt;image_lib-&gt;clear()</li>
 127 </ul>
 128
 129 <p>These functions return boolean TRUE upon success and FALSE for failure.  If they fail you can retrieve the
 130 error message using this function:</p>
 131
 132 <code>echo $this->image_lib->display_errors();</code>
 133
 134 <p>A good practice is use the processing function conditionally, showing an error upon failure, like this:</p>
 135
 136 <code>if ( ! $this->image_lib->resize())<br />
 137 {<br />
 138 &nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
 139 }</code>
 140
 141 <p>Note:  You can optionally specify the HTML formatting to be applied to the errors, by submitting the opening/closing
 142 tags in the function, like this:</p>
 143
 144 <code>$this->image_lib->display_errors('<var>&lt;p></var>', '<var>&lt;/p></var>');</code>
 145
 146
 147 <h2>Preferences</h2>
 148
 149 <p>The  preferences described below allow you to tailor the image processing to suit your needs.</p>
 150
 151 <p>Note that not all preferences are available for every
 152 function.  For example, the x/y axis preferences are only available for image cropping. Likewise, the width and height
 153 preferences have no effect on cropping.  The "availability" column indicates which functions support a given preference.</p>
 154
 155 <p>Availability Legend:</p>
 156
 157 <ul>
 158 <li><var>R</var> - Image Resizing</li>
 159 <li><var>C</var> - Image Cropping</li>
 160 <li><var>X</var> - Image Rotation</li>
 161 <li><var>W</var> - Image Watermarking</li>
 162
 163 </ul>
 164
 165
 166
 167
 168
 169 <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
 170 <tr>
 171 <th>Preference</th>
 172 <th>Default&nbsp;Value</th>
 173 <th>Options</th>
 174 <th>Description</th>
 175 <th>Availability</th>
 176 </tr>
 177
 178 <tr>
 179 <td class="td"><strong>image_library</strong></td>
 180 <td class="td">GD2</td>
 181 <td class="td">GD, GD2, ImageMagick, NetPBM</td>
 182 <td class="td">Sets the image library to be used.</td>
 183 <td class="td">R, C, X, W</td>
 184 </tr>
 185
 186 <tr>
 187 <td class="td"><strong>library_path</strong></td>
 188 <td class="td">None</td>
 189 <td class="td">None</td>
 190 <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>
 191 <td class="td">R, C, X</td>
 192 </tr>
 193
 194 <tr>
 195 <td class="td"><strong>source_image</strong></td>
 196 <td class="td">None</td>
 197 <td class="td">None</td>
 198 <td class="td">Sets the source image name/path.  The path must be a relative or absolute server path, not a URL.</td>
 199 <td class="td">R, C, S, W</td>
 200 </tr>
 201
 202 <tr>
 203 <td class="td"><strong>dynamic_output</strong></td>
 204 <td class="td">FALSE</td>
 205 <td class="td">TRUE/FALSE (boolean)</td>
 206 <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>
 207 <td class="td">R, C, X, W</td>
 208 </tr>
 209
 210
 211 <tr>
 212 <td class="td"><strong>quality</strong></td>
 213 <td class="td">90%</td>
 214 <td class="td">1 - 100%</td>
 215 <td class="td">Sets the quality of the image. The higher the quality the larger the file size.</td>
 216 <td class="td">R, C, X, W</td>
 217 </tr>
 218
 219
 220 <tr>
 221 <td class="td"><strong>new_image</strong></td>
 222 <td class="td">None</td>
 223 <td class="td">None</td>
 224 <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>
 225 <td class="td">R, C, X, W</td>
 226 </tr>
 227
 228 <tr>
 229 <td class="td"><strong>width</strong></td>
 230 <td class="td">None</td>
 231 <td class="td">None</td>
 232 <td class="td">Sets the width you would like the image set to.</td>
 233 <td class="td">R, C </td>
 234 </tr>
 235
 236 <tr>
 237 <td class="td"><strong>height</strong></td>
 238 <td class="td">None</td>
 239 <td class="td">None</td>
 240 <td class="td">Sets the height you would like the image set to.</td>
 241 <td class="td">R, C </td>
 242 </tr>
 243
 244 <tr>
 245 <td class="td"><strong>create_thumb</strong></td>
 246 <td class="td">FALSE</td>
 247 <td class="td">TRUE/FALSE (boolean)</td>
 248 <td class="td">Tells the image processing function to create a thumb.</td>
 249 <td class="td">R</td>
 250 </tr>
 251
 252 <tr>
 253 <td class="td"><strong>thumb_marker</strong></td>
 254 <td class="td">_thumb</td>
 255 <td class="td">None</td>
 256 <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>
 257 <td class="td">R</td>
 258 </tr>
 259
 260 <tr>
 261 <td class="td"><strong>maintain_ratio</strong></td>
 262 <td class="td">TRUE</td>
 263 <td class="td">TRUE/FALSE (boolean)</td>
 264 <td class="td">Specifies whether to maintain the original aspect ratio when resizing or use hard values.</td>
 265 <td class="td">R, C</td>
 266 </tr>
 267
 268
 269 <tr>
 270 <td class="td"><strong>master_dim</strong></td>
 271 <td class="td">auto</td>
 272 <td class="td">auto, width, height</td>
 273 <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>
 274 <td class="td">R</td>
 275 </tr>
 276
 277
 278
 279
 280 <tr>
 281 <td class="td"><strong>rotation_angle</strong></td>
 282 <td class="td">None</td>
 283 <td class="td">90, 180, 270, vrt, hor</td>
 284 <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>
 285 <td class="td">X</td>
 286 </tr>
 287
 288 <tr>
 289 <td class="td"><strong>x_axis</strong></td>
 290 <td class="td">None</td>
 291 <td class="td">None</td>
 292 <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>
 293 <td class="td">C</td>
 294 </tr>
 295 <tr>
 296 <td class="td"><strong>y_axis</strong></td>
 297 <td class="td">None</td>
 298 <td class="td">None</td>
 299 <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>
 300 <td class="td">C</td>
 301 </tr>
 302
 303 </table>
 304
 305
 306 <h2>Setting preferences in a config file</h2>
 307
 308 <p>If you prefer not to set preferences using the above method, you can instead put them into a config file.
 309 Simply create a new file called <var>image_lib.php</var>,  add the <var>$config</var>
 310 array in that file. Then save the file in: <var>config/image_lib.php</var> and it will be used automatically. You
 311 will NOT need to use the <dfn>$this->image_lib->initialize</dfn> function if you save your preferences in a config file.</p>
 312
 313
 314 <h2>$this->image_lib->resize()</h2>
 315
 316 <p>The image resizing function lets you resize the original image, create a copy (with or without resizing),
 317 or create a thumbnail image.</p>
 318
 319 <p>For practical purposes there is no difference between creating a copy and creating
 320 a thumbnail except a thumb will have the thumbnail marker as part of the name (ie, mypic_thumb.jpg).</p>
 321
 322 <p>All preferences listed in the table above are available for this function except these three:  rotation_angle, x_axis, and y_axis.</p>
 323
 324 <h3>Creating a Thumbnail</h3>
 325
 326 <p>The resizing function will create a thumbnail file (and preserve the original) if you set this preference to TRUE:</p>
 327
 328 <code>$config['create_thumb'] = TRUE;</code>
 329
 330 <p>This single preference determines whether a thumbnail is created or not.</p>
 331
 332 <h3>Creating a Copy</h3>
 333
 334 <p>The resizing function will create a copy of the image file (and preserve the original) if you set
 335 a path and/or a new filename using this preference:</p>
 336
 337 <code>$config['new_image'] = '/path/to/new_image.jpg';</code>
 338
 339 <p>Notes regarding this preference:</p>
 340 <ul>
 341 <li>If only the new image name is specified it will be placed in the same folder as the original</li>
 342 <li>If only the path is specified, the new image will be placed in the destination with the same name as the original.</li>
 343 <li>If both the path and image name are specified it will placed in its own destination and given the new name.</li>
 344 </ul>
 345
 346
 347 <h3>Resizing the Original Image</h3>
 348
 349 <p>If neither of the two preferences listed above (create_thumb, and new_image) are used, the resizing function will instead
 350 target the original image for processing.</p>
 351
 352
 353 <h2>$this->image_lib->crop()</h2>
 354
 355 <p>The cropping function works nearly identically to the resizing function except it requires that you set
 356 preferences for the X and Y axis (in pixels) specifying where to crop, like this:</p>
 357
 358 <code>$config['x_axis'] = '100';<br />
 359 $config['y_axis'] = '40';</code>
 360
 361 <p>All preferences listed in the table above are available for this function except these:  rotation_angle, width, height, create_thumb, new_image.</p>
 362
 363 <p>Here's an example showing how you might crop an image:</p>
 364
 365 <code>$config['image_library'] = 'imagemagick';<br />
 366 $config['library_path'] = '/usr/X11R6/bin/';<br />
 367 $config['source_image'] = '/path/to/image/mypic.jpg';<br />
 368 $config['x_axis'] = '100';<br />
 369 $config['y_axis'] = '60';<br />
 370 <br />
 371 $this->image_lib->initialize($config);
 372 <br />
 373 <br />
 374 if ( ! $this->image_lib->crop())<br />
 375 {<br />
 376 &nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
 377 }</code>
 378
 379
 380 <p>Note: Without a visual interface it is difficult to crop images, so this function is not very useful
 381 unless you intend to build such an interface.  That's exactly what we did using for the photo
 382 gallery module in ExpressionEngine, the CMS we develop.  We added a JavaScript UI that lets the cropping
 383 area be selected.</p>
 384
 385 <h2>$this->image_lib->rotate()</h2>
 386
 387 <p>The image rotation function requires that the angle of rotation be set via its preference:</p>
 388
 389 <code>$config['rotation_angle'] = '90';</code>
 390
 391 <p>There are 5 rotation options:</p>
 392
 393 <ol>
 394 <li>90 - rotates counter-clockwise by 90 degrees.</li>
 395 <li>180 - rotates counter-clockwise by 180 degrees.</li>
 396 <li>270 - rotates counter-clockwise by 270 degrees.</li>
 397 <li>hor - flips the image horizontally.</li>
 398 <li>vrt - flips the image vertically.</li>
 399 </ol>
 400
 401 <p>Here's an example showing how you might rotate an image:</p>
 402
 403 <code>$config['image_library'] = 'netpbm';<br />
 404 $config['library_path'] = '/usr/bin/';<br />
 405 $config['source_image'] = '/path/to/image/mypic.jpg';<br />
 406 $config['rotation_angle'] = 'hor';<br />
 407 <br />
 408 $this->image_lib->initialize($config);
 409 <br />
 410 <br />
 411 if ( ! $this->image_lib->rotate())<br />
 412 {<br />
 413 &nbsp;&nbsp;&nbsp;&nbsp;echo $this->image_lib->display_errors();<br />
 414 }</code>
 415
 416
 417
 418 <h2>$this-&gt;image_lib-&gt;clear()</h2>
 419 <p>The clear function resets all of the values used when processing an image. You will want to call this if you are processing images in a loop.</p>
 420 <p><code>$this-&gt;image_lib-&gt;clear();</code></p>
 421 <p>&nbsp;</p>
 422 <h1>Image Watermarking</h1>
 423
 424 <p>The Watermarking feature requires the GD/GD2 library.</p>
 425
 426
 427 <h2>Two Types of Watermarking</h2>
 428
 429 <p>There are two types of watermarking that you can use:</p>
 430
 431 <ul>
 432 <li><strong>Text</strong>: The watermark message will be generating using text, either with a True Type font that you specify, or
 433 using the native text output that the GD library supports. If you use the True Type version your GD installation
 434 must be compiled with True Type support (most are, but not all).</li>
 435
 436 <li><strong>Overlay</strong>: The watermark message will be generated by overlaying an image (usually a transparent PNG or GIF)
 437 containing your watermark over the source image.</li>
 438
 439 </ul>
 440
 441
 442 <h2>Watermarking an Image</h2>
 443
 444 <p>Just as with the other functions (resizing, cropping, and rotating) the general process for watermarking
 445 involves setting the preferences corresponding to the action you intend to perform, then
 446 calling the watermark function.  Here is an example:</p>
 447
 448 <code>
 449 $config['source_image'] = '/path/to/image/mypic.jpg';<br />
 450 $config['wm_text'] = 'Copyright 2006 - John Doe';<br />
 451 $config['wm_type'] = 'text';<br />
 452 $config['wm_font_path'] = './system/fonts/texb.ttf';<br />
 453 $config['wm_font_size'] = '16';<br />
 454 $config['wm_font_color'] = 'ffffff';<br />
 455 $config['wm_vrt_alignment']  = 'bottom';<br />
 456 $config['wm_hor_alignment']  = 'center';<br />
 457 $config['wm_padding']  = '20';<br />
 458 <br />
 459 $this->image_lib->initialize($config);
 460 <br />
 461 <br />
 462 $this->image_lib->watermark();</code>
 463
 464
 465 <p>The above example will use a 16 pixel True Type font to create the text "Copyright 2006 - John Doe".  The watermark
 466 will be positioned at the bottom/center of the image, 20 pixels from the bottom of the image.</p>
 467
 468 <p class="important"><strong>Note:</strong> In order for the image class to be allowed to do any processing, the image file must have &quot;write&quot; file permissions. For example, 777.</p>
 469
 470
 471 <h2>Watermarking Preferences</h2>
 472
 473 <p>This table shown the preferences that are available for both types of watermarking (text or overlay)</p>
 474
 475 <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
 476 <tr>
 477 <th>Preference</th>
 478 <th>Default&nbsp;Value</th>
 479 <th>Options</th>
 480 <th>Description</th>
 481 </tr>
 482
 483 <tr>
 484 <td class="td"><strong>wm_type</strong></td>
 485 <td class="td">text</td>
 486 <td class="td">text, overlay</td>
 487 <td class="td">Sets the type of watermarking that should be used.</td>
 488 </tr>
 489
 490 <tr>
 491 <td class="td"><strong>source_image</strong></td>
 492 <td class="td">None</td>
 493 <td class="td">None</td>
 494 <td class="td">Sets the source image name/path.  The path must be a relative or absolute server path, not a URL.</td>
 495 </tr>
 496
 497 <tr>
 498 <td class="td"><strong>dynamic_output</strong></td>
 499 <td class="td">FALSE</td>
 500 <td class="td">TRUE/FALSE (boolean)</td>
 501 <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>
 502 </tr>
 503
 504 <tr>
 505 <td class="td"><strong>quality</strong></td>
 506 <td class="td">90%</td>
 507 <td class="td">1 - 100%</td>
 508 <td class="td">Sets the quality of the image. The higher the quality the larger the file size.</td>
 509 </tr>
 510
 511 <tr>
 512 <td class="td"><strong>padding</strong></td>
 513 <td class="td">None</td>
 514 <td class="td">A number</td>
 515 <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>
 516 </tr>
 517
 518 <tr>
 519 <td class="td"><strong>wm_vrt_alignment</strong></td>
 520 <td class="td">bottom</td>
 521 <td class="td">top, middle, bottom</td>
 522 <td class="td">Sets the vertical alignment for the watermark image.</td>
 523 </tr>
 524
 525 <tr>
 526 <td class="td"><strong>wm_hor_alignment</strong></td>
 527 <td class="td">center</td>
 528 <td class="td">left, center, right</td>
 529 <td class="td">Sets the horizontal alignment for the watermark image.</td>
 530 </tr>
 531
 532 <tr>
 533 <td class="td"><strong>wm_hor_offset</strong></td>
 534 <td class="td">None</td>
 535 <td class="td">None</td>
 536 <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>
 537 </tr>
 538
 539 <tr>
 540 <td class="td"><strong>wm_vrt_offset</strong></td>
 541 <td class="td">None</td>
 542 <td class="td">None</td>
 543 <td class="td">You may specify a vertical 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>
 544 </tr>
 545
 546 </table>
 547
 548
 549
 550 <h3>Text Preferences</h3>
 551 <p>This table shown the preferences that are available for the text type of watermarking.</p>
 552
 553
 554 <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
 555 <tr>
 556 <th>Preference</th>
 557 <th>Default&nbsp;Value</th>
 558 <th>Options</th>
 559 <th>Description</th>
 560 </tr>
 561
 562 <tr>
 563 <td class="td"><strong>wm_text</strong></td>
 564 <td class="td">None</td>
 565 <td class="td">None</td>
 566 <td class="td">The text you would like shown as the watermark.  Typically this will be a copyright notice.</td>
 567 </tr>
 568
 569 <tr>
 570 <td class="td"><strong>wm_font_path</strong></td>
 571 <td class="td">None</td>
 572 <td class="td">None</td>
 573 <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>
 574 </tr>
 575
 576 <tr>
 577 <td class="td"><strong>wm_font_size</strong></td>
 578 <td class="td">16</td>
 579 <td class="td">None</td>
 580 <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>
 581 </tr>
 582
 583 <tr>
 584 <td class="td"><strong>wm_font_color</strong></td>
 585 <td class="td">ffffff</td>
 586 <td class="td">None</td>
 587 <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>
 588 </tr>
 589
 590
 591 <tr>
 592 <td class="td"><strong>wm_shadow_color</strong></td>
 593 <td class="td">None</td>
 594 <td class="td">None</td>
 595 <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>
 596 </tr>
 597
 598 <tr>
 599 <td class="td"><strong>wm_shadow_distance</strong></td>
 600 <td class="td">3</td>
 601 <td class="td">None</td>
 602 <td class="td">The distance (in pixels) from the font that the drop shadow should appear.</td>
 603 </tr>
 604
 605 </table>
 606
 607
 608
 609
 610 <h3>Overlay Preferences</h3>
 611 <p>This table shown the preferences that are available for the overlay type of watermarking.</p>
 612
 613
 614 <table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
 615 <tr>
 616 <th>Preference</th>
 617 <th>Default&nbsp;Value</th>
 618 <th>Options</th>
 619 <th>Description</th>
 620 </tr>
 621
 622 <tr>
 623 <td class="td"><strong>wm_overlay_path</strong></td>
 624 <td class="td">None</td>
 625 <td class="td">None</td>
 626 <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>
 627 </tr>
 628
 629 <tr>
 630 <td class="td"><strong>wm_opacity</strong></td>
 631 <td class="td">50</td>
 632 <td class="td">1 - 100</td>
 633 <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>
 634 </tr>
 635
 636 <tr>
 637 <td class="td"><strong>wm_x_transp</strong></td>
 638 <td class="td">4</td>
 639 <td class="td">A number</td>
 640 <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>
 641 </tr>
 642
 643 <tr>
 644 <td class="td"><strong>wm_y_transp</strong></td>
 645 <td class="td">4</td>
 646 <td class="td">A number</td>
 647 <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>
 648 </tr>
 649 </table>
 650
 651 </div>
 652 <!-- END CONTENT -->
 653
 654
 655 <div id="footer">
 656 <p>
 657 Previous Topic:&nbsp;&nbsp;<a href="table.html">HTML Table Class</a>
 658 &nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 659 <a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 660 <a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
 661 Next Topic:&nbsp;&nbsp;<a href="input.html">Input Class</a>
 662 </p>
 663 <p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
 664 </div>
 665
 666 </body>
 667 </html>