pub enum CompositorMsg {
Show 24 variants
ChangeRunningAnimationsState(WebViewId, PipelineId, AnimationState),
CreateOrUpdateWebView(SendableFrameTree),
RemoveWebView(WebViewId),
TouchEventProcessed(WebViewId, TouchEventResult),
IsReadyToSaveImageReply(bool),
SetThrottled(WebViewId, PipelineId, bool),
NewWebRenderFrameReady(DocumentId, bool),
PipelineExited(WebViewId, PipelineId, PipelineExitSource),
LoadComplete(WebViewId),
SendInitialTransaction(PipelineId),
SendScrollNode(WebViewId, PipelineId, LayoutVector2D, ExternalScrollId),
SendDisplayList {
webview_id: WebViewId,
display_list_descriptor: BuiltDisplayListDescriptor,
display_list_receiver: IpcBytesReceiver,
},
GenerateFrame,
GenerateImageKey(IpcSender<ImageKey>),
GenerateImageKeysForPipeline(PipelineId),
UpdateImages(SmallVec<[ImageUpdate; 1]>),
DelayNewFrameForCanvas(PipelineId, Epoch, Vec<ImageKey>),
GenerateFontKeys(usize, usize, GenericSender<(Vec<FontKey>, Vec<FontInstanceKey>)>),
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),
}
Expand description
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.
TouchEventProcessed(WebViewId, TouchEventResult)
Script has handled a touch event, and either prevented or allowed default actions.
IsReadyToSaveImageReply(bool)
A reply to the compositor asking if the output image is stable.
SetThrottled(WebViewId, PipelineId, bool)
Set whether to use less resources by stopping animations.
NewWebRenderFrameReady(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 and the
DocumentId
of the new frame.
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.
LoadComplete(WebViewId)
The load of a page has completed
SendInitialTransaction(PipelineId)
Inform WebRender of the existence of this pipeline.
SendScrollNode(WebViewId, PipelineId, LayoutVector2D, ExternalScrollId)
Perform a scroll operation.
SendDisplayList
Inform WebRender of a new display list for the given pipeline.
Fields
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(IpcSender<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>)>)
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.
Trait Implementations§
Source§impl Debug for CompositorMsg
impl Debug for CompositorMsg
Source§impl<'de> Deserialize<'de> for CompositorMsg
impl<'de> Deserialize<'de> for CompositorMsg
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<'_derivative_strum> From<&'_derivative_strum CompositorMsg> for &'static str
impl<'_derivative_strum> From<&'_derivative_strum CompositorMsg> for &'static str
Source§fn from(x: &'_derivative_strum CompositorMsg) -> &'static str
fn from(x: &'_derivative_strum CompositorMsg) -> &'static str
Source§impl From<CompositorMsg> for &'static str
impl From<CompositorMsg> for &'static str
Source§fn from(x: CompositorMsg) -> &'static str
fn from(x: CompositorMsg) -> &'static str
Source§impl OpaqueSender<CompositorMsg> for CompositorProxy
impl OpaqueSender<CompositorMsg> for CompositorProxy
Source§fn send(&self, message: CompositorMsg)
fn send(&self, message: CompositorMsg)
Auto Trait Implementations§
impl !Freeze for CompositorMsg
impl !RefUnwindSafe for CompositorMsg
impl Send for CompositorMsg
impl !Sync for CompositorMsg
impl Unpin for CompositorMsg
impl UnwindSafe for CompositorMsg
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more