Development

Renderer/Temporal/FramePacing.h

Public include <Renderer/Temporal/FramePacing.h>. SnBuild module Temporal.

SnAPI::Renderer::FramePacingConfig

struct SnAPI::Renderer::FramePacingConfig

SnAPI::Renderer::FramePacingConfig::TargetFramesPerSecond

double SnAPI::Renderer::FramePacingConfig::TargetFramesPerSecond = 60.0

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::SleepThreshold

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingConfig::SleepThreshold = std::chrono::microseconds(2'000)

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::SleepGuardBand

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingConfig::SleepGuardBand = std::chrono::microseconds(500)

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::YieldThreshold

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingConfig::YieldThreshold = std::chrono::microseconds(250)

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::MaximumOversleepCompensation

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingConfig::MaximumOversleepCompensation = std::chrono::microseconds(2'000)

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::OversleepUpdateAlpha

double SnAPI::Renderer::FramePacingConfig::OversleepUpdateAlpha = 0.125

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::MaximumCatchUpFrames

std::uint32_t SnAPI::Renderer::FramePacingConfig::MaximumCatchUpFrames = 2

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingConfig::ResyncAfterLateFrameCount

std::uint32_t SnAPI::Renderer::FramePacingConfig::ResyncAfterLateFrameCount = 4

See also SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacingTick

struct SnAPI::Renderer::FramePacingTick

SnAPI::Renderer::FramePacingTick::FrameSequence

std::uint64_t SnAPI::Renderer::FramePacingTick::FrameSequence = 0

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::FirstFrame

bool SnAPI::Renderer::FramePacingTick::FirstFrame = false

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::Resynchronized

bool SnAPI::Renderer::FramePacingTick::Resynchronized = false

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::TargetFrameStartTime

std::chrono::steady_clock::time_point SnAPI::Renderer::FramePacingTick::TargetFrameStartTime {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::FrameStartTime

std::chrono::steady_clock::time_point SnAPI::Renderer::FramePacingTick::FrameStartTime {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::TargetFrameDuration

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::TargetFrameDuration {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::FrameDelta

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::FrameDelta {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::WaitDuration

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::WaitDuration {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::SleepDuration

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::SleepDuration {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::YieldCount

std::uint32_t SnAPI::Renderer::FramePacingTick::YieldCount = 0

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::SpinDuration

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::SpinDuration {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::Lateness

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::Lateness {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::OversleepCompensation

std::chrono::steady_clock::duration SnAPI::Renderer::FramePacingTick::OversleepCompensation {}

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::FrameDeltaSeconds

double SnAPI::Renderer::FramePacingTick::FrameDeltaSeconds() const noexcept

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::TargetFrameDurationSeconds

double SnAPI::Renderer::FramePacingTick::TargetFrameDurationSeconds() const noexcept

See also SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacingTick::ToFrameTiming

FrameTimingInfo SnAPI::Renderer::FramePacingTick::ToFrameTiming(std::optional< std::chrono::steady_clock::duration > predictedPresentationLead=std::nullopt) const noexcept

See also SnAPI::Renderer::FramePacingTick, SnAPI::Renderer::FrameTimingInfo.

SnAPI::Renderer::FramePacer

class SnAPI::Renderer::FramePacer

SnAPI::Renderer::FramePacer::Clock

using SnAPI::Renderer::FramePacer::Clock = std::chrono::steady_clock

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::FramePacer

explicit SnAPI::Renderer::FramePacer::FramePacer(const FramePacingConfig &config={})

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacer::SetConfig

void SnAPI::Renderer::FramePacer::SetConfig(const FramePacingConfig &config) noexcept

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacer::SetTargetFramesPerSecond

void SnAPI::Renderer::FramePacer::SetTargetFramesPerSecond(double targetFramesPerSecond) noexcept

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::Config

const FramePacingConfig & SnAPI::Renderer::FramePacer::Config() const noexcept

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FramePacingConfig.

SnAPI::Renderer::FramePacer::TargetFramesPerSecond

double SnAPI::Renderer::FramePacer::TargetFramesPerSecond() const noexcept

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::TargetFrameDuration

Clock::duration SnAPI::Renderer::FramePacer::TargetFrameDuration() const noexcept

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::Enabled

bool SnAPI::Renderer::FramePacer::Enabled() const noexcept

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::Reset

void SnAPI::Renderer::FramePacer::Reset() noexcept

See also SnAPI::Renderer::FramePacer.

SnAPI::Renderer::FramePacer::ObserveFrameStart

FramePacingTick SnAPI::Renderer::FramePacer::ObserveFrameStart(Clock::time_point frameStartTime) noexcept

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacer::WaitForNextFrame

FramePacingTick SnAPI::Renderer::FramePacer::WaitForNextFrame()

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FramePacingTick.

SnAPI::Renderer::FramePacer::ToTimingStamp

static FrameTimingStamp SnAPI::Renderer::FramePacer::ToTimingStamp(Clock::time_point timePoint) noexcept

See also SnAPI::Renderer::FramePacer, SnAPI::Renderer::FrameTimingStamp.