Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use \-- in doc. to get -- not n-dash in output. #767

Merged
merged 1 commit into from
Sep 13, 2023
Merged

Use \-- in doc. to get -- not n-dash in output. #767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions tools/ktx/command.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ class Command : public Reporter {
/**
//! [command options_generic]
<dl>
<dt>-h, --help</dt>
<dt>-h, \--help</dt>
<dd>Print this usage message and exit.</dd>
<dt>-v, --version</dt>
<dt>-v, \--version</dt>
<dd>Print the version number of this program and exit.</dd>
</dl>
//! [command options_generic]
Expand Down Expand Up @@ -197,7 +197,7 @@ enum class OutputFormat {
/**
//! [command options_format]
<dl>
<dt>--format text | json | mini-json</dt>
<dt>\--format text | json | mini-json</dt>
<dd>Specifies the report output format. Possible options are: <br />
@b text - Human readable text based format. <br />
@b json - Formatted JSON. <br />
Expand Down
50 changes: 25 additions & 25 deletions tools/ktx/command_create.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,7 @@ Create a KTX2 file from various input files.

The following options are available:
<dl>
<dt>--format &lt;enum&gt;</dt>
<dt>\--format &lt;enum&gt;</dt>
<dd>KTX format enum that specifies the image data format.
The enum names are matching the VkFormats without the VK_FORMAT_ prefix.
The VK_FORMAT_ prefix is ignored if present.<br />
Expand All @@ -650,11 +650,11 @@ Create a KTX2 file from various input files.
The format will be used to verify and load all input files into a texture before encoding.<br />
Case insensitive. Required.</dd>
<dl>
<dt>--astc-mode &lt;ldr | hdr&gt;</dt>
<dt>\--astc-mode &lt;ldr | hdr&gt;</dt>
<dd>Specify which encoding mode to use. LDR is the default
unless the input image is 16-bit in which case the default is
HDR.</dd>
<dt>--astc-quality &lt;level&gt;</dt>
<dt>\--astc-quality &lt;level&gt;</dt>
<dd>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
Expand All @@ -670,59 +670,59 @@ Create a KTX2 file from various input files.
<tr><td>exhaustive </td> <td>(equivalent to quality = 100) </td></tr>
</table>
</dd>
<dt>--astc-perceptual</dt>
<dt>\--astc-perceptual</dt>
<dd>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
methods are currently only available for normal maps and RGB
color data.</dd>
</dl>
<dt>--1d</dt>
<dt>\--1d</dt>
<dd>Create a 1D texture. If not set the texture will be a 2D or 3D texture.</dd>
<dt>--cubemap</dt>
<dt>\--cubemap</dt>
<dd>Create a cubemap texture. If not set the texture will be a 2D or 3D texture.</dd>
<dt>--raw</dt>
<dt>\--raw</dt>
<dd>Create from raw image data.</dd>
<dt>--width</dt>
<dt>\--width</dt>
<dd>Base level width in pixels.</dd>
<dt>--height</dt>
<dt>\--height</dt>
<dd>Base level height in pixels.</dd>
<dt>--depth</dt>
<dt>\--depth</dt>
<dd>Base level depth in pixels.
If set the texture will be a 3D texture.</dd>
<dt>--layers</dt>
<dt>\--layers</dt>
<dd>Number of layers.
If set the texture will be an array texture.</dd>
<dt>--runtime-mipmap</dt>
<dt>\--runtime-mipmap</dt>
<dd>Runtime mipmap generation mode.
Sets up the texture to request the mipmaps to be generated by the client application at
runtime.</dd>
<dt>--generate-mipmap</dt>
<dt>\--generate-mipmap</dt>
<dd>Causes mipmaps to be generated during texture creation.
If the --levels is not specified the maximum possible mip level will be generated.
This option is mutually exclusive with --runtime-mipmap and cannot be used with SINT,
UINT or 3D textures.</dd>
When set it enables the use of the following \'Generate Mipmap\' options.
<dl>
<dt>--mipmap-filter &lt;filter&gt;</dt>
<dt>\--mipmap-filter &lt;filter&gt;</dt>
<dd>Specifies the filter to use when generating the mipmaps. Case insensitive.<br />
Possible options are:
box | tent | bell | b-spline | mitchell | blackman | lanczos3 | lanczos4 | lanczos6 |
lanczos12 | kaiser | gaussian | catmullrom | quadratic_interp | quadratic_approx |
quadratic_mix.
Defaults to lanczos4.</dd>
<dt>--mipmap-filter-scale &lt;float&gt;</dt>
<dt>\--mipmap-filter-scale &lt;float&gt;</dt>
<dd>The filter scale to use.
Defaults to 1.0.</dd>
<dt>--mipmap-wrap &lt;mode&gt;</dt>
<dt>\--mipmap-wrap &lt;mode&gt;</dt>
<dd>Specify how to sample pixels near the image boundaries. Case insensitive.<br />
Possible options are:
wrap | reflect | clamp.
Defaults to clamp.</dd>
</dl>
</dl>
<dl>
<dt>--encode basis-lz | uastc<</dt>
<dt>\--encode basis-lz | uastc<</dt>
<dd>Encode the texture with the specified codec before saving it.
This option matches the functionality of the @ref ktx_encode "ktx encode" command.
With each encoding option the following encoder specific options become valid,
Expand All @@ -732,32 +732,32 @@ Create a KTX2 file from various input files.
@snippet{doc} ktx/metrics_utils.h command options_metrics
</dl>
<dl>
<dt>--swizzle [rgba01]{4}</dt>
<dt>\--swizzle [rgba01]{4}</dt>
<dd>KTX swizzle metadata.</dd>
<dt>--input-swizzle [rgba01]{4}</dt>
<dt>\--input-swizzle [rgba01]{4}</dt>
<dd>Pre-swizzle input channels.</dd>
<dt>--assign-oetf &lt;oetf&gt;</dt>
<dt>\--assign-oetf &lt;oetf&gt;</dt>
<dd>Force the created texture to have the specified transfer function, ignoring
the transfer function of the input file(s). Case insensitive.
Possible options are:
linear | srgb
</dd>
<dt>--assign-primaries &lt;primaries&gt;</dt>
<dt>\--assign-primaries &lt;primaries&gt;</dt>
<dd>Force the created texture to have the specified color primaries, ignoring
the color primaries of the input file(s). Case insensitive.
Possible options are:
none | bt709 | srgb | bt601-ebu | bt601-smpte | bt2020 | ciexyz | aces | acescc |
ntsc1953 | pal525 | displayp3 | adobergb
</dd>
<dt>--convert-oetf &lt;oetf&gt;</dt>
<dt>\--convert-oetf &lt;oetf&gt;</dt>
<dd>Convert the input image(s) to the specified transfer function, if different
from the transfer function of the input file(s). If both this and --assign-oetf are
specified, conversion will be performed from the assigned transfer function to the
transfer function specified by this option, if different. Case insensitive.
Possible options are:
linear | srgb
</dd>
<dt>--convert-primaries &lt;primaries&gt;</dt>
<dt>\--convert-primaries &lt;primaries&gt;</dt>
<dd>Convert the image image(s) to the specified color primaries, if different
from the color primaries of the input file(s) or the one specified by --assign-primaries.
If both this and --assign-primaries are specified, conversion will be performed from
Expand All @@ -768,9 +768,9 @@ Create a KTX2 file from various input files.
bt709 | srgb | bt601-ebu | bt601-smpte | bt2020 | ciexyz | aces | acescc | ntsc1953 |
pal525 | displayp3 | adobergb
</dd>
<dt>--fail-on-color-conversions</dt>
<dt>\--fail-on-color-conversions</dt>
<dd>Generates an error if any of the input images would need to be color converted.</dd>
<dt>--warn-on-color-conversions</dt>
<dt>\--warn-on-color-conversions</dt>
<dd>Generates a warning if any of the input images are color converted.</dd>
</dl>
@snippet{doc} ktx/compress_utils.h command options_compress
Expand Down
2 changes: 1 addition & 1 deletion tools/ktx/command_encode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Encode a KTX2 file.

The following options are available:
<dl>
<dt>--codec basis-lz | uastc</dt>
<dt>\--codec basis-lz | uastc</dt>
<dd>Target codec followed by the codec specific options.
With each encoding option the following encoder specific options become valid,
otherwise they are ignored. Case-insensitive.</dd>
Expand Down
16 changes: 8 additions & 8 deletions tools/ktx/command_extract.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Extract selected images from a KTX2 file.

The following options are available:
<dl>
<dt>--transcode &lt;target&gt;</dt>
<dt>\--transcode &lt;target&gt;</dt>
<dd>Transcode the texture to the target format before executing the extract.
Requires the input file to be transcodable (it must be either BasisLZ
supercompressed or has UASTC color model in the DFD). This option matches the
Expand All @@ -88,25 +88,25 @@ Extract selected images from a KTX2 file.
</dd>
</dl>
<dl>
<dt>--uri &lt;uri&gt;</dt>
<dt>\--uri &lt;uri&gt;</dt>
<dd>KTX Fragment URI. https://registry.khronos.org/KTX/specs/2.0/ktx-frag.html
</dd>
<dt>--level [0-9]+ | all</dt>
<dt>\--level [0-9]+ | all</dt>
<dd>Level to extract. When 'all' is used every level is exported. Defaults to 0.
</dd>
<dt>--layer [0-9]+ | all</dt>
<dt>\--layer [0-9]+ | all</dt>
<dd>Layer to extract. When 'all' is used every layer is exported. Defaults to 0.
</dd>
<dt>--face [0-9]+ | all</dt>
<dt>\--face [0-9]+ | all</dt>
<dd>Face to extract. When 'all' is used every face is exported. Defaults to 0.
</dd>
<dt>--depth [0-9]+ | all</dt>
<dt>\--depth [0-9]+ | all</dt>
<dd>Depth slice to extract. When 'all' is used every depth is exported. Defaults to 0.
</dd>
<dt>--all</dt>
<dt>\--all</dt>
<dd>Extract every image slice from the texture.
</dd>
<dt>--raw</dt>
<dt>\--raw</dt>
<dd>Extract the raw image data without any conversion.
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion tools/ktx/command_transcode.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Transcode a KTX2 file.

The following options are available:
<dl>
<dt>--target &lt;target&gt;</dt>
<dt>\--target &lt;target&gt;</dt>
<dd>Target transcode format.
If the target option is not set the r8, rg8, rgb8 or rgba8 target will be
selected based on the number of channels in the input texture.
Expand Down
4 changes: 2 additions & 2 deletions tools/ktx/command_validate.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Validate a KTX2 file.
The following options are available:
@snippet{doc} ktx/command.h command options_format
<dl>
<dt>-g, --gltf-basisu</dt>
<dt>-g, \--gltf-basisu</dt>
<dd>Check compatibility with KHR_texture_basisu glTF extension.</dd>
<dt>-e, --warnings-as-errors</dt>
<dt>-e, \--warnings-as-errors</dt>
<dd>Treat warnings as errors.</dd>
</dl>
@snippet{doc} ktx/command.h command options_generic
Expand Down
4 changes: 2 additions & 2 deletions tools/ktx/compress_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ namespace ktx {
/**
//! [command options_compress]
<dl>
<dt>--zstd &lt;level&gt;</dt>
<dt>\--zstd &lt;level&gt;</dt>
<dd>
Supercompress the data with Zstandard.
Cannot be used with ETC1S / BasisLZ format.
Level range is [1,22].
Lower levels give faster but worse compression.
Values above 20 should be used with caution as they require more memory.
</dd>
<dt>--zlib &lt;level&gt;</dt>
<dt>\--zlib &lt;level&gt;</dt>
<dd>
Supercompress the data with ZLIB.
Cannot be used with ETC1S / BasisLZ format.
Expand Down
38 changes: 19 additions & 19 deletions tools/ktx/encode_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ enum class EncodeCodec {
</dd>

<dl>
<dt>--clevel &lt;level&gt;</dt>
<dt>\--clevel &lt;level&gt;</dt>
<dd>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.</dd>
<dt>--qlevel &lt;level&gt;</dt>
<dt>\--qlevel &lt;level&gt;</dt>
<dd>ETC1S / BasisLZ quality level. Range is [1,255]. Lower
gives better compression/lower quality/faster. Higher gives
less compression/higher quality/slower. @b --qlevel
Expand All @@ -60,27 +60,27 @@ enum class EncodeCodec {
@b --endpoint-rdo-threshold and @b --selector-rdo-threshold
when its value exceeds 128, otherwise their defaults will be
used.</dd>
<dt>--max-endpoints &lt;arg&gt;</dt>
<dt>\--max-endpoints &lt;arg&gt;</dt>
<dd>Manually set the maximum number of color endpoint clusters.
Range is [1,16128]. Default is 0, unset.</dd>
<dt>--endpoint-rdo-threshold &lt;arg&gt;</dt>
<dt>\--endpoint-rdo-threshold &lt;arg&gt;</dt>
<dd>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.</dd>
<dt>--max-selectors &lt;arg&gt;</dt>
<dt>\--max-selectors &lt;arg&gt;</dt>
<dd>Manually set the maximum number of color selector clusters
from [1,16128]. Default is 0, unset.</dd>
<dt>--selector-rdo-threshold &lt;arg&gt;</dt>
<dt>\--selector-rdo-threshold &lt;arg&gt;</dt>
<dd>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.</dd>
<dt>--no-endpoint-rdo</dt>
<dt>\--no-endpoint-rdo</dt>
<dd>Disable endpoint rate distortion optimizations. Slightly
faster, less noisy output, but lower quality per output bit.
Default is to do endpoint RDO.</dd>
<dt>--no-selector-rdo</dt>
<dt>\--no-selector-rdo</dt>
<dd>Disable selector rate distortion optimizations. Slightly
faster, less noisy output, but lower quality per output bit.
Default is to do selector RDO.</dd>
Expand All @@ -94,7 +94,7 @@ enum class EncodeCodec {
</dd>

<dl>
<dt>--uastc-quality &lt;level&gt;</dt>
<dt>\--uastc-quality &lt;level&gt;</dt>
<dd>This optional parameter selects a speed vs quality
tradeoff as shown in the following table:

Expand All @@ -113,9 +113,9 @@ enum class EncodeCodec {
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:</dd>
<dt>--uastc-rdo</dt>
<dt>\--uastc-rdo</dt>
<dd>Enable UASTC RDO post-processing.</dd>
<dt>--uastc-rdo-l &lt;lambda&gt;</dt>
<dt>\--uastc-rdo-l &lt;lambda&gt;</dt>
<dd>Set UASTC RDO quality scalar (lambda) to @e lambda. Lower values yield
higher quality/larger LZ compressed files, higher values yield
lower quality/smaller LZ compressed files. A good range to try
Expand All @@ -124,22 +124,22 @@ enum class EncodeCodec {

Note that previous versions used the @b --uastc-rdo-q option
which was removed because the RDO algorithm changed.</dd>
<dt>--uastc-rdo-d &lt;dictsize&gt;</dt>
<dt>\--uastc-rdo-d &lt;dictsize&gt;</dt>
<dd>Set UASTC RDO dictionary size in bytes. Default is 4096.
Lower values=faster, but give less compression. Range is
[64,65536].</dd>
<dt>--uastc-rdo-b &lt;scale&gt;</dt>
<dt>\--uastc-rdo-b &lt;scale&gt;</dt>
<dd>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.</dd>
<dt>--uastc-rdo-s &lt;deviation&gt;</dt>
<dt>\--uastc-rdo-s &lt;deviation&gt;</dt>
<dd>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.</dd>
<dt>--uastc-rdo-f</dt>
<dt>\--uastc-rdo-f</dt>
<dd>Do not favor simpler UASTC modes in RDO mode.</dd>
<dt>--uastc-rdo-m</dt>
<dt>\--uastc-rdo-m</dt>
<dd>Disable RDO multithreading (slightly higher compression,
deterministic).</dd>
</dl>
Expand All @@ -152,7 +152,7 @@ enum class EncodeCodec {
</dd>

<dl>
<dt>--normal-mode</dt>
<dt>\--normal-mode</dt>
<dd>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
Expand All @@ -172,12 +172,12 @@ enum class EncodeCodec {
</pre>
For ETC1S / BasisLZ encoding, @b '--encode basis-lz', RDO is disabled
(no selector RDO, no endpoint RDO) to provide better quality.</dd>
<dt>--threads &lt;count&gt;</dt>
<dt>\--threads &lt;count&gt;</dt>
<dd>Explicitly set the number of threads to use during
compression. By default, ETC1S / BasisLZ will use the number of
threads reported by thread::hardware_concurrency or 1 if value
returned is 0.</dd>
<dt>--no-sse</dt>
<dt>\--no-sse</dt>
<dd>Forbid use of the SSE instruction set. Ignored if CPU does
not support SSE. SSE can only be disabled on the basis-lz and
uastc compressors.</dd>
Expand Down
4 changes: 2 additions & 2 deletions tools/ktx/metrics_utils.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ namespace ktx {
/**
//! [command options_metrics]
<dl>
<dt>--compare-ssim</dt>
<dt>\--compare-ssim</dt>
<dd>Calculate encoding structural similarity index measure (SSIM) and print it to stdout. Requires Basis-LZ or UASTC encoding.</dd>
<dt>--compare-psnr</dt>
<dt>\--compare-psnr</dt>
<dd>Calculate encoding peak signal-to-noise ratio (PSNR) and print it to stdout. Requires Basis-LZ or UASTC encoding.</dd>
</dl>
//! [command options_metrics]
Expand Down
Loading