From 6cb90570a3af18b1a1ad455dc1ce5858f8446aa6 Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Sat, 30 May 2020 03:04:16 +0200
Subject: Expose `Backend` in `iced_glow`

---
 glow/src/backend.rs | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'glow/src/backend.rs')

diff --git a/glow/src/backend.rs b/glow/src/backend.rs
index 6bd443ad..a54dce79 100644
--- a/glow/src/backend.rs
+++ b/glow/src/backend.rs
@@ -9,9 +9,10 @@ use iced_graphics::Primitive;
 use iced_native::mouse;
 use iced_native::{Font, HorizontalAlignment, Size, VerticalAlignment};
 
-/// A [`glow`] renderer.
+/// A [`glow`] graphics backend for [`iced`].
 ///
 /// [`glow`]: https://github.com/grovesNL/glow
+/// [`iced`]: https://github.com/hecrj/iced
 #[derive(Debug)]
 pub struct Backend {
     quad_pipeline: quad::Pipeline,
@@ -20,9 +21,9 @@ pub struct Backend {
 }
 
 impl Backend {
-    /// Creates a new [`Renderer`].
+    /// Creates a new [`Backend`].
     ///
-    /// [`Renderer`]: struct.Renderer.html
+    /// [`Backend`]: struct.Renderer.html
     pub fn new(gl: &glow::Context, settings: Settings) -> Self {
         let text_pipeline = text::Pipeline::new(gl, settings.default_font);
         let quad_pipeline = quad::Pipeline::new(gl);
@@ -35,6 +36,10 @@ impl Backend {
         }
     }
 
+    /// Draws the provided primitives in the default framebuffer.
+    ///
+    /// The text provided as overlay will be rendered on top of the primitives.
+    /// This is useful for rendering debug information.
     pub fn draw<T: AsRef<str>>(
         &mut self,
         gl: &glow::Context,
-- 
cgit