averello/ImageMagick-mirror
1
0
Fork 0
mirror of https://github.com/ImageMagick/ImageMagick.git synced 2026-05-25 11:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
ImageMagick-mirror/www/api/Magick++/classMagick_1_1ImageRef.html
T
Cristy 0442c9d0ff latest ImageMagick documentation
2022-05-30 18:05:57 +00:00

369 lines
19 KiB
HTML
Raw Permalink Blame History

<!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++: Magick::ImageRef Class Reference</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.1.0</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('classMagick_1_1ImageRef.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classMagick_1_1ImageRef.html#pub-methods">Public Member Functions</a> &#124;
<a href="classMagick_1_1ImageRef.html#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="https://imagemagick.org/api/Magick++/classMagick_1_1ImageRef-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Magick::ImageRef Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="ImageRef_8h_source.html">ImageRef.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a690c73e5b36e3829762f9b5b8c9bfe3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a690c73e5b36e3829762f9b5b8c9bfe3d">ImageRef</a> (void)</td></tr>
<tr class="separator:a690c73e5b36e3829762f9b5b8c9bfe3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c9a9676c811c332ad556238da8c4614"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a5c9a9676c811c332ad556238da8c4614">ImageRef</a> (MagickCore::Image *image_)</td></tr>
<tr class="separator:a5c9a9676c811c332ad556238da8c4614"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac3534f1dc5af42482043bdf2432c1ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#aac3534f1dc5af42482043bdf2432c1ab">~ImageRef</a> (void)</td></tr>
<tr class="separator:aac3534f1dc5af42482043bdf2432c1ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71a53a454d80d4e53b316a68f7f3a6c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#ac71a53a454d80d4e53b316a68f7f3a6c">decrease</a> ()</td></tr>
<tr class="separator:ac71a53a454d80d4e53b316a68f7f3a6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a536ef15ddde656d1ae1b9c40b0479f"><td class="memItemLeft" align="right" valign="top">MagickCore::Image *&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a5a536ef15ddde656d1ae1b9c40b0479f">image</a> (void)</td></tr>
<tr class="separator:a5a536ef15ddde656d1ae1b9c40b0479f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf869f9b24fbcd6e2f849f24a99a24b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#abf869f9b24fbcd6e2f849f24a99a24b1">increase</a> ()</td></tr>
<tr class="separator:abf869f9b24fbcd6e2f849f24a99a24b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a1884c4154c9ef25165285a17ba588a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#a4a1884c4154c9ef25165285a17ba588a">isShared</a> ()</td></tr>
<tr class="separator:a4a1884c4154c9ef25165285a17ba588a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8046af715cd67ff566592bc86e4a17c"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr class="separator:ab8046af715cd67ff566592bc86e4a17c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae7db022ab698b4531af04913167afc2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classMagick_1_1Options.html">Options</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#aae7db022ab698b4531af04913167afc2">options</a> (void)</td></tr>
<tr class="separator:aae7db022ab698b4531af04913167afc2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50fcf3a4aeb0422abc29831de0e9aa5"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMagick_1_1ImageRef.html#ad50fcf3a4aeb0422abc29831de0e9aa5">signature</a> (const bool force_=false)</td></tr>
<tr class="separator:ad50fcf3a4aeb0422abc29831de0e9aa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3659834ce9be0d3f542936ad1e2202f7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a> *&#160;</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>
<tr class="separator:a3659834ce9be0d3f542936ad1e2202f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="ImageRef_8h_source.html#l00028">28</a> of file <a class="el" href="ImageRef_8h_source.html">ImageRef.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a690c73e5b36e3829762f9b5b8c9bfe3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a690c73e5b36e3829762f9b5b8c9bfe3d">&#9670;&nbsp;</a></span>ImageRef() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::ImageRef::ImageRef </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00020">20</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01561">GetPPException</a>, <a class="el" href="Options_8cpp_source.html#l00950">Magick::Options::imageInfo()</a>, and <a class="el" href="Include_8h_source.html#l01580">ThrowPPException</a>.</p>
</div>
</div>
<a id="a5c9a9676c811c332ad556238da8c4614"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a5c9a9676c811c332ad556238da8c4614">&#9670;&nbsp;</a></span>ImageRef() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::ImageRef::ImageRef </td>
<td>(</td>
<td class="paramtype">MagickCore::Image *&#160;</td>
<td class="paramname"><em>image_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00031">31</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
</div>
</div>
<a id="aac3534f1dc5af42482043bdf2432c1ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#aac3534f1dc5af42482043bdf2432c1ab">&#9670;&nbsp;</a></span>~ImageRef()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Magick::ImageRef::~ImageRef </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00039">39</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">References <a class="el" href="Drawable_8h_source.html#l00722">Magick::Image</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac71a53a454d80d4e53b316a68f7f3a6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ac71a53a454d80d4e53b316a68f7f3a6c">&#9670;&nbsp;</a></span>decrease()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t Magick::ImageRef::decrease </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00050">50</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">References <a class="el" href="Exception_8cpp_source.html#l00808">Magick::throwExceptionExplicit()</a>.</p>
</div>
</div>
<a id="a5a536ef15ddde656d1ae1b9c40b0479f"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a5a536ef15ddde656d1ae1b9c40b0479f">&#9670;&nbsp;</a></span>image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MagickCore::Image *&amp; Magick::ImageRef::image </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00068">68</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
</div>
</div>
<a id="abf869f9b24fbcd6e2f849f24a99a24b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#abf869f9b24fbcd6e2f849f24a99a24b1">&#9670;&nbsp;</a></span>increase()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Magick::ImageRef::increase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00073">73</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l00202">Magick::Image::Image()</a>, and <a class="el" href="Image_8cpp_source.html#l00282">Magick::Image::operator=()</a>.</p>
</div>
</div>
<a id="a4a1884c4154c9ef25165285a17ba588a"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a4a1884c4154c9ef25165285a17ba588a">&#9670;&nbsp;</a></span>isShared()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Magick::ImageRef::isShared </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00080">80</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
</div>
</div>
<a id="ab8046af715cd67ff566592bc86e4a17c"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ab8046af715cd67ff566592bc86e4a17c">&#9670;&nbsp;</a></span>options() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Magick::ImageRef::options </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMagick_1_1Options.html">Magick::Options</a> *&#160;</td>
<td class="paramname"><em>options_</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00091">91</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l00208">Magick::Image::Image()</a>.</p>
</div>
</div>
<a id="aae7db022ab698b4531af04913167afc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#aae7db022ab698b4531af04913167afc2">&#9670;&nbsp;</a></span>options() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMagick_1_1Options.html">Magick::Options</a> * Magick::ImageRef::options </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00097">97</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
</div>
</div>
<a id="a3659834ce9be0d3f542936ad1e2202f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#a3659834ce9be0d3f542936ad1e2202f7">&#9670;&nbsp;</a></span>replaceImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMagick_1_1ImageRef.html">Magick::ImageRef</a> * Magick::ImageRef::replaceImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMagick_1_1ImageRef.html">ImageRef</a> *&#160;</td>
<td class="paramname"><em>imgRef</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MagickCore::Image *&#160;</td>
<td class="paramname"><em>replacement_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00102">102</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">References <a class="el" href="Drawable_8h_source.html#l00722">Magick::Image</a>, <a class="el" href="Thread_8cpp_source.html#l00078">Magick::MutexLock::lock()</a>, and <a class="el" href="Thread_8cpp_source.html#l00097">Magick::MutexLock::unlock()</a>.</p>
<p class="reference">Referenced by <a class="el" href="Image_8cpp_source.html#l05074">Magick::Image::replaceImage()</a>.</p>
</div>
</div>
<a id="ad50fcf3a4aeb0422abc29831de0e9aa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="classMagick_1_1ImageRef.html#ad50fcf3a4aeb0422abc29831de0e9aa5">&#9670;&nbsp;</a></span>signature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Magick::ImageRef::signature </td>
<td>(</td>
<td class="paramtype">const bool&#160;</td>
<td class="paramname"><em>force_</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ImageRef_8cpp_source.html#l00128">128</a> of file <a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a>.</p>
<p class="reference">References <a class="el" href="Include_8h_source.html#l01561">GetPPException</a>, and <a class="el" href="Include_8h_source.html#l01580">ThrowPPException</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ImageRef_8h_source.html">ImageRef.h</a></li>
<li><a class="el" href="ImageRef_8cpp_source.html">ImageRef.cpp</a></li>
</ul>
</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="namespaceMagick.html">Magick</a></li><li class="navelem"><a class="el" href="classMagick_1_1ImageRef.html">ImageRef</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>
Reference in New Issue View Git Blame Copy Permalink