aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 398de14bb663edfb3a6528f76ad3b60065bc1f34 (plain)
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
66
67
68
69
70
71
# astc-codec

astc-codec is a software ASTC decoder implementation, which supports the ASTC
LDR profile.

Example usage:

```
#include <astc-codec/astc-codec.h>

// ...

std::vector<uint8_t> astc = LoadMyASTCData();
const size_t width = 640;
const size_t height = 480;

std::vector<uint8_t> result;
result.resize(width * height * 4);

bool success = astc_codec::ASTCDecompressToRGBA(
    astc.data(), astc.size(), width, height, astc_codec::FootprintType::k4x4,
    result.data(), result.size(), /* stride */ width * 4);
```

## Building

### With bazel

Install [Bazel](https://bazel.build/), and then run:

```
bazel build :astc_codec -c opt
```

astc-codec has been tested on Mac and Linux.

### Run Tests

```
bazel test //...
```

### With CMake

Install [CMake](https://cmake.org/), and the run:

```
mkdir build && cd build && cmake .. && make
```

Or open the project in your favorite IDE and import CMakeLists.txt.

### Run Tests

In the build directory, execute:

```
ctest
```


## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for important contributing requirements.

## License

astc-codec project is licensed under the Apache License Version 2.0. You can
find a copy of it in [LICENSE](LICENSE).

This is not an officially supported Google product.