Write documentation for iced_native::svg
This commit is contained in:
parent
597ef7d5fc
commit
faaa17c3a5
1 changed files with 4 additions and 6 deletions
|
|
@ -1,3 +1,4 @@
|
||||||
|
//! Load and draw vector graphics.
|
||||||
use crate::{Hasher, Rectangle};
|
use crate::{Hasher, Rectangle};
|
||||||
|
|
||||||
use std::hash::{Hash, Hasher as _};
|
use std::hash::{Hash, Hasher as _};
|
||||||
|
|
@ -75,16 +76,13 @@ impl std::fmt::Debug for Data {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The renderer of an [`Svg`].
|
/// A [`Renderer`] that can render vector graphics.
|
||||||
///
|
|
||||||
/// Your [renderer] will need to implement this trait before being able to use
|
|
||||||
/// an [`Svg`] in your user interface.
|
|
||||||
///
|
///
|
||||||
/// [renderer]: crate::renderer
|
/// [renderer]: crate::renderer
|
||||||
pub trait Renderer: crate::Renderer {
|
pub trait Renderer: crate::Renderer {
|
||||||
/// Returns the default dimensions of an [`Svg`] for the given [`Handle`].
|
/// Returns the default dimensions of an SVG for the given [`Handle`].
|
||||||
fn dimensions(&self, handle: &Handle) -> (u32, u32);
|
fn dimensions(&self, handle: &Handle) -> (u32, u32);
|
||||||
|
|
||||||
// Draws an [`Svg`].
|
/// Draws an SVG with the given [`Handle`] and inside the provided `bounds`.
|
||||||
fn draw(&mut self, handle: Handle, bounds: Rectangle);
|
fn draw(&mut self, handle: Handle, bounds: Rectangle);
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue