Kimelas/bgc-c
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Исправление названий в документации

Browse source
This commit is contained in:
Andrey Pokidov 2025-02-05 00:03:55 +07:00
parent c8f5a3f077
commit 847c022533
13 changed files with 104 additions and 104 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/prefixes-rus.md
View file

@ -2,21 +2,22 @@
Библиотека использует префиксы в названиях типов, констант и функций.
Основным префиксом является **BG** (сокращение от **B**asic **G**eometry / Базовая
Геометрия).
Основным префиксом является **BGC** (сокращение от **B**asic **G**eometric
**C**omputations / Базовые Геометрие Вычисления).
Для структур данных префикс имеет вид **Bg**, например: BgFP64Vector3,
BgFP32Versor, BgFP32Matrix2x2.
Для структур данных префикс имеет вид **Bgc**, например: BgcVector3FP64,
BgcVersorFP32, BgcMatrix2x2FP32.
Константы имеют префикс в виде **BG_**, например: BG_FP32_EPSYLON,
BG_FP64_TWO_PI.
Константы имеют префикс в виде **BGC_**, например: BGC_EPSYLON_FP32,
BGC_TWO_PI_FP64.
Функции имеют префикс в виде **bg_**, например: bg_fp32_versor_combine,
bg_fp64_matrix3x3_subtract.
Функции имеют префикс в виде **bgc_**, например: bgc_versor_combine_fp32,
bgc_matrix3x3_subtract_fp64.
Сразу после префикса библиотеки идёт префикс типа. Библиотека использует
два типа чисел с плавающей запятой: **float** и **double** (типы **binary32**
и **binary64** стандарта **IEEE 754**).
Названия констант, типов и функций оканчиваются суффиксом, указывающим на
базовый тип. Библиотека использует два типа чисел с плавающей запятой:
**float** и **double** (типы **binary32** и **binary64** стандарта
**IEEE 754**).
Поэтому в библиотеке есть два префикса типа:
@ -26,20 +27,19 @@ bg_fp64_matrix3x3_subtract.
* **FP64** - означает **F**loating **P**oint **64** bit, то есть, число с
плавающей запятой, 64 бита, что соответствует типу **double** языка Си.
Типы структур, использующие тип **float** имеют префикс типа в виде **FP32**:
BgFP32Vector3, BgFP32Matrix3x2, BgFP32Quaternion
Типы структур, использующие тип **float** имеют суффикс **FP32**:
BgcVector3FP32, BgcMatrix3x2FP32, BgcQuaternionFP32
Типы структур, использующие тип **double** имеют префикс типа в виде **FP64**:
BgFP64Vector2, BgFP64Matrix2x3, BgFP64Versor
Типы структур, использующие тип **double** имеют суффикс **FP64**:
BgcVector2FP64, BgcMatrix2x3FP64, BgcVersorFP64
Константы типа **float** имеют префикс типа в виде **FP32_**: BG_FP32_PI,
BG_FP32_EPSYLON.
Константы типа **float** имеют суффикс **FP32_**: BGC_PI_FP32, BGC_EPSYLON_FP32.
Константы типа **double** имеют префикс типа в виде **FP64_**: BG_FP64_HALF_PI,
BG_FP64_ONE_THIRD.
Константы типа **double** имеют суффикс **FP64_**: BGC_HALF_PI_FP64,
BGC_ONE_THIRD_FP64.
Функции, которые работают с данными типа **float** имеют префикс **fp32_**:
bg_fp32_vector2_get_module, bg_fp32_radians_to_degrees.
Функции, которые работают с данными типа **float** имеют суффикс **_fp32**:
bcg_vector2_get_modulus_fp32, bgc_radians_to_degrees_fp32.
Функции, которые работают с данными типа **double** имеют префикс **fp64_**:
bg_fp64_vector3_reset, bg_fp64_radians_normalize.
Функции, которые работают с данными типа **double** имеют суффикс **_fp64**:
bgc_vector3_reset_fp64, bgc_radians_normalize_fp64.