Enum CompositorMsg 

pub enum CompositorMsg {
    ChangeRunningAnimationsState(WebViewId, PipelineId, AnimationState),
    CreateOrUpdateWebView(SendableFrameTree),
    RemoveWebView(WebViewId),
    SetThrottled(WebViewId, PipelineId, bool),
    NewWebRenderFrameReady(PainterId, DocumentId, bool),
    PipelineExited(WebViewId, PipelineId, PipelineExitSource),
    SendInitialTransaction(WebViewId, PipelineId),
    ScrollNodeByDelta(WebViewId, PipelineId, LayoutVector2D, ExternalScrollId),
    ScrollViewportByDelta(WebViewId, LayoutVector2D),
    UpdateEpoch {
        webview_id: WebViewId,
        pipeline_id: PipelineId,
        epoch: Epoch,
    },
    SendDisplayList {
        webview_id: WebViewId,
        display_list_descriptor: BuiltDisplayListDescriptor,
        display_list_receiver: IpcBytesReceiver,
    },
    GenerateFrame,
    GenerateImageKey(GenericSender<ImageKey>),
    GenerateImageKeysForPipeline(PipelineId),
    UpdateImages(SmallVec<[ImageUpdate; 1]>),
    DelayNewFrameForCanvas(PipelineId, Epoch, Vec<ImageKey>),
    GenerateFontKeys(usize, usize, GenericSender<(Vec<FontKey>, Vec<FontInstanceKey>)>, PainterId),
    AddFont(FontKey, Arc<IpcSharedMemory>, u32),
    AddSystemFont(FontKey, NativeFontHandle),
    AddFontInstance(FontInstanceKey, FontKey, f32, FontInstanceFlags, Vec<FontVariation>),
    RemoveFonts(Vec<FontKey>, Vec<FontInstanceKey>),
    CollectMemoryReport(ReportsChan),
    Viewport(WebViewId, ViewportDescription),
    ScreenshotReadinessReponse(WebViewId, FxHashMap<PipelineId, Epoch>),
    SendLCPCandidate(LCPCandidate, WebViewId, PipelineId, Epoch),
}

Messages from (or via) the constellation thread to the compositor.

Variants

ChangeRunningAnimationsState(WebViewId, PipelineId, AnimationState)

Alerts the compositor that the given pipeline has changed whether it is running animations.

CreateOrUpdateWebView(SendableFrameTree)

Create or update a webview, given its frame tree.

RemoveWebView(WebViewId)

Remove a webview.

SetThrottled(WebViewId, PipelineId, bool)

Set whether to use less resources by stopping animations.

NewWebRenderFrameReady(PainterId, DocumentId, bool)

WebRender has produced a new frame. This message informs the compositor that the frame is ready. It contains a bool to indicate if it needs to composite, the DocumentId of the new frame and the PainterId of the associated painter.

PipelineExited(WebViewId, PipelineId, PipelineExitSource)

Script or the Constellation is notifying the renderer that a Pipeline has finished shutting down. The renderer will not discard the Pipeline until both report that they have fully shut it down, to avoid recreating it due to any subsequent messages.

SendInitialTransaction(WebViewId, PipelineId)

Inform WebRender of the existence of this pipeline.

ScrollNodeByDelta(WebViewId, PipelineId, LayoutVector2D, ExternalScrollId)

Scroll the given node (ExternalScrollId) by the provided delta. This will only adjust the node’s scroll position and will not do panning in the pinch zoom viewport.

ScrollViewportByDelta(WebViewId, LayoutVector2D)

Scroll the WebView’s viewport by the given delta. This will also do panning in the pinch zoom viewport if possible and the remaining delta will be used to scroll the root layer.

UpdateEpoch

Update the rendering epoch of the given Pipeline.

Fields

webview_id: WebViewId

The WebViewId that this display list belongs to.

pipeline_id: PipelineId

The PipelineId of the Pipeline to update.

epoch: Epoch

The new Epoch value.

SendDisplayList

Inform WebRender of a new display list for the given pipeline.

Fields

webview_id: WebViewId

The WebViewId that this display list belongs to.

display_list_descriptor: BuiltDisplayListDescriptor

A descriptor of this display list used to construct this display list from raw data.

display_list_receiver: IpcBytesReceiver

An ipc::IpcBytesReceiver used to send the raw data of the display list.

GenerateFrame

Ask the renderer to generate a frame for the current set of display lists that have been sent to the renderer.

GenerateImageKey(GenericSender<ImageKey>)

Create a new image key. The result will be returned via the provided channel sender.

GenerateImageKeysForPipeline(PipelineId)

The same as the above but it will be forwarded to the pipeline instead of send via a channel.

UpdateImages(SmallVec<[ImageUpdate; 1]>)

Perform a resource update operation.

DelayNewFrameForCanvas(PipelineId, Epoch, Vec<ImageKey>)

Pause all pipeline display list processing for the given pipeline until the following image updates have been received. This is used to ensure that canvas elements have had a chance to update their rendering and send the image update to the renderer before their associated display list is actually displayed.

GenerateFontKeys(usize, usize, GenericSender<(Vec<FontKey>, Vec<FontInstanceKey>)>, PainterId)

Generate a new batch of font keys which can be used to allocate keys asynchronously.

AddFont(FontKey, Arc<IpcSharedMemory>, u32)

Add a font with the given data and font key.

AddSystemFont(FontKey, NativeFontHandle)

Add a system font with the given font key and handle.

AddFontInstance(FontInstanceKey, FontKey, f32, FontInstanceFlags, Vec<FontVariation>)

Add an instance of a font with the given instance key.

RemoveFonts(Vec<FontKey>, Vec<FontInstanceKey>)

Remove the given font resources from our WebRender instance.

CollectMemoryReport(ReportsChan)

Measure the current memory usage associated with the compositor. The report must be sent on the provided channel once it’s complete.

Viewport(WebViewId, ViewportDescription)

A top-level frame has parsed a viewport metatag and is sending the new constraints.

ScreenshotReadinessReponse(WebViewId, FxHashMap<PipelineId, Epoch>)

Let the compositor know that the given WebView is ready to have a screenshot taken after the given pipeline’s epochs have been rendered.

SendLCPCandidate(LCPCandidate, WebViewId, PipelineId, Epoch)

The candidate of largest-contentful-paint

Trait Implementations

impl Debug for CompositorMsg

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompositorMsg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'_derivative_strum> From<&'_derivative_strum CompositorMsg> for &'static str

fn from(x: &'_derivative_strum CompositorMsg) -> &'static str

Converts to this type from the input type.

impl From<CompositorMsg> for &'static str

fn from(x: CompositorMsg) -> &'static str

Converts to this type from the input type.

impl OpaqueSender<CompositorMsg> for CompositorProxy

fn send(&self, message: CompositorMsg)

Send a message.

impl Serialize for CompositorMsg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.