Vkm::Engine::Config Namespace Reference

Engine-level configuration constants. More...

Functions
constexpr uint32_t	clampTickRate (uint32_t ticksPerSecond)
	What a project's requested tick rate is honoured as.
constexpr uint32_t	clampSeats (uint32_t seats)
	What a project's requested seat count is honoured as.

Detailed Description

Engine-level configuration constants.

Backend-agnostic limits and loop constants. A per-system tunable belongs in that system's Settings struct; a backend knob in the backend's config (e.g. src/backend/opengl/convention/gl_bindings.h).

Most are written into every shader's prelude (GLBackend::shaderConstants); never re-declare one in a shader. See docs/reference/lighting.md.

Function Documentation

clampTickRate()

uint32_t Vkm::Engine::Config::clampTickRate ( uint32_t ticksPerSecond )

constexpr

What a project's requested tick rate is honoured as.

Anything pacing off the rate must use this, or a headless host spins at a rate the simulation is not running at.

Parameters

ticksPerSecond

The rate as asked for.

Returns

It, clamped to [MIN_TICK_RATE, MAX_TICK_RATE].

clampSeats()

uint32_t Vkm::Engine::Config::clampSeats ( uint32_t seats )

constexpr

What a project's requested seat count is honoured as.

Zero is kept: the session then refuses to host.

Parameters

seats

The count as asked for.

Returns

It, clamped to [0, MAX_PLAYERS_PER_GAME].