Flutter Linux Embedder
fl_view_renderer.h File Reference
#include <gtk/gtk.h>
#include "flutter/shell/platform/embedder/embedder.h"

Go to the source code of this file.

Functions

G_BEGIN_DECLS G_DECLARE_DERIVABLE_TYPE (FlViewRenderer, fl_view_renderer, FL, VIEW_RENDERER, GtkDrawingArea) struct _FlViewRendererClass
 
void fl_view_renderer_set_background_color (FlViewRenderer *renderer, const GdkRGBA *color)
 
void fl_view_renderer_paint_background (FlViewRenderer *renderer, cairo_t *cr)
 
void fl_view_renderer_present_layers (FlViewRenderer *renderer, const FlutterLayer **layers, size_t layers_count)
 
void fl_view_renderer_notify_frame (FlViewRenderer *renderer)
 
gboolean fl_view_renderer_resize_to_frame (FlViewRenderer *renderer, size_t frame_width, size_t frame_height)
 

Function Documentation

◆ fl_view_renderer_notify_frame()

void fl_view_renderer_notify_frame ( FlViewRenderer *  renderer)

fl_view_renderer_notify_frame: @renderer: an #FlViewRenderer.

Notifies that a frame has been rendered. Subclasses call this on each frame. The "first-frame" signal is emitted on the first call.

Definition at line 99 of file fl_view_renderer.cc.

99  {
100  g_return_if_fail(FL_IS_VIEW_RENDERER(self));
101 
103  fl_view_renderer_get_instance_private(self));
104 
105  if (!priv->have_first_frame) {
106  priv->have_first_frame = TRUE;
107  g_signal_emit(self, fl_view_renderer_signals[SIGNAL_FIRST_FRAME], 0);
108  }
109 }
FlAccessibilityHandlerPrivate * priv
@ SIGNAL_FIRST_FRAME
static guint fl_view_renderer_signals[LAST_SIGNAL]

References fl_view_renderer_signals, priv, SIGNAL_FIRST_FRAME, and TRUE.

◆ fl_view_renderer_paint_background()

void fl_view_renderer_paint_background ( FlViewRenderer *  renderer,
cairo_t *  cr 
)

fl_view_renderer_paint_background: @renderer: an #FlViewRenderer. @cr: a #cairo_t to paint to.

Paints the background color behind the Flutter frame. Subclasses call this at the start of their draw implementation.

Definition at line 73 of file fl_view_renderer.cc.

73  {
74  g_return_if_fail(FL_IS_VIEW_RENDERER(self));
75 
77  fl_view_renderer_get_instance_private(self));
78 
79  // Don't bother drawing if fully transparent - the widget above this will
80  // already be drawn by GTK.
81  if (priv->background_color->red == 0 && priv->background_color->green == 0 &&
82  priv->background_color->blue == 0 && priv->background_color->alpha == 0) {
83  return;
84  }
85 
86  gdk_cairo_set_source_rgba(cr, priv->background_color);
87  cairo_paint(cr);
88 }

References priv.

◆ fl_view_renderer_present_layers()

void fl_view_renderer_present_layers ( FlViewRenderer *  renderer,
const FlutterLayer **  layers,
size_t  layers_count 
)

fl_view_renderer_present_layers: @renderer: an #FlViewRenderer. @layers: layers to draw. @layers_count: number of layers.

Composites a frame into the renderer. This method can be called from any thread.

Definition at line 90 of file fl_view_renderer.cc.

92  {
93  g_return_if_fail(FL_IS_VIEW_RENDERER(self));
94 
95  FlViewRendererClass* klass = FL_VIEW_RENDERER_GET_CLASS(self);
96  klass->present_layers(self, layers, layers_count);
97 }
const FlutterLayer size_t layers_count
const FlutterLayer ** layers

References layers, and layers_count.

Referenced by fl_view_present_layers(), and TEST_F().

◆ fl_view_renderer_resize_to_frame()

gboolean fl_view_renderer_resize_to_frame ( FlViewRenderer *  renderer,
size_t  frame_width,
size_t  frame_height 
)

fl_view_renderer_resize_to_frame: @renderer: an #FlViewRenderer. @frame_width: the width of the current frame in pixels. @frame_height: the height of the current frame in pixels.

Requests the view (and its toplevel window) to be resized to fit the frame when the widget size does not match it. Called from the GTK thread when Flutter controls the view size.

Returns: TRUE if a resize was requested, FALSE if the widget already matches the frame size.

Definition at line 111 of file fl_view_renderer.cc.

113  {
114  g_return_val_if_fail(FL_IS_VIEW_RENDERER(self), FALSE);
115 
116  GtkWidget* widget = GTK_WIDGET(self);
117  GtkAllocation allocation;
118  gtk_widget_get_allocation(widget, &allocation);
119  gint scale_factor = gtk_widget_get_scale_factor(widget);
120  size_t width = allocation.width * scale_factor;
121  size_t height = allocation.height * scale_factor;
122  gboolean frame_size_matches = width == frame_width && height == frame_height;
123  if (frame_size_matches) {
124  return FALSE;
125  }
126 
127  gtk_widget_set_size_request(widget, frame_width / scale_factor,
128  frame_height / scale_factor);
129  GtkWidget* toplevel = gtk_widget_get_toplevel(widget);
130  if (GTK_IS_WINDOW(toplevel)) {
131  // Resize to smallest size, so that the window will shrink to fit the new
132  // size of the render area.
133  gtk_window_resize(GTK_WINDOW(toplevel), 1, 1);
134  }
135  return TRUE;
136 }
const uint8_t uint32_t uint32_t * height
const uint8_t uint32_t * width

References height, TRUE, and width.

◆ fl_view_renderer_set_background_color()

void fl_view_renderer_set_background_color ( FlViewRenderer *  renderer,
const GdkRGBA *  color 
)

fl_view_renderer_set_background_color: @renderer: an #FlViewRenderer. @color: the background color.

Sets the background color drawn behind the Flutter frame.

Definition at line 59 of file fl_view_renderer.cc.

60  {
61  g_return_if_fail(FL_IS_VIEW_RENDERER(self));
62 
64  fl_view_renderer_get_instance_private(self));
65 
66  gdk_rgba_free(priv->background_color);
67  priv->background_color = gdk_rgba_copy(color);
68 
69  // Redraw so the new background color is shown.
70  gtk_widget_queue_draw(GTK_WIDGET(self));
71 }

References priv.

Referenced by fl_view_set_background_color().

◆ G_DECLARE_DERIVABLE_TYPE()

G_BEGIN_DECLS G_DECLARE_DERIVABLE_TYPE ( FlViewRenderer  ,
fl_view_renderer  ,
FL  ,
VIEW_RENDERER  ,
GtkDrawingArea   
)

FlViewRenderer:

#FlViewRenderer is a GTK widget that renders the contents of a Flutter view. Input handling and other view responsibilities are handled by #FlView.

Subclasses implement rendering for a particular backend, for example #FlViewRendererOpenGL and #FlViewRendererSoftware. The "first-frame" signal is emitted when the first frame has been rendered.

Composites a frame into the renderer. May be called from any thread.

This method is abstract and must be implemented by subclasses.

Definition at line 14 of file fl_view_renderer.h.

31  {
32  GtkDrawingAreaClass parent_class;
33 
34  /**
35  * Composites a frame into the renderer. May be called from any thread.
36  *
37  * This method is abstract and must be implemented by subclasses.
38  */
39  void (*present_layers)(FlViewRenderer* renderer,
40  const FlutterLayer** layers,
41  size_t layers_count);
42 };

References layers, and layers_count.