Skip to content
Permalink
Browse files

Add some overview docs to compositing::constellation

  • Loading branch information
brson committed May 9, 2015
1 parent aa906a5 commit 17747ad0e23c8213da3d5a550ade28baece33de0
Showing with 12 additions and 0 deletions.
  1. +12 −0 components/compositing/constellation.rs
@@ -2,6 +2,13 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

//! The `Constellation`, Servo's Grand Central Station
//!
//! The primary duty of a `Constellation` is to mediate between the
//! graphics compositor and the many `Pipeline`s in the browser's
//! navigation context, each `Pipeline` encompassing a `ScriptTask`,
//! `LayoutTask`, and `PaintTask`.

use pipeline::{Pipeline, CompositionPipeline};

use compositor_task::CompositorProxy;
@@ -44,6 +51,11 @@ use clipboard::ClipboardContext;
use webdriver_traits::WebDriverScriptCommand;

/// Maintains the pipelines and navigation context and grants permission to composite.
///
/// It is parameterized over a `LayoutTaskFactory` and a
/// `ScriptTaskFactory` (which in practice are implemented by
/// `LayoutTask` in the `layout` crate, and `ScriptTask` in
/// the `script` crate).
pub struct Constellation<LTF, STF> {
/// A channel through which messages can be sent to this object.
pub chan: ConstellationChan,

0 comments on commit 17747ad

Please sign in to comment.
You can’t perform that action at this time.