Struct RenderApiSender

pub struct RenderApiSender { /* private fields */ }

Allows the API to communicate with WebRender.

This object is created along with the Renderer and it’s main use from a user perspective is to create one or several RenderApi objects.

Implementations

impl RenderApiSender

pub fn new(api_sender: MsgSender<ApiMsg>, payload_sender: PayloadSender) -> Self

Used internally by the Renderer.

pub fn create_api(&self) -> RenderApi

Creates a new resource API object with a dedicated namespace.

pub fn create_api_by_client(&self, namespace_id: IdNamespace) -> RenderApi

Creates a new resource API object with a dedicated namespace. Namespace id is allocated by client.

The function could be used only when RendererOptions::namespace_alloc_by_client is true. When the option is true, create_api() could not be used to prevent namespace id conflict.

Trait Implementations

impl Clone for RenderApiSender

fn clone(&self) -> RenderApiSender

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for RenderApiSender

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RenderApiSender

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

where __S: Serializer,

Serialize this value into the given Serde serializer.