Epok Engine

PSYQO SDK

psyqo::SoftMath::normOfVec3

Function · 2 overloads

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Computes the norm of a 3D vector.

Belongs to
psyqo::SoftMath
Header
soft-math.hh
Overloads
2

Declaration 1 of 2

Declaration
FixedPoint<> normOfVec3(const Vec3 &v)

Computes the norm of a 3D vector.

ParameterTypeMeaning
vconst Vec3 &The vector.

Returns: FixedPoint<> — psyqo::FixedPoint<> The norm.

Example sketch

C++ example
#include "psyqo/soft-math.hh"

// Assume these named values have been initialized with valid data:
// const Vec3 & v

auto result = psyqo::SoftMath::normOfVec3(v);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/soft-math.hh:218

Declaration 2 of 2

static
Declaration
static inline FixedPoint<> normOfVec3(const Vec3 *v)

Performs `norm of vec3` as part of the soft math module.

ParameterTypeMeaning
vconst Vec3 *Not documented; consult the linked header.

Returns: FixedPoint<>. Consult the linked header for its meaning.

Example sketch

C++ example
#include "psyqo/soft-math.hh"

// Assume these named values have been initialized with valid data:
// const Vec3 * v

auto result = psyqo::SoftMath::normOfVec3(v);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/soft-math.hh:219

Related members