Fix up Window::take_snapshot docs

Clarify the "performance" as discussed in the API review.
This commit is contained in:
Simon Hausmann 2024-12-11 17:07:23 +01:00
parent eae05b9686
commit 8d85c54a6f
2 changed files with 2 additions and 4 deletions

View file

@ -621,8 +621,7 @@ public:
/// Takes a snapshot of the window contents and returns it as RGBA8 encoded pixel buffer.
///
/// Note that this function may be slow to call. Reading from the framebuffer previously
/// rendered, too, may take a long time.
/// Note that this function may be slow to call as it may need to re-render the scene.
std::optional<SharedPixelBuffer<Rgba8Pixel>> take_snapshot() const
{
SharedPixelBuffer<Rgba8Pixel> result;