Skip to content

Latest commit

 

History

History
136 lines (102 loc) · 3.9 KB

Usage.md

File metadata and controls

136 lines (102 loc) · 3.9 KB
Raw

Usage

Executable

You can use texconv.exe or texconv to convert textures.

Arguments

If you want to see the usage of arguments, use the executable with -help option. (texconv.exe -help or ./texconv -help)
And you can see the document of texconv for the details.

Example

These commands will convert test.dds to outdir/test.tga.

for Windows

mkdir outdir
texconv.exe -ft tga -o outdir -y -- test.dds

for Unix

mkdir outdir
./texconv -ft tga -o outdir -y -- test.dds

DLL (or shared library)

You can use texconv as a function of a DLL (or a shared library).

Available functions

texconv

int texconv(int argc, wchar_t* argv[], bool verbose = true,
            bool init_com = false, bool allow_slow_codec = true,
            wchar_t* err_buf = nullptr, int err_buf_size = 0)
  • argc: The number of arguments for texconv.
  • argv: An array of arguments for texconv.
  • verbose: Show info
  • init_com: This flag was used for old versions. It does nothing.
  • allow_slow_codec: Allow to use CPU coded for BC6 and BC7.
  • err_buf: A buffer to store error messages.
  • err_buf_size: The size of the buffer.

The return value is the execution status.
0 means no errors.
And 1 means failed to convert.

texassemble

You can use texassemble if you built the dll with TEXCONV_USE_TEXASSEMBLE option.

int texassemble(int argc, wchar_t* argv[], bool verbose = true,
            bool init_com = false,
            wchar_t* err_buf = nullptr, int err_buf_size = 0)
  • argc: The number of arguments for texassemble.
  • argv: An array of arguments for texassemble.
  • verbose: Shows info
  • init_com: Calls init_com() and uninit_com() internally.
  • err_buf: A buffer to store error messages.
  • err_buf_size: The size of the buffer.

The return value is the execution status.
0 means no errors.
And 1 means failed to convert.

init_com

int init_com()

On Windows, you should initialize COM once in a process.
This function provides a way to do.
It will do nothing on Unix/Linux systems.

The return value is the same as CoInitializeEx's one.
0 means "Initialized."
1 means "It is already initialized."
-2147417850 means "It is already initialized with single thread mode."

uninit_com

void uninit_com()

If init_com() returns 0 or 1, you should uninitialize COM with this function after executing your program.
It will do nothing on Unix/Linux systems.

Example for Python

Here is a sample code for Python.
It'll convert test.dds to outdir/test.tga

import ctypes
import os

# Get DLL
dll_path = os.path.abspath('texconv.dll')  # for windows
# dll_path = os.path.abspath('libtexconv.so')  # for linux
# dll_path = os.path.abspath('libtexconv.dylib')  # for mac
dll = ctypes.cdll.LoadLibrary(dll_path)

# Make arguments
dds_file = 'test.dds'
argv = ['-ft', 'tga', '-o', 'outdir', '-y', '--', dds_file]
argv = [ctypes.c_wchar_p(arg) for arg in argv]
argv = (ctypes.c_wchar_p*len(argv))(*argv)
err_buf = ctypes.create_unicode_buffer(512)

# Convert DDS to TGA
result = dll.texconv(len(argv), argv, verbose=True, init_com=True, allow_slow_codec=False,
                     err_buf=err_buf, err_buf_size=512)

"""
# You can also initialize COM by yourself.
initialized = dll.init_com()
result = dll.texconv(len(argv), argv, verbose=True, init_com=False, allow_slow_codec=False,
                     err_buf=err_buf, err_buf_size=512)
if initialized == 0 or initialized == 1:
    dll.uninit_com()
"""

# Show error message
if result != 0:
    raise RuntimeError(err_buf.value)