Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release_body_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**Status:** ${STATUS_DATE}
**Status:** Released ${STATUS_DATE}

The ${RELEASE_VERSION} release is a minor/major maintenance release.

Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ if(MSVC)
add_compile_options("/wd4324")
endif()

project(astcencoder VERSION 5.5.0)
project(astcencoder VERSION 5.6.0)

set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
Expand Down
22 changes: 12 additions & 10 deletions Docs/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ are an extra build output that are not currently used by the command line tool.
All normal builds will support all ASTC block sizes, including the worst case
6x6x6 3D block size (216 texels per block). Compressor memory footprint and
performance can be improved by limiting the block sizes supported in the build
by adding `-DASTCENC_BLOCK_MAX_TEXELS=<texel_count>` to to CMake command line
by adding `-DASTCENC_BLOCK_MAX_TEXELS=<texel_count>` to the CMake command line
when configuring. Legal block sizes that are unavailable in a restricted build
will return the error `ASTCENC_ERR_NOT_IMPLEMENTED` during context creation.

Expand Down Expand Up @@ -221,7 +221,7 @@ microarchitecture pairing that you are targeting.
### Test builds

We support building unit tests. These use the `googletest` framework, which is
pulled in though a git submodule. On first use, you must fetch the submodule
pulled in through a git submodule. On first use, you must fetch the submodule
dependency:

```shell
Expand Down Expand Up @@ -294,10 +294,11 @@ The current RISC-V Vector backend only supports VLEN=256 hardware, due to
toolchain limitations that make a vector-length-agnostic port challenging.
Hopefully there will be one in the future.

Since the backend only works when the VLEN is exactly 256, and you can only
enable this as a global compiler flag, there is no separate build target for
the backend yet. To enable it, simple build the none or native build target,
with the `-mrvv-vector-bits=zvl` CXXFLAG and a `zvl256b` in the ISA string.
Since the backend only works when the vector length is exactly 256 bits, and
you can only enable this as a global compiler flag, there is no separate build
target for the backend yet. To enable it, simply build the NONE or NATIVE build
target, with the `-mrvv-vector-bits=zvl` CXXFLAG and a `zvl256b` in the
`-march` ISA configuration string.

You can cross-compile to RISC-V with the backend enabled using the following
commands:
Expand All @@ -319,7 +320,7 @@ the current CMake configuration using the `package` build target

Configure CMake with:

* `-DASTCENC_PACAKGE=<arch>` to set the package architecture/variant name used
* `-DASTCENC_PACKAGE=<arch>` to set the package architecture/variant name used
to name the package archive (not set by default).

```shell
Expand All @@ -335,9 +336,10 @@ Windows packages will use the `.zip` format, other packages will use the

The core codec of `astcenc` is built as a library, and so can be easily
integrated into other projects. We recommend integrating the project in a way
that lets you control which version of `astcenc` you are using, as this allows you to manage API version changes.
that lets you control which version of `astcenc` you are using, as this allows
you to manage API version changes.

An basic example of CMake integration and codec API usage can be found in the `./Utils/Example` directory. See the [Example Readme](../Utils/Example/README.md) for more details.
A basic example of CMake integration and codec API usage can be found in the `./Utils/Example` directory. See the [Example Readme](../Utils/Example/README.md) for more details.

> [!CAUTION]
> This example is designed to always use the latest main branch so that it
Expand All @@ -354,7 +356,7 @@ increment.

When updating to a newer major version, callers of the API should expect that
they will need to update to synchronize with any changes. When a major API
version makes changes to the API, they will be done in way that deliberately
version makes changes to the API, they will be done in a way that deliberately
causes a compilation failure. This avoids applications hitting failures that
only occur at runtime.

Expand Down
308 changes: 0 additions & 308 deletions Docs/ChangeLog-3x.md

This file was deleted.

Loading
Loading