Работа над документацией по библиотеке

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

View file

@ -2,8 +2,6 @@
[Русская версия / Russian version](reset-rus.md)
These functions set all parts of a quaternion to 0.
Function for **BGC_FP32_Quaternion**:
```c
@ -16,6 +14,8 @@ Function for **BGC_FP64_Quaternion**:
inline void bgc_fp64_quaternion_reset(BGC_FP64_Quaternion* const quaternion);
```
These functions set all the components of a quaternion to zero.
Each of these functions is equivalent to the following lines of code:
```c
@ -25,12 +25,17 @@ vector->y = 0;
vector->z = 0;
```
You should pass valid pointers to these functions. The NULL (0) value is also
considered invalid.
This function is good for setting up the initial state of a quaternion.
Example of use:
### Parameter
| Parameter | Direction | Description |
| ---------- | --------- | ------------------------------------------------------------ |
| quaternion | out | A pointer to a quaternions which components must be set to 0 |
You should pass only valid pointers in the parameter *quaternion*. The NULL (0) value is considered invalid.
### Example
```c
#include <stdio.h>
@ -49,3 +54,4 @@ int main()
```
[Documentation](../intro-eng.md) / [Quaternions](../quaternion-eng.md)