Enum ApiMsg

pub enum ApiMsg {
    UpdateResources(Vec<ResourceUpdate>),
    GetGlyphDimensions(FontInstanceKey, Vec<GlyphIndex>, MsgSender<Vec<Option<GlyphDimensions>>>),
    GetGlyphIndices(FontKey, String, MsgSender<Vec<Option<u32>>>),
    CloneApi(MsgSender<IdNamespace>),
    CloneApiByClient(IdNamespace),
    AddDocument(DocumentId, DeviceIntSize, DocumentLayer),
    UpdateDocuments(Vec<DocumentId>, Vec<TransactionMsg>),
    DeleteDocument(DocumentId),
    ExternalEvent(ExternalEvent),
    ClearNamespace(IdNamespace),
    MemoryPressure,
    ReportMemory(MsgSender<Box<MemoryReport>>),
    DebugCommand(DebugCommand),
    WakeUp,
    WakeSceneBuilder,
    FlushSceneBuilder(MsgSender<()>),
    ShutDown(Option<MsgSender<()>>),
}

Message sent by the RenderApi to the render backend thread.

Variants

UpdateResources(Vec<ResourceUpdate>)

Add/remove/update images and fonts.

GetGlyphDimensions(FontInstanceKey, Vec<GlyphIndex>, MsgSender<Vec<Option<GlyphDimensions>>>)

Gets the glyph dimensions

GetGlyphIndices(FontKey, String, MsgSender<Vec<Option<u32>>>)

Gets the glyph indices from a string

CloneApi(MsgSender<IdNamespace>)

Adds a new document namespace.

CloneApiByClient(IdNamespace)

Adds a new document namespace.

AddDocument(DocumentId, DeviceIntSize, DocumentLayer)

Adds a new document with given initial size.

UpdateDocuments(Vec<DocumentId>, Vec<TransactionMsg>)

A message targeted at a particular document.

DeleteDocument(DocumentId)

Deletes an existing document.

ExternalEvent(ExternalEvent)

An opaque handle that must be passed to the render notifier. It is used by Gecko to forward gecko-specific messages to the render thread preserving the ordering within the other messages.

ClearNamespace(IdNamespace)

Removes all resources associated with a namespace.

MemoryPressure

Flush from the caches anything that isn’t necessary, to free some memory.

ReportMemory(MsgSender<Box<MemoryReport>>)

Collects a memory report.

DebugCommand(DebugCommand)

Change debugging options.

WakeUp

Wakes the render backend’s event loop up. Needed when an event is communicated through another channel.

WakeSceneBuilder

See RenderApi::wake_scene_builder.

FlushSceneBuilder(MsgSender<()>)

Block until a round-trip to the scene builder thread has completed. This ensures that any transactions (including ones deferred to the scene builder thread) have been processed.

ShutDown(Option<MsgSender<()>>)

Shut the WebRender instance down.

Trait Implementations

impl Clone for ApiMsg

fn clone(&self) -> ApiMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiMsg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.