vkmEngine 1.0.0
A C++ game engine · vkmengine.com
Loading...
Searching...
No Matches
Vkm::Engine::FaultLatch Class Reference

Names a recurring fault once per gap rather than once a frame. More...

#include <fault_latch.h>

Public Member Functions

bool report ()
 Record that the pass in progress met the fault.
void endPass ()
 Close the pass: a fault it did not meet is named again next time.

Detailed Description

Names a recurring fault once per gap rather than once a frame.

A pass logs when report() answers true, and calls endPass() however it exits. A fault that clears and returns is named again.

Member Function Documentation

◆ report()

bool Vkm::Engine::FaultLatch::report ( )
inline

Record that the pass in progress met the fault.

Returns
True, and the caller logs, when the fault is unnamed since a pass last missed it.

The documentation for this class was generated from the following file: