vtimofei
/
smithay
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

renderer: Document `Frame` Associated Type and Trait

This commit is contained in:
Victor Brekenfeld 2021-05-29 17:57:34 +02:00
parent 7aa0c43396
commit 87d33fc42e
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/backend/renderer/mod.rs
View File

@ -139,6 +139,7 @@ pub trait Texture {
fn height(&self) -> u32; fn height(&self) -> u32;
} }
/// Helper trait for [`Renderer`], which defines a rendering api for a currently in-progress frame during [`Renderer::render`].
pub trait Frame { pub trait Frame {
/// Error type returned by the rendering operations of this renderer. /// Error type returned by the rendering operations of this renderer.
type Error: Error; type Error: Error;
@ -198,7 +199,7 @@ pub trait Renderer {
type Error: Error; type Error: Error;
/// Texture Handle type used by this renderer. /// Texture Handle type used by this renderer.
type TextureId: Texture; type TextureId: Texture;
/// Type representing a currently in-progress frame during the [`Renderer::render`]-call
type Frame: Frame<Error = Self::Error, TextureId = Self::TextureId>; type Frame: Frame<Error = Self::Error, TextureId = Self::TextureId>;
/// Import a given bitmap into the renderer. /// Import a given bitmap into the renderer.