language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-08-04 18:58:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve documentation of AbstractRenderer

Browse source
This commit is contained in:
Olivier Goffart 2023-07-28 12:18:34 +02:00 • committed by GitHub
parent ecf3937518
commit f3b2b5d457
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
api/cpp/include/slint-platform.h
View file

@ -28,12 +28,22 @@ namespace slint {
namespace platform {
/// Internal interface for a renderer for use with the WindowAdapter.
///
/// You are not supposed to re-implement this class, but you can use one of the provided one
/// such as SoftwareRenderer or SkiaRenderer.
class AbstractRenderer
{
private:
virtual ~AbstractRenderer() { }
AbstractRenderer(const AbstractRenderer &) = delete;
AbstractRenderer &operator=(const AbstractRenderer &) = delete;
AbstractRenderer() = default;
/// \private
virtual cbindgen_private::RendererPtr renderer_handle() const = 0;
friend class WindowAdapter;
friend class SoftwareRenderer;
friend class SkiaRenderer;
};
/// Base class for the layer between a slint::Window and the internal window from the platform
@ -93,6 +103,9 @@ public:
/// Re-implement this function to provide a reference to the renderer for use with the window
/// adapter.
///
/// Your re-implementation should contain a renderer such as SoftwareRenderer or SkiaRenderer
/// and you must return a reference to it.
virtual AbstractRenderer &renderer() = 0;
/// Return the slint::Window associated with this window.