C++ docs: Elaborate a little on the argument to Window::set_rendering_notifier

This commit is contained in:
Simon Hausmann 2023-02-17 10:22:18 +01:00 committed by Simon Hausmann
parent b888870705
commit aba5797eaa

View file

@ -414,6 +414,10 @@ public:
/// This function allows registering a callback that's invoked during the different phases of
/// rendering. This allows custom rendering on top or below of the scene.
///
/// The provided callback must be callable with a slint::RenderingState and the
/// slint::GraphicsAPI argument.
///
/// On success, the function returns a std::optional without value. On error, the function
/// returns the error code as value in the std::optional.
template<std::invocable<RenderingState, GraphicsAPI> F>