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

401 lines
19 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: ktxStream Struct 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('structktxStream.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">ktxStream Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Interface of <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a>.
<a href="#details">More...</a></p>
<p><code>#include &lt;ktx.h&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ktxStream:</div>
<div class="dyncontent">
<div class="center"><img src="structktxStream__coll__graph.png" border="0" usemap="#aktxStream_coll__map" loading="lazy" alt="Collaboration graph"/></div>
<map name="aktxStream_coll__map" id="aktxStream_coll__map">
<area shape="rect" title="Interface of ktxStream." alt="" coords="5,167,87,193"/>
<area shape="poly" title=" " alt="" coords="75,158,89,156,101,160,110,168,113,180,108,195,95,203,78,203,62,197,62,191,79,198,94,197,104,192,108,180,105,170,99,164,89,162,77,163"/>
<area shape="rect" title=" " alt="" coords="12,5,80,32"/>
<area shape="poly" title=" " alt="" coords="48,46,49,166,43,166,44,49"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a723def611194cfe6570ae5b94bdee904" id="r_a723def611194cfe6570ae5b94bdee904"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a6beb14c7c8e74de38847b6a5d9ebd171">ktxStream_read</a>&#160;</td><td class="memItemRight"><a class="el" href="#a723def611194cfe6570ae5b94bdee904">read</a></td></tr>
<tr class="memitem:ad224d1f8e4291a2e66e090b3c6df3698" id="r_ad224d1f8e4291a2e66e090b3c6df3698"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a0890fb8e1623b63c86883d50a0d841aa">ktxStream_skip</a>&#160;</td><td class="memItemRight"><a class="el" href="#ad224d1f8e4291a2e66e090b3c6df3698">skip</a></td></tr>
<tr class="memitem:ae6018760261edc9387c2123395a1447a" id="r_ae6018760261edc9387c2123395a1447a"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a3d5d2a3a413c5e549dedc54873afc668">ktxStream_write</a>&#160;</td><td class="memItemRight"><a class="el" href="#ae6018760261edc9387c2123395a1447a">write</a></td></tr>
<tr class="memitem:adcabf99e783fe9ca551ac9706372400c" id="r_adcabf99e783fe9ca551ac9706372400c"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a2eacbb95ed30f1e9ae81fd6d121fd16e">ktxStream_getpos</a>&#160;</td><td class="memItemRight"><a class="el" href="#adcabf99e783fe9ca551ac9706372400c">getpos</a></td></tr>
<tr class="memitem:aba03500510363a0b45025645ba4327cf" id="r_aba03500510363a0b45025645ba4327cf"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ae2022617df68fe4041c707e1693370d1">ktxStream_setpos</a>&#160;</td><td class="memItemRight"><a class="el" href="#aba03500510363a0b45025645ba4327cf">setpos</a></td></tr>
<tr class="memitem:a76bd679ca3d583cc56c524e53665e775" id="r_a76bd679ca3d583cc56c524e53665e775"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a261dbe3b2c1ba0d35a1bf76ad9a98ba0">ktxStream_getsize</a>&#160;</td><td class="memItemRight"><a class="el" href="#a76bd679ca3d583cc56c524e53665e775">getsize</a></td></tr>
<tr class="memitem:a1215c8b33ba64ba53bd86134ae80c1d6" id="r_a1215c8b33ba64ba53bd86134ae80c1d6"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ab703620f9a5c5911d6013debf72393d6">ktxStream_destruct</a>&#160;</td><td class="memItemRight"><a class="el" href="#a1215c8b33ba64ba53bd86134ae80c1d6">destruct</a></td></tr>
<tr class="memitem:"><td class="memItemLeft anon">union {&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:a702945180aa732857b380a007a7e2a21" id="r_a702945180aa732857b380a007a7e2a21"><td class="memItemLeft anon">&#160;&#160;&#160;FILE *&#160;&#160;&#160;<a class="el" href="#a702945180aa732857b380a007a7e2a21">file</a>&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:a2f3b4c3238e6625fb92d53b1c62389cb" id="r_a2f3b4c3238e6625fb92d53b1c62389cb"><td class="memItemLeft anon">&#160;&#160;&#160;ktxMem *&#160;&#160;&#160;<a class="el" href="#a2f3b4c3238e6625fb92d53b1c62389cb">mem</a>&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:"><td class="memItemLeft anon">&#160;&#160;&#160;struct {&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:ab96816d317aa5196e2ef198d9a8d621b" id="r_ab96816d317aa5196e2ef198d9a8d621b"><td class="memItemLeft anon">&#160;&#160;&#160;&#160;&#160;&#160;void *&#160;&#160;&#160;<a class="el" href="#ab96816d317aa5196e2ef198d9a8d621b">address</a>&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:a6de39e2650d144d37e3f2c32081dd55f" id="r_a6de39e2650d144d37e3f2c32081dd55f"><td class="memItemLeft anon">&#160;&#160;&#160;&#160;&#160;&#160;void *&#160;&#160;&#160;<a class="el" href="#a6de39e2650d144d37e3f2c32081dd55f">allocatorAddress</a>&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:ab3d4a868dd03d0fa92cdb5e5fd99ba50" id="r_ab3d4a868dd03d0fa92cdb5e5fd99ba50"><td class="memItemLeft anon">&#160;&#160;&#160;&#160;&#160;&#160;ktx_size_t&#160;&#160;&#160;<a class="el" href="#ab3d4a868dd03d0fa92cdb5e5fd99ba50">size</a>&#160;</td><td class="memItemRight"></td></tr>
<tr class="memitem:a26a82a7cdf288fc1a7e2b77ecb9d1d38" id="r_a26a82a7cdf288fc1a7e2b77ecb9d1d38"><td class="memItemLeft anonEnd">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="#a26a82a7cdf288fc1a7e2b77ecb9d1d38">custom_ptr</a></td></tr>
<tr class="memitem:a01015dd5ef6b90112358effdee79a6bc" id="r_a01015dd5ef6b90112358effdee79a6bc"><td class="memItemLeft anonEnd">}&#160;</td><td class="memItemRight"><a class="el" href="#a01015dd5ef6b90112358effdee79a6bc">data</a></td></tr>
<tr class="memitem:a9d2fb0a8f4454c78013c49b914c603b6" id="r_a9d2fb0a8f4454c78013c49b914c603b6"><td class="memItemLeft">ktx_off_t&#160;</td><td class="memItemRight"><a class="el" href="#a9d2fb0a8f4454c78013c49b914c603b6">readpos</a></td></tr>
<tr class="memitem:abac8ddd51b8b30aee6c98a1ab2adef13" id="r_abac8ddd51b8b30aee6c98a1ab2adef13"><td class="memItemLeft">ktx_bool_t&#160;</td><td class="memItemRight"><a class="el" href="#abac8ddd51b8b30aee6c98a1ab2adef13">closeOnDestruct</a></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface of <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a>. </p>
<dl class="section author"><dt>Author</dt><dd>Maksim Kolesin </dd>
<dd>
Georg Kolling, Imagination Technology </dd>
<dd>
Mark Callow, HI Corporation </dd></dl>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="ab96816d317aa5196e2ef198d9a8d621b" name="ab96816d317aa5196e2ef198d9a8d621b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab96816d317aa5196e2ef198d9a8d621b">&#9670;&#160;</a></span>address</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* address</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to the data. </p>
</div>
</div>
<a id="a6de39e2650d144d37e3f2c32081dd55f" name="a6de39e2650d144d37e3f2c32081dd55f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6de39e2650d144d37e3f2c32081dd55f">&#9670;&#160;</a></span>allocatorAddress</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* allocatorAddress</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to a memory allocator. </p>
</div>
</div>
<a id="abac8ddd51b8b30aee6c98a1ab2adef13" name="abac8ddd51b8b30aee6c98a1ab2adef13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abac8ddd51b8b30aee6c98a1ab2adef13">&#9670;&#160;</a></span>closeOnDestruct</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ktx_bool_t closeOnDestruct</td>
</tr>
</table>
</div><div class="memdoc">
<p>Close FILE* or dispose of memory on destruct. </p>
</div>
</div>
<a id="a26a82a7cdf288fc1a7e2b77ecb9d1d38" name="a26a82a7cdf288fc1a7e2b77ecb9d1d38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26a82a7cdf288fc1a7e2b77ecb9d1d38">&#9670;&#160;</a></span>[struct]</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } custom_ptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to a struct for custom streams. </p>
</div>
</div>
<a id="a01015dd5ef6b90112358effdee79a6bc" name="a01015dd5ef6b90112358effdee79a6bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01015dd5ef6b90112358effdee79a6bc">&#9670;&#160;</a></span>[union]</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } data</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to the stream data. </p>
</div>
</div>
<a id="a1215c8b33ba64ba53bd86134ae80c1d6" name="a1215c8b33ba64ba53bd86134ae80c1d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1215c8b33ba64ba53bd86134ae80c1d6">&#9670;&#160;</a></span>destruct</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ab703620f9a5c5911d6013debf72393d6">ktxStream_destruct</a> destruct</td>
</tr>
</table>
</div><div class="memdoc">
<p>destruct the stream. </p>
</div>
</div>
<a id="a702945180aa732857b380a007a7e2a21" name="a702945180aa732857b380a007a7e2a21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a702945180aa732857b380a007a7e2a21">&#9670;&#160;</a></span>file</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FILE* file</td>
</tr>
</table>
</div><div class="memdoc">
<p>a stdio FILE pointer for a ktxFileStream. </p>
</div>
</div>
<a id="adcabf99e783fe9ca551ac9706372400c" name="adcabf99e783fe9ca551ac9706372400c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcabf99e783fe9ca551ac9706372400c">&#9670;&#160;</a></span>getpos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#a2eacbb95ed30f1e9ae81fd6d121fd16e">ktxStream_getpos</a> getpos</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for getting current position in stream. </p>
</div>
</div>
<a id="a76bd679ca3d583cc56c524e53665e775" name="a76bd679ca3d583cc56c524e53665e775"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76bd679ca3d583cc56c524e53665e775">&#9670;&#160;</a></span>getsize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#a261dbe3b2c1ba0d35a1bf76ad9a98ba0">ktxStream_getsize</a> getsize</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for querying size. </p>
</div>
</div>
<a id="a2f3b4c3238e6625fb92d53b1c62389cb" name="a2f3b4c3238e6625fb92d53b1c62389cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f3b4c3238e6625fb92d53b1c62389cb">&#9670;&#160;</a></span>mem</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ktxMem* mem</td>
</tr>
</table>
</div><div class="memdoc">
<p>a pointer to a ktxMem struct for a ktxMemStream. </p>
</div>
</div>
<a id="a723def611194cfe6570ae5b94bdee904" name="a723def611194cfe6570ae5b94bdee904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a723def611194cfe6570ae5b94bdee904">&#9670;&#160;</a></span>read</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#a6beb14c7c8e74de38847b6a5d9ebd171">ktxStream_read</a> read</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for reading bytes. </p>
</div>
</div>
<a id="a9d2fb0a8f4454c78013c49b914c603b6" name="a9d2fb0a8f4454c78013c49b914c603b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d2fb0a8f4454c78013c49b914c603b6">&#9670;&#160;</a></span>readpos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ktx_off_t readpos</td>
</tr>
</table>
</div><div class="memdoc">
<p>used by FileStream for stdin. </p>
</div>
</div>
<a id="aba03500510363a0b45025645ba4327cf" name="aba03500510363a0b45025645ba4327cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba03500510363a0b45025645ba4327cf">&#9670;&#160;</a></span>setpos</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ae2022617df68fe4041c707e1693370d1">ktxStream_setpos</a> setpos</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for setting current position in stream. </p>
</div>
</div>
<a id="ab3d4a868dd03d0fa92cdb5e5fd99ba50" name="ab3d4a868dd03d0fa92cdb5e5fd99ba50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3d4a868dd03d0fa92cdb5e5fd99ba50">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ktx_size_t size</td>
</tr>
</table>
</div><div class="memdoc">
<p>size of the data. </p>
</div>
</div>
<a id="ad224d1f8e4291a2e66e090b3c6df3698" name="ad224d1f8e4291a2e66e090b3c6df3698"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad224d1f8e4291a2e66e090b3c6df3698">&#9670;&#160;</a></span>skip</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#a0890fb8e1623b63c86883d50a0d841aa">ktxStream_skip</a> skip</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for skipping bytes. </p>
</div>
</div>
<a id="ae6018760261edc9387c2123395a1447a" name="ae6018760261edc9387c2123395a1447a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6018760261edc9387c2123395a1447a">&#9670;&#160;</a></span>write</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#a3d5d2a3a413c5e549dedc54873afc668">ktxStream_write</a> write</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to function for writing bytes. </p>
</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"><a href="structktxStream.html">ktxStream</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