Struct CrossProcessCompositorApi 

pub struct CrossProcessCompositorApi(pub(crate) GenericCallback<CompositorMsg>);

A mechanism to send messages from ScriptThread to the parent process’ WebRender instance.

Tuple Fields

0: GenericCallback<CompositorMsg>

Implementations

impl CrossProcessCompositorApi

pub fn new(callback: GenericCallback<CompositorMsg>) -> Self

Create a new CrossProcessCompositorApi struct.

pub fn dummy() -> Self

Create a new CrossProcessCompositorApi struct that does not have a listener on the other end to use for unit testing.

pub fn dummy_with_callback( callback: Option<Box<dyn Fn(CompositorMsg) + Send + 'static>>, ) -> Self

Create a new CrossProcessCompositorApi struct for unit testing with an optional callback that can respond to compositor messages.

pub fn send_initial_transaction( &self, webview_id: WebViewId, pipeline: WebRenderPipelineId, )

Inform WebRender of the existence of this pipeline.

pub fn scroll_node_by_delta( &self, webview_id: WebViewId, pipeline_id: WebRenderPipelineId, delta: LayoutVector2D, scroll_id: 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.

pub fn scroll_viewport_by_delta( &self, webview_id: WebViewId, delta: 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.

Note the value provided here is in DeviceIndependentPixels and will first be converted to DevicePixels by the renderer.

pub fn delay_new_frame_for_canvas( &self, pipeline_id: PipelineId, canvas_epoch: Epoch, image_keys: Vec<ImageKey>, )

pub fn update_epoch( &self, webview_id: WebViewId, pipeline_id: PipelineId, epoch: Epoch, )

Inform the renderer that the rendering epoch has advanced. This typically happens after a new display list is sent and/or canvas and animated images are updated.

pub fn send_display_list( &self, webview_id: WebViewId, display_list_info: &CompositorDisplayListInfo, list: BuiltDisplayList, )

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

pub fn send_lcp_candidate( &self, lcp_candidate: LCPCandidate, webview_id: WebViewId, pipeline_id: PipelineId, epoch: Epoch, )

Send the largest contentful paint candidate to the compositor.

pub fn generate_frame(&self, webview_ids: Vec<WebViewId>)

Ask the Servo renderer to generate a new frame after having new display lists.

pub fn generate_image_key_blocking(&self) -> Option<ImageKey>

Create a new image key. Blocks until the key is available.

pub fn generate_image_key_async(&self, pipeline_id: PipelineId)

Sends a message to the compositor for creating new image keys. The compositor will then send a batch of keys over the constellation to the script_thread and the appropriate pipeline.

pub fn add_image( &self, key: ImageKey, descriptor: ImageDescriptor, data: SerializableImageData, )

pub fn update_image( &self, key: ImageKey, descriptor: ImageDescriptor, data: SerializableImageData, epoch: Option<Epoch>, )

pub fn delete_image(&self, key: ImageKey)

pub fn update_images(&self, updates: SmallVec<[ImageUpdate; 1]>)

Perform an image resource update operation.

pub fn remove_unused_font_resources( &self, keys: Vec<FontKey>, instance_keys: Vec<FontInstanceKey>, )

pub fn add_font_instance( &self, font_instance_key: FontInstanceKey, font_key: FontKey, size: f32, flags: FontInstanceFlags, variations: Vec<FontVariation>, )

pub fn add_font( &self, font_key: FontKey, data: Arc<IpcSharedMemory>, index: u32, )

pub fn add_system_font(&self, font_key: FontKey, handle: NativeFontHandle)

pub fn fetch_font_keys( &self, number_of_font_keys: usize, number_of_font_instance_keys: usize, painter_id: PainterId, ) -> (Vec<FontKey>, Vec<FontInstanceKey>)

pub fn viewport(&self, webview_id: WebViewId, description: ViewportDescription)

pub fn pipeline_exited( &self, webview_id: WebViewId, pipeline_id: PipelineId, source: PipelineExitSource, )

Trait Implementations

impl Clone for CrossProcessCompositorApi

fn clone(&self) -> CrossProcessCompositorApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for CrossProcessCompositorApi

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl MallocSizeOf for CrossProcessCompositorApi

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl Serialize for CrossProcessCompositorApi

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

where __S: Serializer,

Serialize this value into the given Serde serializer.