575646 - [e10s] document canvas ipc interfaces

Status: RESOLVED FIXED

(Core :: IPC, defect)

Description

[Doug Turner (:dougt)]

>+class DocumentRendererChild : public PDocumentRendererChild

Please document what this class is supposed to do (ideally in mxr-form)?  And
perhaps document the ipdl to describe what the actors represent and what the
contract is (specifically that just constructing a PDocumentRenderer from the
parent's side will do the rendering and then communicate ther results back via
the __delete__)?  In fact, decent docs on the ipdl for this and its manager
might be good enough.

>+    bool RenderDocument(nsIDOMWindow *window, const PRInt32& x, const PRInt32& y, const PRInt32& w, const PRInt32& h,

Document what this does (at least by reference to whatever would explain what
|flags| means)?  What coordinate space and units are the various integers in?
This applies to all the renderers, child and parent.

>+++ b/content/canvas/public/DocumentRendererNativeIDChild.h

Same issues here.

>+++ b/content/canvas/public/DocumentRendererNativeIDParent.h

And here.

>+++ b/content/canvas/public/DocumentRendererParent.h

And here.

>+++ b/content/canvas/public/DocumentRendererShmemChild.h

And here.  What's the gfxMatrix arg?

>+++ b/content/canvas/public/DocumentRendererShmemParent.h

And here.

>+++ b/content/canvas/public/nsICanvasRenderingContextInternal.h
>+  // Redraw the dirty rectangle of this canvas.
>+  NS_IMETHOD Redraw(const gfxRect &dirty) = 0;

In what units/coords?

>+  // If this context can be set to use Mozilla's Shmem segments as its backing
>+  // store, this will set it to that state. Note that if you have drawn
>+  // anything into this canvas before changing the shmem state, it will be
>+  // lost.

"it" == "what you have drawn", not "the shmem state", right?  Clarify?

>+  // Swap this back buffer with the front, and copy its contents to the new
>+  // back. x, y, w, and h specify the area of |back| that is dirty.

In which coord system?  What happens if you call this on a non-shmem canvas?

>+  // Sync back and front buffer, move ownership of back buffer to parent


Similar here.  Also, what does nativeID mean?

Comment 1

[Doug Turner (:dougt)]

would not block fennec from shipping on this.

Comment 2

[Doug Turner (:dougt)]

chris might be the best person to doc these up.

Comment 3

[Chris Jones [:cjones] inactive; ni?/f?/r? if you need me]

This code will die after bug 590525 or fast -moz-element, not worth doc'ing now IMHO.