Update Doxygen doc
[openjpeg.git] / doxygen / opj__malloc_8h_source.html
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.10"/>
7 <title>OpenJPEG: opj_malloc.h Source File</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li class="current"><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39   <div id="navrow2" class="tabs2">
40     <ul class="tablist">
41       <li><a href="files.html"><span>File&#160;List</span></a></li>
42       <li><a href="globals.html"><span>Globals</span></a></li>
43     </ul>
44   </div>
45 <div id="nav-path" class="navpath">
46   <ul>
47 <li class="navelem"><a class="el" href="dir_d522931ffa1371640980b621734a4381.html">Users</a></li><li class="navelem"><a class="el" href="dir_694e20c96f4fc1be4aed4f026eadce94.html">antonin</a></li><li class="navelem"><a class="el" href="dir_3ca1ad36e65e03f9e8d67ddc2553765b.html">dev</a></li><li class="navelem"><a class="el" href="dir_181a881edfcb8646dab693a228fa6bde.html">opj</a></li><li class="navelem"><a class="el" href="dir_5064bb5511811c3176850b7e47443f14.html">github</a></li><li class="navelem"><a class="el" href="dir_0b20524d8f8835ca75acc430451c8412.html">openjpeg</a></li><li class="navelem"><a class="el" href="dir_e3f8a8e294f8271ee71cbcf3c2acacc1.html">src</a></li><li class="navelem"><a class="el" href="dir_da83fe5fdfb6c4554d36abffc03790ad.html">lib</a></li><li class="navelem"><a class="el" href="dir_68013e83e260d17d49dee5e209315608.html">openjp2</a></li>  </ul>
48 </div>
49 </div><!-- top -->
50 <div class="header">
51   <div class="headertitle">
52 <div class="title">opj_malloc.h</div>  </div>
53 </div><!--header-->
54 <div class="contents">
55 <a href="opj__malloc_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">/*</span></div>
56 <div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * The copyright in this software is being made available under the 2-clauses</span></div>
57 <div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * BSD License, included below. This software may be subject to other third</span></div>
58 <div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * party and contributor rights, including patent rights, and no such rights</span></div>
59 <div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * are granted under this license.</span></div>
60 <div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div>
61 <div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Copyright (c) 2005, Herve Drolon, FreeImage Team</span></div>
62 <div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * Copyright (c) 2007, Callum Lerwick &lt;seg@haxxed.com&gt;</span></div>
63 <div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * All rights reserved.</span></div>
64 <div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div>
65 <div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
66 <div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions</span></div>
67 <div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * are met:</span></div>
68 <div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * 1. Redistributions of source code must retain the above copyright</span></div>
69 <div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer.</span></div>
70 <div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span></div>
71 <div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *    notice, this list of conditions and the following disclaimer in the</span></div>
72 <div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *    documentation and/or other materials provided with the distribution.</span></div>
73 <div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *</span></div>
74 <div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS&#39;</span></div>
75 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
76 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
77 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE</span></div>
78 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</span></div>
79 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
80 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
81 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
82 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
83 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</span></div>
84 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * POSSIBILITY OF SUCH DAMAGE.</span></div>
85 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> */</span></div>
86 <div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#ifndef OPJ_MALLOC_H</span></div>
87 <div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#define OPJ_MALLOC_H</span></div>
88 <div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
89 <div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
90 <div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div>
91 <div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
92 <div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
93 <div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc</a>(<span class="keywordtype">size_t</span> size);</div>
94 <div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
95 <div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga7fe6dfcb0a623dbec30daf0f48624bf7">opj_calloc</a>(<span class="keywordtype">size_t</span> numOfElements, <span class="keywordtype">size_t</span> sizeOfElements);</div>
96 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div>
97 <div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga4418db34754a5b9ac5a79fece518c601">opj_aligned_malloc</a>(<span class="keywordtype">size_t</span> size);</div>
98 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga0fdc9e5dfa748e01dd87621a12a0e102">opj_aligned_realloc</a>(<span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size);</div>
99 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___m_i_s_c.html#gaefeccfbb22ba64c00f94f7f66fc97126">opj_aligned_free</a>(<span class="keywordtype">void</span>* ptr);</div>
100 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div>
101 <div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#gaca33611a393378b0314a07d239b66099">opj_aligned_32_malloc</a>(<span class="keywordtype">size_t</span> size);</div>
102 <div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga42f91b38d00506a6851fc1dde0fba402">opj_aligned_32_realloc</a>(<span class="keywordtype">void</span> *ptr, <span class="keywordtype">size_t</span> size);</div>
103 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div>
104 <div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="keywordtype">void</span> * <a class="code" href="group___m_i_s_c.html#ga95862b2a456efdc436c61beba816fb25">opj_realloc</a>(<span class="keywordtype">void</span> * m, <span class="keywordtype">size_t</span> s);</div>
105 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;</div>
106 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free</a>(<span class="keywordtype">void</span> * m);</div>
107 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
108 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="preprocessor">#if defined(__GNUC__) &amp;&amp; !defined(OPJ_SKIP_POISON)</span></div>
109 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="preprocessor">#pragma GCC poison malloc calloc realloc free</span></div>
110 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="preprocessor">#endif</span></div>
111 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;</div>
112 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">/* ----------------------------------------------------------------------- */</span></div>
113 <div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
114 <div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* OPJ_MALLOC_H */</span><span class="preprocessor"></span></div>
115 <div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
116 <div class="ttc" id="group___m_i_s_c_html_ga49c70931cbed786f6eef5f095bcb2917"><div class="ttname"><a href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc</a></div><div class="ttdeci">void * opj_malloc(size_t size)</div><div class="ttdoc">Allocate an uninitialized memory block. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:191</div></div>
117 <div class="ttc" id="group___m_i_s_c_html_gaefeccfbb22ba64c00f94f7f66fc97126"><div class="ttname"><a href="group___m_i_s_c.html#gaefeccfbb22ba64c00f94f7f66fc97126">opj_aligned_free</a></div><div class="ttdeci">void opj_aligned_free(void *ptr)</div><div class="ttdef"><b>Definition:</b> opj_malloc.c:225</div></div>
118 <div class="ttc" id="group___m_i_s_c_html_ga0fdc9e5dfa748e01dd87621a12a0e102"><div class="ttname"><a href="group___m_i_s_c.html#ga0fdc9e5dfa748e01dd87621a12a0e102">opj_aligned_realloc</a></div><div class="ttdeci">void * opj_aligned_realloc(void *ptr, size_t size)</div><div class="ttdef"><b>Definition:</b> opj_malloc.c:211</div></div>
119 <div class="ttc" id="group___m_i_s_c_html_ga42f91b38d00506a6851fc1dde0fba402"><div class="ttname"><a href="group___m_i_s_c.html#ga42f91b38d00506a6851fc1dde0fba402">opj_aligned_32_realloc</a></div><div class="ttdeci">void * opj_aligned_32_realloc(void *ptr, size_t size)</div><div class="ttdef"><b>Definition:</b> opj_malloc.c:220</div></div>
120 <div class="ttc" id="group___m_i_s_c_html_ga95862b2a456efdc436c61beba816fb25"><div class="ttname"><a href="group___m_i_s_c.html#ga95862b2a456efdc436c61beba816fb25">opj_realloc</a></div><div class="ttdeci">void * opj_realloc(void *m, size_t s)</div><div class="ttdoc">Reallocate memory blocks. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:239</div></div>
121 <div class="ttc" id="group___m_i_s_c_html_ga2bd00e2482ae36197631bde0665cfdfe"><div class="ttname"><a href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free</a></div><div class="ttdeci">void opj_free(void *m)</div><div class="ttdoc">Deallocates or frees a memory block. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:246</div></div>
122 <div class="ttc" id="group___m_i_s_c_html_ga7fe6dfcb0a623dbec30daf0f48624bf7"><div class="ttname"><a href="group___m_i_s_c.html#ga7fe6dfcb0a623dbec30daf0f48624bf7">opj_calloc</a></div><div class="ttdeci">void * opj_calloc(size_t numOfElements, size_t sizeOfElements)</div><div class="ttdoc">Allocate a memory block with elements initialized to 0. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:198</div></div>
123 <div class="ttc" id="group___m_i_s_c_html_gaca33611a393378b0314a07d239b66099"><div class="ttname"><a href="group___m_i_s_c.html#gaca33611a393378b0314a07d239b66099">opj_aligned_32_malloc</a></div><div class="ttdeci">void * opj_aligned_32_malloc(size_t size)</div><div class="ttdoc">Allocate memory aligned to a 32 byte boundary. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:216</div></div>
124 <div class="ttc" id="group___m_i_s_c_html_ga4418db34754a5b9ac5a79fece518c601"><div class="ttname"><a href="group___m_i_s_c.html#ga4418db34754a5b9ac5a79fece518c601">opj_aligned_malloc</a></div><div class="ttdeci">void * opj_aligned_malloc(size_t size)</div><div class="ttdoc">Allocate memory aligned to a 16 byte boundary. </div><div class="ttdef"><b>Definition:</b> opj_malloc.c:207</div></div>
125 </div><!-- fragment --></div><!-- contents -->
126 <!-- start footer part -->
127 <hr class="footer"/><address class="footer"><small>
128 Generated by &#160;<a href="http://www.doxygen.org/index.html">
129 <img class="footer" src="doxygen.png" alt="doxygen"/>
130 </a> 1.8.10
131 </small></address>
132 </body>
133 </html>