Epok Engine

EPOK RUNTIME

epok::bp::saturate

Function · 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.

Function

Blueprint arithmetic saturates, divides by zero to zero, and rounds division toward zero.

Belongs to
epok::bp
Header
blueprint_runtime.hpp
Overloads
1

Declaration

Declaration
constexpr int32_t saturate(int64_t value)

Blueprint arithmetic saturates, divides by zero to zero, and rounds division toward zero.

ParameterTypeMeaning
valueint64_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "blueprint_runtime.hpp"

// Assume these named values have been initialized with valid data:
// int64_t value

auto result = epok::bp::saturate(value);

Trade-offs and warnings

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

Declared in runtime/blueprint_runtime.hpp:15

Related members