mirror of
https://github.com/BinomialLLC/basis_universal.git
synced 2026-11-17 21:36:14 +00:00
Fixing/updating basisu tool help text.
This commit is contained in:
+20
-20
@@ -54,24 +54,24 @@ static void print_usage()
|
||||
"Important: By default, the compressor assumes the input is in the sRGB colorspace (like photos/albedo textures).\n"
|
||||
"If the input is NOT sRGB (like a normal map), be sure to specify -linear for less artifacts.\n"
|
||||
"\n"
|
||||
"Filenames prefixed with a @ symbol are read as filename listing files, specifying which filenames to actually process.\n"
|
||||
"Filenames prefixed with a @ symbol are read as filename listing files. Listing text files specify which actual filenames to process (one filename per line).\n"
|
||||
"\n"
|
||||
"Options:\n"
|
||||
" -file filename.png: Input image filename, multiple images are OK, use -file X for each input filename (prefixing input filenames with -file is optional)\n"
|
||||
" -alpha_file filename.png: Input alpha image filename, multiple images are OK, use -file X for each input filename (must be paired with -file), images converted to REC709 grayscale and used as input alpha\n"
|
||||
" -multifile_printf: printf() format strint to use to compose multiple filenames\n"
|
||||
" -multifile_first: The index of the first file to process, default is 0 (must specify -multifile_printf and -multifile_num))\n"
|
||||
" -multifile_num: The total number of files to process\n"
|
||||
" -linear: Use linear colorspace metrics (instead of sRGB).\n"
|
||||
" -multifile_first: The index of the first file to process, default is 0 (must specify -multifile_printf and -multifile_num)\n"
|
||||
" -multifile_num: The total number of files to process.\n"
|
||||
" -linear: Use linear colorspace metrics (instead of the default sRGB).\n"
|
||||
" -q X: Set quality level, 1-255, default is 128, lower=better compression/lower quality/faster, higher=less compression/higher quality/slower, default is 128\n"
|
||||
" -output_file filename: Output .basis/.ktx filename\n"
|
||||
" -output_path: Output .basis/.ktx files to specified directory\n"
|
||||
" -debug: Enable codec debug print to stdout (slightly slower)\n"
|
||||
" -debug_images: Enable codec debug images (much slower)\n"
|
||||
" -stats: Compute and display image quality metrics (slightly slower)\n"
|
||||
" -slower: Enable optional stages in the compressor for slower but higher quality compression\n"
|
||||
" -output_path: Output .basis/.ktx files to specified directory.\n"
|
||||
" -debug: Enable codec debug print to stdout (slightly slower).\n"
|
||||
" -debug_images: Enable codec debug images (much slower).\n"
|
||||
" -stats: Compute and display image quality metrics (slightly slower).\n"
|
||||
" -slower: Enable optional stages in the compressor for slower but higher quality compression using better codebooks.\n"
|
||||
" -tex_type <2d, 2darray, 3d, video, cubemap>: Set Basis file header's texture type field. Cubemap arrays require multiples of 6 images, in X+, X-, Y+, Y-, Z+, Z- order, each image must be the same resolutions.\n"
|
||||
" (2d=arbitrary 2D images, 2darray=2D array, 3D=volume texture slices, video=video frames, cubemap=array of faces. For 2darray/3d/cubemaps/video, each source image's dimensions and # of mipmap levels must be the same.)\n"
|
||||
" 2d=arbitrary 2D images, 2darray=2D array, 3D=volume texture slices, video=video frames, cubemap=array of faces. For 2darray/3d/cubemaps/video, each source image's dimensions and # of mipmap levels must be the same.\n"
|
||||
" -framerate X: Set framerate in header to X/frames sec\n"
|
||||
" -individual: Process input images individually and output multiple .basis files (not as a texture array)\n"
|
||||
" -fuzz_testing: Use with -validate: Disables CRC16 validation of file contents before transcoding\n"
|
||||
@@ -80,7 +80,7 @@ static void print_usage()
|
||||
" -max_endpoints X: Manually set the max number of color endpoint clusters from 1-16128, use instead of -q\n"
|
||||
" -max_selectors X: Manually set the max number of color selector clusters from 1-16128, use instead of -q\n"
|
||||
" -y_flip: Flip input images vertically before compression\n"
|
||||
" -normal_map: Tunes codec parameters for better quality on normal maps (no selector RDO, no sRGB)\n"
|
||||
" -normal_map: Tunes codec parameters for better quality on normal maps (linear colorspace metrics, linear mipmap filtering, no selector RDO, no sRGB)\n"
|
||||
" -no_alpha: Always output non-alpha basis files, even if one or more inputs has alpha\n"
|
||||
" -force_alpha: Always output alpha basis files, even if no inputs has alpha\n"
|
||||
" -seperate_rg_to_color_alpha: Seperate input R and G channels to RGB and A (for tangent space XY normal maps)\n"
|
||||
@@ -89,18 +89,18 @@ static void print_usage()
|
||||
"\n"
|
||||
"Mipmap generation options:\n"
|
||||
" -mipmap: Generate mipmaps for each source image\n"
|
||||
" -mip_srgb: Convert image to linear before filtering, then back to sRGB\n"
|
||||
" -mip_scale X: Set mipmap filter kernel's scale, lower=sharper, higher=more blurry, default is 1.0\n"
|
||||
" -mip_filter X: Set mipmap filter kernel, default is kaiser, filters: box, tent, bell, blackman, catmullrom, mitchell, etc.\n"
|
||||
" -mip_renorm: Renormalize normal map to unit length vectors after filtering\n"
|
||||
" -mip_clamp: Use clamp addressing on borders, instead of wrapping\n"
|
||||
" -mip_smallest X: Set smallest pixel dimension for generated mipmaps, default is 1\n"
|
||||
" -mip_srgb: Convert image to linear before filtering, then back to sRGB\n"
|
||||
" -mip_smallest X: Set smallest pixel dimension for generated mipmaps, default is 1 pixel\n"
|
||||
"\n"
|
||||
"Backend endpoint/selector RDO codec options:\n"
|
||||
" -no_selector_rdo: Disable backend's selector rate distortion optimizations (slightly faster, less noisy output, but lower quality per output bit)\n"
|
||||
" -selector_rdo_thresh X: Set selector RDO quality threshold, default is 1.25, lower is higher quality but less quality per output bit (try 1.0-3.0)\n"
|
||||
" -no_endpoint_rdo: Disable backend's endpoint rate distortion optimizations (slightly faster, less noisy output, but lower quality per output bit)\n"
|
||||
" -endpoint_rdo_thresh X: Set endpoint RDO quality threshold, default is 1.75, lower is higher quality but less quality per output bit (try 1.0-3.0)\n"
|
||||
" -endpoint_rdo_thresh X: Set endpoint RDO quality threshold, default is 1.5, lower is higher quality but less quality per output bit (try 1.0-3.0)\n"
|
||||
"\n"
|
||||
"Hierarchical virtual selector codebook options:\n"
|
||||
" -global_sel_pal: Always use vitual selector palettes (instead of custom palettes), slightly smaller files, but lower quality, slower encoding\n"
|
||||
@@ -116,16 +116,16 @@ static void print_usage()
|
||||
" -userdata1 X: Set 32-bit userdata1 field in Basis file header to X (X is a signed 32-bit int)\n"
|
||||
"\n"
|
||||
"Various command line examples:\n"
|
||||
"basisu x.png : Compress sRGB image x.png to x.basis using default settings (multiple filenames OK)\n"
|
||||
"basisu x.basis : Unpack x.basis to PNG/KTX files (multiple filenames OK)\n"
|
||||
"basisu -file x.png -mipmap -y_flip : Compress a mipmapped x.basis file from an sRGB image named x.png, Y flip each source image\n"
|
||||
"basisu -validate -file x.basis : Validate x.basis (check header, check file CRC's, attempt to transcode all slices)\n"
|
||||
"basisu -unpack -file x.basis : Validates, transcodes and unpacks x.basis to mipmapped .KTX and RGB/A .PNG files (transcodes to all supported GPU texture formats)\n"
|
||||
"basisu -q 255 -file x.png -mipmap -debug -comput_stats : Compress sRGB x.png to x.basis at quality level 255 with compressor debug output/statistics\n"
|
||||
"basisu -linear -max_endpoint_clusters 16128 -max_selector_clusters 16128 -file x.png : Compress non-sRGB x.png to x.basis using the largest supported manually specified codebook sizes\n"
|
||||
"basisu -q 255 -file x.png -mipmap -debug -stats : Compress sRGB x.png to x.basis at quality level 255 with compressor debug output/statistics\n"
|
||||
"basisu -linear -max_endpoints 16128 -max_selectors 16128 -file x.png : Compress non-sRGB x.png to x.basis using the largest supported manually specified codebook sizes\n"
|
||||
"basisu -linear -global_sel_pal -no_hybrid_sel_cb -file x.png : Compress a non-sRGB image, use virtual selector codebooks for improved compression (but slower encoding)\n"
|
||||
"basisu -linear -global_sel_pal -file x.png: Compress a non-sRGB image, use hybrid selector codebooks for slightly improved compression (but slower encoding)\n"
|
||||
"basisu -multifile_printf \"x%02u.png\" -multifile_first 1 -multifile_count 20 : Compress a 20 sRGB source image video sequence (x01.png, x02.png, x03.png, etc.) to x01.basis\n"
|
||||
"basisu x.png : Compress sRGB image x.png to x.basis using default settings (multiple filenames OK)\n"
|
||||
"basisu x.basis : Unpack x.basis to PNG/KTX files (multiple filenames OK)\n"
|
||||
"basisu -tex_type video -framerate 20 -multifile_printf \"x%02u.png\" -multifile_first 1 -multifile_count 20 : Compress a 20 sRGB source image video sequence (x01.png, x02.png, x03.png, etc.) to x01.basis\n"
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1143,7 +1143,7 @@ static int main_internal(int argc, const char **argv)
|
||||
{
|
||||
basisu_encoder_init();
|
||||
|
||||
printf("Basis Universal GPU Texture Compressor v" BASISU_TOOL_VERSION ", Copyright (C) 2017-2019 Binomial LLC, All rights reserved\n");
|
||||
printf("Basis Universal GPU Texture Compressor Reference Encoder v" BASISU_TOOL_VERSION ", Copyright (C) 2017-2019 Binomial LLC, All rights reserved\n");
|
||||
|
||||
#if defined(DEBUG) || defined(_DEBUG)
|
||||
printf("DEBUG build\n");
|
||||
|
||||
Reference in New Issue
Block a user