blob: 5b23829c21cebe7e03f7453b3ed78815d81246da [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Skia: SkImageEncoder Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
</div>
<div class="contents">
<h1>SkImageEncoder Class Reference</h1><!-- doxytag: class="SkImageEncoder" -->
<p><code>#include &lt;<a class="el" href="_sk_image_encoder_8h_source.html">SkImageEncoder.h</a>&gt;</code></p>
<p><a href="class_sk_image_encoder-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a> { <a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5a13a6deec0513c67d69fb5cccf17d70f5">kJPEG_Type</a>,
<a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5a4526e73571b14a256595e8ddb5532d0c">kPNG_Type</a>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_sk_image_encoder.html#a88997d93dca938df634f12026e08aed7a4b0b327395973f3304d75b701fa405dc">kDefaultQuality</a> = 80
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a4494f818806116828a9fd3e4abc1b412">~SkImageEncoder</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#aef9d3f0f5971c4233e02b913335db227">encodeFile</a> (const char file[], const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;, int quality)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a0e64ad547d8ee1e2aa05ea4f46fc8856">encodeStream</a> (<a class="el" href="class_sk_w_stream.html">SkWStream</a> *, const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;, int quality)</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_sk_image_encoder.html">SkImageEncoder</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a7d58fa16e6d2f8bfdc90121722c6b3ce">Create</a> (<a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a86554d3e9c839c0466c778654718f8fe">EncodeFile</a> (const char file[], const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;, <a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>, int quality)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#ac6553bcf96ab7273c57537c2723ffe27">EncodeStream</a> (<a class="el" href="class_sk_w_stream.html">SkWStream</a> *, const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;, <a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>, int quality)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_encoder.html#a9ec9f0791245e2c8aa865347d9b98cc5">onEncode</a> (<a class="el" href="class_sk_w_stream.html">SkWStream</a> *, const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;, int quality)=0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_sk_image_encoder_8h_source.html#l00009">9</a> of file <a class="el" href="_sk_image_encoder_8h_source.html">SkImageEncoder.h</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a88997d93dca938df634f12026e08aed7"></a><!-- doxytag: member="SkImageEncoder::@23" ref="a88997d93dca938df634f12026e08aed7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a88997d93dca938df634f12026e08aed7a4b0b327395973f3304d75b701fa405dc"></a><!-- doxytag: member="kDefaultQuality" ref="a88997d93dca938df634f12026e08aed7a4b0b327395973f3304d75b701fa405dc" args="" -->kDefaultQuality</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sk_image_encoder_8h_source.html#l00020">20</a> of file <a class="el" href="_sk_image_encoder_8h_source.html">SkImageEncoder.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0ae6fc1dcd835970367fb2bbb6c713e5"></a><!-- doxytag: member="SkImageEncoder::Type" ref="a0ae6fc1dcd835970367fb2bbb6c713e5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">SkImageEncoder::Type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a0ae6fc1dcd835970367fb2bbb6c713e5a13a6deec0513c67d69fb5cccf17d70f5"></a><!-- doxytag: member="kJPEG_Type" ref="a0ae6fc1dcd835970367fb2bbb6c713e5a13a6deec0513c67d69fb5cccf17d70f5" args="" -->kJPEG_Type</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a0ae6fc1dcd835970367fb2bbb6c713e5a4526e73571b14a256595e8ddb5532d0c"></a><!-- doxytag: member="kPNG_Type" ref="a0ae6fc1dcd835970367fb2bbb6c713e5a4526e73571b14a256595e8ddb5532d0c" args="" -->kPNG_Type</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_sk_image_encoder_8h_source.html#l00011">11</a> of file <a class="el" href="_sk_image_encoder_8h_source.html">SkImageEncoder.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4494f818806116828a9fd3e4abc1b412"></a><!-- doxytag: member="SkImageEncoder::~SkImageEncoder" ref="a4494f818806116828a9fd3e4abc1b412" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual SkImageEncoder::~SkImageEncoder </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7d58fa16e6d2f8bfdc90121722c6b3ce"></a><!-- doxytag: member="SkImageEncoder::Create" ref="a7d58fa16e6d2f8bfdc90121722c6b3ce" args="(Type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_sk_image_encoder.html">SkImageEncoder</a>* SkImageEncoder::Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a86554d3e9c839c0466c778654718f8fe"></a><!-- doxytag: member="SkImageEncoder::EncodeFile" ref="a86554d3e9c839c0466c778654718f8fe" args="(const char file[], const SkBitmap &amp;, Type, int quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool SkImageEncoder::EncodeFile </td>
<td>(</td>
<td class="paramtype">const char&nbsp;</td>
<td class="paramname"> <em>file</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>quality</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aef9d3f0f5971c4233e02b913335db227"></a><!-- doxytag: member="SkImageEncoder::encodeFile" ref="aef9d3f0f5971c4233e02b913335db227" args="(const char file[], const SkBitmap &amp;, int quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SkImageEncoder::encodeFile </td>
<td>(</td>
<td class="paramtype">const char&nbsp;</td>
<td class="paramname"> <em>file</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>quality</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac6553bcf96ab7273c57537c2723ffe27"></a><!-- doxytag: member="SkImageEncoder::EncodeStream" ref="ac6553bcf96ab7273c57537c2723ffe27" args="(SkWStream *, const SkBitmap &amp;, Type, int quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool SkImageEncoder::EncodeStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_w_stream.html">SkWStream</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_image_encoder.html#a0ae6fc1dcd835970367fb2bbb6c713e5">Type</a>&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>quality</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0e64ad547d8ee1e2aa05ea4f46fc8856"></a><!-- doxytag: member="SkImageEncoder::encodeStream" ref="a0e64ad547d8ee1e2aa05ea4f46fc8856" args="(SkWStream *, const SkBitmap &amp;, int quality)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SkImageEncoder::encodeStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_w_stream.html">SkWStream</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>quality</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9ec9f0791245e2c8aa865347d9b98cc5"></a><!-- doxytag: member="SkImageEncoder::onEncode" ref="a9ec9f0791245e2c8aa865347d9b98cc5" args="(SkWStream *, const SkBitmap &amp;, int quality)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SkImageEncoder::onEncode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_w_stream.html">SkWStream</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_sk_bitmap.html">SkBitmap</a> &amp;&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>quality</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Volumes/disk/skia/trunk/include/images/<a class="el" href="_sk_image_encoder_8h_source.html">SkImageEncoder.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Oct 20 10:33:04 2009 for Skia by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>