170 lines
6.7 KiB
HTML
170 lines
6.7 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 validate</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('ktx_validate.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 validate </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Validate a KTX2 file.</p>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_synopsis"></a>
|
|
SYNOPSIS</h1>
|
|
<p>ktx validate [option...] <em>input-file</em> </p>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_description"></a>
|
|
DESCRIPTION</h1>
|
|
<p><b>ktx</b> <b>validate</b> validates the Khronos texture format version 2 (KTX2) file specified as the <em>input-file</em> argument. It prints any found errors and warnings to stdout. If the <em>input-file</em> is '-' the file will be read from the stdin.</p>
|
|
<p>The validation rules and checks are based on the official specification: KTX File Format Specification - <a href="https://registry.khronos.org/KTX/specs/2.0/ktxspec.v2.html">https://registry.khronos.org/KTX/specs/2.0/ktxspec.v2.html</a></p>
|
|
<p>The JSON output formats conform to the <a href="https://schema.khronos.org/ktx/validate_v0.json">https://schema.khronos.org/ktx/validate_v0.json</a> schema.</p>
|
|
<dl class="section note"><dt>Note</dt><dd><b>ktx</b> <b>validate</b> prints using UTF-8 encoding. If your console is not set for UTF-8 you will see incorrect characters in output of the file identifier on each side of the "KTX nn".</dd></dl>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_options"></a>
|
|
OPTIONS</h1>
|
|
<p>The following options are available: </p><dl>
|
|
<dt>--format text | json | mini-json </dt>
|
|
<dd>Specifies the report output format. Possible options are: <br />
|
|
<b>text</b> - Human readable text based format. <br />
|
|
<b>json</b> - Formatted JSON. <br />
|
|
<b>mini-json</b> - Minified JSON. <br />
|
|
The default format is <b>text</b>. </dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>-g, --gltf-basisu </dt>
|
|
<dd>Check compatibility with KHR_texture_basisu glTF extension. </dd>
|
|
<dt>-e, --warnings-as-errors </dt>
|
|
<dd>Treat warnings as errors. </dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>-h, --help </dt>
|
|
<dd>Print this usage message and exit. </dd>
|
|
<dt>-v, --version </dt>
|
|
<dd>Print the version number of this program and exit. </dd>
|
|
</dl>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_exitstatus"></a>
|
|
EXIT STATUS</h1>
|
|
<ul>
|
|
<li>0 - Success</li>
|
|
<li>1 - Command line error</li>
|
|
<li>2 - IO failure</li>
|
|
<li>3 - Invalid input file</li>
|
|
<li>4 - Runtime or library error</li>
|
|
<li>5 - Not supported state or operation</li>
|
|
<li>6 - Requested feature is not yet implemented </li>
|
|
</ul>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_history"></a>
|
|
HISTORY</h1>
|
|
<dl class="section user"><dt>Version 4.0</dt><dd><ul>
|
|
<li>Initial version</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<h1 class="doxsection"><a class="anchor" id="ktx_validate_author"></a>
|
|
AUTHOR</h1>
|
|
<ul>
|
|
<li>Mátyás Császár [Vader], RasterGrid www.rastergrid.com</li>
|
|
<li>Daniel Rákos, RasterGrid www.rastergrid.com </li>
|
|
</ul>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</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 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>
|