1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.8.14"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>Magick++: Magick::ImageRef Class Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="navtree.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="resize.js"></script> 14<script type="text/javascript" src="navtreedata.js"></script> 15<script type="text/javascript" src="navtree.js"></script> 16<script type="text/javascript"> 17/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 18 $(document).ready(initResizable); 19/* @license-end */</script> 20<link href="doxygen.css" rel="stylesheet" type="text/css" /> 21</head> 22<body> 23<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 24<div id="titlearea"> 25<table cellspacing="0" cellpadding="0"> 26 <tbody> 27 <tr style="height: 56px;"> 28 <td id="projectalign" style="padding-left: 0.5em;"> 29 <div id="projectname">Magick++ 30  <span id="projectnumber">7.0.10</span> 31 </div> 32 </td> 33 </tr> 34 </tbody> 35</table> 36</div> 37<!-- end header part --> 38<!-- Generated by Doxygen 1.8.14 --> 39</div><!-- top --> 40<div id="side-nav" class="ui-resizable side-nav-resizable"> 41 <div id="nav-tree"> 42 <div id="nav-tree-contents"> 43 <div id="nav-sync" class="sync"></div> 44 </div> 45 </div> 46 <div id="splitbar" style="-moz-user-select:none;" 47 class="ui-resizable-handle"> 48 </div> 49</div> 50<script type="text/javascript"> 51/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 52$(document).ready(function(){initNavTree('classMagick_1_1ImageRef.html','');}); 53/* @license-end */ 54</script> 55<div id="doc-content"> 56<div class="header"> 57 <div class="summary"> 58<a href="classMagick_1_1ImageRef.html#pub-methods">Public Member Functions</a> | 59<a href="classMagick_1_1ImageRef.html#pub-static-methods">Static Public Member Functions</a> | 60<a href="https://imagemagick.org/api/Magick++/classMagick_1_1ImageRef-members.html">List of all members</a> </div> 61 <div class="headertitle"> 62<div class="title">Magick::ImageRef Class Reference</div> </div> 63</div><!--header--> 64<div class="contents"> 65 66<p><code>#include <<a class="el" href="ImageRef_8h_source.html">ImageRef.h</a>></code></p> 67<table class="memberdecls"> 68<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 69Public Member Functions</h2></td></tr> 70<tr class="memitem:a690c73e5b36e3829762f9b5b8c9bfe3d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a690c73e5b36e3829762f9b5b8c9bfe3d">ImageRef</a> (void)</td></tr> 71<tr class="separator:a690c73e5b36e3829762f9b5b8c9bfe3d"><td class="memSeparator" colspan="2"> </td></tr> 72<tr class="memitem:a5c9a9676c811c332ad556238da8c4614"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a5c9a9676c811c332ad556238da8c4614">ImageRef</a> (MagickCore::Image *image_)</td></tr> 73<tr class="separator:a5c9a9676c811c332ad556238da8c4614"><td class="memSeparator" colspan="2"> </td></tr> 74<tr class="memitem:aac3534f1dc5af42482043bdf2432c1ab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#aac3534f1dc5af42482043bdf2432c1ab">~ImageRef</a> (void)</td></tr> 75<tr class="separator:aac3534f1dc5af42482043bdf2432c1ab"><td class="memSeparator" colspan="2"> </td></tr> 76<tr class="memitem:ac71a53a454d80d4e53b316a68f7f3a6c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#ac71a53a454d80d4e53b316a68f7f3a6c">decrease</a> ()</td></tr> 77<tr class="separator:ac71a53a454d80d4e53b316a68f7f3a6c"><td class="memSeparator" colspan="2"> </td></tr> 78<tr class="memitem:a5a536ef15ddde656d1ae1b9c40b0479f"><td class="memItemLeft" align="right" valign="top">MagickCore::Image *& </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a5a536ef15ddde656d1ae1b9c40b0479f">image</a> (void)</td></tr> 79<tr class="separator:a5a536ef15ddde656d1ae1b9c40b0479f"><td class="memSeparator" colspan="2"> </td></tr> 80<tr class="memitem:abf869f9b24fbcd6e2f849f24a99a24b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#abf869f9b24fbcd6e2f849f24a99a24b1">increase</a> ()</td></tr> 81<tr class="separator:abf869f9b24fbcd6e2f849f24a99a24b1"><td class="memSeparator" colspan="2"> </td></tr> 82<tr class="memitem:a4a1884c4154c9ef25165285a17ba588a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a4a1884c4154c9ef25165285a17ba588a">isShared</a> ()</td></tr> 83<tr class="separator:a4a1884c4154c9ef25165285a17ba588a"><td class="memSeparator" colspan="2"> </td></tr> 84<tr class="memitem:ab8046af715cd67ff566592bc86e4a17c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#ab8046af715cd67ff566592bc86e4a17c">options</a> (<a class="el" href="classMagick_1_1Options.html">Options</a> *options_)</td></tr> 85<tr class="separator:ab8046af715cd67ff566592bc86e4a17c"><td class="memSeparator" colspan="2"> </td></tr> 86<tr class="memitem:aae7db022ab698b4531af04913167afc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMagick_1_1Options.html">Options</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#aae7db022ab698b4531af04913167afc2">options</a> (void)</td></tr> 87<tr class="separator:aae7db022ab698b4531af04913167afc2"><td class="memSeparator" colspan="2"> </td></tr> 88<tr class="memitem:ad50fcf3a4aeb0422abc29831de0e9aa5"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#ad50fcf3a4aeb0422abc29831de0e9aa5">signature</a> (const bool force_=false)</td></tr> 89<tr class="separator:ad50fcf3a4aeb0422abc29831de0e9aa5"><td class="memSeparator" colspan="2"> </td></tr> 90</table><table class="memberdecls"> 91<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> 92Static Public Member Functions</h2></td></tr> 93<tr class="memitem:a3659834ce9be0d3f542936ad1e2202f7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a3659834ce9be0d3f542936ad1e2202f7">replaceImage</a> (<a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a> *imgRef, MagickCore::Image *replacement_)</td></tr> 94<tr class="separator:a3659834ce9be0d3f542936ad1e2202f7"><td class="memSeparator" colspan="2"> </td></tr> 95</table> 96<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 97<div class="textblock"> 98<p class="definition">Definition at line <a class="el" href="ImageRef_8h_source.html#l00026">26</a> of file <a class="el" href="ImageRef_8h_source.html">ImageRef.h</a>.</p> 99</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> 100<a id="a690c73e5b36e3829762f9b5b8c9bfe3d"></a> 101<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a690c73e5b36e3829762f9b5b8c9bfe3d">◆ </a></span>ImageRef() <span class="overload">[1/2]</span></h2> 102 103<div class="memitem"> 104<div class="memproto"> 105 <table class="memname"> 106 <tr> 107 <td class="memname">Magick::ImageRef::ImageRef </td> 108 <td>(</td> 109 <td class="paramtype">void </td> 110 <td class="paramname"></td><td>)</td> 111 <td></td> 112 </tr> 113 </table> 114</div><div class="memdoc"> 115 116<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00018">18</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 117 118<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, <a class="el" href="Options_8cpp_source.html#l00948">Magick::Options::imageInfo()</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p> 119 120</div> 121</div> 122<a id="a5c9a9676c811c332ad556238da8c4614"></a> 123<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a5c9a9676c811c332ad556238da8c4614">◆ </a></span>ImageRef() <span class="overload">[2/2]</span></h2> 124 125<div class="memitem"> 126<div class="memproto"> 127 <table class="memname"> 128 <tr> 129 <td class="memname">Magick::ImageRef::ImageRef </td> 130 <td>(</td> 131 <td class="paramtype">MagickCore::Image * </td> 132 <td class="paramname"><em>image_</em></td><td>)</td> 133 <td></td> 134 </tr> 135 </table> 136</div><div class="memdoc"> 137 138<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00029">29</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 139 140</div> 141</div> 142<a id="aac3534f1dc5af42482043bdf2432c1ab"></a> 143<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#aac3534f1dc5af42482043bdf2432c1ab">◆ </a></span>~ImageRef()</h2> 144 145<div class="memitem"> 146<div class="memproto"> 147 <table class="memname"> 148 <tr> 149 <td class="memname">Magick::ImageRef::~ImageRef </td> 150 <td>(</td> 151 <td class="paramtype">void </td> 152 <td class="paramname"></td><td>)</td> 153 <td></td> 154 </tr> 155 </table> 156</div><div class="memdoc"> 157 158<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00037">37</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 159 160<p class="reference">References <a class="el" href="Drawable_8h_source.html#l00720">Magick::Image</a>.</p> 161 162</div> 163</div> 164<h2 class="groupheader">Member Function Documentation</h2> 165<a id="ac71a53a454d80d4e53b316a68f7f3a6c"></a> 166<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ac71a53a454d80d4e53b316a68f7f3a6c">◆ </a></span>decrease()</h2> 167 168<div class="memitem"> 169<div class="memproto"> 170 <table class="memname"> 171 <tr> 172 <td class="memname">size_t Magick::ImageRef::decrease </td> 173 <td>(</td> 174 <td class="paramname"></td><td>)</td> 175 <td></td> 176 </tr> 177 </table> 178</div><div class="memdoc"> 179 180<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00048">48</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 181 182<p class="reference">References <a class="el" href="Exception_8cpp_source.html#l00806">Magick::throwExceptionExplicit()</a>.</p> 183 184</div> 185</div> 186<a id="a5a536ef15ddde656d1ae1b9c40b0479f"></a> 187<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a5a536ef15ddde656d1ae1b9c40b0479f">◆ </a></span>image()</h2> 188 189<div class="memitem"> 190<div class="memproto"> 191 <table class="memname"> 192 <tr> 193 <td class="memname">MagickCore::Image *& Magick::ImageRef::image </td> 194 <td>(</td> 195 <td class="paramtype">void </td> 196 <td class="paramname"></td><td>)</td> 197 <td></td> 198 </tr> 199 </table> 200</div><div class="memdoc"> 201 202<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00066">66</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 203 204</div> 205</div> 206<a id="abf869f9b24fbcd6e2f849f24a99a24b1"></a> 207<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#abf869f9b24fbcd6e2f849f24a99a24b1">◆ </a></span>increase()</h2> 208 209<div class="memitem"> 210<div class="memproto"> 211 <table class="memname"> 212 <tr> 213 <td class="memname">void Magick::ImageRef::increase </td> 214 <td>(</td> 215 <td class="paramname"></td><td>)</td> 216 <td></td> 217 </tr> 218 </table> 219</div><div class="memdoc"> 220 221<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00071">71</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 222 223<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l00200">Magick::Image::Image()</a>, and <a class="el" href="Image_8cpp_source.html#l00280">Magick::Image::operator=()</a>.</p> 224 225</div> 226</div> 227<a id="a4a1884c4154c9ef25165285a17ba588a"></a> 228<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a4a1884c4154c9ef25165285a17ba588a">◆ </a></span>isShared()</h2> 229 230<div class="memitem"> 231<div class="memproto"> 232 <table class="memname"> 233 <tr> 234 <td class="memname">bool Magick::ImageRef::isShared </td> 235 <td>(</td> 236 <td class="paramname"></td><td>)</td> 237 <td></td> 238 </tr> 239 </table> 240</div><div class="memdoc"> 241 242<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00078">78</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 243 244</div> 245</div> 246<a id="ab8046af715cd67ff566592bc86e4a17c"></a> 247<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ab8046af715cd67ff566592bc86e4a17c">◆ </a></span>options() <span class="overload">[1/2]</span></h2> 248 249<div class="memitem"> 250<div class="memproto"> 251 <table class="memname"> 252 <tr> 253 <td class="memname">void Magick::ImageRef::options </td> 254 <td>(</td> 255 <td class="paramtype"><a class="el" href="classMagick_1_1Options.html">Magick::Options</a> * </td> 256 <td class="paramname"><em>options_</em></td><td>)</td> 257 <td></td> 258 </tr> 259 </table> 260</div><div class="memdoc"> 261 262<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00089">89</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 263 264<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l00206">Magick::Image::Image()</a>.</p> 265 266</div> 267</div> 268<a id="aae7db022ab698b4531af04913167afc2"></a> 269<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#aae7db022ab698b4531af04913167afc2">◆ </a></span>options() <span class="overload">[2/2]</span></h2> 270 271<div class="memitem"> 272<div class="memproto"> 273 <table class="memname"> 274 <tr> 275 <td class="memname"><a class="el" href="classMagick_1_1Options.html">Magick::Options</a> * Magick::ImageRef::options </td> 276 <td>(</td> 277 <td class="paramtype">void </td> 278 <td class="paramname"></td><td>)</td> 279 <td></td> 280 </tr> 281 </table> 282</div><div class="memdoc"> 283 284<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00095">95</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 285 286</div> 287</div> 288<a id="a3659834ce9be0d3f542936ad1e2202f7"></a> 289<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a3659834ce9be0d3f542936ad1e2202f7">◆ </a></span>replaceImage()</h2> 290 291<div class="memitem"> 292<div class="memproto"> 293<table class="mlabels"> 294 <tr> 295 <td class="mlabels-left"> 296 <table class="memname"> 297 <tr> 298 <td class="memname"><a class="el" href="classMagick_1_1ImageRef.html">Magick::ImageRef</a> * Magick::ImageRef::replaceImage </td> 299 <td>(</td> 300 <td class="paramtype"><a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a> * </td> 301 <td class="paramname"><em>imgRef</em>, </td> 302 </tr> 303 <tr> 304 <td class="paramkey"></td> 305 <td></td> 306 <td class="paramtype">MagickCore::Image * </td> 307 <td class="paramname"><em>replacement_</em> </td> 308 </tr> 309 <tr> 310 <td></td> 311 <td>)</td> 312 <td></td><td></td> 313 </tr> 314 </table> 315 </td> 316 <td class="mlabels-right"> 317<span class="mlabels"><span class="mlabel">static</span></span> </td> 318 </tr> 319</table> 320</div><div class="memdoc"> 321 322<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00100">100</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 323 324<p class="reference">References <a class="el" href="Drawable_8h_source.html#l00720">Magick::Image</a>, <a class="el" href="Thread_8cpp_source.html#l00076">Magick::MutexLock::lock()</a>, and <a class="el" href="Thread_8cpp_source.html#l00095">Magick::MutexLock::unlock()</a>.</p> 325 326<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l05058">Magick::Image::replaceImage()</a>.</p> 327 328</div> 329</div> 330<a id="ad50fcf3a4aeb0422abc29831de0e9aa5"></a> 331<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ad50fcf3a4aeb0422abc29831de0e9aa5">◆ </a></span>signature()</h2> 332 333<div class="memitem"> 334<div class="memproto"> 335 <table class="memname"> 336 <tr> 337 <td class="memname">std::string Magick::ImageRef::signature </td> 338 <td>(</td> 339 <td class="paramtype">const bool </td> 340 <td class="paramname"><em>force_</em> = <code>false</code></td><td>)</td> 341 <td></td> 342 </tr> 343 </table> 344</div><div class="memdoc"> 345 346<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00126">126</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p> 347 348<p class="reference">References <a class="el" href="Include_8h_source.html#l01544">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01563">ThrowPPException</a>.</p> 349 350</div> 351</div> 352<hr/>The documentation for this class was generated from the following files:<ul> 353<li><a class="el" href="ImageRef_8h_source.html">ImageRef.h</a></li> 354<li><a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a></li> 355</ul> 356</div><!-- contents --> 357</div><!-- doc-content --> 358<!-- start footer part --> 359<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 360 <ul> 361 <li class="navelem"><a class="el" href="namespaceMagick.html">Magick</a></li><li class="navelem"><a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a></li> 362 <li class="footer">Generated by 363 <a href="http://www.doxygen.org/index.html"> 364 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li> 365 </ul> 366</div> 367</body> 368</html> 369
