Struct CrossProcessCompositorApi

pub struct CrossProcessCompositorApi(pub IpcSender<CompositorMsg>);

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

Tuple Fields

0: IpcSender<CompositorMsg>

Implementations

impl CrossProcessCompositorApi

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 sender(&self) -> &IpcSender<CompositorMsg>

Get the sender for this proxy.

pub fn send_initial_transaction(&self, pipeline: WebRenderPipelineId)

Inform WebRender of the existence of this pipeline.

pub fn send_scroll_node( &self, webview_id: WebViewId, pipeline_id: WebRenderPipelineId, point: LayoutVector2D, scroll_id: ExternalScrollId, )

Perform a scroll operation.

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 hit_test( &self, pipeline: Option<WebRenderPipelineId>, point: DevicePoint, flags: HitTestFlags, ) -> Vec<CompositorHitTestResult>

Perform a hit test operation. Blocks until the operation is complete and and a result is available.

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, )

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, )

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, ) -> (Vec<FontKey>, Vec<FontInstanceKey>)

Trait Implementations

impl Clone for CrossProcessCompositorApi

fn clone(&self) -> CrossProcessCompositorApi

Returns a copy 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.