LiteFX::Rendering::ISwapChain::registerTimingEvent

Creates a new instance of a TimingEvent.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, nodiscard, dllexport]] SharedPtr<TimingEvent const> registerTimingEvent(StringView name = "");

Description

Note that registering a new timing event does invalidate previously registered events, i.e. they do not return meaningful time stamps for the next frame. Timing events should only be registered during application startup, before the first frame is rendered.

Return Value

A pointer with shared ownership to the newly created timing event instance.

Note

The return value should not be discarded.

Parameters

Name	Description
name	The name of the timing event.