identiconpp/docs/identiconpp__c_8h_source.html

89 lines
14 KiB
HTML

<!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>identiconpp: src/identiconpp_c.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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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">identiconpp
&#160;<span id="projectnumber">0.6.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">identiconpp_c.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="identiconpp__c_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 file is part of identiconpp.</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright © 2019 tastytea &lt;tastytea@tastytea.de&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * it under the terms of the GNU General Public License as published by</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the Free Software Foundation, version 3.</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 program is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * GNU General Public License for more details.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></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">#ifndef IDENTICONPP_C_H</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define IDENTICONPP_C_H</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"> 20</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span></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="preprocessor">#endif</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="preprocessor"> #include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor"> #include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor"> #include &lt;stddef.h&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832"> 38</a></span>&#160; <span class="keyword">typedef</span> <span class="keyword">enum</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832a2364149e2343fa3521641c0cd7f1ac79"> 41</a></span>&#160; <a class="code" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832a2364149e2343fa3521641c0cd7f1ac79">identiconpp_ltr_symmetric</a>,</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832acb9278ec748cecd85c4eff2992c07f7b"> 43</a></span>&#160; <a class="code" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832acb9278ec748cecd85c4eff2992c07f7b">identiconpp_ltr_asymmetric</a>,</div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832adeae262829ee11fb003aee261bc4067b"> 49</a></span>&#160; <a class="code" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832adeae262829ee11fb003aee261bc4067b">identiconpp_sigil</a></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; } <a class="code" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832">identiconpp_algorithm</a>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="identiconpp__c_8h.html#afa8065f45fe255f7e0940b2d09ffe482">identiconpp_setup</a>(<span class="keyword">const</span> uint8_t columns, <span class="keyword">const</span> uint8_t rows,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <a class="code" href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832">identiconpp_algorithm</a> type,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> background[9],</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> foreground[][9],</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keyword">const</span> uint8_t foreground_len,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">const</span> uint8_t padding[2]);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; uint64_t <a class="code" href="identiconpp__c_8h.html#a4462d23411d8910225b030a925f3da1f">identiconpp_generate</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> magick[],</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> digest[], <span class="keyword">const</span> uint16_t width);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="identiconpp__c_8h.html#ab3de11147af05193798aae5fa0548594">identiconpp_base64</a>();</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="preprocessor">#endif // IDENTICONPP_C_H</span></div><div class="ttc" id="identiconpp__c_8h_html_a4462d23411d8910225b030a925f3da1f"><div class="ttname"><a href="identiconpp__c_8h.html#a4462d23411d8910225b030a925f3da1f">identiconpp_generate</a></div><div class="ttdeci">uint64_t identiconpp_generate(const char magick[], const char digest[], const uint16_t width)</div><div class="ttdoc">Generates identicon from digest. </div><div class="ttdef"><b>Definition:</b> c_interface.cpp:81</div></div>
<div class="ttc" id="identiconpp__c_8h_html_a9846d0a99fddf0b21eee241c15b4d832acb9278ec748cecd85c4eff2992c07f7b"><div class="ttname"><a href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832acb9278ec748cecd85c4eff2992c07f7b">identiconpp_ltr_asymmetric</a></div><div class="ttdoc">Generates asymmetric identicons. </div><div class="ttdef"><b>Definition:</b> identiconpp_c.h:43</div></div>
<div class="ttc" id="identiconpp__c_8h_html_afa8065f45fe255f7e0940b2d09ffe482"><div class="ttname"><a href="identiconpp__c_8h.html#afa8065f45fe255f7e0940b2d09ffe482">identiconpp_setup</a></div><div class="ttdeci">bool identiconpp_setup(const uint8_t columns, const uint8_t rows, identiconpp_algorithm type, const char background[9], const char foreground[][9], const uint8_t foreground_len, const uint8_t padding[2])</div><div class="ttdoc">Setup identicon parameters. </div><div class="ttdef"><b>Definition:</b> c_interface.cpp:33</div></div>
<div class="ttc" id="identiconpp__c_8h_html_a9846d0a99fddf0b21eee241c15b4d832a2364149e2343fa3521641c0cd7f1ac79"><div class="ttname"><a href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832a2364149e2343fa3521641c0cd7f1ac79">identiconpp_ltr_symmetric</a></div><div class="ttdoc">Generates symmetric (vertically mirrored) identicons. </div><div class="ttdef"><b>Definition:</b> identiconpp_c.h:41</div></div>
<div class="ttc" id="identiconpp__c_8h_html_a9846d0a99fddf0b21eee241c15b4d832adeae262829ee11fb003aee261bc4067b"><div class="ttname"><a href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832adeae262829ee11fb003aee261bc4067b">identiconpp_sigil</a></div><div class="ttdef"><b>Definition:</b> identiconpp_c.h:49</div></div>
<div class="ttc" id="identiconpp__c_8h_html_a9846d0a99fddf0b21eee241c15b4d832"><div class="ttname"><a href="identiconpp__c_8h.html#a9846d0a99fddf0b21eee241c15b4d832">identiconpp_algorithm</a></div><div class="ttdeci">identiconpp_algorithm</div><div class="ttdoc">List of identicon algorithms. </div><div class="ttdef"><b>Definition:</b> identiconpp_c.h:38</div></div>
<div class="ttc" id="identiconpp__c_8h_html_ab3de11147af05193798aae5fa0548594"><div class="ttname"><a href="identiconpp__c_8h.html#ab3de11147af05193798aae5fa0548594">identiconpp_base64</a></div><div class="ttdeci">const char * identiconpp_base64()</div><div class="ttdoc">Return base64-encoded string of the image generated with identiconpp_generate(). </div><div class="ttdef"><b>Definition:</b> c_interface.cpp:100</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>