.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH MIPGEN "1" "October 2021" "mipgen " "User Commands"
.SH NAME
mipgen \- filament material tools
.SH DESCRIPTION
mipgen generates mipmaps for an image down to the 1x1 level.
.PP
The <output_pattern> argument is a printf\-style pattern.
For example, "mip%2d.png" generates mip01.png, mip02.png, etc.
Miplevel 0 is not generated since it is the original image.
.PP
If the output format is a container format like KTX, then
<output_pattern> is simply a filename.
.SS "Usage:"
.IP
mipgen [options] <input_file> <output_pattern>
.SH OPTIONS
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
print this message
.HP
\fB\-\-license\fR, \fB\-L\fR
.IP
print copyright and license information
.HP
\fB\-\-linear\fR, \fB\-l\fR
.IP
assume that image pixels are already linearized
.HP
\fB\-\-page\fR, \fB\-p\fR
.IP
generate HTML page for review purposes (mipmap.html)
.HP
\fB\-\-quiet\fR, \fB\-q\fR
.IP
suppress console output from the mipgen tool
.HP
\fB\-\-grayscale\fR, \fB\-g\fR
.IP
create a single\-channel image and do not perform gamma correction
.HP
\fB\-\-format\fR=\fI\,[exr\/\fR|hdr|rgbm|psd|png|dds|ktx], \fB\-f\fR [exr|hdr|rgbm|psd|png|dds|ktx]
.IP
specify output file format, inferred from output pattern if omitted
.HP
\fB\-\-kernel\fR=\fI\,[box\/\fR|nearest|hermite|gaussian|normals|mitchell|lanczos|min], \fB\-k\fR [filter]
.IP
specify filter kernel type (defaults to lanczos)
the "normals" filter may automatically change the compression scheme
.HP
\fB\-\-add\-alpha\fR
.IP
if the source image has 3 channels, this adds a fourth channel filled with 1.0
.HP
\fB\-\-strip\-alpha\fR
.IP
ignore the alpha component of the input image
.HP
\fB\-\-mip\-levels\fR=\fI\,N\/\fR, \fB\-m\fR N
.IP
specifies the number of mip levels to generate
if 0 (default), all levels are generated
.HP
\fB\-\-compression\fR=\fI\,COMPRESSION\/\fR, \fB\-c\fR COMPRESSION
.IP
format specific compression:
.IP
KTX:
.IP
astc_[fast|thorough]_[ldr|hdr]_WxH, where WxH is a valid block size
s3tc_rgb_dxt1, s3tc_rgba_dxt5
etc_FORMAT_METRIC_EFFORT
.TP
FORMAT is r11, signed_r11, rg11, signed_rg11, rgb8, srgb8, rgb8_alpha
srgb8_alpha, rgba8, or srgb8_alpha8
.IP
METRIC is rgba, rgbx, rec709, numeric, or normalxyz
EFFORT is an integer between 0 and 100
.IP
PNG: Ignored
Radiance: Ignored
Photoshop: 16 (default), 32
OpenEXR: RAW, RLE, ZIPS, ZIP, PIZ (default)
DDS: 8, 16 (default), 32
.HP
\fB\-\-help\fR, \fB\-h\fR
.IP
print this message
.HP
\fB\-\-license\fR, \fB\-L\fR
.IP
print copyright and license information
.HP
\fB\-\-linear\fR, \fB\-l\fR
.IP
assume that image pixels are already linearized
.HP
\fB\-\-page\fR, \fB\-p\fR
.IP
generate HTML page for review purposes (mipmap.html)
.HP
\fB\-\-quiet\fR, \fB\-q\fR
.IP
suppress console output from the mipgen tool
.HP
\fB\-\-grayscale\fR, \fB\-g\fR
.IP
create a single\-channel image and do not perform gamma correction
.HP
\fB\-\-format\fR=\fI\,[exr\/\fR|hdr|rgbm|psd|png|dds|ktx], \fB\-f\fR [exr|hdr|rgbm|psd|png|dds|ktx]
.IP
specify output file format, inferred from output pattern if omitted
.HP
\fB\-\-kernel\fR=\fI\,[box\/\fR|nearest|hermite|gaussian|normals|mitchell|lanczos|min], \fB\-k\fR [filter]
.IP
specify filter kernel type (defaults to lanczos)
the "normals" filter may automatically change the compression scheme
.HP
\fB\-\-add\-alpha\fR
.IP
if the source image has 3 channels, this adds a fourth channel filled with 1.0
.HP
\fB\-\-strip\-alpha\fR
.IP
ignore the alpha component of the input image
.HP
\fB\-\-mip\-levels\fR=\fI\,N\/\fR, \fB\-m\fR N
.IP
specifies the number of mip levels to generate
if 0 (default), all levels are generated
.HP
\fB\-\-compression\fR=\fI\,COMPRESSION\/\fR, \fB\-c\fR COMPRESSION
.IP
format specific compression:
.IP
KTX:
.IP
astc_[fast|thorough]_[ldr|hdr]_WxH, where WxH is a valid block size
s3tc_rgb_dxt1, s3tc_rgba_dxt5
etc_FORMAT_METRIC_EFFORT
.TP
FORMAT is r11, signed_r11, rg11, signed_rg11, rgb8, srgb8, rgb8_alpha
srgb8_alpha, rgba8, or srgb8_alpha8
.IP
METRIC is rgba, rgbx, rec709, numeric, or normalxyz
EFFORT is an integer between 0 and 100
.IP
PNG: Ignored
Radiance: Ignored
Photoshop: 16 (default), 32
OpenEXR: RAW, RLE, ZIPS, ZIP, PIZ (default)
DDS: 8, 16 (default), 32
.SH EXAMPLES
.IP
mipgen \-g \-\-kernel=hermite grassland.png mip_%03d.png
mipgen \-f ktx \-\-compression=astc_fast_ldr_4x4 grassland.png mips.ktx
mipgen \-f ktx \-\-compression=etc_rgb_rgba_40 grassland.png mips.ktx
.PP
mipgen generates mipmaps for an image down to the 1x1 level.
.PP
The <output_pattern> argument is a printf\-style pattern.
For example, "mip%2d.png" generates mip01.png, mip02.png, etc.
Miplevel 0 is not generated since it is the original image.
.PP
If the output format is a container format like KTX, then
<output_pattern> is simply a filename.
.SS "Usage:"
.IP
mipgen [options] <input_file> <output_pattern>
.IP
mipgen \-g \-\-kernel=hermite grassland.png mip_%03d.png
mipgen \-f ktx \-\-compression=astc_fast_ldr_4x4 grassland.png mips.ktx
mipgen \-f ktx \-\-compression=etc_rgb_rgba_40 grassland.png mips.ktx