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-03-31 20:43:10 +07:00
parent ed404690ed
commit 8ba075b557
16 changed files with 279 additions and 222 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,20 +2,20 @@
[Русская версия / Russian version](reset-rus.md)
These functions set all coordinates of 3D vectors to 0.
Function for **BGC_FP32_Vector3**:
The function for **BGC_FP32_Vector3**:
```c
inline void bgc_fp32_vector3_reset(BGC_FP32_Vector3* const vector);
```
Function for **BGC_FP64_Vector3**:
The function for **BGC_FP64_Vector3**:
```c
inline void bgc_fp64_vector3_reset(BGC_FP64_Vector3* const vector);
```
These functions set all coordinates of 3D vectors to 0.
Each of these functions is equivalent to the following lines of code:
```c
@ -24,12 +24,17 @@ vector->y = 0;
vector->z = 0;
```
You should not pass invalid pointers to these functions. The NULL (0) value is
also considered invalid.
This function is good for setting up the initial state of a 3D vector.
Example of use:
### Parameters
| 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.
### Example
```c
#include <stdio.h>
@ -48,3 +53,4 @@ int main()
```
[Documentation](../intro-eng.md) / [3D vectors](../vector3-eng.md)