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

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

@ -1,10 +1,7 @@
# Копирование
# Копирование значений компотент
[English version / Английская версия](copy-eng.md)
Функции копирования позволяют скопировать значения компонент одного кватерниона
в другой кватернион.
Функция для **BGC_FP32_Quaternion**:
```c
@ -17,6 +14,9 @@ inline void bgc_fp32_quaternion_copy(BGC_FP32_Quaternion* const destination, con
inline void bgc_fp64_quaternion_copy(BGC_FP64_Quaternion* const destination, const BGC_FP64_Quaternion* const source);
```
Данные функции позволяют скопировать значения компонентов одного кватерниона в другой кватернион.
Каждая из данных функции эквивалентна следующим строкам кода:
```c
@ -26,18 +26,16 @@ destination->y = source->y;
destination->z = source->z;
```
Параметры **source** и **destination** должны быть корректными указателями.
Значение NULL (0) также считается некорректным.
### Parameters
Параметр **source** должен быть указателем на кватернион, компоненты которого
должны быть скопированы. Компоненты кватерниона **source** не изменятся после
вызова функции.
Параметр **destination** должен быть указателем на кватернионы, компоненты
которого должны быть изменены. Координаты кватерниона **destination** после
вызова функции станут такими же, как и у кватерниона **source**.
| Параметр | Направление | Описание |
| ----------- | ----------- | ------------------------------------------------------------------------------------- |
| destination | исходящий | Указатель на кватернион, в который будут скопированы значения компонентов из *source* |
| source | входящий | Указатель на кватернион, компоненты которого должны быть скопированы в *destination* |
Пример применения:
Параметры *source* и *destination* должны быть корректными указателями. Значение NULL (0) также считается некорректным.
### Пример
```c
#include <stdio.h>
@ -61,3 +59,4 @@ int main()
```
[Документация](../intro-rus.md) / [Кватернионы](../quaternion-rus.md)