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 Texdiag (markdown)

Chuck Walbourn 2024-10-28 15:11:02 -07:00
parent cddd4a3f4e
commit 0794a994fb
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Texdiag.md

@ -37,55 +37,55 @@ The file-name parameter indicates the file(s) to diagnose using ``dds``, ``tga``
**-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** _filename_: Provides the output filename and file type for a ``diff`` command. Defaults to the same as the first input image as a ``bmp``.
**-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) for ``diff`` command.
**-y**, **--overwrite**: overwrite existing output file (if any) for ``diff`` command.
## Filtering options
**-if _filter_**: Image filter used for loading WIC-based images required for some formats. 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 loading WIC-based images required for some formats. 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.
## DirectDraw Surface (DDS) file options
**-tu**: DDS files with TYPELESS formats are treated as UNORM
**-tf**: DDS files with TYPELESS formats are treated as FLOAT
**-tu**, **--typeless-unorm**: DDS files with TYPELESS formats are treated as UNORM
**-tf**, **--typeless-float**: DDS files with TYPELESS formats are treated as FLOAT
> Generally typeless formats will fail most operations, so these options let you override the type.
**-dword**: For DDS files that use a DWORD alignment instead of BYTE alignment (used for some legacy files typically 24bpp).
**-dword**, **--dword-alignment**: For DDS files that use a DWORD alignment instead of BYTE alignment (used for some legacy files typically 24bpp).
**-badtails**: For older DDS files that incorrectly encode the DXTn block compression mipchain surface blocks smaller than 4x4. This switch causes the loader to tolerate the slightly too short file length and to copy the 4x4 blocks to the smaller ones. The result is not identical to re-computing computing the mipchain fully, but does provide non-corrupted data.
**--bad-tails**: For older DDS files that incorrectly encode the DXTn block compression mipchain surface blocks smaller than 4x4. This switch causes the loader to tolerate the slightly too short file length and to copy the 4x4 blocks to the smaller ones. The result is not identical to re-computing computing the mipchain fully, but does provide non-corrupted data.
**-permissive**: Allows some malformed and variant header files to be loaded.
**--permissive**: Allows some malformed and variant header files to be loaded.
**-ignoremips**: Loads only the top-level mipmap, which is useful for some malformed files that are missing data.
**--ignore-mips**: Loads only the top-level mipmap, which is useful for some malformed files that are missing data.
**-xlum**: DDS files with L8, A8L8, or L16 formats are expanded to 8:8:8:8 or 16:16:16:16. Without this flag, they are converted to 1-channel (red) or 2-channel (red/green) formats.
**-xlum**, **--expand-luminance**: DDS files with L8, A8L8, or L16 formats are expanded to 8:8:8:8 or 16:16:16:16. Without this flag, they are converted to 1-channel (red) or 2-channel (red/green) formats.
## DIFF options
**-f** _format_: Provides the desired output format for a ``diff`` command. Defaults to BRGA32.
**-f _format_**, **--format _format_**: Provides the desired output format for a ``diff`` command. Defaults to BRGA32.
**-c _color_**: Provide a 'highlight color' to use for the ``diff`` command. By default, no highlight is used. For example, use ``-c 00FF00`` for a green highlight where the absolute difference exceeds a threshold.
**-c _color_**, **--diff-color _color_**: Provide a 'highlight color' to use for the ``diff`` command. By default, no highlight is used. For example, use ``-c 00FF00`` for a green highlight where the absolute difference exceeds a threshold.
**-t _float_**: Provides the threshold value in 0..1 for the ``diff`` command to control color highlighting (``-c``). Defaults to 0.25.
**-t _float_**, **--threshold _float_**: Provides the threshold value in 0..1 for the ``diff`` command to control color highlighting (``-c``). Defaults to 0.25.
## DUMPBC options
**-targetx** _num_, **-targety** _num_: Provides a target pixel location for the ``dumpbc`` command. For ``DDS`` files with mipmap chains it will match the block that maps to the pixel location in subsequently lower mip-levels. By default ``dumpbc`` dumps out all blocks.
**--target-x** _num_, **--target-y** _num_: Provides a target pixel location for the ``dumpbc`` command. For ``DDS`` files with mipmap chains it will match the block that maps to the pixel location in subsequently lower mip-levels. By default ``dumpbc`` dumps out all blocks.
## DUMPDDS options
**-ft _file-type_**: (``dumpdds`` command only) A file type for the output texture. Use one of the following. The default value is ``bmp``.
**-ft _file-type_**, **--file-type _file-type_**: (``dumpdds`` command only) A file type for the output texture. Use one of the following. The default value is ``bmp``.
* ``bmp``: Windows BMP
* ``hdr``: Radiance RGBE
* ``jpg``, ``jpeg``: Joint Photographic Experts Group