Актуализация документации по проекту
This commit is contained in:
parent
ed404690ed
commit
8ba075b557
16 changed files with 279 additions and 222 deletions
|
|
@ -1,22 +1,22 @@
|
|||
# Сброс состояния трёхмерного вектора
|
||||
# Сброс состояния трёхмерного вектора
|
||||
|
||||
[English version / Английская версия](reset-eng.md)
|
||||
[English version / Английская версия](reset-eng.md)
|
||||
|
||||
Функции устанавливают значение 0 всем координатам трёхмерных векторов.
|
||||
|
||||
Функция для **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.
|
||||
|
||||
Каждая из функций соответствуют следуюим трём строкам кода:
|
||||
|
||||
```c
|
||||
vector->x = 0;
|
||||
|
|
@ -24,12 +24,17 @@ vector->y = 0;
|
|||
vector->z = 0;
|
||||
```
|
||||
|
||||
В данные функции не следует передавать некорректные указатели. Значение NULL (0)
|
||||
также считается некорректным.
|
||||
Данные функции подходят для иницализации начального состояния трёхмерного вектора.
|
||||
|
||||
Данная функция хорошо подходит для инициализации начального состояния вектора.
|
||||
### Параметры
|
||||
|
||||
Пример применения:
|
||||
| Параметр | Направление | Описание |
|
||||
| -------- | ----------- | -------------------------------------------------------------------- |
|
||||
| vector | исходящий | Указатель на вектор, координаты которого должны быть установлены в 0 |
|
||||
|
||||
Необходимо передавать только корректные указатели в параметр *vector*. Значение NULL (0) также считается некорректным.
|
||||
|
||||
### Пример
|
||||
|
||||
```c
|
||||
#include <stdio.h>
|
||||
|
|
@ -47,4 +52,5 @@ int main()
|
|||
}
|
||||
```
|
||||
|
||||
[Документация](../intro-rus.md) / [3D векторы](../vector3-rus.md)
|
||||
[Документация](../intro-eng.md) / [Трёхмерные векторы](../vector3-eng.md)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue