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

Resetting the state of a 3D vector

Русская версия / Russian version

These functions set all coordinates of 3D vectors to 0.

Function for BGC_FP32_Vector3:

inline void bgc_fp32_vector3_reset(BGC_FP32_Vector3* const vector);

Function for BGC_FP64_Vector3:

inline void bgc_fp64_vector3_reset(BGC_FP64_Vector3* const vector);

Each of these functions is equivalent to the following lines of code:

vector->x = 0;
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:

#include <stdio.h>
#include <basic-geometry.h>

int main()
{
    BGC_FP32_Vector3 v;

    bgc_fp32_vector3_reset(&v);

    printf("x = %f, y = %f, z = %f\n", v.x, v.y, v.z);

    return 0;
}

Documentation / 3D vectors