summaryrefslogtreecommitdiffstats
path: root/graphics/src/window/compositor.rs
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/src/window/compositor.rs')
-rw-r--r--graphics/src/window/compositor.rs60
1 files changed, 60 insertions, 0 deletions
diff --git a/graphics/src/window/compositor.rs b/graphics/src/window/compositor.rs
new file mode 100644
index 00000000..82faa6e1
--- /dev/null
+++ b/graphics/src/window/compositor.rs
@@ -0,0 +1,60 @@
+use crate::Viewport;
+use iced_native::mouse;
+use raw_window_handle::HasRawWindowHandle;
+
+/// A graphics compositor that can draw to windows.
+pub trait Compositor: Sized {
+ /// The settings of the backend.
+ type Settings: Default + Clone;
+
+ /// The iced renderer of the backend.
+ type Renderer: iced_native::Renderer;
+
+ /// The surface of the backend.
+ type Surface;
+
+ /// The swap chain of the backend.
+ type SwapChain;
+
+ /// Creates a new [`Backend`].
+ ///
+ /// [`Backend`]: trait.Backend.html
+ fn new(settings: Self::Settings) -> Self;
+
+ /// Crates a new [`Surface`] for the given window.
+ ///
+ /// [`Surface`]: #associatedtype.Surface
+ fn create_surface<W: HasRawWindowHandle>(
+ &mut self,
+ window: &W,
+ ) -> Self::Surface;
+
+ /// Crates a new [`Renderer`].
+ ///
+ /// [`Renderer`]: #associatedtype.Renderer
+ fn create_renderer(&mut self, settings: Self::Settings) -> Self::Renderer;
+
+ /// Crates a new [`SwapChain`] for the given [`Surface`].
+ ///
+ /// [`SwapChain`]: #associatedtype.SwapChain
+ /// [`Surface`]: #associatedtype.Surface
+ fn create_swap_chain(
+ &mut self,
+ surface: &Self::Surface,
+ width: u32,
+ height: u32,
+ ) -> Self::SwapChain;
+
+ /// Draws the output primitives to the next frame of the given [`SwapChain`].
+ ///
+ /// [`SwapChain`]: #associatedtype.SwapChain
+ /// [`Surface`]: #associatedtype.Surface
+ fn draw<T: AsRef<str>>(
+ &mut self,
+ renderer: &mut Self::Renderer,
+ swap_chain: &mut Self::SwapChain,
+ viewport: &Viewport,
+ output: &<Self::Renderer as iced_native::Renderer>::Output,
+ overlay: &[T],
+ ) -> mouse::Interaction;
+}