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

renderer: describe at parameter in Frame::clear

This commit is contained in:
i509VCB 2022-01-22 14:31:46 -06:00
parent e019b4fa9e
commit c5f24fe574
No known key found for this signature in database
GPG Key ID: EE47F5EFC5EE8CDC
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -122,6 +122,9 @@ pub trait Frame {
/// Clear the complete current target with a single given color. /// Clear the complete current target with a single given color.
/// ///
/// The `at` parameter specifies a set of rectangles to clear in the current target. This allows partially
/// clearing the target which may be useful for damaged rendering.
///
/// This operation is only valid in between a `begin` and `finish`-call. /// This operation is only valid in between a `begin` and `finish`-call.
/// If called outside this operation may error-out, do nothing or modify future rendering results in any way. /// If called outside this operation may error-out, do nothing or modify future rendering results in any way.
fn clear(&mut self, color: [f32; 4], at: &[Rectangle<i32, Physical>]) -> Result<(), Self::Error>; fn clear(&mut self, color: [f32; 4], at: &[Rectangle<i32, Physical>]) -> Result<(), Self::Error>;