322 lines
14 KiB
HTML
322 lines
14 KiB
HTML
<!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: ktxTextureCreateInfo 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"> 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('structktxTextureCreateInfo.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">ktxTextureCreateInfo Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create().
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <ktx.h></code></p>
|
|
<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:a1318d73f800ff61d045b740331939596" id="r_a1318d73f800ff61d045b740331939596"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a1318d73f800ff61d045b740331939596">glInternalformat</a></td></tr>
|
|
<tr class="memitem:abc50403eebde1f027704eadc05d304c7" id="r_abc50403eebde1f027704eadc05d304c7"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#abc50403eebde1f027704eadc05d304c7">vkFormat</a></td></tr>
|
|
<tr class="memitem:a4bdd6bd9ddee632131ab2e371ea9d66e" id="r_a4bdd6bd9ddee632131ab2e371ea9d66e"><td class="memItemLeft">ktx_uint32_t * </td><td class="memItemRight"><a class="el" href="#a4bdd6bd9ddee632131ab2e371ea9d66e">pDfd</a></td></tr>
|
|
<tr class="memitem:a3fa51cc9001702e3f1d5a69cee65adf8" id="r_a3fa51cc9001702e3f1d5a69cee65adf8"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a3fa51cc9001702e3f1d5a69cee65adf8">baseWidth</a></td></tr>
|
|
<tr class="memitem:afe7371a26104de3e131e82cf5cc39e9c" id="r_afe7371a26104de3e131e82cf5cc39e9c"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#afe7371a26104de3e131e82cf5cc39e9c">baseHeight</a></td></tr>
|
|
<tr class="memitem:a71d7762f2b0dd61d57c0a7ec31ee46ac" id="r_a71d7762f2b0dd61d57c0a7ec31ee46ac"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a71d7762f2b0dd61d57c0a7ec31ee46ac">baseDepth</a></td></tr>
|
|
<tr class="memitem:a3c48573960eb90b1e38cc70457d2cda1" id="r_a3c48573960eb90b1e38cc70457d2cda1"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a3c48573960eb90b1e38cc70457d2cda1">numDimensions</a></td></tr>
|
|
<tr class="memitem:a782126a62c27ee8660a14565b906694c" id="r_a782126a62c27ee8660a14565b906694c"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a782126a62c27ee8660a14565b906694c">numLevels</a></td></tr>
|
|
<tr class="memitem:ae1412e2bd82ef1baa7cb1479735d9c86" id="r_ae1412e2bd82ef1baa7cb1479735d9c86"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#ae1412e2bd82ef1baa7cb1479735d9c86">numLayers</a></td></tr>
|
|
<tr class="memitem:a3a4bc2fa2e41bcec0bdb265505af0068" id="r_a3a4bc2fa2e41bcec0bdb265505af0068"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="#a3a4bc2fa2e41bcec0bdb265505af0068">numFaces</a></td></tr>
|
|
<tr class="memitem:a9b5ca8c2e3fd76d8b427928775289078" id="r_a9b5ca8c2e3fd76d8b427928775289078"><td class="memItemLeft">ktx_bool_t </td><td class="memItemRight"><a class="el" href="#a9b5ca8c2e3fd76d8b427928775289078">isArray</a></td></tr>
|
|
<tr class="memitem:a9c26601222e6a037f7dbae7b61b18fd0" id="r_a9c26601222e6a037f7dbae7b61b18fd0"><td class="memItemLeft">ktx_bool_t </td><td class="memItemRight"><a class="el" href="#a9c26601222e6a037f7dbae7b61b18fd0">generateMipmaps</a></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create(). </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__writer.html#ga9ad46bface6dab07a35579c0635877d3" title="ktxTexture1_Create()">ktxTexture1_Create()</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__writer.html#gaa8e29216921eadd3c09c3a76bc286acd" title="ktxTexture2_Create()">ktxTexture2_Create()</a> </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="a71d7762f2b0dd61d57c0a7ec31ee46ac" name="a71d7762f2b0dd61d57c0a7ec31ee46ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a71d7762f2b0dd61d57c0a7ec31ee46ac">◆ </a></span>baseDepth</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t baseDepth</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Depth of the base level of the texture. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afe7371a26104de3e131e82cf5cc39e9c" name="afe7371a26104de3e131e82cf5cc39e9c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe7371a26104de3e131e82cf5cc39e9c">◆ </a></span>baseHeight</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t baseHeight</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Height of the base level of the texture. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3fa51cc9001702e3f1d5a69cee65adf8" name="a3fa51cc9001702e3f1d5a69cee65adf8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fa51cc9001702e3f1d5a69cee65adf8">◆ </a></span>baseWidth</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t baseWidth</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Width of the base level of the texture. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c26601222e6a037f7dbae7b61b18fd0" name="a9c26601222e6a037f7dbae7b61b18fd0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c26601222e6a037f7dbae7b61b18fd0">◆ </a></span>generateMipmaps</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_bool_t generateMipmaps</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set to KTX_TRUE if mipmaps should be generated for the texture when loading into a 3D API. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1318d73f800ff61d045b740331939596" name="a1318d73f800ff61d045b740331939596"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1318d73f800ff61d045b740331939596">◆ </a></span>glInternalformat</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t glInternalformat</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Internal format for the texture, e.g., GL_RGB8. Ignored when creating a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b5ca8c2e3fd76d8b427928775289078" name="a9b5ca8c2e3fd76d8b427928775289078"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b5ca8c2e3fd76d8b427928775289078">◆ </a></span>isArray</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_bool_t isArray</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set to KTX_TRUE if the texture is to be an array texture. Means OpenGL will use a GL_TEXTURE_*_ARRAY target. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c48573960eb90b1e38cc70457d2cda1" name="a3c48573960eb90b1e38cc70457d2cda1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c48573960eb90b1e38cc70457d2cda1">◆ </a></span>numDimensions</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t numDimensions</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Number of dimensions in the texture, 1, 2 or 3. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a4bc2fa2e41bcec0bdb265505af0068" name="a3a4bc2fa2e41bcec0bdb265505af0068"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a4bc2fa2e41bcec0bdb265505af0068">◆ </a></span>numFaces</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t numFaces</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Number of faces: 6 for cube maps, 1 otherwise. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1412e2bd82ef1baa7cb1479735d9c86" name="ae1412e2bd82ef1baa7cb1479735d9c86"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1412e2bd82ef1baa7cb1479735d9c86">◆ </a></span>numLayers</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t numLayers</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Number of array layers in the texture. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a782126a62c27ee8660a14565b906694c" name="a782126a62c27ee8660a14565b906694c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a782126a62c27ee8660a14565b906694c">◆ </a></span>numLevels</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t numLevels</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Number of mip levels in the texture. Should be 1 if <code>generateMipmaps</code> is KTX_TRUE; </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4bdd6bd9ddee632131ab2e371ea9d66e" name="a4bdd6bd9ddee632131ab2e371ea9d66e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bdd6bd9ddee632131ab2e371ea9d66e">◆ </a></span>pDfd</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t* pDfd</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Pointer to DFD. Used only when creating a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> and only if vkFormat is VK_FORMAT_UNDEFINED. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc50403eebde1f027704eadc05d304c7" name="abc50403eebde1f027704eadc05d304c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc50403eebde1f027704eadc05d304c7">◆ </a></span>vkFormat</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ktx_uint32_t vkFormat</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>VkFormat for texture. Ignored when creating a <a class="el" href="structktxTexture1.html" title="Class representing a KTX version 1 format texture.">ktxTexture1</a>. </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="structktxTextureCreateInfo.html">ktxTextureCreateInfo</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>
|