Улучшение структуры документации

This commit is contained in:
Andrey Pokidov 2025-02-08 00:47:44 +07:00
parent 72b6690ad6
commit f8f6b07c81
20 changed files with 262 additions and 156 deletions

View file

@ -1,6 +1,8 @@
# Названия
# Библиотека базовых геометрических вычислений
## Префиксы
## Особенности наименования
### Префиксы
Библиотека использует префиксы в названиях типов, констант и функций.
@ -16,7 +18,7 @@ BGC_TWO_PI_FP64.
Функции имеют префикс в виде **bgc_**, например: bgc_versor_combine_fp32,
bgc_matrix3x3_subtract_fp64.
## Cуффиксы
### Cуффиксы
Названия констант, типов и функций оканчиваются суффиксом, указывающим на
базовый тип. Библиотека использует два типа чисел с плавающей запятой:
@ -48,7 +50,9 @@ bcg_vector2_get_modulus_fp32, bgc_radians_to_degrees_fp32.
Функции, которые работают с данными типа **double** имеют суффикс **_fp64**:
bgc_vector3_reset_fp64, bgc_radians_normalize_fp64.
## Contents
## Сущности
- 2D и 3D векторы
- [Versors](./versor-rus.md)
- [2D векторы](vector-rus.md)
- 3D векторы
- [Кватернионы](quaternion-rus.md)
- [Версоры](versor-rus.md)