Epok Engine

PSYQO SDK

psyqo::FixedPointInternals::iDiv

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

Performs `i div` as part of the fixed point module.

Belongs to
psyqo::FixedPointInternals
Header
fixed-point.hh
Overloads
1

Declaration

Declaration
constexpr uint32_t iDiv(uint64_t rem, uint32_t base, unsigned scale)

Performs `i div` as part of the fixed point module.

ParameterTypeMeaning
remuint64_tNot documented; consult the linked header.
baseuint32_tNot documented; consult the linked header.
scaleunsigned intNot documented; consult the linked header.

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

Example sketch

C++ example
#include "psyqo/fixed-point.hh"

// Assume these named values have been initialized with valid data:
// uint64_t rem
// uint32_t base
// unsigned int scale

auto result = psyqo::FixedPointInternals::iDiv(rem, base, scale);

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/fixed-point.hh:42

Related members