Google Git
Sign in
android / toolchain / benchmark / honeycomb / . / skia / src / docs / html / class_sk_image_ref.html
blob: b2cf01482fe3aebc765c71c6055d74ce2ebcb9be [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: SkImageRef 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>SkImageRef Class Reference</h1><!-- doxytag: class="SkImageRef" --><!-- doxytag: inherits="SkPixelRef" -->
<p><code>#include &lt;<a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>&gt;</code></p>
<p>Inherits <a class="el" href="class_sk_pixel_ref.html">SkPixelRef</a>.</p>
<p>Inherited by <a class="el" href="class_sk_image_ref___global_pool.html">SkImageRef_GlobalPool</a>.</p>
<div class="dynheader">
Collaboration diagram for SkImageRef:</div>
<div class="dynsection">
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_sk_image_ref-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a21342c87dbb37222a60e69a7a74516c2">SkImageRef</a> (<a class="el" href="class_sk_stream.html">SkStream</a> *, <a class="el" href="class_sk_bitmap.html#a62602e28fc755def34d7e261bfd0b74a">SkBitmap::Config</a> config, int sampleSize=1)</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_ref.html#aa8cce9cdbe92d9b8a249ce6ba1e2a3b2">~SkImageRef</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a742caca16140424f503307b07e732c5e">setDitherImage</a> (bool dither)</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_ref.html#a1b49e443410b43981b001fcc581c5cd0">getInfo</a> (<a class="el" href="class_sk_bitmap.html">SkBitmap</a> *bm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a82f145783c8f049b74260237892a16de">getDecoderFactory</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a1b44612ee4dff3928d17c2556176b466">setDecoderFactory</a> (<a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#af2f8d5259dc5363268eca4129c12554c">flatten</a> (<a class="el" href="class_sk_flattenable_write_buffer.html">SkFlattenableWriteBuffer</a> &amp;) const </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_ref.html#a5a8451ba585fa1c3a3f1c7e6e734bd23">onDecode</a> (<a class="el" href="class_sk_image_decoder.html">SkImageDecoder</a> *codec, <a class="el" href="class_sk_stream.html">SkStream</a> *, <a class="el" href="class_sk_bitmap.html">SkBitmap</a> *, <a class="el" href="class_sk_bitmap.html#a62602e28fc755def34d7e261bfd0b74a">SkBitmap::Config</a>, <a class="el" href="class_sk_image_decoder.html#a01cd7635ff77a7378071b343034e796a">SkImageDecoder::Mode</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a25c015c686124bd7e7f43c90fa7d712e">onLockPixels</a> (<a class="el" href="class_sk_color_table.html">SkColorTable</a> **)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a12a219d19f542f6ac37cd43036a7af31">onUnlockPixels</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a1844e84611342f7b7be0ce90a3bef7e1">SkImageRef</a> (<a class="el" href="class_sk_flattenable_read_buffer.html">SkFlattenableReadBuffer</a> &amp;)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sk_bitmap.html">SkBitmap</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#abbe66d1ee0ec51dc1bdf4d967873bab8">fBitmap</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sk_image_ref.html#a3abe80da5480e6cb57d591a7d158f0f3">SkImageRefPool</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_sk_image_ref_8h_source.html#l00031">31</a> of file <a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a21342c87dbb37222a60e69a7a74516c2"></a><!-- doxytag: member="SkImageRef::SkImageRef" ref="a21342c87dbb37222a60e69a7a74516c2" args="(SkStream *, SkBitmap::Config config, int sampleSize=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkImageRef::SkImageRef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_stream.html">SkStream</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_bitmap.html#a62602e28fc755def34d7e261bfd0b74a">SkBitmap::Config</a>&nbsp;</td>
<td class="paramname"> <em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>sampleSize</em> = <code>1</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new imageref from a stream. NOTE: the stream is not copied, but since it may be accessed from another thread, the caller must ensure that this imageref is the only owner of the stream. i.e. - sole ownership of the stream object is transferred to this imageref object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stream</em>&nbsp;</td><td>The stream containing the encoded image data. This may be retained (by calling <a class="el" href="class_sk_ref_cnt.html#ad20a3a041c22c00ab926956aa5bbd8e1">ref()</a>), so the caller should not explicitly delete it. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em>&nbsp;</td><td>The preferred config of the decoded bitmap. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sampleSize</em>&nbsp;</td><td>Requested sampleSize for decoding. Defaults to 1. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa8cce9cdbe92d9b8a249ce6ba1e2a3b2"></a><!-- doxytag: member="SkImageRef::~SkImageRef" ref="aa8cce9cdbe92d9b8a249ce6ba1e2a3b2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual SkImageRef::~SkImageRef </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1844e84611342f7b7be0ce90a3bef7e1"></a><!-- doxytag: member="SkImageRef::SkImageRef" ref="a1844e84611342f7b7be0ce90a3bef7e1" args="(SkFlattenableReadBuffer &amp;)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SkImageRef::SkImageRef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_flattenable_read_buffer.html">SkFlattenableReadBuffer</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af2f8d5259dc5363268eca4129c12554c"></a><!-- doxytag: member="SkImageRef::flatten" ref="af2f8d5259dc5363268eca4129c12554c" args="(SkFlattenableWriteBuffer &amp;) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SkImageRef::flatten </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_flattenable_write_buffer.html">SkFlattenableWriteBuffer</a> &amp;&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="class_sk_pixel_ref.html#a566e87893b09bc7759b3194f57de01e1">SkPixelRef</a>.</p>
</div>
</div>
<a class="anchor" id="a82f145783c8f049b74260237892a16de"></a><!-- doxytag: member="SkImageRef::getDecoderFactory" ref="a82f145783c8f049b74260237892a16de" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a>* SkImageRef::getDecoderFactory </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_image_ref_8h_source.html#l00060">60</a> of file <a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1b49e443410b43981b001fcc581c5cd0"></a><!-- doxytag: member="SkImageRef::getInfo" ref="a1b49e443410b43981b001fcc581c5cd0" args="(SkBitmap *bm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SkImageRef::getInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_bitmap.html">SkBitmap</a> *&nbsp;</td>
<td class="paramname"> <em>bm</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if the image can be decoded. If so, and bitmap is non-null, call its setConfig() with the corresponding values, but explicitly will not set its pixels or colortable. Use <a class="el" href="class_sk_pixel_ref.html#a17b231a66de15ec3ad176764a4723c70">SkPixelRef::lockPixels()</a> for that.</p>
<p>If there has been an error decoding the bitmap, this will return false and ignore the bitmap parameter. </p>
</div>
</div>
<a class="anchor" id="a5a8451ba585fa1c3a3f1c7e6e734bd23"></a><!-- doxytag: member="SkImageRef::onDecode" ref="a5a8451ba585fa1c3a3f1c7e6e734bd23" args="(SkImageDecoder *codec, SkStream *, SkBitmap *, SkBitmap::Config, SkImageDecoder::Mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool SkImageRef::onDecode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_image_decoder.html">SkImageDecoder</a> *&nbsp;</td>
<td class="paramname"> <em>codec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_stream.html">SkStream</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_bitmap.html">SkBitmap</a> *&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_bitmap.html#a62602e28fc755def34d7e261bfd0b74a">SkBitmap::Config</a>&nbsp;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_sk_image_decoder.html#a01cd7635ff77a7378071b343034e796a">SkImageDecoder::Mode</a>&nbsp;</td>
<td class="paramname"></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Override if you want to install a custom allocator. When this is called we will have already acquired the mutex! </p>
<p>Reimplemented in <a class="el" href="class_sk_image_ref___global_pool.html#ac5e6004704342faf815732ad84ac2169">SkImageRef_GlobalPool</a>.</p>
</div>
</div>
<a class="anchor" id="a25c015c686124bd7e7f43c90fa7d712e"></a><!-- doxytag: member="SkImageRef::onLockPixels" ref="a25c015c686124bd7e7f43c90fa7d712e" args="(SkColorTable **)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* SkImageRef::onLockPixels </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_color_table.html">SkColorTable</a> **&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the lockCount goes from 0 to 1. The caller will have already acquire a mutex for thread safety, so this method need not do that. </p>
<p>Implements <a class="el" href="class_sk_pixel_ref.html#ad5273767fc7d16afbc217e7046211128">SkPixelRef</a>.</p>
</div>
</div>
<a class="anchor" id="a12a219d19f542f6ac37cd43036a7af31"></a><!-- doxytag: member="SkImageRef::onUnlockPixels" ref="a12a219d19f542f6ac37cd43036a7af31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void SkImageRef::onUnlockPixels </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when the lock count goes from 1 to 0. The caller will have already acquire a mutex for thread safety, so this method need not do that. </p>
<p>Implements <a class="el" href="class_sk_pixel_ref.html#a164e3a980bbff502da6c2e5f101a4616">SkPixelRef</a>.</p>
<p>Reimplemented in <a class="el" href="class_sk_image_ref___global_pool.html#adc65337979f0bb63c897c55ee6e845e7">SkImageRef_GlobalPool</a>.</p>
</div>
</div>
<a class="anchor" id="a1b44612ee4dff3928d17c2556176b466"></a><!-- doxytag: member="SkImageRef::setDecoderFactory" ref="a1b44612ee4dff3928d17c2556176b466" args="(SkImageDecoderFactory *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a>* SkImageRef::setDecoderFactory </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_sk_image_decoder_factory.html">SkImageDecoderFactory</a> *&nbsp;</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a742caca16140424f503307b07e732c5e"></a><!-- doxytag: member="SkImageRef::setDitherImage" ref="a742caca16140424f503307b07e732c5e" args="(bool dither)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SkImageRef::setDitherImage </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>dither</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>this value is passed onto the decoder. Default is true </p>
<p>Definition at line <a class="el" href="_sk_image_ref_8h_source.html#l00049">49</a> of file <a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a3abe80da5480e6cb57d591a7d158f0f3"></a><!-- doxytag: member="SkImageRef::SkImageRefPool" ref="a3abe80da5480e6cb57d591a7d158f0f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class SkImageRefPool<code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_image_ref_8h_source.html#l00099">99</a> of file <a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="abbe66d1ee0ec51dc1bdf4d967873bab8"></a><!-- doxytag: member="SkImageRef::fBitmap" ref="abbe66d1ee0ec51dc1bdf4d967873bab8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_sk_bitmap.html">SkBitmap</a> <a class="el" href="class_sk_image_ref.html#abbe66d1ee0ec51dc1bdf4d967873bab8">SkImageRef::fBitmap</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_sk_image_ref_8h_source.html#l00084">84</a> of file <a class="el" href="_sk_image_ref_8h_source.html">SkImageRef.h</a>.</p>
</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_ref_8h_source.html">SkImageRef.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>