abdelrahman/how-to-vulkan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
13fa90a0e94b17ef2c88ac895a9d2368241a6eab
how-to-vulkan/ktx/build/docs/html/libktx/memstream_8c.html
T
abdelrahman 13fa90a0e9 Add ktx
2026-06-14 19:09:18 +01:00

331 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libktx Reference: lib/memstream.c File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="ktx_logo_200.png"/></td>
<td id="projectalign">
<div id="projectname">libktx Reference<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">Libraries and tools to create and read KTX image texture files.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</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">
$(function(){initNavTree('memstream_8c.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">memstream.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Implementation of <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> for memory.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;<a class="el" href="ktx_8h.html">ktx.h</a>&quot;</code><br />
<code>#include &quot;ktxint.h&quot;</code><br />
<code>#include &quot;memstream.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for memstream.c:</div>
<div class="dyncontent">
<div class="center"><img src="memstream_8c__incl.png" border="0" usemap="#alib_2memstream_8c" loading="lazy" alt=""/></div>
<map name="alib_2memstream_8c" id="alib_2memstream_8c">
<area shape="rect" title="Implementation of ktxStream for memory." alt="" coords="199,5,317,32"/>
<area shape="rect" title=" " alt="" coords="5,80,74,107"/>
<area shape="poly" title=" " alt="" coords="219,35,90,78,88,73,221,30"/>
<area shape="rect" title=" " alt="" coords="98,80,162,107"/>
<area shape="poly" title=" " alt="" coords="234,34,167,74,164,70,238,31"/>
<area shape="rect" title=" " alt="" coords="186,80,250,107"/>
<area shape="poly" title=" " alt="" coords="253,31,234,68,230,64,249,34"/>
<area shape="rect" href="ktx_8h.html" title="Declares the public functions and structures of the KTX API." alt="" coords="274,80,325,107"/>
<area shape="poly" title=" " alt="" coords="266,30,288,67,282,66,264,35"/>
<area shape="rect" title=" " alt="" coords="349,80,413,107"/>
<area shape="poly" title=" " alt="" coords="280,30,349,71,343,72,279,35"/>
<area shape="rect" title=" " alt="" coords="437,80,538,107"/>
<area shape="poly" title=" " alt="" coords="298,30,435,74,430,76,298,35"/>
<area shape="rect" title=" " alt="" coords="90,155,154,181"/>
<area shape="poly" title=" " alt="" coords="276,105,168,151,167,146,271,105"/>
<area shape="rect" title=" " alt="" coords="177,155,238,181"/>
<area shape="poly" title=" " alt="" coords="286,106,236,147,234,143,281,108"/>
<area shape="rect" title=" " alt="" coords="262,155,337,181"/>
<area shape="poly" title=" " alt="" coords="301,105,302,141,297,137,298,109"/>
<area shape="rect" title=" " alt="" coords="360,155,450,181"/>
<area shape="poly" title=" " alt="" coords="319,105,377,146,371,145,317,110"/>
<area shape="rect" title=" " alt="" coords="474,155,538,181"/>
<area shape="poly" title=" " alt="" coords="326,101,462,150,457,151,325,106"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad9d0c31ff64d0512e98e0b6991051b62" id="r_ad9d0c31ff64d0512e98e0b6991051b62"><td class="memItemLeft"><a id="ad9d0c31ff64d0512e98e0b6991051b62" name="ad9d0c31ff64d0512e98e0b6991051b62"></a>
#define&#160;</td><td class="memItemRight"><b>KTX_MEM_DEFAULT_ALLOCATED_SIZE</b>&#160;&#160;&#160;256</td></tr>
<tr class="memdesc:ad9d0c31ff64d0512e98e0b6991051b62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default allocation size for a ktxMemStream. <br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3f9cc251a3604f80da67440efff21b6d" id="r_a3f9cc251a3604f80da67440efff21b6d"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a3f9cc251a3604f80da67440efff21b6d">ktxMemStream_getdata</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str, ktx_uint8_t **ppBytes)</td></tr>
<tr class="memdesc:a3f9cc251a3604f80da67440efff21b6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a pointer to a ktxMemStream's data. <br /></td></tr>
<tr class="memitem:a777303765bd7d021820c90ff6ad85afa" id="r_a777303765bd7d021820c90ff6ad85afa"><td class="memItemLeft"><a id="a777303765bd7d021820c90ff6ad85afa" name="a777303765bd7d021820c90ff6ad85afa"></a>
void&#160;</td><td class="memItemRight"><b>ktxMemStream_setup</b> (<a class="el" href="structktxStream.html">ktxStream</a> *str)</td></tr>
<tr class="memdesc:a777303765bd7d021820c90ff6ad85afa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup ktxMemStream function pointers. <br /></td></tr>
<tr class="memitem:a899a1878ad93c797c8c2d9aacffc6365" id="r_a899a1878ad93c797c8c2d9aacffc6365"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a899a1878ad93c797c8c2d9aacffc6365">ktxMemStream_construct</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str, ktx_bool_t freeOnDestruct)</td></tr>
<tr class="memdesc:a899a1878ad93c797c8c2d9aacffc6365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a read-write ktxMemStream. <br /></td></tr>
<tr class="memitem:a3c0f816438f1e4412376b35fa66f9424" id="r_a3c0f816438f1e4412376b35fa66f9424"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a3c0f816438f1e4412376b35fa66f9424">ktxMemStream_construct_ro</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str, const ktx_uint8_t *bytes, const ktx_size_t numBytes)</td></tr>
<tr class="memdesc:a3c0f816438f1e4412376b35fa66f9424"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a read-only ktxMemStream. <br /></td></tr>
<tr class="memitem:a81f0db4b157134a8edf51c2936e853e4" id="r_a81f0db4b157134a8edf51c2936e853e4"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a81f0db4b157134a8edf51c2936e853e4">ktxMemStream_destruct</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str)</td></tr>
<tr class="memdesc:a81f0db4b157134a8edf51c2936e853e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free the memory used by a ktxMemStream. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> for memory. </p>
<dl class="section author"><dt>Author</dt><dd>Maksim Kolesin, Under Development </dd>
<dd>
Georg Kolling, Imagination Technology </dd>
<dd>
Mark Callow, HI Corporation </dd></dl>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="a899a1878ad93c797c8c2d9aacffc6365" name="a899a1878ad93c797c8c2d9aacffc6365"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a899a1878ad93c797c8c2d9aacffc6365">&#9670;&#160;</a></span>ktxMemStream_construct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxMemStream_construct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ktx_bool_t</td> <td class="paramname"><span class="paramname"><em>freeOnDestruct</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a read-write ktxMemStream. </p>
<p>Memory is allocated as data is written. The caller of this is responsible for freeing this memory unless <em class="arg">freeOnDestruct</em> is not KTX_FALSE.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>pointer to a <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> struct to initialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">freeOnDestruct</td><td>If not KTX_FALSE memory holding the data will be freed by the destructor.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values on error.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">str</code> is <code>NULL</code>. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>system failed to allocate sufficient memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3c0f816438f1e4412376b35fa66f9424" name="a3c0f816438f1e4412376b35fa66f9424"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c0f816438f1e4412376b35fa66f9424">&#9670;&#160;</a></span>ktxMemStream_construct_ro()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxMemStream_construct_ro </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ktx_uint8_t *</td> <td class="paramname"><span class="paramname"><em>bytes</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ktx_size_t</td> <td class="paramname"><span class="paramname"><em>numBytes</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a read-only ktxMemStream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>pointer to a <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> struct to initialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bytes</td><td>pointer to an array of bytes containing the data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">numBytes</td><td>size of array of data for ktxMemStream.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values on error.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">str</code> or <code class="param">mem</code> is <code>NULL</code> or <code class="param">numBytes</code> is 0. or <code class="param">size</code> is less than 0. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>system failed to allocate sufficient memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a81f0db4b157134a8edf51c2936e853e4" name="a81f0db4b157134a8edf51c2936e853e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81f0db4b157134a8edf51c2936e853e4">&#9670;&#160;</a></span>ktxMemStream_destruct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxMemStream_destruct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>str</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free the memory used by a ktxMemStream. </p>
<p>This only frees the memory used to store the data written to the stream, if the <code>freeOnDestruct</code> parameter to <a class="el" href="#a899a1878ad93c797c8c2d9aacffc6365" title="Initialize a read-write ktxMemStream.">ktxMemStream_construct()</a> was not <code>KTX_FALSE</code>. Otherwise it is the responsibility of the caller of <a class="el" href="#a899a1878ad93c797c8c2d9aacffc6365" title="Initialize a read-write ktxMemStream.">ktxMemStream_construct()</a> and a pointer to this memory should be retrieved using <a class="el" href="#a3f9cc251a3604f80da67440efff21b6d" title="Get a pointer to a ktxMemStream&#39;s data.">ktxMemStream_getdata()</a> before calling this function.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a899a1878ad93c797c8c2d9aacffc6365" title="Initialize a read-write ktxMemStream.">ktxMemStream_construct</a>, <a class="el" href="#a3f9cc251a3604f80da67440efff21b6d" title="Get a pointer to a ktxMemStream&#39;s data.">ktxMemStream_getdata</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>pointer to the <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> whose memory is to be freed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3f9cc251a3604f80da67440efff21b6d" name="a3f9cc251a3604f80da67440efff21b6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f9cc251a3604f80da67440efff21b6d">&#9670;&#160;</a></span>ktxMemStream_getdata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxMemStream_getdata </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>str</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ktx_uint8_t **</td> <td class="paramname"><span class="paramname"><em>ppBytes</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to a ktxMemStream's data. </p>
<p>Gets a pointer to data that has been written to the stream. Returned pointer will be 0 if stream is read-only.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>pointer to the <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> whose data pointer is to be queried. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppBytes</td><td>pointer to a variable in which the data pointer will be written.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values on error.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">str</code> or <code class="param">ppBytes</code> is <code>NULL</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>lib</b></li><li class="navelem"><a href="memstream_8c.html">memstream.c</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for libktx Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink