Google Git
Sign in
android / platform / external / ImageMagick / refs/heads/main / . / www / api / Magick++ / ImageRef_8h_source.html
blob: 57e2ff371cae3fc5b9c01cfcd37edeb3fb2807e4 [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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Magick++: ImageRef.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Magick++
&#160;<span id="projectnumber">7.0.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('ImageRef_8h_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">ImageRef.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="ImageRef_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// This may look like C code, but it is really -*- C++ -*-</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// Copyright Bob Friesenhahn, 1999, 2000, 2001, 2002</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright Dirk Lemstra 2014-2015</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Definition of an Image reference</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// This is a private implementation class which should never be</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// referenced by any user code.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#if !defined(Magick_ImageRef_header)</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define Magick_ImageRef_header</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Include_8h.html">Magick++/Include.h</a>&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Thread_8h.html">Magick++/Thread.h</a>&quot;</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceMagick.html">Magick</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">class </span>Options;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">//</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="comment">// Reference counted access to Image *</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">//</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classMagick_1_1ImageRef.html"> 26</a></span>&#160; <span class="keyword">class </span><a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// Construct with null image and default options</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="comment">// Construct with an image pointer and default options</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>(<a class="code" href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">MagickCore::Image</a> *image_);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="comment">// Destroy image and options</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; ~<a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="comment">// Decreases reference count and return the new count</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">size_t</span> decrease();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="comment">// Retrieve image from reference</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">MagickCore::Image</a> *&amp;image(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// Increases reference count</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> increase();</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// Returns true if the reference count is more than one</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">bool</span> isShared();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Retrieve Options from reference</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> options(<a class="code" href="classMagick_1_1Options.html">Options</a> *options_);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classMagick_1_1Options.html">Options</a> *options(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="comment">// Tries to replaces the images with the specified image, returns</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// a new instance when the current image is shared.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keyword">static</span> <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a> *replaceImage(<a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a> *imgRef,</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">MagickCore::Image</a> *replacement_);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="comment">// Image signature. Set force_ to true in order to re-calculate</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// the signature regardless of whether the image data has been</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="comment">// modified.</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; std::string signature(<span class="keyword">const</span> <span class="keywordtype">bool</span> force_=<span class="keyword">false</span>);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// Construct with an image pointer and options</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>(<a class="code" href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">MagickCore::Image</a> *image_,<span class="keyword">const</span> <a class="code" href="classMagick_1_1Options.html">Options</a> *options_);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// Copy constructor and assignment are not supported</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>(<span class="keyword">const</span> <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>&amp;);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="classMagick_1_1ImageRef.html">ImageRef</a>&amp;);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <a class="code" href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">MagickCore::Image</a> *_image; <span class="comment">// ImageMagick Image</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <a class="code" href="classMagick_1_1MutexLock.html">MutexLock</a> _mutexLock; <span class="comment">// Mutex lock</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <a class="code" href="classMagick_1_1Options.html">Options</a> *_options; <span class="comment">// User-specified options</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; ::ssize_t _refCount; <span class="comment">// Reference count</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;} <span class="comment">// end of namespace Magick</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="preprocessor">#endif // Magick_ImageRef_header</span></div><div class="ttc" id="classMagick_1_1Options_html"><div class="ttname"><a href="classMagick_1_1Options.html">Magick::Options</a></div><div class="ttdef"><b>Definition:</b> <a href="Options_8h_source.html#l00028">Options.h:28</a></div></div>
<div class="ttc" id="classMagick_1_1ImageRef_html"><div class="ttname"><a href="classMagick_1_1ImageRef.html">Magick::ImageRef</a></div><div class="ttdef"><b>Definition:</b> <a href="ImageRef_8h_source.html#l00026">ImageRef.h:26</a></div></div>
<div class="ttc" id="classMagick_1_1MutexLock_html"><div class="ttname"><a href="classMagick_1_1MutexLock.html">Magick::MutexLock</a></div><div class="ttdef"><b>Definition:</b> <a href="Thread_8h_source.html#l00027">Thread.h:27</a></div></div>
<div class="ttc" id="Thread_8h_html"><div class="ttname"><a href="Thread_8h.html">Thread.h</a></div></div>
<div class="ttc" id="Include_8h_html_a3648b581d4f8adf56a18ae67b7111a04"><div class="ttname"><a href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a></div><div class="ttdeci">#define MagickPPExport</div><div class="ttdef"><b>Definition:</b> <a href="Include_8h_source.html#l00281">Include.h:281</a></div></div>
<div class="ttc" id="Include_8h_html"><div class="ttname"><a href="Include_8h.html">Include.h</a></div></div>
<div class="ttc" id="namespaceMagick_html_a4848723142d4954f66b2dbb123fc29f0"><div class="ttname"><a href="namespaceMagick.html#a4848723142d4954f66b2dbb123fc29f0">Magick::Image</a></div><div class="ttdeci">class MagickPPExport Image</div><div class="ttdef"><b>Definition:</b> <a href="Drawable_8h_source.html#l00720">Drawable.h:720</a></div></div>
<div class="ttc" id="namespaceMagick_html"><div class="ttname"><a href="namespaceMagick.html">Magick</a></div><div class="ttdef"><b>Definition:</b> <a href="Blob_8h_source.html#l00015">Blob.h:15</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_68918867e77b0a45f29c43673f2273f8.html">cristy</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_0664224c5e489c82e6416cddc46e1af0.html">ImageMagick-7</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_436bc20d1ebf054c4eca7a72174ce42e.html">Magick++</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_94b620f9ceea3d56d5ade00d9eab2203.html">lib</a></li><li class="navelem"><a class="el" href="https://imagemagick.org/api/Magick++/dir_106943ebd3829a5b74c083ee2c0647d8.html">Magick++</a></li><li class="navelem"><a class="el" href="ImageRef_8h.html">ImageRef.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>