160 lines
11 KiB
HTML
160 lines
11 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>KTX Tools Reference: KTX Tools Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="ktx_logo_200.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">KTX Tools 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('index.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><div class="header">
|
|
<div class="headertitle"><div class="title">KTX Tools Reference </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>There are two sets of tools: a new set with a unified front end, <a class="el" href="ktx.html" title="ktx">ktx</a>, and an older set of individual tools. Both are documented here.</p>
|
|
<h2 class="doxsection"><a class="anchor" id="autotoc_md0"></a>
|
|
ktx Overview</h2>
|
|
<p><a class="el" href="ktx.html" title="ktx">ktx</a> includes the following tools:</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadLeft">Tool </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Equivalent old tool </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_compare.html" title="ktx compare">ktx compare</a> </td><td class="markdownTableBodyNone">Compare two KTX2 files. </td><td class="markdownTableBodyNone"></td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_create.html" title="ktx create">ktx create</a> </td><td class="markdownTableBodyNone">Create a KTX2 file from various input files </td><td class="markdownTableBodyNone"><span class="tt">toktx</span> </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_deflate.html" title="ktx deflate">ktx deflate</a> </td><td class="markdownTableBodyNone">Deflate (supercompress) a KTX2 file. </td><td class="markdownTableBodyNone"><span class="tt">ktxsc</span> </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_extract.html" title="ktx extract">ktx extract</a> </td><td class="markdownTableBodyNone">Export selected images from a KTX2 file </td><td class="markdownTableBodyNone">- </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_encode.html" title="ktx encode">ktx encode</a> </td><td class="markdownTableBodyNone">Encode a KTX2 file </td><td class="markdownTableBodyNone"><span class="tt">ktxsc</span> </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_info.html" title="ktx info">ktx info</a> </td><td class="markdownTableBodyNone">Prints information about a KTX2 file </td><td class="markdownTableBodyNone"><span class="tt">ktxinfo</span> </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_transcode.html" title="ktx transcode">ktx transcode</a> </td><td class="markdownTableBodyNone">Transcode a KTX2 file </td><td class="markdownTableBodyNone">- </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_validate.html" title="ktx validate">ktx validate</a> </td><td class="markdownTableBodyNone">Validate a KTX2 file </td><td class="markdownTableBodyNone"><span class="tt">ktx2check</span> </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyLeft"><a class="el" href="ktx_help.html" title="ktx help">ktx help</a> </td><td class="markdownTableBodyNone">Display help information about the ktx tools </td><td class="markdownTableBodyNone">- </td></tr>
|
|
</table>
|
|
<p>Equivalent old tools are deprecated and will be removed soon.</p>
|
|
<p>Some features of old tools are not currently available in the new equivalent.</p>
|
|
<table class="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadCenter">Old Tool </th><th class="markdownTableHeadCenter">New Tool </th><th class="markdownTableHeadNone">Missing Features </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyCenter"><a class="el" href="toktx.html" title="toktx">toktx</a> </td><td class="markdownTableBodyCenter"><a class="el" href="ktx_create.html" title="ktx create">create</a> </td><td class="markdownTableBodyNone">JPEG and NBPM input. </td></tr>
|
|
</table>
|
|
<p>The command-line syntax and semantics differ from the old tools including, but not limited to:</p>
|
|
<ul>
|
|
<li>KTX 1.0 files are not supported by the new tools.</li>
|
|
<li>Words in multi-word option names are connected with <span class="tt">-</span> instead of <span class="tt">_</span>.</li>
|
|
<li>Individual option names may differ between the old and new tools.</li>
|
|
<li>The <span class="tt">ktx validate</span> tool may be stricter than <span class="tt">ktx2check</span> or otherwise differ in behavior, as the new tool enforces all rules of the KTX 2.0 specification. In addition, all new tools that accept KTX 2.0 files as input will be validated in a similar fashion as they would be with the <span class="tt">ktx validate</span> tool and will fail on the first specification rule violation, if there is one. It also has the option to output the validation results in human readable text format or in JSON format (both formatted and minified options are available), as controlled by the <span class="tt">--format</span> command-line option.</li>
|
|
<li>The <span class="tt">ktx validate</span> tool also supports validating KTX 2.0 files against the additional restrictions defined by the <em>KHR_texture_basisu</em> extension. Use the <span class="tt">--gltf-basisu</span> command-line option to verify glTF and WebGL compatibility.</li>
|
|
<li>The new <span class="tt">ktx info</span> tool produces a unified and complete output of all metadata in KTX 2.0 files and can provide output in human readable text format or in JSON format (both formatted and minified options are available), as controlled by the <span class="tt">--format</span> command-line option.</li>
|
|
<li>The source repository also includes the JSON schemas that the JSON outputs of the <span class="tt">ktx info</span> and <span class="tt">ktx validate</span> tools comply to.</li>
|
|
<li>The <span class="tt">ktx create</span> tool takes an explicit Vulkan format argument (<span class="tt">--format</span>) instead of inferring the format based on the provided input files as <span class="tt">toktx</span>, and thus doesn't perform any implicit color-space conversions except gamma 2.2 to sRGB. Use the <span class="tt">--assign-tf</span>, <span class="tt">--convert-tf</span>, <span class="tt">--assign-primaries</span>, and the new <span class="tt">--convert-primaries</span> for fine grained control over color-space interpretation and conversion.</li>
|
|
<li>The <span class="tt">ktx create</span> tool does not support resizing or scaling like <span class="tt">toktx</span>, and, in general, does not perform any image transformations except the optional color-space conversion and mipmap generation options. Users should resize input images to the appropriate resolution before converting them to KTX 2.0 files.</li>
|
|
<li>The <span class="tt">ktx create</span> and <span class="tt">ktx extract</span> tools consume and produce, respectively, image file formats that best suit the used Vulkan format. In general, barring special cases, 8-bit and 16-bit normalized integer formats are imported from and exported to PNG files, while integer and floating point formats are imported from and exported to EXR files based on predefined rules. This may be extended in the future using additional command line options and in response to support for other image file formats.</li>
|
|
<li>The new tools and updated <span class="tt">libktx</span> support ZLIB supercompression besides the BasisLZ and Zstd supercompression schemes supported previously.</li>
|
|
</ul>
|
|
<p>Please refer to the manual pages or use the <span class="tt">--help</span> command-line option for further details on the options available and associated semantics for each individual command.</p>
|
|
<hr />
|
|
<dl class="section user"><dt>This page last modified $Date$</dt><dd></dd></dl>
|
|
</div></div><!-- PageDoc -->
|
|
<a href="doxygen_crawl.html"></a>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
</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 KTX Tools 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>
|