Command Reference
quicktex
Encode and Decode various image formats
quicktex [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
decode
Decode DDS files to images.
quicktex decode [OPTIONS] [FILENAMES]...
Options
- -f, --flip, -F, --no-flip
Vertically flip image after converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -x, --extension <extension>
Extension to use for output. Ignored if output is a single file. Output filetype is deduced from this
- Default
.png
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)
encode
Encode images to DDS files of the given format.
quicktex encode [OPTIONS] COMMAND [ARGS]...
auto
Encode images to BC1 or BC3, with the format chosen based on each image’s alpha channel.
quicktex encode auto [OPTIONS] [FILENAMES]...
Options
- -l, --level <level>
Quality level to use. Higher values = higher quality, but slower.
- -b, --black, -B, --no-black
[BC1 only] Enable 3-color mode for blocks containing black or very dark pixels. –3color must also be enabled for this to work. (Important: engine/shader MUST ignore decoded texture alpha if this flag is enabled!)
- -3, --3color, -4, --4color
[BC1 only] Enable 3-color mode for non-black pixels. Higher quality, but slightly slower.
- -f, --flip, -F, --no-flip
Vertically flip image before converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)
bc1
Encode images to BC1 (RGB, no alpha).
quicktex encode bc1 [OPTIONS] [FILENAMES]...
Options
- -l, --level <level>
Quality level to use. Higher values = higher quality, but slower.
- -b, --black, -B, --no-black
Enable 3-color mode for blocks containing black or very dark pixels. –3color must also be enabled for this to work. (Important: engine/shader MUST ignore decoded texture alpha if this flag is enabled!)
- -3, --3color, -4, --4color
Enable 3-color mode for non-black pixels. Higher quality, but slightly slower.
- -f, --flip, -F, --no-flip
Vertically flip image before converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)
bc3
Encode images to BC4 (RGBA, 8-bit interpolated alpha).
quicktex encode bc3 [OPTIONS] [FILENAMES]...
Options
- -l, --level <level>
Quality level to use. Higher values = higher quality, but slower.
- -f, --flip, -F, --no-flip
Vertically flip image before converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)
bc4
Encode images to BC4 (Single channel, 8-bit interpolated red channel).
quicktex encode bc4 [OPTIONS] [FILENAMES]...
Options
- -f, --flip, -F, --no-flip
Vertically flip image before converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)
bc5
Encode images to BC5 (2-channel, 8-bit interpolated red and green channels).
quicktex encode bc5 [OPTIONS] [FILENAMES]...
Options
- -f, --flip, -F, --no-flip
Vertically flip image before converting.
- Default
True
- -r, --remove
Remove input images after converting.
- -s, --suffix <suffix>
Suffix to append to output file(s). Ignored if output is a single file.
- -o, --output <output>
Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are decoded in place.
Arguments
- FILENAMES
Optional argument(s)