253 lines
38 KiB
HTML
253 lines
38 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: ktxTexture2 Class 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('structktxTexture2.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">ktxTexture2 Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class representing a KTX version 2 format texture.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <ktx.h></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ktxTexture2:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="structktxTexture2__coll__graph.png" border="0" usemap="#aktxTexture2_coll__map" loading="lazy" alt="Collaboration graph"/></div>
|
|
<map name="aktxTexture2_coll__map" id="aktxTexture2_coll__map">
|
|
<area shape="rect" title="Class representing a KTX version 2 format texture." alt="" coords="88,317,177,344"/>
|
|
<area shape="rect" href="structktxTexture__vtbl.html" title="Table of virtual ktxTexture methods." alt="" coords="273,5,384,32"/>
|
|
<area shape="poly" title=" " alt="" coords="299,40,289,57,274,90,269,121,272,179,274,207,271,236,262,265,241,295,212,316,178,327,177,322,210,311,237,291,257,263,266,235,268,207,266,179,263,121,269,89,284,55,295,44"/>
|
|
<area shape="rect" href="structktxTexture.html" title="Base class representing a texture." alt="" coords="287,317,370,344"/>
|
|
<area shape="poly" title=" " alt="" coords="327,45,328,56,324,175,328,293,329,318,325,315,322,293,318,175,322,56,324,50"/>
|
|
<area shape="poly" title=" " alt="" coords="351,303,357,292,377,228,384,175,377,121,357,57,343,35,344,30,362,55,382,120,389,175,382,229,362,294,354,307"/>
|
|
<area shape="rect" title=" " alt="" coords="46,5,155,32"/>
|
|
<area shape="poly" title=" " alt="" coords="58,44,49,57,19,121,12,149,8,177,10,204,17,231,30,261,48,292,66,308,90,321,85,322,63,313,44,295,25,263,12,233,5,205,3,177,6,148,14,119,44,55,60,39"/>
|
|
<area shape="poly" title=" " alt="" coords="121,42,130,55,135,78,137,108,137,178,139,246,145,273,155,291,176,304,210,313,289,326,284,327,209,318,174,309,151,295,140,275,134,247,131,179,132,108,130,79,125,57,121,47"/>
|
|
</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-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:gaf08421ae0893a9e9205d3e84fad66bd8" id="r_gaf08421ae0893a9e9205d3e84fad66bd8"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gaf08421ae0893a9e9205d3e84fad66bd8">ktxTexture2_CompressAstcEx</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxAstcParams.html">ktxAstcParams</a> *params)</td></tr>
|
|
<tr class="memdesc:gaf08421ae0893a9e9205d3e84fad66bd8"><td class="mdescLeft"> </td><td class="mdescRight">Encode and compress a ktx texture with uncompressed images to astc. <br /></td></tr>
|
|
<tr class="memitem:ga00b153dbfa1fe115c7d4322dbe07f172" id="r_ga00b153dbfa1fe115c7d4322dbe07f172"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga00b153dbfa1fe115c7d4322dbe07f172">ktxTexture2_CompressAstc</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t quality)</td></tr>
|
|
<tr class="memdesc:ga00b153dbfa1fe115c7d4322dbe07f172"><td class="mdescLeft"> </td><td class="mdescRight">Encode and compress a ktx texture with uncompressed images to astc. <br /></td></tr>
|
|
<tr class="memitem:ga0e75755e3cc69964e57363dad82ffd77" id="r_ga0e75755e3cc69964e57363dad82ffd77"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga0e75755e3cc69964e57363dad82ffd77">ktxTexture2_CompressBasisEx</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxBasisParams.html">ktxBasisParams</a> *params)</td></tr>
|
|
<tr class="memdesc:ga0e75755e3cc69964e57363dad82ffd77"><td class="mdescLeft"> </td><td class="mdescRight">Encode and possibly Supercompress a KTX2 texture with uncompressed images. <br /></td></tr>
|
|
<tr class="memitem:ga405c44d6daf8ddf83dc805810bf4f989" id="r_ga405c44d6daf8ddf83dc805810bf4f989"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga405c44d6daf8ddf83dc805810bf4f989">ktxTexture2_CompressBasis</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t quality)</td></tr>
|
|
<tr class="memdesc:ga405c44d6daf8ddf83dc805810bf4f989"><td class="mdescLeft"> </td><td class="mdescRight">Supercompress a KTX2 texture with uncompressed images. <br /></td></tr>
|
|
<tr class="memitem:ga90cc33928a2dae962fb94b3fa2f6575d" id="r_ga90cc33928a2dae962fb94b3fa2f6575d"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga90cc33928a2dae962fb94b3fa2f6575d">ktxTexture2_TranscodeBasis</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="ktx_8h.html#a30cc58c576392303d9a5a54b57ef29b5">ktx_transcode_fmt_e</a> outputFormat, ktx_transcode_flags transcodeFlags)</td></tr>
|
|
<tr class="memdesc:ga90cc33928a2dae962fb94b3fa2f6575d"><td class="mdescLeft"> </td><td class="mdescRight">Transcode a KTX2 texture with BasisLZ/ETC1S or UASTC images. <br /></td></tr>
|
|
<tr class="memitem:ga7624860df8e44573862fa5754ea2976c" id="r_ga7624860df8e44573862fa5754ea2976c"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__ktx__glloader.html#ga7624860df8e44573862fa5754ea2976c">ktxTexture2_GLUpload</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, GLuint *pTexture, GLenum *pTarget, GLenum *pGlerror)</td></tr>
|
|
<tr class="memdesc:ga7624860df8e44573862fa5754ea2976c"><td class="mdescLeft"> </td><td class="mdescRight">Create a GL texture object from a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:gaa8e29216921eadd3c09c3a76bc286acd" id="r_gaa8e29216921eadd3c09c3a76bc286acd"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gaa8e29216921eadd3c09c3a76bc286acd">ktxTexture2_Create</a> (const <a class="el" href="structktxTextureCreateInfo.html">ktxTextureCreateInfo</a> *const createInfo, ktxTextureCreateStorageEnum storageAllocation, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:gaa8e29216921eadd3c09c3a76bc286acd"><td class="mdescLeft"> </td><td class="mdescRight">Create a new empty <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>. <br /></td></tr>
|
|
<tr class="memitem:ga5fcfdc3d237419ab65287639e1f4aeb1" id="r_ga5fcfdc3d237419ab65287639e1f4aeb1"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga5fcfdc3d237419ab65287639e1f4aeb1">ktxTexture2_CreateCopy</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *orig, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:ga5fcfdc3d237419ab65287639e1f4aeb1"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> by making a copy of a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>. <br /></td></tr>
|
|
<tr class="memitem:gae9de7e23ffe3ae3aeed4cc95c61699e4" id="r_gae9de7e23ffe3ae3aeed4cc95c61699e4"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#gae9de7e23ffe3ae3aeed4cc95c61699e4">ktxTexture2_CreateFromStdioStream</a> (FILE *stdioStream, ktxTextureCreateFlags createFlags, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:gae9de7e23ffe3ae3aeed4cc95c61699e4"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> from a stdio stream reading from a KTX source. <br /></td></tr>
|
|
<tr class="memitem:ga8680560274b31da6f3f07ee911055431" id="r_ga8680560274b31da6f3f07ee911055431"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga8680560274b31da6f3f07ee911055431">ktxTexture2_CreateFromNamedFile</a> (const char *const filename, ktxTextureCreateFlags createFlags, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:ga8680560274b31da6f3f07ee911055431"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> from a named KTX file. <br /></td></tr>
|
|
<tr class="memitem:ga6805a144f0bfd17b51d46fb28b0786a5" id="r_ga6805a144f0bfd17b51d46fb28b0786a5"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga6805a144f0bfd17b51d46fb28b0786a5">ktxTexture2_CreateFromMemory</a> (const ktx_uint8_t *bytes, ktx_size_t size, ktxTextureCreateFlags createFlags, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:ga6805a144f0bfd17b51d46fb28b0786a5"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> from KTX-formatted data in memory. <br /></td></tr>
|
|
<tr class="memitem:ga1e865473d23f82fc22a16bb3eadf60ed" id="r_ga1e865473d23f82fc22a16bb3eadf60ed"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga1e865473d23f82fc22a16bb3eadf60ed">ktxTexture2_CreateFromStream</a> (<a class="el" href="structktxStream.html">ktxStream</a> *stream, ktxTextureCreateFlags createFlags, <a class="el" href="structktxTexture2.html">ktxTexture2</a> **newTex)</td></tr>
|
|
<tr class="memdesc:ga1e865473d23f82fc22a16bb3eadf60ed"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> from KTX-formatted data from a stream. <br /></td></tr>
|
|
<tr class="memitem:ga01ec49abe73b77f2f8db99b5d9cf46d9" id="r_ga01ec49abe73b77f2f8db99b5d9cf46d9"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="group__reader.html#ga01ec49abe73b77f2f8db99b5d9cf46d9">ktxTexture2_Destroy</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:ga01ec49abe73b77f2f8db99b5d9cf46d9"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:gad3aab08fa013c602fc055964e78c7566" id="r_gad3aab08fa013c602fc055964e78c7566"><td class="memItemLeft">void </td><td class="memItemRight"><a class="el" href="group__reader.html#gad3aab08fa013c602fc055964e78c7566">ktxTexture2_GetComponentInfo</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, uint32_t *pNumComponents, uint32_t *pComponentByteLength)</td></tr>
|
|
<tr class="memdesc:gad3aab08fa013c602fc055964e78c7566"><td class="mdescLeft"> </td><td class="mdescRight">Return information about the components of an image in a texture. <br /></td></tr>
|
|
<tr class="memitem:gacc7762adb6ff311ca65cfe5ed89db21e" id="r_gacc7762adb6ff311ca65cfe5ed89db21e"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gacc7762adb6ff311ca65cfe5ed89db21e">ktxTexture2_GetNumComponents</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gacc7762adb6ff311ca65cfe5ed89db21e"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of components in an image of the texture. <br /></td></tr>
|
|
<tr class="memitem:gab29978f318436c009ae45b7d3c515f8e" id="r_gab29978f318436c009ae45b7d3c515f8e"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#gab29978f318436c009ae45b7d3c515f8e">ktxTexture2_GetImageOffset</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t level, ktx_uint32_t layer, ktx_uint32_t faceSlice, ktx_size_t *pOffset)</td></tr>
|
|
<tr class="memdesc:gab29978f318436c009ae45b7d3c515f8e"><td class="mdescLeft"> </td><td class="mdescRight">Find the offset of an image within a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a>'s image data. <br /></td></tr>
|
|
<tr class="memitem:ga37cd5b4ae9ee373d825197dc8998d0bb" id="r_ga37cd5b4ae9ee373d825197dc8998d0bb"><td class="memItemLeft">khr_df_transfer_e </td><td class="memItemRight"><a class="el" href="group__reader.html#ga37cd5b4ae9ee373d825197dc8998d0bb">ktxTexture2_GetTransferFunction_e</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:ga37cd5b4ae9ee373d825197dc8998d0bb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the transfer function of the images. <br /></td></tr>
|
|
<tr class="memitem:gaddf6746c18d970a238e89bb9b8e13e77" id="r_gaddf6746c18d970a238e89bb9b8e13e77"><td class="memItemLeft">khr_df_transfer_e </td><td class="memItemRight"><a class="el" href="group__reader.html#gaddf6746c18d970a238e89bb9b8e13e77">ktxTexture2_GetOETF_e</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gaddf6746c18d970a238e89bb9b8e13e77"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the transfer function of the images. <br /></td></tr>
|
|
<tr class="memitem:gac1b0eccd69f541450ed88da2ad260dcc" id="r_gac1b0eccd69f541450ed88da2ad260dcc"><td class="memItemLeft">ktx_uint32_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gac1b0eccd69f541450ed88da2ad260dcc">ktxTexture2_GetOETF</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gac1b0eccd69f541450ed88da2ad260dcc"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the transfer function of the images. <br /></td></tr>
|
|
<tr class="memitem:ga7200d548b480a3abb69c206f530c0669" id="r_ga7200d548b480a3abb69c206f530c0669"><td class="memItemLeft">khr_df_model_e </td><td class="memItemRight"><a class="el" href="group__reader.html#ga7200d548b480a3abb69c206f530c0669">ktxTexture2_GetColorModel_e</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:ga7200d548b480a3abb69c206f530c0669"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the DFD color model of the images. <br /></td></tr>
|
|
<tr class="memitem:gab773b3ad45bacb6f487b62c4b0a07fcf" id="r_gab773b3ad45bacb6f487b62c4b0a07fcf"><td class="memItemLeft">ktx_bool_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gab773b3ad45bacb6f487b62c4b0a07fcf">ktxTexture2_GetPremultipliedAlpha</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gab773b3ad45bacb6f487b62c4b0a07fcf"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve whether the RGB components have been premultiplied by the alpha component. <br /></td></tr>
|
|
<tr class="memitem:gac7323c6f9fe75f442484392506b2024b" id="r_gac7323c6f9fe75f442484392506b2024b"><td class="memItemLeft">khr_df_primaries_e </td><td class="memItemRight"><a class="el" href="group__reader.html#gac7323c6f9fe75f442484392506b2024b">ktxTexture2_GetPrimaries_e</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gac7323c6f9fe75f442484392506b2024b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the color primaries of the images. <br /></td></tr>
|
|
<tr class="memitem:gade1ffc5d31c2f9b5f1e861b59e7619ce" id="r_gade1ffc5d31c2f9b5f1e861b59e7619ce"><td class="memItemLeft">ktx_bool_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gade1ffc5d31c2f9b5f1e861b59e7619ce">ktxTexture2_NeedsTranscoding</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gade1ffc5d31c2f9b5f1e861b59e7619ce"><td class="mdescLeft"> </td><td class="mdescRight">Query if the images are in a transcodable format. <br /></td></tr>
|
|
<tr class="memitem:ga9894284fd16fed4697505353043bbeae" id="r_ga9894284fd16fed4697505353043bbeae"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga9894284fd16fed4697505353043bbeae">ktxTexture2_SetOETF</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, khr_df_transfer_e tf)</td></tr>
|
|
<tr class="memdesc:ga9894284fd16fed4697505353043bbeae"><td class="mdescLeft"> </td><td class="mdescRight">Set the transfer function for the images in a texture. <br /></td></tr>
|
|
<tr class="memitem:gaa623fd7f433e3827a52cdb499f9162f9" id="r_gaa623fd7f433e3827a52cdb499f9162f9"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gaa623fd7f433e3827a52cdb499f9162f9">ktxTexture2_SetPrimaries</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, khr_df_primaries_e primaries)</td></tr>
|
|
<tr class="memdesc:gaa623fd7f433e3827a52cdb499f9162f9"><td class="mdescLeft"> </td><td class="mdescRight">Set the primaries for the images in a texture. <br /></td></tr>
|
|
<tr class="memitem:gaefcaf84425830ba095eb670a275dad34" id="r_gaefcaf84425830ba095eb670a275dad34"><td class="memItemLeft">ktx_size_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gaefcaf84425830ba095eb670a275dad34">ktxTexture2_GetDataSizeUncompressed</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:gaefcaf84425830ba095eb670a275dad34"><td class="mdescLeft"> </td><td class="mdescRight">Return the total size in bytes of the uncompressed data of a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>. <br /></td></tr>
|
|
<tr class="memitem:gaa4b800f418f57b10737ac6533f1769d2" id="r_gaa4b800f418f57b10737ac6533f1769d2"><td class="memItemLeft">ktx_size_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gaa4b800f418f57b10737ac6533f1769d2">ktxTexture2_GetImageSize</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t level)</td></tr>
|
|
<tr class="memdesc:gaa4b800f418f57b10737ac6533f1769d2"><td class="mdescLeft"> </td><td class="mdescRight">Calculate & return the size in bytes of an image at the specified mip level. <br /></td></tr>
|
|
<tr class="memitem:gac344745350aff9cf5bcc2969729b7f0e" id="r_gac344745350aff9cf5bcc2969729b7f0e"><td class="memItemLeft">ktx_size_t </td><td class="memItemRight"><a class="el" href="group__reader.html#gac344745350aff9cf5bcc2969729b7f0e">ktxTexture2_GetLevelSize</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t level)</td></tr>
|
|
<tr class="memdesc:gac344745350aff9cf5bcc2969729b7f0e"><td class="mdescLeft"> </td><td class="mdescRight">Calculate & return the size in bytes of all the images in the specified mip level. <br /></td></tr>
|
|
<tr class="memitem:ga1b47270a151b67615aed9eeca5f25bf7" id="r_ga1b47270a151b67615aed9eeca5f25bf7"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga1b47270a151b67615aed9eeca5f25bf7">ktxTexture2_IterateLevels</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, PFNKTXITERCB iterCb, void *userdata)</td></tr>
|
|
<tr class="memdesc:ga1b47270a151b67615aed9eeca5f25bf7"><td class="mdescLeft"> </td><td class="mdescRight">Iterate over the mip levels in a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:gaf57628ec7f9a554b46ba84ab9c214bab" id="r_gaf57628ec7f9a554b46ba84ab9c214bab"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#gaf57628ec7f9a554b46ba84ab9c214bab">ktxTexture2_IterateLoadLevelFaces</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, PFNKTXITERCB iterCb, void *userdata)</td></tr>
|
|
<tr class="memdesc:gaf57628ec7f9a554b46ba84ab9c214bab"><td class="mdescLeft"> </td><td class="mdescRight">Iterate over the images in a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object while loading the image data. <br /></td></tr>
|
|
<tr class="memitem:ga032b7f1926861c8b40655527b84f5533" id="r_ga032b7f1926861c8b40655527b84f5533"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#ga032b7f1926861c8b40655527b84f5533">ktxTexture2_LoadImageData</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint8_t *pBuffer, ktx_size_t bufSize)</td></tr>
|
|
<tr class="memdesc:ga032b7f1926861c8b40655527b84f5533"><td class="mdescLeft"> </td><td class="mdescRight">Load all the image data from the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>'s source. <br /></td></tr>
|
|
<tr class="memitem:gaa1f681c144baa70ef9af6db4c7333b3c" id="r_gaa1f681c144baa70ef9af6db4c7333b3c"><td class="memItemLeft"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> </td><td class="memItemRight"><a class="el" href="group__reader.html#gaa1f681c144baa70ef9af6db4c7333b3c">ktxTexture2_LoadDeflatedImageData</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint8_t *pBuffer, ktx_size_t bufSize)</td></tr>
|
|
<tr class="memdesc:gaa1f681c144baa70ef9af6db4c7333b3c"><td class="mdescLeft"> </td><td class="mdescRight">Load all the image data from the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>'s source without inflatiion.. <br /></td></tr>
|
|
<tr class="memitem:gacb13edcb651f0a8fb26dab9594ef7dc7" id="r_gacb13edcb651f0a8fb26dab9594ef7dc7"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#gacb13edcb651f0a8fb26dab9594ef7dc7">ktxTexture2_VkUploadEx_WithSuballocator</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxVulkanDeviceInfo.html">ktxVulkanDeviceInfo</a> *vdi, <a class="el" href="structktxVulkanTexture.html">ktxVulkanTexture</a> *vkTexture, VkImageTiling tiling, VkImageUsageFlags usageFlags, VkImageLayout finalLayout, <a class="el" href="structktxVulkanTexture__subAllocatorCallbacks.html">ktxVulkanTexture_subAllocatorCallbacks</a> *subAllocatorCallbacks)</td></tr>
|
|
<tr class="memdesc:gacb13edcb651f0a8fb26dab9594ef7dc7"><td class="mdescLeft"> </td><td class="mdescRight">Create a Vulkan image object from a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:ga265926439e3f9502f248684238e5cc48" id="r_ga265926439e3f9502f248684238e5cc48"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#ga265926439e3f9502f248684238e5cc48">ktxTexture2_VkUploadEx</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxVulkanDeviceInfo.html">ktxVulkanDeviceInfo</a> *vdi, <a class="el" href="structktxVulkanTexture.html">ktxVulkanTexture</a> *vkTexture, VkImageTiling tiling, VkImageUsageFlags usageFlags, VkImageLayout finalLayout)</td></tr>
|
|
<tr class="memdesc:ga265926439e3f9502f248684238e5cc48"><td class="mdescLeft"> </td><td class="mdescRight">Create a Vulkan image object from a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:gadf0fba44f518b61acd5d0ae86225ddee" id="r_gadf0fba44f518b61acd5d0ae86225ddee"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#gadf0fba44f518b61acd5d0ae86225ddee">ktxTexture2_VkUpload</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxVulkanDeviceInfo.html">ktxVulkanDeviceInfo</a> *vdi, <a class="el" href="structktxVulkanTexture.html">ktxVulkanTexture</a> *vkTexture)</td></tr>
|
|
<tr class="memdesc:gadf0fba44f518b61acd5d0ae86225ddee"><td class="mdescLeft"> </td><td class="mdescRight">Create a Vulkan image object from a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:ga7a9baaf3aa2e114c6f6e58fe68051815" id="r_ga7a9baaf3aa2e114c6f6e58fe68051815"><td class="memItemLeft">VkFormat </td><td class="memItemRight"><a class="el" href="group__ktx__vkloader.html#ga7a9baaf3aa2e114c6f6e58fe68051815">ktxTexture2_GetVkFormat</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This)</td></tr>
|
|
<tr class="memdesc:ga7a9baaf3aa2e114c6f6e58fe68051815"><td class="mdescLeft"> </td><td class="mdescRight">Return the VkFormat enum of a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object. <br /></td></tr>
|
|
<tr class="memitem:ga50a5ecf22586b26977da62cf19a78518" id="r_ga50a5ecf22586b26977da62cf19a78518"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga50a5ecf22586b26977da62cf19a78518">ktxTexture2_SetImageFromStdioStream</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t level, ktx_uint32_t layer, ktx_uint32_t faceSlice, FILE *src, ktx_size_t srcSize)</td></tr>
|
|
<tr class="memdesc:ga50a5ecf22586b26977da62cf19a78518"><td class="mdescLeft"> </td><td class="mdescRight">Set image for level, layer, faceSlice from a stdio stream source. <br /></td></tr>
|
|
<tr class="memitem:ga01b13c38300016ce36c5b97bf4957d48" id="r_ga01b13c38300016ce36c5b97bf4957d48"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga01b13c38300016ce36c5b97bf4957d48">ktxTexture2_SetImageFromMemory</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t level, ktx_uint32_t layer, ktx_uint32_t faceSlice, const ktx_uint8_t *src, ktx_size_t srcSize)</td></tr>
|
|
<tr class="memdesc:ga01b13c38300016ce36c5b97bf4957d48"><td class="mdescLeft"> </td><td class="mdescRight">Set image for level, layer, faceSlice from an image in memory. <br /></td></tr>
|
|
<tr class="memitem:gacb722c7d0c1df7e6e3b4caa78ae729cf" id="r_gacb722c7d0c1df7e6e3b4caa78ae729cf"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gacb722c7d0c1df7e6e3b4caa78ae729cf">ktxTexture2_WriteToStream</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, <a class="el" href="structktxStream.html">ktxStream</a> *dststr)</td></tr>
|
|
<tr class="memdesc:gacb722c7d0c1df7e6e3b4caa78ae729cf"><td class="mdescLeft"> </td><td class="mdescRight">Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a> in KTX format. <br /></td></tr>
|
|
<tr class="memitem:gadf2c2542471b7a94636216807cedd819" id="r_gadf2c2542471b7a94636216807cedd819"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gadf2c2542471b7a94636216807cedd819">ktxTexture2_WriteToStdioStream</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, FILE *dstsstr)</td></tr>
|
|
<tr class="memdesc:gadf2c2542471b7a94636216807cedd819"><td class="mdescLeft"> </td><td class="mdescRight">Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a stdio stream in KTX format. <br /></td></tr>
|
|
<tr class="memitem:ga745cee3857ade59e612c533d6faa8e2a" id="r_ga745cee3857ade59e612c533d6faa8e2a"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga745cee3857ade59e612c533d6faa8e2a">ktxTexture2_WriteToNamedFile</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, const char *const dstname)</td></tr>
|
|
<tr class="memdesc:ga745cee3857ade59e612c533d6faa8e2a"><td class="mdescLeft"> </td><td class="mdescRight">Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a named file in KTX format. <br /></td></tr>
|
|
<tr class="memitem:ga0113194b669b789a22d85b7ad992f117" id="r_ga0113194b669b789a22d85b7ad992f117"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga0113194b669b789a22d85b7ad992f117">ktxTexture2_WriteToMemory</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint8_t **ppDstBytes, ktx_size_t *pSize)</td></tr>
|
|
<tr class="memdesc:ga0113194b669b789a22d85b7ad992f117"><td class="mdescLeft"> </td><td class="mdescRight">Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to block of memory in KTX format. <br /></td></tr>
|
|
<tr class="memitem:ga08d7222fbf845f25d883ed81c14c6430" id="r_ga08d7222fbf845f25d883ed81c14c6430"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#ga08d7222fbf845f25d883ed81c14c6430">ktxTexture2_DeflateZstd</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t compressionLevel)</td></tr>
|
|
<tr class="memdesc:ga08d7222fbf845f25d883ed81c14c6430"><td class="mdescLeft"> </td><td class="mdescRight">Deflate the data in a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object using Zstandard. <br /></td></tr>
|
|
<tr class="memitem:gaafc3cf2c872ea75be7096b1fc70dfb2c" id="r_gaafc3cf2c872ea75be7096b1fc70dfb2c"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="group__writer.html#gaafc3cf2c872ea75be7096b1fc70dfb2c">ktxTexture2_DeflateZLIB</a> (<a class="el" href="structktxTexture2.html">ktxTexture2</a> *This, ktx_uint32_t compressionLevel)</td></tr>
|
|
<tr class="memdesc:gaafc3cf2c872ea75be7096b1fc70dfb2c"><td class="mdescLeft"> </td><td class="mdescRight">Deflate the data in a <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object using miniz (ZLIB). <br /></td></tr>
|
|
</table><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:a0093ccc55cbbc2d352e6e1e8d8fbc2ab" id="r_a0093ccc55cbbc2d352e6e1e8d8fbc2ab"><td class="memItemLeft">struct ktxTexture2_private * </td><td class="memItemRight"><a class="el" href="#a0093ccc55cbbc2d352e6e1e8d8fbc2ab">_private</a></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class representing a KTX version 2 format texture. </p>
|
|
<p>ktxTextures should be created only by one of the ktxTexture_Create* functions and these fields should be considered read-only. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="glloader_8c-example.html#_a32">glloader.c</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="a0093ccc55cbbc2d352e6e1e8d8fbc2ab" name="a0093ccc55cbbc2d352e6e1e8d8fbc2ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0093ccc55cbbc2d352e6e1e8d8fbc2ab">◆ </a></span>_private</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct ktxTexture2_private* _private</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Private data. </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="structktxTexture2.html">ktxTexture2</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>
|