Skip to content

Commit 8899291

Browse files
committed
Update documentation about C++ version change
1 parent 908a29c commit 8899291

File tree

4 files changed

+15
-14
lines changed

4 files changed

+15
-14
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
[![Documentation Status](https://readthedocs.org/projects/fastgltf/badge/?version=latest)](https://fastgltf.readthedocs.io/latest/?badge=latest)
88

99

10-
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies.
10+
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++20 with minimal dependencies.
1111
It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data.
12-
By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data.
12+
By taking advantage of modern C++20 it also provides easy and safe access to the properties and data.
1313
It is also available as a C++20 [named module](https://en.cppreference.com/w/cpp/language/modules).
1414

1515
The library supports the entirety of glTF 2.0 specification, including many extensions.
@@ -19,6 +19,9 @@ including accessor tools, the ability to directly write to mapped GPU buffers, a
1919

2020
To learn more about fastgltf, its features, performance and API you can read [the docs](https://fastgltf.readthedocs.io/).
2121

22+
> [!NOTE]
23+
> For C++17 compatibility, please use v0.9.x. Later versions require C++20.
24+
2225
## Examples and real-world usage
2326

2427
You can find some examples in the `examples/` directory of this repository on how to use fastgltf in a 3D renderer to load glTF files.

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
fastgltf
22
========
33

4-
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies.
4+
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++20 with minimal dependencies.
55
It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data.
6-
By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data.
6+
By taking advantage of modern C++20 it also provides easy and safe access to the properties and data.
7+
It is also available as a C++20 `named module <https://en.cppreference.com/w/cpp/language/modules>`_.
78

89
The library supports the entirety of glTF 2.0 specification, including many extensions.
910
By default, fastgltf will only do the absolute minimum to work with a glTF model.
1011
However, it brings many additional features to ease working with the data,
1112
including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices.
1213

14+
.. note::
15+
For C++17 compatibility, please use v0.9.x. Later versions require C++20.
1316

1417
Indices and tables
1518
------------------

docs/options.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,6 @@ This allocator allocates fixed-size blocks of memory as needed and divides them
4040
All of this functionality can be disabled using this flag.
4141
All types will then be normal ``std`` containers and use standard heap allocation with new and malloc.
4242

43-
``FASTGLTF_COMPILE_AS_CPP20``
44-
-----------------------------
45-
46-
This ``BOOL`` option controls the C++ standard the library is compiled as. When ``NO`` fastgltf is always compiled as C++17.
47-
When ``YES`` fastgltf is compiled as C++20, including the tests. This might allow the compiler to perform certain optimisations,
48-
since fastgltf then uses some specialized stdlib functions instead.
49-
5043
``FASTGLTF_ENABLE_CPP_MODULES``
5144
-------------------------------
5245

docs/overview.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@ Overview
44

55
.. contents:: Table of Contents
66

7-
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies.
7+
**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++20 with minimal dependencies.
88
It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data.
9-
By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data.
9+
By taking advantage of modern C++20 it also provides easy and safe access to the properties and data.
1010
It is also available as a C++20 `named module <https://en.cppreference.com/w/cpp/language/modules>`_.
1111

1212
The library supports the entirety of glTF 2.0 specification, including many extensions.
1313
By default, **fastgltf** will only do the absolute minimum to work with a glTF model.
1414
However, it brings many additional features to ease working with the data,
1515
including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices.
1616

17+
.. note::
18+
For C++17 compatibility, please use v0.9.x. Later versions require C++20.
1719

1820
.. _why:
1921

@@ -110,7 +112,7 @@ Usage
110112
.. _vcpkg: https://github.com/microsoft/vcpkg
111113
.. _conan: https://conan.io/
112114

113-
**fastgltf** is a pure C++17 library and only depends on simdjson.
115+
**fastgltf** is a C++20 library and only depends on simdjson.
114116
By using the included CMake 3.11 script, simdjson is automatically downloaded while configuring by default.
115117
The library is tested on GCC 9, GCC 10, Clang 13, and MSVC 14 (Visual Studio 2022) using CI.
116118
**fastgltf** is also available from vcpkg_ and conan_.

0 commit comments

Comments
 (0)