bgc-c/docs/vector2/reset-eng.md

49 lines
940 B
Markdown

# Resetting the state of a 2D vector
[Русская версия / Russian version](reset-rus.md)
These functions set all coordinates of 2D vectors to 0.
Function for **BGC_FP32_Vector2**:
```c
inline void bgc_fp32_vector2_reset(BGC_FP32_Vector2* const vector);
```
Function for **BGC_FP64_Vector2**:
```c
inline void bgc_fp64_vector2_reset(BGC_FP64_Vector2* const vector);
```
Each of these functions is equivalent to the following lines of code:
```c
vector->x = 0;
vector->y = 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 2D vector.
Example of use:
```c
#include <stdio.h>
#include <basic-geometry.h>
int main()
{
BGC_FP32_Vector2 v;
bgc_fp32_vector2_reset(&v);
printf("x = %f, y = %f\n", v.x, v.y);
return 0;
}
```
[Documentation](../intro-eng.md) / [2D vectors](../vector2-eng.md)