nvtt_rs 0.9.0

High-level bindings to the nvtt library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# nvtt_rs

nvtt is a library for converting textures into common compressed formats for use
with graphics APIs. See the [wiki] for more info.

## Example

```rust
use nvtt_rs::{Compressor, CompressionOptions, Format, InputOptions, OutputOptions};

let input_options = InputOptions::new()?;

let mut output_options = OutputOptions::new()?;
output_options.set_output_location("output.dds");

let mut compression_opts = CompressionOptions::new()?;
compression_opts.set_format(Format::Dxt1);

let mut compressor = Compressor::new()?;
compressor.compress(&compression_opts, &input_options, &output_options)?;
```

## Features

### `nvtt_image_integration`

This feature provides the convenience method [`InputOptions::set_image`], which
can be used to configure the [`InputOptions`] directly from types provided by the
[`image`] crate.

Only a limited number of image formats are supported, although this library can
provide automatic conversions from a [`DynamicImage`]. See the [`ValidImage`]
type for more information.

### `serde-serialize`

This feature provides [`serde`] impls for simple `enum` and `struct` types. It is not
possible to serialize a [`Compressor`], [`CompressionOptions`], [`InputOptions`] or
[`OutputOptions`].

## Dependencies

### Linux/macOS

This crate requires a valid cmake installation and a C++ compiler to build.

### Windows

This crate requires a valid installation of Visual Studio.

## Notes

This crate does not currently work on Microsoft Windows due to incomplete work
on the build system.

[wiki]: https://github.com/castano/nvidia-texture-tools/wiki/ApiDocumentation
[`InputOptions::set_image`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/struct.InputOptions.html#method.set_image
[`InputOptions`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/struct.InputOptions.html
[`image`]: https://docs.rs/image/latest/image
[`DynamicImage`]: https://docs.rs/image/latest/image/enum.DynamicImage.html
[`ValidImage`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/enum.ValidImage.html
[`serde`]: https://serde.rs
[`Compressor`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/struct.Compressor.html
[`CompressionOptions`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/struct.CompressionOptions.html
[`OutputOptions`]: http://docs.rs/nvtt_rs/latest/nvtt_rs/struct.OutputOptions.html