Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 419

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csDebugImageWriter Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csDebugImageWriter Class Reference</h1><!-- doxytag: class="csDebugImageWriter" -->Helper class allowing in debug builds for to quickly dump an <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object onto disk for visual inspection.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="debugimagewriter_8h-source.html">cstool/debugimagewriter.h</a>&gt;</code>
<p>

<p>
<a href="classcsDebugImageWriter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsDebugImageWriter.html#05071ce13fd5ca793999ae02a7f71892">DebugImageWrite</a> (<a class="el" href="structiImage.html">iImage</a> *image, const char *filename,...)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write an image onto disk.  <a href="#05071ce13fd5ca793999ae02a7f71892"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class allowing in debug builds for to quickly dump an <a class="el" href="structiImage.html" title="The iImage interface is used to work with image objects.">iImage</a> object onto disk for visual inspection. 
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>Only works in debug builds. </dd></dl>

<p>Definition at line <a class="el" href="debugimagewriter_8h-source.html#l00039">39</a> of file <a class="el" href="debugimagewriter_8h-source.html">debugimagewriter.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="05071ce13fd5ca793999ae02a7f71892"></a><!-- doxytag: member="csDebugImageWriter::DebugImageWrite" ref="05071ce13fd5ca793999ae02a7f71892" args="(iImage *image, const char *filename,...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void csDebugImageWriter::DebugImageWrite           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiImage.html">iImage</a> *&nbsp;</td>
          <td class="paramname"> <em>image</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&nbsp;</td>
          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Write an image onto disk. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>image</em>&nbsp;</td><td>The image to be written. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The VFS name of the file to be written. </td></tr>
  </table>
</dl>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd><em>filename</em> is a string with printf() style format specifiers. <p>
If <em>filename</em> does not contain an absolute VFS path, it will be treated as relative to "/tmp/". </dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>

<p>Definition at line <a class="el" href="debugimagewriter_8h-source.html#l00061">61</a> of file <a class="el" href="debugimagewriter_8h-source.html">debugimagewriter.h</a>.</p>

<p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>, <a class="el" href="reporter_8h-source.html#l00050">CS_REPORTER_SEVERITY_ERROR</a>, <a class="el" href="classcsStringBase.html#3cf8dbc33b6acaa9b7feef830d72f6e5">csStringBase::FormatV()</a>, <a class="el" href="csstring_8h-source.html#l01049">csStringFast&lt; LEN &gt;::GetData()</a>, and <a class="el" href="scf__interface_8h-source.html#l00159">iSCF::SCF</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cstool/<a class="el" href="debugimagewriter_8h-source.html">debugimagewriter.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>