| 1 |
<?xml version="1.0" encoding="utf-8" ?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 4 |
|
| 5 |
<head> |
| 6 |
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| 7 |
<title>Magick++ API: Access Raw Image Pixels</title> |
| 8 |
<link rel="stylesheet" href="magick.css" type="text/css" /> |
| 9 |
</head> |
| 10 |
|
| 11 |
<body> |
| 12 |
<div class="doc-section"> |
| 13 |
<h3 align="center">Magick::CoderInfo</h3> |
| 14 |
<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> |
| 15 |
<p>The following code fragment illustrates how CoderInfo may be used.</p> |
| 16 |
<pre class="code"> |
| 17 |
CoderInfo info("GIF"); |
| 18 |
cout < info->name() << ": (" << info->description() << ") : "; |
| 19 |
cout << "Readable = "; |
| 20 |
if ( info->isReadable() ) |
| 21 |
cout << "true"; |
| 22 |
else |
| 23 |
cout << "false"; |
| 24 |
cout << ", "; |
| 25 |
cout << "Writable = "; |
| 26 |
if ( info->isWritable() ) |
| 27 |
cout << "true"; |
| 28 |
else |
| 29 |
cout << "false"; |
| 30 |
cout << ", "; |
| 31 |
cout << "Multiframe = "; |
| 32 |
if ( info->isMultiframe() ) |
| 33 |
cout << "true"; |
| 34 |
else |
| 35 |
cout << "false"; |
| 36 |
cout << endl; |
| 37 |
</pre> |
| 38 |
<p style="margin-bottom: 0cm">The methods available in the <i>CoderInfo</i> class are shown in the following table:</p> |
| 39 |
<br /> |
| 40 |
<ul> |
| 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> |
| 46 |
</td> |
| 47 |
<td> |
| 48 |
<p align="center"><b>Returns</b></p> |
| 49 |
</td> |
| 50 |
<td> |
| 51 |
<p align="center"><b>Signature</b></p> |
| 52 |
</td> |
| 53 |
<td> |
| 54 |
<p align="center"><b>Description</b></p> |
| 55 |
</td> |
| 56 |
</tr> |
| 57 |
<tr> |
| 58 |
<td rowspan="3"> |
| 59 |
<p align="center"><a name="CoderInfo"></a> |
| 60 |
<font size="2">CoderInfo</font> |
| 61 |
</p> |
| 62 |
</td> |
| 63 |
<td rowspan="3" bgcolor="#999999"></td> |
| 64 |
<td> |
| 65 |
<p> |
| 66 |
<font size="2">void</font> |
| 67 |
</p> |
| 68 |
</td> |
| 69 |
<td> |
| 70 |
<p> |
| 71 |
<font size="2">Default constructor</font> |
| 72 |
</p> |
| 73 |
</td> |
| 74 |
</tr> |
| 75 |
<tr> |
| 76 |
<td> |
| 77 |
<p> |
| •78 |
<font size="2">const CoderInfo &coder_</font> |
| 79 |
</p> |
| 80 |
</td> |
| 81 |
<td> |
| 82 |
<p> |
| 83 |
<font size="2">Copy constructor</font> |
| 84 |
</p> |
| 85 |
</td> |
| 86 |
</tr> |
| 87 |
<tr> |
| 88 |
<td> |
| 89 |
<p> |
| •90 |
<font size="2">const std::string &name_</font> |
| 91 |
</p> |
| 92 |
</td> |
| 93 |
<td> |
| 94 |
<p> |
| 95 |
<font size="2">Construct with coder name</font> |
| 96 |
</p> |
| 97 |
</td> |
| 98 |
</tr> |
| 99 |
<tr> |
| 100 |
<td> |
| 101 |
<p align="center"><a name="name"></a> |
| 102 |
<font size="2">name</font> |
| 103 |
</p> |
| 104 |
</td> |
| 105 |
<td> |
| 106 |
<p> |
| 107 |
<font size="2">std::string</font> |
| 108 |
</p> |
| 109 |
</td> |
| 110 |
<td> |
| 111 |
<p> |
| 112 |
<font size="2">void</font> |
| 113 |
</p> |
| 114 |
</td> |
| 115 |
<td> |
| 116 |
<p> |
| 117 |
<font size="2">Format name (e.g. "GIF").</font> |
| 118 |
</p> |
| 119 |
</td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td> |
| 123 |
<p align="center"><a name="description"></a> |
| 124 |
<font size="2">description</font> |
| 125 |
</p> |
| 126 |
</td> |
| 127 |
<td> |
| 128 |
<p> |
| 129 |
<font size="2">std::string</font> |
| 130 |
</p> |
| 131 |
</td> |
| 132 |
<td> |
| 133 |
<p> |
| 134 |
<font size="2">void</font> |
| 135 |
</p> |
| 136 |
</td> |
| 137 |
<td> |
| 138 |
<p> |
| 139 |
<font size="2">Format description (e.g. "CompuServe graphics interchange format").</font> |
| 140 |
</p> |
| 141 |
</td> |
| 142 |
</tr> |
| 143 |
<tr> |
| 144 |
<td> |
| 145 |
<p align="center"><a name="isReadable"></a> |
| 146 |
<font size="2">isReadable</font> |
| 147 |
</p> |
| 148 |
</td> |
| 149 |
<td> |
| 150 |
<p> |
| 151 |
<font size="2">bool</font> |
| 152 |
</p> |
| 153 |
</td> |
| 154 |
<td> |
| 155 |
<p> |
| 156 |
<font size="2">void</font> |
| 157 |
</p> |
| 158 |
</td> |
| 159 |
<td> |
| 160 |
<p> |
| 161 |
<font size="2">Format is readable.</font> |
| 162 |
</p> |
| 163 |
</td> |
| 164 |
</tr> |
| 165 |
<tr> |
| 166 |
<td> |
| 167 |
<p align="center"><a name="isWritable"></a> |
| 168 |
<font size="2">isWritable</font> |
| 169 |
</p> |
| 170 |
</td> |
| 171 |
<td> |
| 172 |
<p> |
| 173 |
<font size="2">bool</font> |
| 174 |
</p> |
| 175 |
</td> |
| 176 |
<td> |
| 177 |
<p> |
| 178 |
<font size="2">void</font> |
| 179 |
</p> |
| 180 |
</td> |
| 181 |
<td> |
| 182 |
<p> |
| 183 |
<font size="2">Format is writeable.</font> |
| 184 |
</p> |
| 185 |
</td> |
| 186 |
</tr> |
| 187 |
<tr> |
| 188 |
<td> |
| 189 |
<p align="center"><a name="isMultiFrame"></a> |
| 190 |
<font size="2">isMultiFrame</font> |
| 191 |
</p> |
| 192 |
</td> |
| 193 |
<td> |
| 194 |
<p> |
| 195 |
<font size="2">bool</font> |
| 196 |
</p> |
| 197 |
</td> |
| 198 |
<td> |
| 199 |
<p> |
| 200 |
<font size="2">void</font> |
| 201 |
</p> |
| 202 |
</td> |
| 203 |
<td> |
| 204 |
<p> |
| 205 |
<font size="2">Format supports multiple frames.</font> |
| 206 |
</p> |
| 207 |
</td> |
| 208 |
</tr> |
| 209 |
</table> |
| 210 |
</ul> |
| 211 |
</div> |
| 212 |
</body> |
| 213 |
|
| •214 |
</html> |