blob: d0cdfed7e849732f7b8e61cd76c11eac482de620 [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.10"/>
<title>Magick++: Functions.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">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
</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">
$(document).ready(function(){initNavTree('Functions_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Functions.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Functions_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, 2003</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright Dirk Lemstra 2014</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">// Simple C++ function wrappers for often used or otherwise</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// inconvenient ImageMagick equivalents</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#if !defined(Magick_Functions_header)</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define Magick_Functions_header</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</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="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceMagick.html">Magick</a></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="comment">// Clone C++ string as allocated C string, de-allocating any existing string</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a7c22815e81dd2dcc911a3d83986fb343">CloneString</a>(<span class="keywordtype">char</span> **destination_,</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">const</span> std::string &amp;source_);</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="comment">// Disable OpenCL acceleration (only works when build with OpenCL support)</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a619d5f55f1f0971b2e0d72e8bed0051a">DisableOpenCL</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// Enable OpenCL acceleration (only works when build with OpenCL support)</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceMagick.html#a8db47cc183547a1f5a1c6b5a5a81871f">EnableOpenCL</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> useCache_=<span class="keyword">true</span>);</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="comment">// C library initialization routine</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#ae9a4f92303d2fc6074f91181db864be1">InitializeMagick</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path_);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// Seed a new sequence of pseudo-random numbers</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a8df77532f69bfc1138f62e202111bc71">SetRandomSeed</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> seed);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="comment">// C library initialization routine</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#ab2ba5f1b607df720ab1f562e2d232980">TerminateMagick</a>();</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#endif // Magick_Functions_header</span></div>
<div class="ttc" id="namespaceMagick_html_a8db47cc183547a1f5a1c6b5a5a81871f"><div class="ttname"><a href="namespaceMagick.html#a8db47cc183547a1f5a1c6b5a5a81871f">Magick::EnableOpenCL</a></div><div class="ttdeci">MagickPPExport bool EnableOpenCL(const bool useCache_=true)</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00037">Functions.cpp:37</a></div></div>
<div class="ttc" id="namespaceMagick_html_a619d5f55f1f0971b2e0d72e8bed0051a"><div class="ttname"><a href="namespaceMagick.html#a619d5f55f1f0971b2e0d72e8bed0051a">Magick::DisableOpenCL</a></div><div class="ttdeci">MagickPPExport void DisableOpenCL(void)</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00029">Functions.cpp:29</a></div></div>
<div class="ttc" id="namespaceMagick_html_a8df77532f69bfc1138f62e202111bc71"><div class="ttname"><a href="namespaceMagick.html#a8df77532f69bfc1138f62e202111bc71">Magick::SetRandomSeed</a></div><div class="ttdeci">MagickPPExport void SetRandomSeed(const unsigned long seed)</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00062">Functions.cpp:62</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#l00256">Include.h:256</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_a7c22815e81dd2dcc911a3d83986fb343"><div class="ttname"><a href="namespaceMagick.html#a7c22815e81dd2dcc911a3d83986fb343">Magick::CloneString</a></div><div class="ttdeci">MagickPPExport void CloneString(char **destination_, const std::string &amp;source_)</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00023">Functions.cpp:23</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 class="ttc" id="namespaceMagick_html_ae9a4f92303d2fc6074f91181db864be1"><div class="ttname"><a href="namespaceMagick.html#ae9a4f92303d2fc6074f91181db864be1">Magick::InitializeMagick</a></div><div class="ttdeci">MagickPPExport void InitializeMagick(const char *path_)</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00055">Functions.cpp:55</a></div></div>
<div class="ttc" id="namespaceMagick_html_ab2ba5f1b607df720ab1f562e2d232980"><div class="ttname"><a href="namespaceMagick.html#ab2ba5f1b607df720ab1f562e2d232980">Magick::TerminateMagick</a></div><div class="ttdeci">MagickPPExport void TerminateMagick()</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00067">Functions.cpp:67</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="http://nextgen.imagemagick.org/api/Magick++/dir_43e0a1f539e00dcfa1a6bc4d4fee4fc2.html">home</a></li><li class="navelem"><a class="el" href="http://nextgen.imagemagick.org/api/Magick++/dir_68918867e77b0a45f29c43673f2273f8.html">cristy</a></li><li class="navelem"><a class="el" href="http://nextgen.imagemagick.org/api/Magick++/dir_0664224c5e489c82e6416cddc46e1af0.html">ImageMagick-7</a></li><li class="navelem"><a class="el" href="http://nextgen.imagemagick.org/api/Magick++/dir_436bc20d1ebf054c4eca7a72174ce42e.html">Magick++</a></li><li class="navelem"><a class="el" href="http://nextgen.imagemagick.org/api/Magick++/dir_94b620f9ceea3d56d5ade00d9eab2203.html">lib</a></li><li class="navelem"><a class="el" href="http://nextgen.imagemagick.org/api/Magick++/dir_106943ebd3829a5b74c083ee2c0647d8.html">Magick++</a></li><li class="navelem"><a class="el" href="Functions_8h.html">Functions.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.10 </li>
</ul>
</div>
</body>
</html>