feat: engine skeleton (Build Order step 1) and siege_tests
Engine: - SdlContext and Window: RAII, throwing constructors, non-movable - FrameClock (real time, clamped dt) and SimClock (fixed 1/60 s steps, speed 0 = planning phase, backlog capped per frame) - Application owns them in lifetime order, exposes EngineContext, and runs the fixed-timestep loop; AppConfig::FromArgs parses --frames, --seed and --fullscreen - Temporary window-surface fill so Wayland maps the window until RenderDevice lands in step 2 Build: - Split into the siege_engine static lib and the siege_deck exe - check_engine_deps fails the build if Engine/ includes Game/ - ctest smoke test: siege_deck --frames 30 on the offscreen driver - siege_tests on Catch2 v3.15.3 (nixpkgs + CPM pin), with SimClock, FrameClock and AppConfig tests Docs: - Decision Log: error handling split, Catch2 for unit tests - Build Order step 1 done; Engine Overview, Main Loop and Time and README updated to match - AGENTS.md with build, conventions and gotchas for coding agents - .gitignore: .mcp.json (local CLion MCP port) and Obsidian's workspace.json (tab/pane state), now untracked Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
//
|
||||
// Created by darman on 9/24/26.
|
||||
//
|
||||
|
||||
#include "FrameClock.h"
|
||||
|
||||
#include <SDL3/SDL_timer.h>
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace SiegeDeck::Engine
|
||||
{
|
||||
|
||||
FrameClock::FrameClock() : frequency(SDL_GetPerformanceFrequency()), lastCounter(SDL_GetPerformanceCounter())
|
||||
{
|
||||
}
|
||||
|
||||
void FrameClock::Tick()
|
||||
{
|
||||
uint64 now = SDL_GetPerformanceCounter();
|
||||
// The first frame measures from construction (startup time), which would read as one long hitch.
|
||||
double elapsed = frameCount == 0 ? 0.0 : static_cast<double>(now - lastCounter) / frequency;
|
||||
lastCounter = now;
|
||||
|
||||
dt = std::min(elapsed, kMaxDt);
|
||||
time += dt;
|
||||
++frameCount;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
//
|
||||
// Created by darman on 9/24/26.
|
||||
//
|
||||
|
||||
#pragma once
|
||||
|
||||
namespace SiegeDeck::Engine
|
||||
{
|
||||
|
||||
// Real (wall-clock) time between frames. Drives UI, the card hand, menus, the camera
|
||||
// and UI tweens: things that keep moving while the simulation is paused.
|
||||
// Not pausable and not scaled by game speed; see SimClock for that.
|
||||
class FrameClock
|
||||
{
|
||||
public:
|
||||
// A frame longer than this (window drag, breakpoint, loading hitch) counts as this long,
|
||||
// so nothing driven by Dt() jumps across the screen afterwards.
|
||||
static constexpr double kMaxDt = 0.25;
|
||||
|
||||
FrameClock();
|
||||
|
||||
// Call once at the start of every frame. The first call yields Dt() == 0.
|
||||
void Tick();
|
||||
|
||||
// Seconds since the previous Tick(), clamped to kMaxDt.
|
||||
[[nodiscard]] double Dt() const { return dt; }
|
||||
// Sum of all clamped Dt()s: time the game has seen, not wall-clock uptime.
|
||||
[[nodiscard]] double Time() const { return time; }
|
||||
[[nodiscard]] uint64 FrameCount() const { return frameCount; }
|
||||
|
||||
private:
|
||||
uint64 frequency;
|
||||
uint64 lastCounter;
|
||||
|
||||
double dt = 0.0;
|
||||
double time = 0.0;
|
||||
uint64 frameCount = 0;
|
||||
};
|
||||
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
//
|
||||
// Created by darman on 9/24/26.
|
||||
//
|
||||
|
||||
#include "SimClock.h"
|
||||
|
||||
#include <algorithm>
|
||||
|
||||
namespace SiegeDeck::Engine
|
||||
{
|
||||
|
||||
SimClock::SimClock(double stepDt, int32 maxStepsPerFrame)
|
||||
: stepDt(stepDt), maxBacklog(stepDt * maxStepsPerFrame)
|
||||
{
|
||||
if (stepDt <= 0.0 || maxStepsPerFrame < 1)
|
||||
throw std::invalid_argument("SimClock needs a positive step and at least one step per frame");
|
||||
}
|
||||
|
||||
void SimClock::Accumulate(double realDt)
|
||||
{
|
||||
// Capping here, not in the step loop, keeps the caller's loop a plain while. It also
|
||||
// means a stall loses its excess time for good instead of piling up across frames.
|
||||
accumulator = std::min(accumulator + realDt * speed, maxBacklog);
|
||||
}
|
||||
|
||||
bool SimClock::ConsumeStep()
|
||||
{
|
||||
if (accumulator < stepDt)
|
||||
return false;
|
||||
accumulator -= stepDt;
|
||||
++stepIndex;
|
||||
return true;
|
||||
}
|
||||
|
||||
void SimClock::SetSpeed(double newSpeed)
|
||||
{
|
||||
// The accumulator is kept on pause, so Alpha() holds still and paused entities don't snap.
|
||||
speed = std::max(newSpeed, 0.0);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
//
|
||||
// Created by darman on 9/24/26.
|
||||
//
|
||||
|
||||
#pragma once
|
||||
|
||||
namespace SiegeDeck::Engine
|
||||
{
|
||||
|
||||
// Fixed-timestep simulation time. Real time is fed in each frame, scaled by Speed(),
|
||||
// and handed out again as whole steps of StepDt():
|
||||
//
|
||||
// sim.Accumulate(frame.Dt());
|
||||
// while (sim.ConsumeStep())
|
||||
// FixedUpdate(sim.StepDt());
|
||||
// Render(sim.Alpha());
|
||||
//
|
||||
// Speed 0 is the planning phase. 2x and 3x run more steps per frame, never bigger ones,
|
||||
// so fast projectiles can't skip past enemies at high speed.
|
||||
class SimClock
|
||||
{
|
||||
public:
|
||||
// maxStepsPerFrame caps catch-up work after a stall: past it, the backlog is dropped
|
||||
// and the simulation slows down instead of freezing the frame (the spiral of death).
|
||||
SimClock(double stepDt, int32 maxStepsPerFrame);
|
||||
|
||||
void Accumulate(double realDt);
|
||||
// True if a whole step is available; consumes it and advances Time() and StepIndex().
|
||||
bool ConsumeStep();
|
||||
|
||||
// 0 pauses. Negative values are treated as 0.
|
||||
void SetSpeed(double newSpeed);
|
||||
[[nodiscard]] double Speed() const { return speed; }
|
||||
[[nodiscard]] bool Paused() const { return speed == 0.0; }
|
||||
|
||||
[[nodiscard]] double StepDt() const { return stepDt; }
|
||||
// How far between the previous and the current step the renderer is, in [0, 1).
|
||||
// Blend PrevTransform -> Transform3D by this.
|
||||
[[nodiscard]] double Alpha() const { return accumulator / stepDt; }
|
||||
|
||||
// Simulated seconds and steps since construction. Stops advancing while paused.
|
||||
[[nodiscard]] double Time() const { return static_cast<double>(stepIndex) * stepDt; }
|
||||
[[nodiscard]] uint64 StepIndex() const { return stepIndex; }
|
||||
|
||||
private:
|
||||
double stepDt;
|
||||
double maxBacklog;
|
||||
|
||||
double speed = 1.0;
|
||||
double accumulator = 0.0;
|
||||
uint64 stepIndex = 0;
|
||||
};
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user