summaryrefslogtreecommitdiffstats
path: root/graphics/src/renderer.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:37:59 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-05-28 01:40:30 +0200
commit2ca7e3c4b0cb293adebf9a9bf9a26191069d495d (patch)
tree653a1f24422079231ff5a9f0d868c7d117ca92ed /graphics/src/renderer.rs
parent45511a442f707e93fe6e568d2100756b63af7362 (diff)
downloadiced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.tar.gz
iced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.tar.bz2
iced-2ca7e3c4b0cb293adebf9a9bf9a26191069d495d.zip
Write documentation for `iced_graphics`
Diffstat (limited to 'graphics/src/renderer.rs')
-rw-r--r--graphics/src/renderer.rs18
1 files changed, 16 insertions, 2 deletions
diff --git a/graphics/src/renderer.rs b/graphics/src/renderer.rs
index f16e04b1..c9360f3a 100644
--- a/graphics/src/renderer.rs
+++ b/graphics/src/renderer.rs
@@ -3,19 +3,33 @@ use iced_native::layout::{self, Layout};
use iced_native::mouse;
use iced_native::{Background, Color, Element, Point, Widget};
-pub struct Renderer<B> {
+/// A backend-agnostic renderer that supports all the built-in widgets.
+#[derive(Debug)]
+pub struct Renderer<B: Backend> {
backend: B,
}
-impl<B> Renderer<B> {
+impl<B: Backend> Renderer<B> {
+ /// Creates a new [`Renderer`] from the given [`Backend`].
+ ///
+ /// [`Renderer`]: struct.Renderer.html
+ /// [`Backend`]: backend/trait.Backend.html
pub fn new(backend: B) -> Self {
Self { backend }
}
+ /// Returns a reference to the [`Backend`] of the [`Renderer`].
+ ///
+ /// [`Renderer`]: struct.Renderer.html
+ /// [`Backend`]: backend/trait.Backend.html
pub fn backend(&self) -> &B {
&self.backend
}
+ /// Returns a mutable reference to the [`Backend`] of the [`Renderer`].
+ ///
+ /// [`Renderer`]: struct.Renderer.html
+ /// [`Backend`]: backend/trait.Backend.html
pub fn backend_mut(&mut self) -> &mut B {
&mut self.backend
}