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/filestream_8c.html
T
abdelrahman 13fa90a0e9 Add ktx
2026-06-14 19:09:18 +01:00

252 lines
13 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/filestream.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('filestream_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">filestream.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 FILE.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;assert.h&gt;</code><br />
<code>#include &lt;errno.h&gt;</code><br />
<code>#include &lt;inttypes.h&gt;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;sys/types.h&gt;</code><br />
<code>#include &lt;sys/stat.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;filestream.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for filestream.c:</div>
<div class="dyncontent">
<div class="center"><img src="filestream_8c__incl.png" border="0" usemap="#alib_2filestream_8c" loading="lazy" alt=""/></div>
<map name="alib_2filestream_8c" id="alib_2filestream_8c">
<area shape="rect" title="Implementation of ktxStream for FILE." alt="" coords="385,5,491,32"/>
<area shape="rect" title=" " alt="" coords="5,80,74,107"/>
<area shape="poly" title=" " alt="" coords="382,29,255,51,90,82,88,77,254,46,387,27"/>
<area shape="rect" title=" " alt="" coords="98,80,160,107"/>
<area shape="poly" title=" " alt="" coords="383,34,175,82,174,77,385,29"/>
<area shape="rect" title=" " alt="" coords="183,80,261,107"/>
<area shape="poly" title=" " alt="" coords="398,34,275,77,273,72,403,32"/>
<area shape="rect" title=" " alt="" coords="286,80,350,107"/>
<area shape="poly" title=" " alt="" coords="420,32,353,74,351,69,415,34"/>
<area shape="rect" title=" " alt="" coords="309,155,370,181"/>
<area shape="poly" title=" " alt="" coords="432,32,358,144,355,140,427,33"/>
<area shape="rect" title=" " alt="" coords="550,80,614,107"/>
<area shape="poly" title=" " alt="" coords="464,30,546,73,541,73,463,35"/>
<area shape="rect" title=" " alt="" coords="394,155,483,181"/>
<area shape="poly" title=" " alt="" coords="440,31,440,140,436,138,436,34"/>
<area shape="rect" title=" " alt="" coords="638,80,718,107"/>
<area shape="poly" title=" " alt="" coords="480,30,626,75,621,76,480,35"/>
<area shape="rect" href="ktx_8h.html" title="Declares the public functions and structures of the KTX API." alt="" coords="476,80,526,107"/>
<area shape="poly" title=" " alt="" coords="450,30,483,69,477,68,448,35"/>
<area shape="rect" title=" " alt="" coords="742,80,806,107"/>
<area shape="poly" title=" " alt="" coords="492,27,729,79,724,80,491,33"/>
<area shape="rect" title=" " alt="" coords="831,80,920,107"/>
<area shape="poly" title=" " alt="" coords="492,25,818,79,813,81,492,30"/>
<area shape="poly" title=" " alt="" coords="478,106,382,151,381,145,473,107"/>
<area shape="poly" title=" " alt="" coords="492,106,460,145,458,141,487,108"/>
<area shape="rect" title=" " alt="" coords="506,155,570,181"/>
<area shape="poly" title=" " alt="" coords="509,105,527,142,522,140,506,109"/>
<area shape="rect" title=" " alt="" coords="594,155,669,181"/>
<area shape="poly" title=" " alt="" coords="524,105,598,147,593,146,523,110"/>
<area shape="rect" title=" " alt="" coords="693,155,757,181"/>
<area shape="poly" title=" " alt="" coords="527,100,681,152,675,152,526,106"/>
</map>
</div>
</div><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:a217a544c241e80216315a50883190519" id="r_a217a544c241e80216315a50883190519"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a217a544c241e80216315a50883190519">ktxFileStream_construct</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str, FILE *file, ktx_bool_t closeFileOnDestruct)</td></tr>
<tr class="memdesc:a217a544c241e80216315a50883190519"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize a ktxFileStream. <br /></td></tr>
<tr class="memitem:adc6cf29b8543378ffae60e6eaa77c7fc" id="r_adc6cf29b8543378ffae60e6eaa77c7fc"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#adc6cf29b8543378ffae60e6eaa77c7fc">ktxFileStream_destruct</a> (<a class="el" href="structktxStream.html">ktxStream</a> *str)</td></tr>
<tr class="memdesc:adc6cf29b8543378ffae60e6eaa77c7fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destruct the stream, potentially closing the underlying FILE. <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 FILE. </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="a217a544c241e80216315a50883190519" name="a217a544c241e80216315a50883190519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a217a544c241e80216315a50883190519">&#9670;&#160;</a></span>ktxFileStream_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> ktxFileStream_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">FILE *</td> <td class="paramname"><span class="paramname"><em>file</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>closeFileOnDestruct</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a ktxFileStream. </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> to initialize. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>pointer to the underlying FILE object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">closeFileOnDestruct</td><td>if not false, stdio file pointer will be closed when <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> is destructed.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, KTX_INVALID_VALUE 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">stream</code> is <code>NULL</code> or <code class="param">file</code> is <code>NULL</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adc6cf29b8543378ffae60e6eaa77c7fc" name="adc6cf29b8543378ffae60e6eaa77c7fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6cf29b8543378ffae60e6eaa77c7fc">&#9670;&#160;</a></span>ktxFileStream_destruct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxFileStream_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>Destruct the stream, potentially closing the underlying FILE. </p>
<p>This only closes the underyling FILE if the <code>closeOnDestruct</code> parameter to <a class="el" href="#a217a544c241e80216315a50883190519" title="Initialize a ktxFileStream.">ktxFileStream_construct()</a> was not <code>KTX_FALSE</code>.</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 FILE is to potentially be closed. </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="filestream_8c.html">filestream.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