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

267 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/strings.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('strings_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">strings.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Functions to return a string corresponding to various enumerations.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="ktx_8h.html">ktx.h</a>&quot;</code><br />
<code>#include &quot;basis_sgd.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for strings.c:</div>
<div class="dyncontent">
<div class="center"><img src="strings_8c__incl.png" border="0" usemap="#alib_2strings_8c" loading="lazy" alt=""/></div>
<map name="alib_2strings_8c" id="alib_2strings_8c">
<area shape="rect" title="Functions to return a string corresponding to various enumerations." alt="" coords="217,5,305,32"/>
<area shape="rect" href="ktx_8h.html" title="Declares the public functions and structures of the KTX API." alt="" coords="189,80,240,107"/>
<area shape="poly" title=" " alt="" coords="255,31,232,69,229,65,251,34"/>
<area shape="rect" title=" " alt="" coords="263,80,355,107"/>
<area shape="poly" title=" " alt="" coords="270,30,295,67,290,67,268,35"/>
<area shape="rect" title=" " alt="" coords="5,155,69,181"/>
<area shape="poly" title=" " alt="" coords="189,108,83,151,81,146,188,103"/>
<area shape="rect" title=" " alt="" coords="92,155,152,181"/>
<area shape="poly" title=" " alt="" coords="201,106,151,147,149,143,196,108"/>
<area shape="rect" title=" " alt="" coords="177,155,252,181"/>
<area shape="poly" title=" " alt="" coords="216,105,217,140,212,138,212,109"/>
<area shape="rect" title=" " alt="" coords="275,155,364,181"/>
<area shape="poly" title=" " alt="" coords="233,105,291,146,286,146,232,110"/>
<area shape="rect" title=" " alt="" coords="389,155,453,181"/>
<area shape="poly" title=" " alt="" coords="241,101,377,150,371,151,240,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:a252d7741a00562fbe2fd9d91d54d873b" id="r_a252d7741a00562fbe2fd9d91d54d873b"><td class="memItemLeft">const char *&#160;</td><td class="memItemRight"><a class="el" href="#a252d7741a00562fbe2fd9d91d54d873b">ktxErrorString</a> (<a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> error)</td></tr>
<tr class="memdesc:a252d7741a00562fbe2fd9d91d54d873b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string corresponding to a KTX error code. <br /></td></tr>
<tr class="memitem:a25b70a70161c149687d0ca19fc839b81" id="r_a25b70a70161c149687d0ca19fc839b81"><td class="memItemLeft">const char *&#160;</td><td class="memItemRight"><a class="el" href="#a25b70a70161c149687d0ca19fc839b81">ktxTranscodeFormatString</a> (<a class="el" href="ktx_8h.html#a30cc58c576392303d9a5a54b57ef29b5">ktx_transcode_fmt_e</a> format)</td></tr>
<tr class="memdesc:a25b70a70161c149687d0ca19fc839b81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string corresponding to a transcode format enumeration. <br /></td></tr>
<tr class="memitem:a68c7368105d35f01b54573f22ecbe5fb" id="r_a68c7368105d35f01b54573f22ecbe5fb"><td class="memItemLeft">const char *&#160;</td><td class="memItemRight"><a class="el" href="#a68c7368105d35f01b54573f22ecbe5fb">ktxSupercompressionSchemeString</a> (<a class="el" href="ktx_8h.html#a011cf6c6de4e1acd2307ec7d24ee5daa">ktxSupercmpScheme</a> scheme)</td></tr>
<tr class="memdesc:a68c7368105d35f01b54573f22ecbe5fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string corresponding to a supercompressionScheme enumeration. <br /></td></tr>
<tr class="memitem:aa9077e4635ae86d84ec8bcb025d6b373" id="r_aa9077e4635ae86d84ec8bcb025d6b373"><td class="memItemLeft">const char *&#160;</td><td class="memItemRight"><a class="el" href="#aa9077e4635ae86d84ec8bcb025d6b373">ktxBUImageFlagsBitString</a> (ktx_uint32_t bit_index, bool bit_value)</td></tr>
<tr class="memdesc:aa9077e4635ae86d84ec8bcb025d6b373"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string corresponding to a bu_image_flags bit. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions to return a string corresponding to various enumerations. </p>
<dl class="section author"><dt>Author</dt><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="aa9077e4635ae86d84ec8bcb025d6b373" name="aa9077e4635ae86d84ec8bcb025d6b373"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9077e4635ae86d84ec8bcb025d6b373">&#9670;&#160;</a></span>ktxBUImageFlagsBitString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ktxBUImageFlagsBitString </td>
<td>(</td>
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>bit_index</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>bit_value</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string corresponding to a bu_image_flags bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bit_index</td><td>the bu_image_flag bit to test. </td></tr>
<tr><td class="paramname">bit_value</td><td>the bu_image_flag bit value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the message string or NULL otherwise. </dd></dl>
</div>
</div>
<a id="a252d7741a00562fbe2fd9d91d54d873b" name="a252d7741a00562fbe2fd9d91d54d873b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a252d7741a00562fbe2fd9d91d54d873b">&#9670;&#160;</a></span>ktxErrorString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ktxErrorString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a></td> <td class="paramname"><span class="paramname"><em>error</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string corresponding to a KTX error code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>the error code for which to return a string</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the message string. </dd></dl>
</div>
</div>
<a id="a68c7368105d35f01b54573f22ecbe5fb" name="a68c7368105d35f01b54573f22ecbe5fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68c7368105d35f01b54573f22ecbe5fb">&#9670;&#160;</a></span>ktxSupercompressionSchemeString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ktxSupercompressionSchemeString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ktx_8h.html#a011cf6c6de4e1acd2307ec7d24ee5daa">ktxSupercmpScheme</a></td> <td class="paramname"><span class="paramname"><em>scheme</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string corresponding to a supercompressionScheme enumeration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scheme</td><td>the supercompression scheme for which to return a string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the message string. </dd></dl>
</div>
</div>
<a id="a25b70a70161c149687d0ca19fc839b81" name="a25b70a70161c149687d0ca19fc839b81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b70a70161c149687d0ca19fc839b81">&#9670;&#160;</a></span>ktxTranscodeFormatString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ktxTranscodeFormatString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="ktx_8h.html#a30cc58c576392303d9a5a54b57ef29b5">ktx_transcode_fmt_e</a></td> <td class="paramname"><span class="paramname"><em>format</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string corresponding to a transcode format enumeration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">format</td><td>the transcode format for which to return a string.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the message string. </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="strings_8c.html">strings.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