From c2c7246ffb3a09495aee212431358a1a50699f1f Mon Sep 17 00:00:00 2001 From: Mark Callow <2244683+MarkCallow@users.noreply.github.com> Date: Wed, 13 Sep 2023 21:48:10 +0900 Subject: [PATCH] Use \-- in doc. to get -- not n-dash in output. (#767) Fixes #766. --- utils/ktxapp.h | 4 ++-- utils/scapp.h | 60 +++++++++++++++++++++++++------------------------- 2 files changed, 32 insertions(+), 32 deletions(-) diff --git a/utils/ktxapp.h b/utils/ktxapp.h index 86c6bbbfe5..d069e12d6a 100644 --- a/utils/ktxapp.h +++ b/utils/ktxapp.h @@ -79,9 +79,9 @@ struct clamped /** //! [ktxApp options]
-
-h, --help
+
-h, \--help
Print this usage message and exit.
-
-v, --version
+
-v, \--version
Print the version number of this program and exit.
diff --git a/utils/scapp.h b/utils/scapp.h index 49ce8a8aff..ea2bb757bf 100644 --- a/utils/scapp.h +++ b/utils/scapp.h @@ -139,7 +139,7 @@ astcEncoderMode(const char* mode) { // so the table below has to be laboriously done in html. //! [scApp options]
-
--encode <astc | etc1s | uastc>
+
\--encode <astc | etc1s | uastc>
Compress the image data to ASTC, transcodable ETC1S / BasisLZ or high-quality transcodable UASTC format. Implies @b --t2. With each encoding option the following @@ -148,7 +148,7 @@ astcEncoderMode(const char* mode) {
astc:
Create a texture in high-quality ASTC format.
-
--astc_blk_d <XxY | XxYxZ>
+
\--astc_blk_d <XxY | XxYxZ>
Specify which block dimension to use for compressing the textures. e.g. @b --astc_blk_d 6x5 for 2D or @b --astc_blk_d 6x6x6 for 3D. 6x6 is the default for 2D. @@ -180,11 +180,11 @@ astcEncoderMode(const char* mode) { 6x6x5 0.71 bpp 6x6x6 0.59 bpp
-
--astc_mode <ldr | hdr>
+
\--astc_mode <ldr | hdr>
Specify which encoding mode to use. LDR is the default unless the input image is 16-bit in which case the default is HDR.
-
--astc_quality <level>
+
\--astc_quality <level>
The quality level configures the quality-performance tradeoff for the compressor; more complete searches of the search space improve image quality at the expense of @@ -200,7 +200,7 @@ astcEncoderMode(const char* mode) { exhaustive (equivalent to quality = 100)
-
--astc_perceptual
+
\--astc_perceptual
The codec should optimize for perceptual error, instead of direct RMS error. This aims to improve perceived image quality, but typically lowers the measured PSNR score. Perceptual @@ -214,14 +214,14 @@ astcEncoderMode(const char* mode) { images will have R in the RGB part and G in the alpha part of the compressed texture. When set, the following BasisLZ-related options become valid, otherwise they are ignored.
-
--no_multithreading
+
\--no_multithreading
Disable multithreading. Deprecated. For backward compatibility. Use @b --threads 1 instead.
-
--clevel <level>
+
\--clevel <level>
ETC1S / BasisLZ compression level, an encoding speed vs. quality tradeoff. Range is [0,5], default is 1. Higher values are slower but give higher quality.
-
--qlevel <level>
+
\--qlevel <level>
ETC1S / BasisLZ quality level. Range is [1,255]. Lower gives better compression/lower quality/faster. Higher gives less compression/higher quality/slower. @b --qlevel @@ -241,27 +241,27 @@ astcEncoderMode(const char* mode) { @b --endpoint_rdo_threshold and @b --selector_rdo_threshold when its value exceeds 128, otherwise their defaults will be used.
-
--max_endpoints <arg>
+
\--max_endpoints <arg>
Manually set the maximum number of color endpoint clusters. Range is [1,16128]. Default is 0, unset.
-
--endpoint_rdo_threshold <arg>
+
\--endpoint_rdo_threshold <arg>
Set endpoint RDO quality threshold. The default is 1.25. Lower is higher quality but less quality per output bit (try [1.0,3.0]). This will override the value chosen by @b --qlevel.
-
--max_selectors <arg>
+
\--max_selectors <arg>
Manually set the maximum number of color selector clusters from [1,16128]. Default is 0, unset.
-
--selector_rdo_threshold <arg>
+
\--selector_rdo_threshold <arg>
Set selector RDO quality threshold. The default is 1.25. Lower is higher quality but less quality per output bit (try [1.0,3.0]). This will override the value chosen by @b --qlevel.
-
--no_endpoint_rdo
+
\--no_endpoint_rdo
Disable endpoint rate distortion optimizations. Slightly faster, less noisy output, but lower quality per output bit. Default is to do endpoint RDO.
-
--no_selector_rdo
+
\--no_selector_rdo
Disable selector rate distortion optimizations. Slightly faster, less noisy output, but lower quality per output bit. Default is to do selector RDO.
@@ -270,7 +270,7 @@ astcEncoderMode(const char* mode) {
uastc:
Create a texture in high-quality transcodable UASTC format.
-
--uastc_quality <level>
+
\--uastc_quality <level>
This optional parameter selects a speed vs quality tradeoff as shown in the following table: @@ -289,7 +289,7 @@ astcEncoderMode(const char* mode) { UASTC texture data using the Rate Distortion Optimization (RDO) post-process stage. When uastc encoding is set the following options become available for controlling RDO:
-
--uastc_rdo_l [<lambda>]
+
\--uastc_rdo_l [<lambda>]
Enable UASTC RDO post-processing and optionally set UASTC RDO quality scalar (lambda) to @e lambda. Lower values yield higher quality/larger LZ compressed files, higher values yield @@ -299,30 +299,30 @@ astcEncoderMode(const char* mode) { Note that previous versions used the @b --uastc_rdo_q option which was removed because the RDO algorithm changed.
-
--uastc_rdo_d <dictsize>
+
\--uastc_rdo_d <dictsize>
Set UASTC RDO dictionary size in bytes. Default is 4096. Lower values=faster, but give less compression. Range is [64,65536].
-
--uastc_rdo_b <scale>
+
\--uastc_rdo_b <scale>
Set UASTC RDO max smooth block error scale. Range is [1.0,300.0]. Default is 10.0, 1.0 is disabled. Larger values suppress more artifacts (and allocate more bits) on smooth blocks.
-
--uastc_rdo_s <deviation>
+
\--uastc_rdo_s <deviation>
Set UASTC RDO max smooth block standard deviation. Range is [.01,65536.0]. Default is 18.0. Larger values expand the range of blocks considered smooth.
-
--uastc_rdo_f
+
\--uastc_rdo_f
Do not favor simpler UASTC modes in RDO mode.
-
--uastc_rdo_m
+
\--uastc_rdo_m
Disable RDO multithreading (slightly higher compression, deterministic).
-
--input_swizzle <swizzle> +
\--input_swizzle <swizzle>
Swizzle the input components according to @e swizzle which is an alhpanumeric sequence matching the regular expression @c ^[rgba01]{4}$. -
--normal_mode
+
\--normal_mode
Only valid for linear textures with two or more components. If the input texture has three or four linear components it is assumed to be a three component linear normal map storing unit @@ -347,22 +347,22 @@ astcEncoderMode(const char* mode) { In @em toktx you can prevent conversion of the normal map to two components by specifying '@b --input_swizzle rgb1'. -
--normalize
+
\--normalize
Normalize input normals to have a unit length. Only valid for linear textures with 2 or more components. For 2-component inputs 2D unit normals are calculated. Do not use these 2D unit normals to generate X+Y normals for --normal_mode. For 4-component inputs a 3D unit normal is calculated. 1.0 is used for the value of the 4th component.
-
--no_sse
+
\--no_sse
Forbid use of the SSE instruction set. Ignored if CPU does not support SSE. Only the Basis Universal compressor uses SSE.
-
--bcmp
+
\--bcmp
Deprecated. Use '@b --encode etc1s' instead.
-
--uastc [<level>]
+
\--uastc [<level>]
Deprecated. Use '@b --encode uastc' instead.
-
--zcmp [<compressionLevel>]
+
\--zcmp [<compressionLevel>]
Supercompress the data with Zstandard. Implies @b --t2. Can be used with data in any format except ETC1S / BasisLZ. Most effective with RDO-conditioned UASTC or uncompressed formats. @@ -370,12 +370,12 @@ astcEncoderMode(const char* mode) { is 3. Lower values=faster but give less compression. Values above 20 should be used with caution as they require more memory.
-
--threads <count>
+
\--threads <count>
Explicitly set the number of threads to use during compression. By default, ETC1S / BasisLZ and ASTC compression will use the number of threads reported by thread::hardware_concurrency or 1 if value returned is 0.
-
--verbose
+
\--verbose
Print encoder/compressor activity status to stdout. Currently only the astc, etc1s and uastc encoders emit status.