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 2026-04-01 20:44:49 +07:00
parent 8ba075b557
commit e2bf8d28a8
17 changed files with 233 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/vector3/copy-eng.md
View file

@ -31,7 +31,7 @@ destination->z = source->z;
| destination | out | A pointer to a vector to set coordinate values from *source* |
| source | in | A pointer to a vector which coordinates will be copied to *destination* |
The **source** and **destination** parameters must be valid pointers. The NULL (0) value is also considered invalid.
The *source* and *destination* parameters must be valid pointers. The NULL (0) value is also considered invalid.
### Example

6
docs/vector3/reset-eng.md
View file

@ -28,9 +28,9 @@ This function is good for setting up the initial state of a 3D vector.
### Parameters
| Parameter | Direction | Description |
| ---------- | ---------- | -------------------------------------------------------- |
| vector | out | A pointer to a vector which coordinated must be set to 0 |
| Parameter | Direction | Description |
| --------- | --------- | -------------------------------------------------------- |
| vector | out | A pointer to a vector which coordinated must be set to 0 |
You should pass only valid pointers in the parameter *vector*. The NULL (0) value is considered invalid.

10
docs/vector3/reset-rus.md
View file

@ -2,21 +2,21 @@
[English version / Английская версия](reset-eng.md)
Функиция для **BGC_FP32_Vector3**:
Функция для **BGC_FP32_Vector3**:
```c
inline void bgc_fp32_vector3_reset(BGC_FP32_Vector3* const vector);
```
Функиция для **BGC_FP64_Vector3**:
Функция для **BGC_FP64_Vector3**:
```c
inline void bgc_fp64_vector3_reset(BGC_FP64_Vector3* const vector);
```
Данные функции устанавливают значения всех кооординат равным 0.
Данные функции устанавливают значения всех координат равным 0.
Каждая из функций соответствуют следуюим трём строкам кода:
Каждая из функций соответствуют следующим трём строкам кода:
```c
vector->x = 0;
@ -30,7 +30,7 @@ vector->z = 0;
| Параметр | Направление | Описание |
| -------- | ----------- | -------------------------------------------------------------------- |
| vector | исходящий | Указатель на вектор, координаты которого должны быть установлены в 0 |
| vector | исходящий | Указатель на вектор, координаты которого должны быть установлены в 0 |
Необходимо передавать только корректные указатели в параметр *vector*. Значение NULL (0) также считается некорректным.