Enum CompositorMsg

Source
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

§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(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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<CompositorMsg> for &'static str

Source§

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

Converts to this type from the input type.
Source§

impl OpaqueSender<CompositorMsg> for CompositorProxy

Source§

fn send(&self, message: CompositorMsg)

Send a message.
Source§

impl Serialize for CompositorMsg

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> MaybeBoxed<Box<T>> for T

Source§

fn maybe_boxed(self) -> Box<T>

Convert
Source§

impl<T> MaybeBoxed<T> for T

Source§

fn maybe_boxed(self) -> T

Convert
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T