| cristy | 3ed852e | 2009-09-05 21:47:34 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" |
| 2 | "http://www.w3.org/TR/html4/loose.dtd"> |
| 3 | <html> |
| 4 | <head> |
| 5 | <title>Magick::CoderInfo Class</title> |
| 6 | <meta name="GENERATOR" content="OpenOffice.org 1.0 (Win32)"> |
| 7 | <meta name="AUTHOR" content="Bob Friesenhahn"> |
| 8 | <meta name="CREATED" content="20020805;13531808"> |
| 9 | <meta name="CHANGEDBY" content="Bob Friesenhahn"> |
| 10 | <meta name="CHANGED" content="20020805;13535284"> |
| 11 | <meta name="DESCRIPTION" content="Class to access raw image pixels."> |
| 12 | <meta name="KEYWORDS" content="ImageMagick,Pixel,Magick++"> |
| 13 | <link rel=stylesheet type=text/css href=../../www/magick.css> |
| 14 | </head> |
| 15 | <body lang="en-US" text="#ffffff" link="#0000ff" vlink="#ff0000" bgcolor="#fbc713"> |
| 16 | <h3 align="center">Magick::CoderInfo</h3> |
| 17 | <p>The <i>CoderInfo</i> class provides the means to provide information regarding ImageMagick support for an image format (designated by a magick string). It may be used to provide support for a specific named format (provided as an argument to the constructor), or as an element of a container when format support is queried using the <a href="STL.html#coderInfoList">coderInfoList()</a> templated function.</p> |
| 18 | <p>The following code fragment illustrates how CoderInfo may be used.</p> |
| 19 | <p><tt><font color="#000066">CoderInfo info("GIF");</font></tt><br> |
| 20 | <tt><font color="#000066">cout << info->name() << ": (" << info->description() << ") : ";</font></tt><br> |
| 21 | <tt><font color="#000066">cout << "Readable = ";</font></tt><br> |
| 22 | <tt><font color="#000066">if ( info->isReadable() )</font></tt><br> |
| 23 | <tt><font color="#000066">cout << "true";</font></tt><br> |
| 24 | <tt><font color="#000066">else</font></tt><br> |
| 25 | <tt><font color="#000066">cout << "false";</font></tt><br> |
| 26 | <tt><font color="#000066">cout << ", ";</font></tt><br> |
| 27 | <tt><font color="#000066">cout << "Writable = ";</font></tt><br> |
| 28 | <tt><font color="#000066">if ( info->isWritable() )</font></tt><br> |
| 29 | <tt><font color="#000066">cout << "true";</font></tt><br> |
| 30 | <tt><font color="#000066">else</font></tt><br> |
| 31 | <tt><font color="#000066">cout << "false";</font></tt><br> |
| 32 | <tt><font color="#000066">cout << ", ";</font></tt><br> |
| 33 | <tt><font color="#000066">cout << "Multiframe = ";</font></tt><br> |
| 34 | <tt><font color="#000066">if ( info->isMultiframe() )</font></tt><br> |
| 35 | <tt><font color="#000066">cout << "true";</font></tt><br> |
| 36 | <tt><font color="#000066">else</font></tt><br> |
| 37 | <tt><font color="#000066">cout << "false";</font></tt><br> |
| 38 | <tt><font color="#000066">cout << endl;</font></tt></p> |
| 39 | <p style="margin-bottom: 0cm">The methods available in the <i>CoderInfo</i> class are shown in the following table:</p> |
| 40 | <br> |
| 41 | <p align="center" style="margin-bottom: 0cm"><b>CoderInfo Methods</b></p> |
| 42 | <table width="100%" border="1" cellpadding="2" cellspacing="2"> |
| 43 | <tr> |
| 44 | <td> |
| 45 | <p align="center"><b>Method</b></p></td> |
| 46 | <td> |
| 47 | <p align="center"><b>Returns</b></p></td> |
| 48 | <td> |
| 49 | <p align="center"><b>Signature</b></p></td> |
| 50 | <td> |
| 51 | <p align="center"><b>Description</b></p></td></tr> |
| 52 | <tr> |
| 53 | <td> |
| 54 | <p align="center"><a name="CoderInfo"></a><font size="2">CoderInfo</font></p></td> |
| 55 | <td bgcolor="#999999"></td> |
| 56 | <td> |
| 57 | <p><font size="2">void</font></p></td> |
| 58 | <td> |
| 59 | <p><font size="2">Construct object corresponding to named format (e.g. "GIF"). An exception is thrown if the format is not supported.</font></p></td></tr> |
| 60 | <tr> |
| 61 | <td> |
| 62 | <p align="center"><a name="name"></a><font size="2">name</font></p></td> |
| 63 | <td> |
| 64 | <p><font size="2">std::string</font></p></td> |
| 65 | <td> |
| 66 | <p><font size="2">void</font></p></td> |
| 67 | <td> |
| 68 | <p><font size="2">Format name (e.g. "GIF").</font></p></td></tr> |
| 69 | <tr> |
| 70 | <td> |
| 71 | <p align="center"><a name="description"></a><font size="2">description</font></p></td> |
| 72 | <td> |
| 73 | <p><font size="2">std::string</font></p></td> |
| 74 | <td> |
| 75 | <p><font size="2">void</font></p></td> |
| 76 | <td> |
| 77 | <p><font size="2">Format description (e.g. "CompuServe graphics interchange format").</font></p></td></tr> |
| 78 | <tr> |
| 79 | <td> |
| 80 | <p align="center"><a name="isReadable"></a><font size="2">isReadable</font></p></td> |
| 81 | <td> |
| 82 | <p><font size="2">bool</font></p></td> |
| 83 | <td> |
| 84 | <p><font size="2">void</font></p></td> |
| 85 | <td> |
| 86 | <p><font size="2">Format is readable.</font></p></td></tr> |
| 87 | <tr> |
| 88 | <td> |
| 89 | <p align="center"><a name="isWritable"></a><font size="2">isWritable</font></p></td> |
| 90 | <td> |
| 91 | <p><font size="2">bool</font></p></td> |
| 92 | <td> |
| 93 | <p><font size="2">void</font></p></td> |
| 94 | <td> |
| 95 | <p><font size="2">Format is writeable.</font></p></td></tr> |
| 96 | <tr> |
| 97 | <td> |
| 98 | <p align="center"><a name="isMultiFrame"></a><font size="2">isMultiFrame</font></p></td> |
| 99 | <td> |
| 100 | <p><font size="2">bool</font></p></td> |
| 101 | <td> |
| 102 | <p><font size="2">void</font></p></td> |
| 103 | <td> |
| 104 | <p><font size="2">Format supports multiple frames.</font></p></td></tr></table> |
| 105 | <br> |
| 106 | </body> |
| 107 | </html> |