AuroraMiddleware/DirectXTex
1
0
Fork 0
mirror of https://github.com/microsoft/DirectXTex synced 2024-11-21 20:10:05 +00:00
Code Issues Releases Wiki Activity

Updated Texassemble (markdown)

Chuck Walbourn 2024-10-28 14:58:33 -07:00
parent 97d67bcd5d
commit 28d6bdae03
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Texassemble.md

@ -51,29 +51,29 @@ The file-name parameter indicates the file(s) to use to create the assembled ima
**-r**: Input file names can contain wildcard characters (``?`` or ``*``). If this switch is used, subdirectories are also searched.
**-flist _filename_**: Uses the provided filename as a text file containing a list of input files (one per line). Ignores lines that begin with ``#`` (used for comments). Does not support providing additional command-line arguments or the use of filename wildcards.
**-flist _filename_**, **--file-list _filename_**: Uses the provided filename as a text file containing a list of input files (one per line). Ignores lines that begin with ``#`` (used for comments). Does not support providing additional command-line arguments or the use of filename wildcards.
**-o _Output-filename_**: The default name is a ``.DDS`` file based on the first input image file. For cross/strip generation, the default is a ``.BMP`` file and you can specify any of the extensions supported for input.
**-l**: Forces the output path & filename to all lower-case. *Windows file system is case-insensitive by default, but some programs like git are case-sensitive*.
**-l**, **--to-lowercase**: Forces the output path & filename to all lower-case. *Windows file system is case-insensitive by default, but some programs like git are case-sensitive*.
**-y**: overwrite existing output file if any. By default, the tool will abort if the output file already exists.
**-y**, **--overwrite**: overwrite existing output file if any. By default, the tool will abort if the output file already exists.
## Pixel format options
**-f _format_**: Output format. Specify the DXGI format without the ``DXGI_FORMAT_`` prefix (i.e. ``-f R10G10B10A2_UNORM``). If no format is given, the format of the first image file is used.
**-f _format_**, **--format _format_**: Output format. Specify the DXGI format without the ``DXGI_FORMAT_`` prefix (i.e. ``-f R10G10B10A2_UNORM``). If no format is given, the format of the first image file is used.
## Resizing options
**-w _number_**: Width of the output texture in pixels.
**-h _number_**: Height of the output texture in pixels. If no size is given, the size is taken from the first input image.
**-w _number_**, **--width _number_**: Width of the output texture in pixels.
**-h _number_**, **--height _number_**: Height of the output texture in pixels. If no size is given, the size is taken from the first input image.
## Filtering options
**-if _filter_**: Image filter used for resizing the images. Use one of the following: ``POINT``, ``LINEAR``, ``CUBIC``, ``FANT``, ``BOX``, ``TRIANGLE``, ``POINT_DITHER``, ``LINEAR_DITHER``, ``CUBIC_DITHER``, ``FANT_DITHER``, ``BOX_DITHER``, ``TRIANGLE_DITHER``, ``POINT_DITHER_DIFFUSION``, ``LINEAR_DITHER_DIFFUSION``, ``CUBIC_DITHER_DIFFUSION``, ``FANT_DITHER_DIFFUSION``, ``BOX_DITHER_DIFFUSION``, or ``TRIANGLE_DITHER_DIFFUSION``. Filters with ``DITHER`` in their name indicate that the 4x4 ordered dither algorithm, while ``DITHER_DIFFUSION`` is error diffusion dithering.
**-if _filter_**, **--image-filter _filter_**: Image filter used for resizing the images. Use one of the following: ``POINT``, ``LINEAR``, ``CUBIC``, ``FANT``, ``BOX``, ``TRIANGLE``, ``POINT_DITHER``, ``LINEAR_DITHER``, ``CUBIC_DITHER``, ``FANT_DITHER``, ``BOX_DITHER``, ``TRIANGLE_DITHER``, ``POINT_DITHER_DIFFUSION``, ``LINEAR_DITHER_DIFFUSION``, ``CUBIC_DITHER_DIFFUSION``, ``FANT_DITHER_DIFFUSION``, ``BOX_DITHER_DIFFUSION``, or ``TRIANGLE_DITHER_DIFFUSION``. Filters with ``DITHER`` in their name indicate that the 4x4 ordered dither algorithm, while ``DITHER_DIFFUSION`` is error diffusion dithering.
**-wrap**, **-mirror**: Sets the texture addressing mode for filtering to wrap or mirror, otherwise defaults to clamp.
@ -82,16 +82,16 @@ The file-name parameter indicates the file(s) to use to create the assembled ima
## Colorspace options
**-srgb**, **-srgbi**, or **-srgbo**: Use sRGB if both the input and output data are in the sRGB color format (ie. gamma ~2.2). Use sRGBi if only the input is in sRGB; use sRGBo if only the output is in sRGB.
**-srgb**, **-srgbi** / **--srgb-in**, or **-srgbo** / **--srgb-out**: Use sRGB if both the input and output data are in the sRGB color format (ie. gamma ~2.2). Use sRGBi if only the input is in sRGB; use sRGBo if only the output is in sRGB.
**-tonemap**: Applies [tonemap operator](http://www.cs.utah.edu/~reinhard/cdrom/) based on maximum luminosity to ensure HDR image data is adjusted to an LDR range.
**--tonemap**: Applies [tonemap operator](http://www.cs.utah.edu/~reinhard/cdrom/) based on maximum luminosity to ensure HDR image data is adjusted to an LDR range.
## Alpha options
**-alpha**: Converts a premultiplied alpha image to non-premultiplied alpha (a.k.a. straight alpha).
**-sepalpha**: Separates alpha channel for resize.
**-sepalpha**, **--separate-alpha**: Separates alpha channel for resize.
## DirectDraw Surface (DDS) file options
@ -101,24 +101,24 @@ The file-name parameter indicates the file(s) to use to create the assembled ima
## Direct3D options
**-fl _feature-level_**: Sets the target feature level which determines the maximum supported texture size: ``9.1``, ``9.2``, ``9.3``, ``10.0``, ``10.1``, ``11.0``, ``11.1``, ``12.0``, or ``12.1``. Defaults to ``11.0`` which is 16834, the limit for 11.x and 12.x [Direct3D Hardware Feature Level](https://aka.ms/Apsgrj).
**-fl _feature-level_**, **--feature-level _feature-level_**: Sets the target feature level which determines the maximum supported texture size: ``9.1``, ``9.2``, ``9.3``, ``10.0``, ``10.1``, ``11.0``, ``11.1``, ``12.0``, or ``12.1``. Defaults to ``11.0`` which is 16834, the limit for 11.x and 12.x [Direct3D Hardware Feature Level](https://aka.ms/Apsgrj).
## GIF options
**-bgcolor**: When doing the ``gif`` command, by default it always uses a transparent background color which is consistent with most browsers. You can choose to use the background color metadata in the file with this switch instead, but the results are not likely to match most viewers.
**--gif-bg-color**: When doing the ``gif`` command, by default it always uses a transparent background color which is consistent with most browsers. You can choose to use the background color metadata in the file with this switch instead, but the results are not likely to match most viewers.
## MERGE options
**-swizzle _rgbamask_**: When doing the ``merge`` command, by default it uses the Blue channel from the second image as the Alpha channel for the output; pulling Red, Green, and Blue from the first image which is same as the mask ``rgbB``. This option lets you provide alternative channel patterns using [HLSL-style](https://docs.microsoft.com/windows/win32/direct3dhlsl/dx9-graphics-reference-asm-ps-registers-modifiers-source-register-swizzling) swizzle masks. Lowercase letters indicate channels pulled from the first image (``rgbaxyzw``), and uppercase letters indicate the second image (``RGBAXYZW``). The mask is 1 to 4 characters in length. A ``0`` indicates setting that channel to zero, a ``1`` indicates setting that channel to maximum.
**--swizzle _rgbamask_**: When doing the ``merge`` command, by default it uses the Blue channel from the second image as the Alpha channel for the output; pulling Red, Green, and Blue from the first image which is same as the mask ``rgbB``. This option lets you provide alternative channel patterns using [HLSL-style](https://docs.microsoft.com/windows/win32/direct3dhlsl/dx9-graphics-reference-asm-ps-registers-modifiers-source-register-swizzling) swizzle masks. Lowercase letters indicate channels pulled from the first image (``rgbaxyzw``), and uppercase letters indicate the second image (``RGBAXYZW``). The mask is 1 to 4 characters in length. A ``0`` indicates setting that channel to zero, a ``1`` indicates setting that channel to maximum.
> The ``merge`` command default swizzle mask matches the legacy DirectX Texture Tool behavior when doing "Open Alpha onto Surface..."
## Miscellaneous options
**-stripmips**: For the ``cube``, ``array``, ``volume``, or ``cubearray`` command, the input images are expected to be single images. This option allows mip-mapped 1D or 2D textures to be used as inputs, which removes the mip-chain during processing.
**--strip-mips**: For the ``cube``, ``array``, ``volume``, or ``cubearray`` command, the input images are expected to be single images. This option allows mip-mapped 1D or 2D textures to be used as inputs, which removes the mip-chain during processing.
**-nologo**: Suppress copyright message.