Home | History | Annotate | Download | only in Magick++
      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 <head>
      5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
      6 <title>Magick++ API: Access Raw Image Pixels</title>
      7 <link rel="stylesheet" href="magick.css" type="text/css" />
      8 </head>
      9 <body>
     10 <div class="doc-section">
     11 <h3 align="center">Magick::CoderInfo</h3>
     12 <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>
     13 <p>The following code fragment illustrates how CoderInfo may be used.</p>
     14 <pre class="code">
     15 CoderInfo info("GIF"); 
     16 cout &lt; info->name() &lt;&lt; ": (" &lt;&lt; info->description() &lt;&lt; ") : "; 
     17 cout &lt;&lt; "Readable = "; 
     18 if ( info->isReadable() ) 
     19   cout &lt;&lt; "true"; 
     20 else 
     21   cout &lt;&lt; "false"; 
     22 cout &lt;&lt; ", "; 
     23 cout &lt;&lt; "Writable = "; 
     24 if ( info->isWritable() ) 
     25   cout &lt;&lt; "true"; 
     26 else 
     27   cout &lt;&lt; "false"; 
     28 cout &lt;&lt; ", "; 
     29 cout &lt;&lt; "Multiframe = "; 
     30 if ( info->isMultiframe() ) 
     31   cout &lt;&lt; "true"; 
     32 else 
     33   cout &lt;&lt; "false"; 
     34 cout &lt;&lt; endl;
     35 </pre>
     36 <p style="margin-bottom: 0cm">The methods available in the <i>CoderInfo</i> class are shown in the following table:</p>
     37 <br />
     38 <ul><p align="center" style="margin-bottom: 0cm"><b>CoderInfo Methods</b></p>
     39 <table width="100%" border="1" cellpadding="2" cellspacing="2">
     40 <tr>
     41 <td>
     42 <p align="center"><b>Method</b></p></td>
     43 <td>
     44 <p align="center"><b>Returns</b></p></td>
     45 <td>
     46 <p align="center"><b>Signature</b></p></td>
     47 <td>
     48 <p align="center"><b>Description</b></p></td></tr>
     49 <tr>
     50 <td>
     51 <p align="center"><a name="CoderInfo"></a><font size="2">CoderInfo</font></p></td>
     52 <td bgcolor="#999999"></td>
     53 <td>
     54 <p><font size="2">void</font></p></td>
     55 <td>
     56 <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>
     57 <tr>
     58 <td>
     59 <p align="center"><a name="name"></a><font size="2">name</font></p></td>
     60 <td>
     61 <p><font size="2">std::string</font></p></td>
     62 <td>
     63 <p><font size="2">void</font></p></td>
     64 <td>
     65 <p><font size="2">Format name (e.g. "GIF").</font></p></td></tr>
     66 <tr>
     67 <td>
     68 <p align="center"><a name="description"></a><font size="2">description</font></p></td>
     69 <td>
     70 <p><font size="2">std::string</font></p></td>
     71 <td>
     72 <p><font size="2">void</font></p></td>
     73 <td>
     74 <p><font size="2">Format description (e.g. "CompuServe graphics interchange format").</font></p></td></tr>
     75 <tr>
     76 <td>
     77 <p align="center"><a name="isReadable"></a><font size="2">isReadable</font></p></td>
     78 <td>
     79 <p><font size="2">bool</font></p></td>
     80 <td>
     81 <p><font size="2">void</font></p></td>
     82 <td>
     83 <p><font size="2">Format is readable.</font></p></td></tr>
     84 <tr>
     85 <td>
     86 <p align="center"><a name="isWritable"></a><font size="2">isWritable</font></p></td>
     87 <td>
     88 <p><font size="2">bool</font></p></td>
     89 <td>
     90 <p><font size="2">void</font></p></td>
     91 <td>
     92 <p><font size="2">Format is writeable.</font></p></td></tr>
     93 <tr>
     94 <td>
     95 <p align="center"><a name="isMultiFrame"></a><font size="2">isMultiFrame</font></p></td>
     96 <td>
     97 <p><font size="2">bool</font></p></td>
     98 <td>
     99 <p><font size="2">void</font></p></td>
    100 <td>
    101 <p><font size="2">Format supports multiple frames.</font></p></td></tr></table></ul>
    102 </div>
    103 </body>
    104 </html>
    105