1440 lines
120 KiB
HTML
1440 lines
120 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: Writer</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('group__writer.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">Writer </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Write KTX-formatted data.
|
|
<a href="#details">More...</a></p>
|
|
<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: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="#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="#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="#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="#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:ga9ad46bface6dab07a35579c0635877d3" id="r_ga9ad46bface6dab07a35579c0635877d3"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#ga9ad46bface6dab07a35579c0635877d3">ktxTexture1_Create</a> (const <a class="el" href="structktxTextureCreateInfo.html">ktxTextureCreateInfo</a> *const createInfo, ktxTextureCreateStorageEnum storageAllocation, <a class="el" href="structktxTexture1.html">ktxTexture1</a> **newTex)</td></tr>
|
|
<tr class="memdesc:ga9ad46bface6dab07a35579c0635877d3"><td class="mdescLeft"> </td><td class="mdescRight">Create a new empty <a class="el" href="structktxTexture1.html" title="Class representing a KTX version 1 format texture.">ktxTexture1</a>. <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="#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="#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: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="#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="#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:ga9383755c2e02a9d1aa932e75c847829c" id="r_ga9383755c2e02a9d1aa932e75c847829c"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#ga9383755c2e02a9d1aa932e75c847829c">ktxTexture1_SetImageFromStdioStream</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</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:ga9383755c2e02a9d1aa932e75c847829c"><td class="mdescLeft"> </td><td class="mdescRight">Set image for level, layer, faceSlice from a stdio stream source. <br /></td></tr>
|
|
<tr class="memitem:gabeb1d5eb7ddcfd81405d5726a0b55ee6" id="r_gabeb1d5eb7ddcfd81405d5726a0b55ee6"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gabeb1d5eb7ddcfd81405d5726a0b55ee6">ktxTexture1_SetImageFromMemory</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</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:gabeb1d5eb7ddcfd81405d5726a0b55ee6"><td class="mdescLeft"> </td><td class="mdescRight">Set image for level, layer, faceSlice from an image in memory. <br /></td></tr>
|
|
<tr class="memitem:gac1780ac8315f0cab9893c121481c7453" id="r_gac1780ac8315f0cab9893c121481c7453"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gac1780ac8315f0cab9893c121481c7453">ktxTexture1_WriteToStream</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, <a class="el" href="structktxStream.html">ktxStream</a> *dststr)</td></tr>
|
|
<tr class="memdesc:gac1780ac8315f0cab9893c121481c7453"><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:ga924da3380253c85fffca8c956e00d5c0" id="r_ga924da3380253c85fffca8c956e00d5c0"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#ga924da3380253c85fffca8c956e00d5c0">ktxTexture1_WriteToStdioStream</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, FILE *dstsstr)</td></tr>
|
|
<tr class="memdesc:ga924da3380253c85fffca8c956e00d5c0"><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:gafe0d51799d92b69cdcbe30c98322340b" id="r_gafe0d51799d92b69cdcbe30c98322340b"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gafe0d51799d92b69cdcbe30c98322340b">ktxTexture1_WriteToNamedFile</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, const char *const dstname)</td></tr>
|
|
<tr class="memdesc:gafe0d51799d92b69cdcbe30c98322340b"><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:ga21904a85ada4ee322b87c309566ea4d1" id="r_ga21904a85ada4ee322b87c309566ea4d1"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#ga21904a85ada4ee322b87c309566ea4d1">ktxTexture1_WriteToMemory</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, ktx_uint8_t **ppDstBytes, ktx_size_t *pSize)</td></tr>
|
|
<tr class="memdesc:ga21904a85ada4ee322b87c309566ea4d1"><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:gad0a6406fc9359abd5f6d9956a86ce90f" id="r_gad0a6406fc9359abd5f6d9956a86ce90f"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gad0a6406fc9359abd5f6d9956a86ce90f">ktxTexture1_WriteKTX2ToStream</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, <a class="el" href="structktxStream.html">ktxStream</a> *dststr)</td></tr>
|
|
<tr class="memdesc:gad0a6406fc9359abd5f6d9956a86ce90f"><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 2 format. <br /></td></tr>
|
|
<tr class="memitem:gac31b3532ed02d8cd4a7b517d4d2ab6ef" id="r_gac31b3532ed02d8cd4a7b517d4d2ab6ef"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gac31b3532ed02d8cd4a7b517d4d2ab6ef">ktxTexture1_WriteKTX2ToStdioStream</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, FILE *dstsstr)</td></tr>
|
|
<tr class="memdesc:gac31b3532ed02d8cd4a7b517d4d2ab6ef"><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 KTX2 format. <br /></td></tr>
|
|
<tr class="memitem:ga3009e876fb584268241a9ba7704e8557" id="r_ga3009e876fb584268241a9ba7704e8557"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#ga3009e876fb584268241a9ba7704e8557">ktxTexture1_WriteKTX2ToNamedFile</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, const char *const dstname)</td></tr>
|
|
<tr class="memdesc:ga3009e876fb584268241a9ba7704e8557"><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 KTX2 format. <br /></td></tr>
|
|
<tr class="memitem:gadbc6058afa50d4db3efd738822e6296a" id="r_gadbc6058afa50d4db3efd738822e6296a"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> </td><td class="memItemRight"><a class="el" href="#gadbc6058afa50d4db3efd738822e6296a">ktxTexture1_WriteKTX2ToMemory</a> (<a class="el" href="structktxTexture1.html">ktxTexture1</a> *This, ktx_uint8_t **ppDstBytes, ktx_size_t *pSize)</td></tr>
|
|
<tr class="memdesc:gadbc6058afa50d4db3efd738822e6296a"><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 KTX2 format. <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="#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="#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="#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="#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="#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="#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="#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="#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>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Write KTX-formatted data. </p>
|
|
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
|
|
<a id="ga9ad46bface6dab07a35579c0635877d3" name="ga9ad46bface6dab07a35579c0635877d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9ad46bface6dab07a35579c0635877d3">◆ </a></span>ktxTexture1_Create()</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> ktxTexture1_Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structktxTextureCreateInfo.html">ktxTextureCreateInfo</a> *const</td> <td class="paramname"><span class="paramname"><em>createInfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktxTextureCreateStorageEnum</td> <td class="paramname"><span class="paramname"><em>storageAllocation</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> **</td> <td class="paramname"><span class="paramname"><em>newTex</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new empty <a class="el" href="structktxTexture1.html" title="Class representing a KTX version 1 format texture.">ktxTexture1</a>. </p>
|
|
<p>The address of the newly created <a class="el" href="structktxTexture1.html" title="Class representing a KTX version 1 format texture.">ktxTexture1</a> is written to the location pointed at by <code class="param">newTex</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">createInfo</td><td>pointer to a <a class="el" href="structktxTextureCreateInfo.html" title="Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create().">ktxTextureCreateInfo</a> struct with information describing the texture. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">storageAllocation</td><td>enum indicating whether or not to allocate storage for the texture images. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">newTex</td><td>pointer to a location in which store the address of the newly created texture.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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>glInternalFormat</code> in <code class="param">createInfo</code> is not a valid OpenGL internal format value. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numDimensions</code> in <code class="param">createInfo</code> is not 1, 2 or 3. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>One of <span class="tt">base{Width,Height,Depth}</span> in <code class="param">createInfo</code> is 0. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numFaces</code> in <code class="param">createInfo</code> is not 1 or 6. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numLevels</code> in <code class="param">createInfo</code> is 0. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <span class="tt">base{Width,Height,Depth}</span> specified in <code class="param">createInfo</code> are inconsistent with <code>numDimensions</code>. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting a 3D array or 3D cubemap texture. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting a cubemap with non-square or non-2D images. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting more mip levels than needed for the specified <span class="tt">base{Width,Height,Depth}</span>. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory for the texture's images. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gabeb1d5eb7ddcfd81405d5726a0b55ee6" name="gabeb1d5eb7ddcfd81405d5726a0b55ee6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gabeb1d5eb7ddcfd81405d5726a0b55ee6">◆ </a></span>ktxTexture1_SetImageFromMemory()</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> ktxTexture1_SetImageFromMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>level</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>layer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>faceSlice</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const ktx_uint8_t *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t</td> <td class="paramname"><span class="paramname"><em>srcSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set image for level, layer, faceSlice from an image in memory. </p>
|
|
<p>Uncompressed images in memory are expected to have their rows tightly packed as is the norm for most image file formats. The copied image is padded as necessary to achieve the KTX-specified row alignment. No padding is done if the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a>'s <code>isCompressed</code> field is <code>KTX_TRUE</code>.</p>
|
|
<p>Level, layer, faceSlice rather than offset are specified to enable some validation.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>Do not use <code>memcpy</code> for this as it will not pad when necessary.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>The caller is responsible for freeing the original image memory referred to by <code class="param">src</code>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>mip level of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>array layer of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">faceSlice</td><td>cube map face or depth slice of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>pointer to the image source in memory. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcSize</td><td>size of the source image in bytes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">src</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">srcSize</code> != the expected image size for the specified level, layer & faceSlice. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>No storage was allocated when the texture was created. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9383755c2e02a9d1aa932e75c847829c" name="ga9383755c2e02a9d1aa932e75c847829c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9383755c2e02a9d1aa932e75c847829c">◆ </a></span>ktxTexture1_SetImageFromStdioStream()</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> ktxTexture1_SetImageFromStdioStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>level</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>layer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>faceSlice</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t</td> <td class="paramname"><span class="paramname"><em>srcSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set image for level, layer, faceSlice from a stdio stream source. </p>
|
|
<p>Uncompressed images read from the stream are expected to have their rows tightly packed as is the norm for most image file formats. The copied image is padded as necessary to achieve the KTX-specified row alignment. No padding is done if the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a>'s <code>isCompressed</code> field is <code>KTX_TRUE</code>.</p>
|
|
<p>Level, layer, faceSlice rather than offset are specified to enable some validation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>mip level of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>array layer of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">faceSlice</td><td>cube map face or depth slice of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>stdio stream pointer to the source. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcSize</td><td>size of the source image in bytes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">src</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">srcSize</code> != the expected image size for the specified level, layer & faceSlice. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>No storage was allocated when the texture was created. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadbc6058afa50d4db3efd738822e6296a" name="gadbc6058afa50d4db3efd738822e6296a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadbc6058afa50d4db3efd738822e6296a">◆ </a></span>ktxTexture1_WriteKTX2ToMemory()</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> ktxTexture1_WriteKTX2ToMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint8_t **</td> <td class="paramname"><span class="paramname"><em>ppDstBytes</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t *</td> <td class="paramname"><span class="paramname"><em>pSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to block of memory in KTX2 format. </p>
|
|
<p>Memory is allocated by the function and the caller is responsible for freeing it.</p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
<div class="ttc" id="aktx_8h_html_aa23b5bdd596b2c6a6a2891a2ac48dc2c"><div class="ttname"><a href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a></div><div class="ttdeci">#define KTX_WRITER_KEY</div><div class="ttdoc">Key string for standard writer metadata.</div><div class="ttdef"><b>Definition</b> ktx.h:134</div></div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppDstBytes</td><td>pointer to location to write the address of the destination memory. The Application is responsible for freeing this memory. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">pSize</td><td>pointer to location to write the size in bytes of the KTX data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code>, <code class="param">ppDstBytes</code> or <code class="param">pSize</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> contains unknownY KTX- or ktx- prefixed metadata keys. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3009e876fb584268241a9ba7704e8557" name="ga3009e876fb584268241a9ba7704e8557"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3009e876fb584268241a9ba7704e8557">◆ </a></span>ktxTexture1_WriteKTX2ToNamedFile()</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> ktxTexture1_WriteKTX2ToNamedFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const</td> <td class="paramname"><span class="paramname"><em>dstname</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a named file in KTX2 format. </p>
|
|
<p>The file name must be encoded in utf-8. On Windows convert unicode names to utf-8 with <code>WideCharToMultiByte(CP_UTF8, ...)</code> before calling.</p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstname</td><td>destination file name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstname</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> contains unknownY KTX- or ktx- prefixed metadata keys. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac31b3532ed02d8cd4a7b517d4d2ab6ef" name="gac31b3532ed02d8cd4a7b517d4d2ab6ef"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac31b3532ed02d8cd4a7b517d4d2ab6ef">◆ </a></span>ktxTexture1_WriteKTX2ToStdioStream()</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> ktxTexture1_WriteKTX2ToStdioStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>dstsstr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a stdio stream in KTX2 format. </p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstsstr</td><td>destination stdio stream.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstsstr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> contains unknownY KTX- or ktx- prefixed metadata keys. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad0a6406fc9359abd5f6d9956a86ce90f" name="gad0a6406fc9359abd5f6d9956a86ce90f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad0a6406fc9359abd5f6d9956a86ce90f">◆ </a></span>ktxTexture1_WriteKTX2ToStream()</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> ktxTexture1_WriteKTX2ToStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>dststr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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 2 format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dststr</td><td>destination <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dststr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> contains unknownY KTX- or ktx- prefixed metadata keys. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The length of the already set writerId metadata plus the library's version id exceeds the maximum allowed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga21904a85ada4ee322b87c309566ea4d1" name="ga21904a85ada4ee322b87c309566ea4d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga21904a85ada4ee322b87c309566ea4d1">◆ </a></span>ktxTexture1_WriteToMemory()</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> ktxTexture1_WriteToMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint8_t **</td> <td class="paramname"><span class="paramname"><em>ppDstBytes</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t *</td> <td class="paramname"><span class="paramname"><em>pSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to block of memory in KTX format. </p>
|
|
<p>Memory is allocated by the function and the caller is responsible for freeing it.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppDstBytes</td><td>pointer to location to write the address of the destination memory. The Application is responsible for freeing this memory. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">pSize</td><td>pointer to location to write the size in bytes of the KTX data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code>, <code class="param">ppDstBytes</code> or <code class="param">pSize</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gafe0d51799d92b69cdcbe30c98322340b" name="gafe0d51799d92b69cdcbe30c98322340b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gafe0d51799d92b69cdcbe30c98322340b">◆ </a></span>ktxTexture1_WriteToNamedFile()</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> ktxTexture1_WriteToNamedFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const</td> <td class="paramname"><span class="paramname"><em>dstname</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a named file in KTX format. </p>
|
|
<p>The file name must be encoded in utf-8. On Windows convert unicode names to utf-8 with <code>WideCharToMultiByte(CP_UTF8, ...)</code> before calling.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstname</td><td>destination file name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstname</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga924da3380253c85fffca8c956e00d5c0" name="ga924da3380253c85fffca8c956e00d5c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga924da3380253c85fffca8c956e00d5c0">◆ </a></span>ktxTexture1_WriteToStdioStream()</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> ktxTexture1_WriteToStdioStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>dstsstr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a stdio stream in KTX format. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstsstr</td><td>destination stdio stream.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstsstr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac1780ac8315f0cab9893c121481c7453" name="gac1780ac8315f0cab9893c121481c7453"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac1780ac8315f0cab9893c121481c7453">◆ </a></span>ktxTexture1_WriteToStream()</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> ktxTexture1_WriteToStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture1.html">ktxTexture1</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>dststr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dststr</td><td>destination <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dststr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga00b153dbfa1fe115c7d4322dbe07f172" name="ga00b153dbfa1fe115c7d4322dbe07f172"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga00b153dbfa1fe115c7d4322dbe07f172">◆ </a></span>ktxTexture2_CompressAstc()</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> ktxTexture2_CompressAstc </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>quality</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encode and compress a ktx texture with uncompressed images to astc. </p>
|
|
<p>The images are either encoded to ASTC block-compressed format. The encoded images replace the original images and the texture's fields including the DFD are modified to reflect the new state.</p>
|
|
<p>Such textures can be directly uploaded to a GPU via a graphics API.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">quality</td><td>Compression quality, a value from 0 - 100. Higher=higher quality/slower speed. Lower=lower quality/faster speed. Negative values for quality are considered > 100.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's image are in a block compressed format. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image's format is a packed format (e.g. RGB565). </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image format's component size is not 8-bits. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are 1D. Only 2D images can be supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory to carry out supercompression. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf08421ae0893a9e9205d3e84fad66bd8" name="gaf08421ae0893a9e9205d3e84fad66bd8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf08421ae0893a9e9205d3e84fad66bd8">◆ </a></span>ktxTexture2_CompressAstcEx()</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> ktxTexture2_CompressAstcEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxAstcParams.html">ktxAstcParams</a> *</td> <td class="paramname"><span class="paramname"><em>params</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encode and compress a ktx texture with uncompressed images to astc. </p>
|
|
<p>The images are encoded to ASTC block-compressed format. The encoded images replace the original images and the texture's fields including the DFD are modified to reflect the new state.</p>
|
|
<p>Such textures can be directly uploaded to a GPU via a graphics API.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>pointer to ASTC params object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are in a block compressed format. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image's format is a packed format (e.g. RGB565). </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image format's component size is not 8-bits. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are 1D. Only 2D images can be supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Transfer function of <code>This</code> is not sRGB or Linear. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code>params->mode</code> is HDR but transfer function of <code>This</code> is sRGB. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>ASTC encoder failed to compress image. Possibly due to incorrect floating point compilation settings. Should not happen in release package. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>This->generateMipmaps is set. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory to carry out compression. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca04808a4c3abddb237d2a8cf903205496">KTX_UNSUPPORTED_FEATURE</a></td><td><code>params->mode</code> is HDR mode which is not yet implemented. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca04808a4c3abddb237d2a8cf903205496">KTX_UNSUPPORTED_FEATURE</a></td><td>ASTC encoder not compiled with enough capacity for requested block size. Should not happen in release package. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga405c44d6daf8ddf83dc805810bf4f989" name="ga405c44d6daf8ddf83dc805810bf4f989"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga405c44d6daf8ddf83dc805810bf4f989">◆ </a></span>ktxTexture2_CompressBasis()</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> ktxTexture2_CompressBasis </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>quality</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Supercompress a KTX2 texture with uncompressed images. </p>
|
|
<p>The images are encoded to ETC1S block-compressed format and supercompressed with Basis Universal. The encoded images replace the original images and the texture's fields including the DFD are modified to reflect the new state.</p>
|
|
<p>Such textures must be transcoded to a desired target block compressed format before they can be uploaded to a GPU via a graphics API.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga0e75755e3cc69964e57363dad82ffd77" title="Encode and possibly Supercompress a KTX2 texture with uncompressed images.">ktxTexture2_CompressBasisEx()</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">quality</td><td>Compression quality, a value from 1 - 255. Default is 128 which is selected if <code class="param">quality</code> is 0. Lower=better compression/lower quality/faster. Higher=less compression/higher quality/slower.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture is already supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's image are in a block compressed format. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory to carry out supercompression. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0e75755e3cc69964e57363dad82ffd77" name="ga0e75755e3cc69964e57363dad82ffd77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0e75755e3cc69964e57363dad82ffd77">◆ </a></span>ktxTexture2_CompressBasisEx()</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> ktxTexture2_CompressBasisEx </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxBasisParams.html">ktxBasisParams</a> *</td> <td class="paramname"><span class="paramname"><em>params</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Encode and possibly Supercompress a KTX2 texture with uncompressed images. </p>
|
|
<p>The images are either encoded to ETC1S block-compressed format and supercompressed with Basis LZ or they are encoded to UASTC block-compressed format. UASTC format is selected by setting the <code>uastc</code> field of <em class="arg">params</em> to <code>KTX_TRUE</code>. The encoded images replace the original images and the texture's fields including the DFD are modified to reflect the new state.</p>
|
|
<p>Such textures must be transcoded to a desired target block compressed format before they can be uploaded to a GPU via a graphics API.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__reader.html#ga90cc33928a2dae962fb94b3fa2f6575d" title="Transcode a KTX2 texture with BasisLZ/ETC1S or UASTC images.">ktxTexture2_TranscodeBasis()</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">params</td><td>pointer to Basis params object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are supercompressed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture's images are in a block compressed format. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image's format is a packed format (e.g. RGB565). </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The texture image format's component size is not 8-bits. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code>normalMode</code> is specified but the texture has only one component. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both preSwizzle and and inputSwizzle are specified in <em class="arg">params</em>. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>This->generateMipmaps is set. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory to carry out compression. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa8e29216921eadd3c09c3a76bc286acd" name="gaa8e29216921eadd3c09c3a76bc286acd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa8e29216921eadd3c09c3a76bc286acd">◆ </a></span>ktxTexture2_Create()</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> ktxTexture2_Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structktxTextureCreateInfo.html">ktxTextureCreateInfo</a> *const</td> <td class="paramname"><span class="paramname"><em>createInfo</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktxTextureCreateStorageEnum</td> <td class="paramname"><span class="paramname"><em>storageAllocation</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> **</td> <td class="paramname"><span class="paramname"><em>newTex</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create a new empty <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a>. </p>
|
|
<p>The address of the newly created <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> is written to the location pointed at by <code class="param">newTex</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">createInfo</td><td>pointer to a <a class="el" href="structktxTextureCreateInfo.html" title="Structure for passing texture information to ktxTexture1_Create() and ktxTexture2_Create().">ktxTextureCreateInfo</a> struct with information describing the texture. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">storageAllocation</td><td>enum indicating whether or not to allocate storage for the texture images. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">newTex</td><td>pointer to a location in which store the address of the newly created texture.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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>glInternalFormat</code> in <code class="param">createInfo</code> is not a valid OpenGL internal format value. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numDimensions</code> in <code class="param">createInfo</code> is not 1, 2 or 3. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>One of <span class="tt">base{Width,Height,Depth}</span> in <code class="param">createInfo</code> is 0. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numFaces</code> in <code class="param">createInfo</code> is not 1 or 6. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code>numLevels</code> in <code class="param">createInfo</code> is 0. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <span class="tt">base{Width,Height,Depth}</span> specified in <code class="param">createInfo</code> are inconsistent with <code>numDimensions</code>. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting a 3D array or 3D cubemap texture. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting a cubemap with non-square or non-2D images. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td><code class="param">createInfo</code> is requesting more mip levels than needed for the specified <span class="tt">base{Width,Height,Depth}</span>. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory for the texture's images. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5fcfdc3d237419ab65287639e1f4aeb1" name="ga5fcfdc3d237419ab65287639e1f4aeb1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5fcfdc3d237419ab65287639e1f4aeb1">◆ </a></span>ktxTexture2_CreateCopy()</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> ktxTexture2_CreateCopy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>orig</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> **</td> <td class="paramname"><span class="paramname"><em>newTex</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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>. </p>
|
|
<p>The address of the newly created <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> is written to the location pointed at by <code class="param">newTex</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">orig</td><td>pointer to the texture to copy. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">newTex</td><td>pointer to a location in which store the address of the newly created texture.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>Not enough memory for the texture data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaafc3cf2c872ea75be7096b1fc70dfb2c" name="gaafc3cf2c872ea75be7096b1fc70dfb2c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaafc3cf2c872ea75be7096b1fc70dfb2c">◆ </a></span>ktxTexture2_DeflateZLIB()</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> ktxTexture2_DeflateZLIB </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>compressionLevel</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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). </p>
|
|
<p>The texture's levelIndex, dataSize, DFD, data pointer, and supercompressionScheme will all be updated after successful deflation to reflect the deflated data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compressionLevel</td><td>set speed vs compression ratio trade-off. Values between 1 and 9 are accepted. The lower the level the faster. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga08d7222fbf845f25d883ed81c14c6430" name="ga08d7222fbf845f25d883ed81c14c6430"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga08d7222fbf845f25d883ed81c14c6430">◆ </a></span>ktxTexture2_DeflateZstd()</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> ktxTexture2_DeflateZstd </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>compressionLevel</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<p>The texture's levelIndex, dataSize, DFD, data pointer, and supercompressionScheme will all be updated after successful deflation to reflect the deflated data.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> object of interest. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compressionLevel</td><td>set speed vs compression ratio trade-off. Values between 1 and 22 are accepted. The lower the level the faster. Values above 20 should be used with caution as they require more memory. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga01b13c38300016ce36c5b97bf4957d48" name="ga01b13c38300016ce36c5b97bf4957d48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga01b13c38300016ce36c5b97bf4957d48">◆ </a></span>ktxTexture2_SetImageFromMemory()</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> ktxTexture2_SetImageFromMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>level</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>layer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>faceSlice</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const ktx_uint8_t *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t</td> <td class="paramname"><span class="paramname"><em>srcSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set image for level, layer, faceSlice from an image in memory. </p>
|
|
<p>Uncompressed images in memory are expected to have their rows tightly packed as is the norm for most image file formats. KTX 2 also requires tight packing this function does not add any padding.</p>
|
|
<p>Level, layer, faceSlice rather than offset are specified to enable some validation.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The caller is responsible for freeing the original image memory referred to by <code class="param">src</code>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>mip level of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>array layer of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">faceSlice</td><td>cube map face or depth slice of the image to set or KTX_FACESLICE_WHOLE_LEVEL to set the entire level. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>pointer to the image source in memory. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcSize</td><td>size of the source image in bytes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">src</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">srcSize</code> != the expected image size for the specified level, layer & faceSlice. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>No storage was allocated when the texture was created. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga50a5ecf22586b26977da62cf19a78518" name="ga50a5ecf22586b26977da62cf19a78518"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga50a5ecf22586b26977da62cf19a78518">◆ </a></span>ktxTexture2_SetImageFromStdioStream()</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> ktxTexture2_SetImageFromStdioStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>level</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>layer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint32_t</td> <td class="paramname"><span class="paramname"><em>faceSlice</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t</td> <td class="paramname"><span class="paramname"><em>srcSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set image for level, layer, faceSlice from a stdio stream source. </p>
|
|
<p>Uncompressed images read from the stream are expected to have their rows tightly packed as is the norm for most image file formats. KTX 2 also requires tight packing this function does not add any padding.</p>
|
|
<p>Level, layer, faceSlice rather than offset are specified to enable some validation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>mip level of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">layer</td><td>array layer of the image to set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">faceSlice</td><td>cube map face or depth slice of the image to set or KTX_FACESLICE_WHOLE_LEVEL to set the entire level. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>stdio stream pointer to the source. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcSize</td><td>size of the source image in bytes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">src</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td><code class="param">srcSize</code> != the expected image size for the specified level, layer & faceSlice. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>No storage was allocated when the texture was created. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9894284fd16fed4697505353043bbeae" name="ga9894284fd16fed4697505353043bbeae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9894284fd16fed4697505353043bbeae">◆ </a></span>ktxTexture2_SetOETF()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> ktxTexture2_SetOETF </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">khr_df_transfer_e</td> <td class="paramname"><span class="paramname"><em>tf</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the transfer function for the images in a texture. </p>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated</a></b></dt><dd>Use ktxTexture2_SetTransferFunction.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">tf</td><td>enumerator of the transfer function to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaa623fd7f433e3827a52cdb499f9162f9" name="gaa623fd7f433e3827a52cdb499f9162f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa623fd7f433e3827a52cdb499f9162f9">◆ </a></span>ktxTexture2_SetPrimaries()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116c">ktx_error_code_e</a> ktxTexture2_SetPrimaries </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">khr_df_primaries_e</td> <td class="paramname"><span class="paramname"><em>primaries</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the primaries for the images in a texture. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the <a class="el" href="structktxTexture2.html" title="Class representing a KTX version 2 format texture.">ktxTexture2</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">primaries</td><td>enumerator of the primaries to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0113194b669b789a22d85b7ad992f117" name="ga0113194b669b789a22d85b7ad992f117"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0113194b669b789a22d85b7ad992f117">◆ </a></span>ktxTexture2_WriteToMemory()</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> ktxTexture2_WriteToMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_uint8_t **</td> <td class="paramname"><span class="paramname"><em>ppDstBytes</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ktx_size_t *</td> <td class="paramname"><span class="paramname"><em>pSize</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to block of memory in KTX format. </p>
|
|
<p>Memory is allocated by the function and the caller is responsible for freeing it.</p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppDstBytes</td><td>pointer to location to write the address of the destination memory. The Application is responsible for freeing this memory. </td></tr>
|
|
<tr><td class="paramdir">[in,out]</td><td class="paramname">pSize</td><td>pointer to location to write the size in bytes of the KTX data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code>, <code class="param">ppDstBytes</code> or <code class="param">pSize</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga745cee3857ade59e612c533d6faa8e2a" name="ga745cee3857ade59e612c533d6faa8e2a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga745cee3857ade59e612c533d6faa8e2a">◆ </a></span>ktxTexture2_WriteToNamedFile()</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> ktxTexture2_WriteToNamedFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const</td> <td class="paramname"><span class="paramname"><em>dstname</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a named file in KTX format. </p>
|
|
<p>The file name must be encoded in utf-8. On Windows convert unicode names to utf-8 with <code>WideCharToMultiByte(CP_UTF8, ...)</code> before calling.</p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstname</td><td>destination file name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstname</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadf2c2542471b7a94636216807cedd819" name="gadf2c2542471b7a94636216807cedd819"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadf2c2542471b7a94636216807cedd819">◆ </a></span>ktxTexture2_WriteToStdioStream()</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> ktxTexture2_WriteToStdioStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>dstsstr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object to a stdio stream in KTX format. </p>
|
|
<p>Callers are strongly urged to include a KTXwriter item in the texture's metadata. It can be added by code, similar to the following, prior to calling this function. </p><div class="fragment"><div class="line"><span class="keywordtype">char</span> writer[100];</div>
|
|
<div class="line">snprintf(writer, <span class="keyword">sizeof</span>(writer), <span class="stringliteral">"%s version %s"</span>, appName, appVer);</div>
|
|
<div class="line">ktxHashList_AddKVPair(&texture->kvDataHead, <a class="code hl_define" href="ktx_8h.html#aa23b5bdd596b2c6a6a2891a2ac48dc2c">KTX_WRITER_KEY</a>,</div>
|
|
<div class="line"> (ktx_uint32_t)strlen(writer) + 1,</div>
|
|
<div class="line"> writer);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstsstr</td><td>destination stdio stream.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dstsstr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gacb722c7d0c1df7e6e3b4caa78ae729cf" name="gacb722c7d0c1df7e6e3b4caa78ae729cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gacb722c7d0c1df7e6e3b4caa78ae729cf">◆ </a></span>ktxTexture2_WriteToStream()</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> ktxTexture2_WriteToStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structktxTexture2.html">ktxTexture2</a> *</td> <td class="paramname"><span class="paramname"><em>This</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structktxStream.html">ktxStream</a> *</td> <td class="paramname"><span class="paramname"><em>dststr</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>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. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">This</td><td>pointer to the target <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dststr</td><td>destination <a class="el" href="structktxStream.html" title="Interface of ktxStream.">ktxStream</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS on success, other KTX_* enum values 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">This</code> or <code class="param">dststr</code> is NULL. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> does not contain any image data. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>Both kvDataHead and kvData are set in the <a class="el" href="structktxTexture.html" title="Base class representing a texture.">ktxTexture</a> </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>The length of the already set writerId metadata plus the library's version id exceeds the maximum allowed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf1c77ba0fee3c65d49a334bec949c8a6">KTX_FILE_OVERFLOW</a></td><td>The file exceeded the maximum size supported by the system. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca85733279b7d3e00ad9a6d498d6686645">KTX_FILE_WRITE_ERROR</a></td><td>An error occurred while writing the file. </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="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>
|