Struct RendererBinding 

pub struct RendererBinding { /* private fields */ }

Implementations

impl RendererBinding

pub fn instance(app: &mut App) -> Handle<RendererBinding>

The current binding, initialized on first access (Flutter’s initInstances).

pub fn mouse_tracker(self: Handle<Self>, app: &App) -> Handle<MouseTracker>

The object that manages state about currently connected mice, for hover notification.

pub fn init_mouse_tracker( self: Handle<Self>, app: &mut App, tracker: Option<Handle<MouseTracker>>, )

Creates a MouseTracker which manages state about currently connected mice, for hover notification.

Used by testing framework to reinitialize the mouse tracker between tests.

pub fn root_pipeline_owner( self: Handle<Self>, app: &App, ) -> Handle<PipelineOwner>

The PipelineOwner that is the root of the pipeline owner tree.

Typically, this owner has no root render object (a RenderView is attached to the owners the widget layer adds as children). Until then, init_render_view attaches the implicit view here.

pub fn pipeline_owner( self: Handle<Self>, app: &mut App, ) -> Handle<PipelineOwner>

The PipelineOwner Flutter’s binding keeps for the implicit view.

pub fn render_view( self: Handle<Self>, app: &mut App, ) -> RenderHandle<RenderView>

The RenderView for the platform’s implicit view, created on first access.

Panics

If the platform has no implicit view.

pub fn render_views( self: Handle<Self>, app: &App, ) -> Vec<RenderHandle<RenderView>>

The RenderViews managed by this binding.

pub fn add_render_view( self: Handle<Self>, app: &mut App, view: RenderHandle<RenderView>, )

Adds a RenderView to this binding.

The binding will interact with the RenderView in the following ways:

• setting and updating RenderView::configuration,
• calling RenderView::composite_frame when it is time to produce a new frame.

pub fn remove_render_view( self: Handle<Self>, app: &mut App, view: RenderHandle<RenderView>, )

Removes a RenderView previously added with add_render_view.

pub fn create_view_configuration_for( self: Handle<Self>, app: &App, render_view: RenderHandle<RenderView>, ) -> ViewConfiguration

Returns a ViewConfiguration configured for the provided RenderView based on the current environment.

pub fn handle_metrics_changed(self: Handle<Self>, app: &mut App)

Called when the system metrics change.

See View::metrics.

pub fn send_frames_to_engine(self: Handle<Self>, app: &App) -> bool

Whether frames produced by draw_frame are sent to the host.

If false the framework will do all the work to produce a frame, but the frame is never sent to the host to actually appear on screen.

pub fn defer_first_frame(self: Handle<Self>, app: &mut App)

Tell the framework to not send the first frames to the host until there is a corresponding call to allow_first_frame.

pub fn allow_first_frame(self: Handle<Self>, app: &mut App)

Called after defer_first_frame to tell the framework that it is ok to send the first frame to the host now.

pub fn reset_first_frame_sent(self: Handle<Self>, app: &mut App)

Call this to pretend that no frames have been sent to the host yet.

pub fn set_overrides( self: Handle<Self>, app: &mut App, overrides: Rc<dyn RendererBindingOverrides>, )

Pump the rendering pipeline to generate a frame.

This method is called by handle_draw_frame, which itself is called automatically by the host when it is time to lay out and paint a frame.

Each frame consists of the following phases: layout, paint, then compositing (for each registered RenderView). Registers the binding layered above this one, as Flutter’s WidgetsBinding does by overriding drawFrame.

pub fn draw_frame(self: Handle<Self>, app: &mut App)

pub fn init_render_view( self: Handle<Self>, app: &mut App, ) -> RenderHandle<RenderView>

Flutter’s TestRenderingFlutterBinding.initRenderView: makes the implicit view’s RenderView the root of root_pipeline_owner, registers it, and prepares its first frame. Idempotent, as _ReusableRenderView is.

Trait Implementations

impl Default for RendererBinding

fn default() -> Self

Returns the “default value” for a type.

impl GestureBindingOverridesObject for RendererBinding

Flutter’s RendererBinding.hitTestInView override: the render view for view_id hit-tests first; GestureBinding then adds itself. Flutter’s RendererBinding overrides of GestureBinding: hitTestInView walks the render trees, dispatchEvent updates the mouse tracker before routing.

fn hit_test( self: Handle<Self>, app: &mut App, result: &mut HitTestResult, position: Offset, )

See HitTestable::hit_test.

fn hit_test_in_view( self: Handle<Self>, app: &mut App, result: &mut HitTestResult, position: Offset, view_id: ViewId, )

See HitTestable::hit_test_in_view.

fn will_dispatch_event( self: Handle<Self>, app: &mut App, event: &PointerEvent, hit_test_result: Option<&HitTestResult>, )

See GestureBindingOverrides::will_dispatch_event.