diff --git a/README.md b/README.md index 4344ca099..7156d6e60 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,11 @@ [![Documentation Status](https://readthedocs.org/projects/fastgltf/badge/?version=latest)](https://fastgltf.readthedocs.io/latest/?badge=latest) -**fastgltf** is a speed and usability focused glTF 2.0 parser written in modern C++17 with minimal dependencies. +**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies. It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data. By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data. -The parser supports the entirety of glTF 2.0 specification, including many extensions. +The library supports the entirety of glTF 2.0 specification, including many extensions. By default, fastgltf will only do the absolute minimum to work with a glTF model. However, it brings many additional features to ease working with the data, including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices. diff --git a/docs/api.rst b/docs/api.rst index e80b76eae..ef6fff71e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -143,7 +143,7 @@ Asset Reading & Writing -====== +================= This section contains all types that one requires to read or write a glTF file using fastgltf. This includes the Parser class, Exporter class, options, and data buffers. diff --git a/docs/index.rst b/docs/index.rst index ebf085405..819dac62e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,11 @@ fastgltf ======== -**fastgltf** is a speed and usability focused glTF 2.0 parser written in modern C++17 with minimal dependencies. +**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies. It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data. By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data. -The parser supports the entirety of glTF 2.0 specification, including many extensions. +The library supports the entirety of glTF 2.0 specification, including many extensions. By default, fastgltf will only do the absolute minimum to work with a glTF model. However, it brings many additional features to ease working with the data, including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices. diff --git a/docs/overview.rst b/docs/overview.rst index fd82958cf..e16c0660e 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -4,11 +4,11 @@ Overview .. contents:: Table of Contents -**fastgltf** is a speed and usability focused glTF 2.0 parser written in modern C++17 with minimal dependencies. +**fastgltf** is a speed and usability focused glTF 2.0 library written in modern C++17 with minimal dependencies. It uses SIMD in various areas to decrease the time the application spends parsing and loading glTF data. By taking advantage of modern C++17 (and optionally C++20) it also provides easy and safe access to the properties and data. -The parser supports the entirety of glTF 2.0 specification, including many extensions. +The library supports the entirety of glTF 2.0 specification, including many extensions. By default, fastgltf will only do the absolute minimum to work with a glTF model. However, it brings many additional features to ease working with the data, including accessor tools, the ability to directly write to mapped GPU buffers, and decomposing transform matrices. @@ -118,7 +118,7 @@ The following snippet illustrates how to use fastgltf to load a glTF file. .. code:: c++ - #include + #include #include void load(std::filesystem::path path) { diff --git a/docs/tools.rst b/docs/tools.rst index 5a3b24c45..a8f4529b4 100644 --- a/docs/tools.rst +++ b/docs/tools.rst @@ -21,8 +21,10 @@ For example, ``glm::vec3`` would be a vector of 3 floats, which would be defined template <> struct fastgltf::ElementTraits : fastgltf::ElementTraitsBase {}; -Note that, for glm types, there is a header with all pre-defined types shipped with fastgltf: ``fastgltf/glm_element_traits.hpp``. -This header includes the ElementTraits definition for all relevant glm types. +.. note:: + + Note that, for glm types, there is a header with all pre-defined types shipped with fastgltf: ``fastgltf/glm_element_traits.hpp``. + This header includes the ElementTraits definition for all relevant glm types. .. warning::