mirror of
https://github.com/guezoloic/t3dsr.git
synced 2026-01-25 12:34:24 +00:00
feat(vector3): added documentation for a few basic functions.
This commit is contained in:
@@ -15,11 +15,51 @@ typedef struct {
|
|||||||
*/
|
*/
|
||||||
Vec3* vec3(float x, float y, float z);
|
Vec3* vec3(float x, float y, float z);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Adds two 3D vectors in a new 3D vector.
|
||||||
|
* @param v1 First vector.
|
||||||
|
* @param v2 Second vector.
|
||||||
|
* @return A pointer to a newly allocated 3D vector
|
||||||
|
* representing the sum of v1 and v2.
|
||||||
|
*/
|
||||||
Vec3* vec3Add(Vec3* v1, Vec3* v2);
|
Vec3* vec3Add(Vec3* v1, Vec3* v2);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Subtracts two 3D vectors in a new 3D
|
||||||
|
* vector.
|
||||||
|
* @param v1 First vector.
|
||||||
|
* @param v2 Second vector.
|
||||||
|
* @return A pointer to a newly allocated 3D vector
|
||||||
|
* representing the subtraction of v1 and v2.
|
||||||
|
*/
|
||||||
Vec3* vec3Sub(Vec3* v1, Vec3* v2);
|
Vec3* vec3Sub(Vec3* v1, Vec3* v2);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Scales a 3D vector by a constant scalar in a
|
||||||
|
* new 3D vector.
|
||||||
|
* @param v 3D vector.
|
||||||
|
* @param scalar Constant.
|
||||||
|
* @return A pointer to a newly allocated 3D vector
|
||||||
|
* representing the multiplication of v1 and a
|
||||||
|
* scalar.
|
||||||
|
*/
|
||||||
Vec3* vec3Scale(Vec3* v, float scalar);
|
Vec3* vec3Scale(Vec3* v, float scalar);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Computes the dot product of two 3D vectors
|
||||||
|
* @param a First vector.
|
||||||
|
* @param b Second vector.
|
||||||
|
* @return The dot product of a and b as a scalar value
|
||||||
|
*/
|
||||||
float vec3Dot(Vec3* a, Vec3* b);
|
float vec3Dot(Vec3* a, Vec3* b);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Computes the Length (magnitude) of a 3D
|
||||||
|
* vector
|
||||||
|
* @param v The 3D vector.
|
||||||
|
* @return The length (magnitude) of the vector v as a
|
||||||
|
* scalar value.
|
||||||
|
*/
|
||||||
float vec3Len(Vec3* v);
|
float vec3Len(Vec3* v);
|
||||||
|
|
||||||
Vec3* vec3Norm(Vec3* v);
|
Vec3* vec3Norm(Vec3* v);
|
||||||
|
|||||||
Reference in New Issue
Block a user