Epok Engine

EPOK RUNTIME

epok::MathLibrary::clamp

Method · 1 overload

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.

Method

Performs `clamp` as part of the gameplay api module.

Belongs to
epok::MathLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static Fixed clamp(Fixed value,Fixed minimum,Fixed maximum)

Performs `clamp` as part of the gameplay api module.

ParameterTypeMeaning
valueFixedNot documented; consult the linked header.
minimumFixedNot documented; consult the linked header.
maximumFixedNot documented; consult the linked header.

Returns: Fixed. Consult the linked header for its meaning.

Example sketch

C++ example
#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// Fixed value
// Fixed minimum
// Fixed maximum

auto result = epok::MathLibrary::clamp(value, minimum, maximum);

Trade-offs and warnings

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

Declared in runtime/gameplay_api.hpp:257

Related members