Актуализация документации по проекту

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

View file

@ -1,22 +1,21 @@
# Copying
# Copying of coordinate values
[Русская версия / Russian version](copy-rus.md)
The copy functions allow you to copy the coordinate values of one vector
to another vector.
Function for **BGC_FP32_Vector3**:
The function for **BGC_FP32_Vector3**:
```c
inline void bgc_fp32_vector3_copy(BGC_FP32_Vector3* const destination, const BGC_FP32_Vector3* const source);
```
Function for **BGC_FP64_Vector3**:
The function for **BGC_FP64_Vector3**:
```c
inline void bgc_fp64_vector3_copy(BGC_FP64_Vector3* const destination, const BGC_FP64_Vector3* const source);
```
These functions allow to copy the values of the coordinates of one 3D-vector to another 3D-vector of the same type.
Each of these functions is equivalent to the following lines of code:
```c
@ -25,19 +24,16 @@ destination->y = source->y;
destination->z = source->z;
```
The **source** and **destination** parameters must not be invalid pointers.
The NULL (0) value is also considered invalid.
### Parameters
The **source** parameter must be a pointer to a three-dimensional vector whose
coordinates are to be copied. The coordinates of the **source** vector will
not change after the function call.
| Parameter | Direction | Description |
| ----------- | ---------- | ----------------------------------------------------------------------- |
| destination | out | A pointer to a vector to set coordinate values from *source* |
| source | in | A pointer to a vector which coordinates will be copied to *destination* |
The **destination** parameter must be a pointer to a three-dimensional vector
whose coordinates are to be changed. The coordinates of the **destination**
vector will become the same as those of the **source** vector after the function
call.
The **source** and **destination** parameters must be valid pointers. The NULL (0) value is also considered invalid.
Example of use:
### Example
```c
#include <stdio.h>
@ -60,3 +56,4 @@ int main()
```
[Documentation](../intro-eng.md) / [3D vectors](../vector3-eng.md)