blob: aa26999cb483baed7f9be308f800c581abcc1af5 [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.cpp 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_8cpp_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">Functions.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="Functions_8cpp.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, 2002, 2003</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">// Simple C++ function wrappers for ImageMagick equivalents</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;</div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="Functions_8cpp.html#a24d8db5449916b4dd0283f5f30a5edc7"> 9</a></span>&#160;<span class="preprocessor">#define MAGICKCORE_IMPLEMENTATION 1</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="Functions_8cpp.html#a99e08660df365803d576005502caf7e5"> 10</a></span>&#160;<span class="preprocessor">#define MAGICK_PLUSPLUS_IMPLEMENTATION 1</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">#include &quot;<a class="code" href="Include_8h.html">Magick++/Include.h</a>&quot;</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;string&gt;</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="keyword">using namespace </span><a class="code" href="http://nextgen.imagemagick.org/api/Magick++/namespacestd.html">std</a>;</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Functions_8h.html">Magick++/Functions.h</a>&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Exception_8h.html">Magick++/Exception.h</a>&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c"> 20</a></span>&#160;<span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a>=<span class="keyword">false</span>;</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">// Clone C++ string as allocated C string, de-allocating any existing string</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespaceMagick.html#a7c22815e81dd2dcc911a3d83986fb343"> 23</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a7c22815e81dd2dcc911a3d83986fb343">Magick::CloneString</a>(<span class="keywordtype">char</span> **destination_,</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">const</span> std::string &amp;source_)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="namespaceMagick.html#a7c22815e81dd2dcc911a3d83986fb343">MagickCore::CloneString</a>(destination_,source_.c_str());</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;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="namespaceMagick.html#a619d5f55f1f0971b2e0d72e8bed0051a"> 29</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a619d5f55f1f0971b2e0d72e8bed0051a">Magick::DisableOpenCL</a>(<span class="keywordtype">void</span>)</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; <a class="code" href="Include_8h.html#a66d0d226ad64af8c5d2be6180adca8b4">GetPPException</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; MagickCore::InitImageMagickOpenCL(MagickCore::MAGICK_OPENCL_OFF,NULL,NULL,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; exceptionInfo);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="Include_8h.html#a6a4b81920dd51d0f026cf21a015b194a">ThrowPPException</a>(<span class="keyword">false</span>);</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;</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="namespaceMagick.html#a8db47cc183547a1f5a1c6b5a5a81871f"> 37</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">bool</span> <a class="code" href="namespaceMagick.html#a8db47cc183547a1f5a1c6b5a5a81871f">Magick::EnableOpenCL</a>(<span class="keyword">const</span> <span class="keywordtype">bool</span> useCache_)</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="keywordtype">bool</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; status;</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; <a class="code" href="Include_8h.html#a66d0d226ad64af8c5d2be6180adca8b4">GetPPException</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">if</span> (useCache_)</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; status=MagickCore::InitImageMagickOpenCL(</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; MagickCore::MAGICK_OPENCL_DEVICE_SELECT_AUTO,NULL,NULL,exceptionInfo) ==</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; MagickTrue;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; status=MagickCore::InitImageMagickOpenCL(</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; MagickCore::MAGICK_OPENCL_DEVICE_SELECT_AUTO_CLEAR_CACHE,NULL,NULL,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; exceptionInfo) == MagickTrue;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="Include_8h.html#a6a4b81920dd51d0f026cf21a015b194a">ThrowPPException</a>(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">return</span>(status);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</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"><a class="line" href="namespaceMagick.html#ae9a4f92303d2fc6074f91181db864be1"> 55</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#ae9a4f92303d2fc6074f91181db864be1">Magick::InitializeMagick</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *path_)</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;{</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; MagickCore::MagickCoreGenesis(path_,MagickFalse);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">if</span> (!<a class="code" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a>)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a>=<span class="keyword">true</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;}</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="namespaceMagick.html#a8df77532f69bfc1138f62e202111bc71"> 62</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#a8df77532f69bfc1138f62e202111bc71">Magick::SetRandomSeed</a>(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> seed)</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;{</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; MagickCore::SetRandomSecretKey(seed);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;}</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"><a class="line" href="namespaceMagick.html#ab2ba5f1b607df720ab1f562e2d232980"> 67</a></span>&#160;<a class="code" href="Include_8h.html#a3648b581d4f8adf56a18ae67b7111a04">MagickPPExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceMagick.html#ab2ba5f1b607df720ab1f562e2d232980">Magick::TerminateMagick</a>(<span class="keywordtype">void</span>)</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;{</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a>)</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; {</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <a class="code" href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a>=<span class="keyword">false</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; MagickCore::MagickCoreTerminus();</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div>
<div class="ttc" id="Functions_8h_html"><div class="ttname"><a href="Functions_8h.html">Functions.h</a></div></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="namespacestd_html"><div class="ttname"><a href="http://nextgen.imagemagick.org/api/Magick++/namespacestd.html">std</a></div><div class="ttdoc">STL namespace. </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="Functions_8cpp_html_a9789eda8e8572a0722fb55c29ba2f76c"><div class="ttname"><a href="Functions_8cpp.html#a9789eda8e8572a0722fb55c29ba2f76c">magick_initialized</a></div><div class="ttdeci">static bool magick_initialized</div><div class="ttdef"><b>Definition:</b> <a href="Functions_8cpp_source.html#l00020">Functions.cpp:20</a></div></div>
<div class="ttc" id="Include_8h_html_a6a4b81920dd51d0f026cf21a015b194a"><div class="ttname"><a href="Include_8h.html#a6a4b81920dd51d0f026cf21a015b194a">ThrowPPException</a></div><div class="ttdeci">#define ThrowPPException(quiet)</div><div class="ttdef"><b>Definition:</b> <a href="Include_8h_source.html#l01514">Include.h:1514</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_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 class="ttc" id="Include_8h_html_a66d0d226ad64af8c5d2be6180adca8b4"><div class="ttname"><a href="Include_8h.html#a66d0d226ad64af8c5d2be6180adca8b4">GetPPException</a></div><div class="ttdeci">#define GetPPException</div><div class="ttdef"><b>Definition:</b> <a href="Include_8h_source.html#l01495">Include.h:1495</a></div></div>
<div class="ttc" id="Exception_8h_html"><div class="ttname"><a href="Exception_8h.html">Exception.h</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="Functions_8cpp.html">Functions.cpp</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>