Работа над документацией по библиотеке
This commit is contained in:
parent
8ba075b557
commit
e2bf8d28a8
17 changed files with 233 additions and 69 deletions
|
|
@ -2,8 +2,6 @@
|
|||
|
||||
[English version / Английская версия](reset-eng.md)
|
||||
|
||||
Функции устанавливают значение 0 всем координатам двумерных векторов.
|
||||
|
||||
Функция для **BGC_FP32_Quaternion**:
|
||||
|
||||
```c
|
||||
|
|
@ -16,6 +14,8 @@ inline void bgc_fp32_quaternion_reset(BGC_FP32_Quaternion* const quaternion);
|
|||
inline void bgc_fp64_quaternion_reset(BGC_FP64_Quaternion* const quaternion);
|
||||
```
|
||||
|
||||
Функции устанавливают значение 0 всем компонентам кватерниона.
|
||||
|
||||
Каждая из данных функции эквивалентна следующим строкам кода:
|
||||
|
||||
```c
|
||||
|
|
@ -25,13 +25,17 @@ vector->y = 0;
|
|||
vector->z = 0;
|
||||
```
|
||||
|
||||
В параметре **quaternion** следует передавать корректный указатель на
|
||||
существующую область памяти. Значение NULL (0) считается некорректным.
|
||||
Данная функция хорошо подходит для инициализации начального состояния кватерниона.
|
||||
|
||||
Данная функция хорошо подходит для инициализации начального состояния
|
||||
кватерниона.
|
||||
### Параметр
|
||||
|
||||
Пример применения:
|
||||
| Параметр | Направление | Описание |
|
||||
| ---------- | ----------- | ------------------------------------------------------------------------ |
|
||||
| quaternion | исходящий | Указатель на кватернион, компоненты которого должны быть установлены в 0 |
|
||||
|
||||
Необходимо передавать только корректные указатели в параметр *quaternion*. Значение NULL (0) также считается некорректным.
|
||||
|
||||
### Пример
|
||||
|
||||
```c
|
||||
#include <stdio.h>
|
||||
|
|
@ -50,3 +54,4 @@ int main()
|
|||
```
|
||||
|
||||
[Документация](../intro-rus.md) / [Кватернионы](../quaternion-rus.md)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue