drewcassidy
/
quicktex
mirror of https://github.com/drewcassidy/quicktex.git
1
0
Fork 0
Code Issues Projects Releases Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
311 Commits
9 Branches
11 Tags
30 MiB
C++ 93.7%
Python 5.5%
CMake 0.8%
 
 
 
main
dev
dependabot/github_actions/dev/pypa/cibuildwheel-2.12.0
dependabot/github_actions/dev/actions/setup-python-4.5.0
feature/simd
feature/pytest
scikit-build
hotfix/mipmap-alpha-fix
faster-single-tables
0.2.0
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.5
0.0.3
0.0.2
0.0.1
0.0.4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac4e5b2679'
${ noResults }
Go to file
Andrew Cassidy ac4e5b2679 Release 0.1.3 
### Fixed

- Fixed quicktex not compiling for python 3.10 on Windows

### Changed

- Reworked CI job, adding wheels for ARM macOS, ARM Linux, and x86 musl Linux.
- Added wheels for python 3.10
- Added a more useful error message when importing quicktex on macOS when libomp.dylib isn't installed
 		2 years ago
.github Bump actions/setup-python from 3.1.1 to 3.1.2 2 years ago
docs some util functions 3 years ago
quicktex Add more helpful error when importing without libomp installed 2 years ago
tests Use relative imports in tests 2 years ago
tools use pybind11-stubgen instead 3 years ago
.clang-format Flesh out usage of block classes more 3 years ago
.clang-tidy Flesh out usage of block classes more 3 years ago
.gitignore Remove nose dependence 2 years ago
CHANGELOG.md Release 0.1.3 2 years ago
CMakeLists.txt Another attempt 2 years ago
LICENSE.md I changed my mind. 3 years ago
README.md metadata and readme fixes 3 years ago
pyproject.toml why 2 years ago
setup.py Another attempt 2 years ago

README.md

Quicktex

A python library for using DDS files

Quicktex is a python library and command line tool for encoding and decoding DDS files. It is based on the RGBCX encoder, which is currently one of the highest quality S3TC encoders available. Quicktex has a python front end, but the encoding and decoding is all done in C++ for speed comparable to the original library.

Installation

To install, first clone this repo and cd into it, then run:

git submodule update --init
pip install .

and setuptools will take care of any dependencies for you.

If you are on macOS, it is recommended to first install openMP from homebrew to enable multithreading, since it is not included in the default Apple Clang install:

brew install libomp

The package also makes tests, stub generation, and docs available. To install the required dependencies for them, install with options like so:

pip install .[tests,stubs,docs]

Quicktex will be available on Pypi once it is out of alpha.

Usage

Usage: quicktex [OPTIONS] COMMAND [ARGS]...

  Encode and Decode various image formats

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  decode  Decode DDS files to images.
  encode  Encode images to DDS files of the given format.

To decode DDS files to images, use the decode subdommand, along with a glob or a list of files to decode.

To encode images to DDS files, use the encode subcommand, plus an additional subcommand for the format. For example, quicktex encode bc1 bun.png will encode bun.png in the current directory to a bc1/DXT1 dds file next to it.

encode and decode both accept several common parameters:

  • -f, --flip / -F, --no-flip: Vertically flip image before/after converting. [default: True]
  • -r, --remove: Remove input images after converting.
  • -s, --suffix TEXT: Suffix to append to output filename(s). Ignored if output is a single file.
  • -o, --output: Output file or directory. If outputting to a file, input filenames must be only a single item. By default, files are converted in place.