Bug 1452620 - Document the WrPipelineInfo structure. r?nical,botond draft
authorKartikaya Gupta <kgupta@mozilla.com>
Tue, 10 Apr 2018 17:26:54 -0400
changeset 779949 86cecebf97fe1c40af873c731ea94a59e53a975c
parent 779948 2f7bb998a74aa5c2c6e7a2f57ca3a2a9992451ca
push id105919
push userkgupta@mozilla.com
push dateTue, 10 Apr 2018 21:27:12 +0000
reviewersnical, botond
bugs1452620
milestone61.0a1
Bug 1452620 - Document the WrPipelineInfo structure. r?nical,botond MozReview-Commit-ID: DleDZydMnKS
gfx/webrender_bindings/src/bindings.rs
--- a/gfx/webrender_bindings/src/bindings.rs
+++ b/gfx/webrender_bindings/src/bindings.rs
@@ -644,17 +644,27 @@ impl From<(WrPipelineId, WrEpoch)> for W
             pipeline_id: tuple.0,
             epoch: tuple.1
         }
     }
 }
 
 #[repr(C)]
 pub struct WrPipelineInfo {
+    // This contains an entry for each pipeline that was rendered, along with
+    // the epoch at which it was rendered. Rendered pipelines include the root
+    // pipeline and any other pipelines that were reachable via IFrame display
+    // items from the root pipeline.
     epochs: FfiVec<WrPipelineEpoch>,
+    // This contains an entry for each pipeline that was removed during the
+    // last transaction. These pipelines would have been explicitly removed by
+    // calling remove_pipeline on the transaction object; the pipeline showing
+    // up in this array means that the data structures have been torn down on
+    // the webrender side, and so any remaining data structures on the caller
+    // side can now be torn down also.
     removed_pipelines: FfiVec<PipelineId>,
 }
 
 impl WrPipelineInfo {
     fn new(info: PipelineInfo) -> Self {
         WrPipelineInfo {
             epochs: FfiVec::from_vec(info.epochs.into_iter().map(WrPipelineEpoch::from).collect()),
             removed_pipelines: FfiVec::from_vec(info.removed_pipelines),