EPOK RUNTIME

epok::MathLibrary::clamp

Method · 1 overload

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.

Parameter	Type	Meaning
`value`	`Fixed`	Value supplied for value. Keep referenced or pointed-to data valid for the complete call.
`minimum`	`Fixed`	Value supplied for minimum. Keep referenced or pointed-to data valid for the complete call.
`maximum`	`Fixed`	Value supplied for maximum. Keep referenced or pointed-to data valid for the complete call.

Returns: Fixed. Check the value before continuing when it represents success, availability or a resource handle.

Example

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);

Why use it

It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/gameplay_api.hpp:171

Related members