| Flutter Linux Embedder |

Typedefs | Enumerations | Functions
fl_engine_private.h File Reference
`#include <glib-object.h>`
`#include "flutter/shell/platform/embedder/embedder.h"`
`#include "flutter/shell/platform/linux/fl_display_monitor.h"`
`#include "flutter/shell/platform/linux/fl_keyboard_manager.h"`
`#include "flutter/shell/platform/linux/fl_mouse_cursor_handler.h"`
`#include "flutter/shell/platform/linux/fl_opengl_manager.h"`
`#include "flutter/shell/platform/linux/fl_renderable.h"`
`#include "flutter/shell/platform/linux/fl_task_runner.h"`
`#include "flutter/shell/platform/linux/fl_text_input_handler.h"`
`#include "flutter/shell/platform/linux/fl_windowing_handler.h"`
`#include "flutter/shell/platform/linux/public/flutter_linux/fl_dart_project.h"`
`#include "flutter/shell/platform/linux/public/flutter_linux/fl_engine.h"`

Go to the source code of this file.

## Typedefs
typedef gboolean(* | FlEnginePlatformMessageHandler) (FlEngine *engine, const gchar *channel, GBytes *message, const FlutterPlatformMessageResponseHandle *response_handle, gpointer user_data)

## Enumerations
enum | FlEngineError { FL_ENGINE_ERROR_FAILED }

## Functions
GQuark | fl_engine_error_quark (void) G_GNUC_CONST
FlEngine * | fl_engine_new_with_binary_messenger (FlBinaryMessenger *binary_messenger)
FlutterRendererType | fl_engine_get_renderer_type (FlEngine *engine)
FlOpenGLManager * | fl_engine_get_opengl_manager (FlEngine *engine)
FlDisplayMonitor * | fl_engine_get_display_monitor (FlEngine *engine)
gboolean | fl_engine_start (FlEngine *engine, GError **error)
FlutterEngineProcTable * | fl_engine_get_embedder_api (FlEngine *engine)
void | fl_engine_notify_display_update (FlEngine *engine, const FlutterEngineDisplay *displays, size_t displays_length)
void | fl_engine_set_implicit_view (FlEngine *engine, FlRenderable *renderable)
FlutterViewId | fl_engine_add_view (FlEngine *engine, FlRenderable *renderable, size_t width, size_t height, double pixel_ratio, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_engine_add_view_finish (FlEngine *engine, GAsyncResult *result, GError **error)
FlRenderable * | fl_engine_get_renderable (FlEngine *engine, FlutterViewId view_id)
void | fl_engine_remove_view (FlEngine *engine, FlutterViewId view_id, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_engine_remove_view_finish (FlEngine *engine, GAsyncResult *result, GError **error)
void | fl_engine_set_platform_message_handler (FlEngine *engine, FlEnginePlatformMessageHandler handler, gpointer user_data, GDestroyNotify destroy_notify)
void | fl_engine_send_window_metrics_event (FlEngine *engine, FlutterEngineDisplayId display_id, FlutterViewId view_id, size_t width, size_t height, double pixel_ratio)
void | fl_engine_send_mouse_pointer_event (FlEngine *engine, FlutterViewId view_id, FlutterPointerPhase phase, size_t timestamp, double x, double y, FlutterPointerDeviceKind device_kind, double scroll_delta_x, double scroll_delta_y, int64_t buttons)
void | fl_engine_send_touch_up_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
void | fl_engine_send_touch_down_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
void | fl_engine_send_touch_move_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
void | fl_engine_send_touch_add_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
void | fl_engine_send_touch_remove_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, int32_t device)
void | fl_engine_send_pointer_pan_zoom_event (FlEngine *engine, FlutterViewId view_id, size_t timestamp, double x, double y, FlutterPointerPhase phase, double pan_x, double pan_y, double scale, double rotation)
void | fl_engine_send_key_event (FlEngine *engine, const FlutterKeyEvent *event, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
gboolean | fl_engine_send_key_event_finish (FlEngine *engine, GAsyncResult *result, gboolean *handled, GError **error)
void | fl_engine_dispatch_semantics_action (FlEngine *engine, FlutterViewId view_id, uint64_t node_id, FlutterSemanticsAction action, GBytes *data)
gboolean | fl_engine_send_platform_message_response (FlEngine *engine, const FlutterPlatformMessageResponseHandle *handle, GBytes *response, GError **error)
void | fl_engine_send_platform_message (FlEngine *engine, const gchar *channel, GBytes *message, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data)
GBytes * | fl_engine_send_platform_message_finish (FlEngine *engine, GAsyncResult *result, GError **error)
FlTaskRunner * | fl_engine_get_task_runner (FlEngine *engine)
void | fl_engine_execute_task (FlEngine *engine, FlutterTask *task)
gboolean | fl_engine_mark_texture_frame_available (FlEngine *engine, int64_t texture_id)
gboolean | fl_engine_register_external_texture (FlEngine *engine, int64_t texture_id)
gboolean | fl_engine_unregister_external_texture (FlEngine *engine, int64_t texture_id)
void | fl_engine_update_accessibility_features (FlEngine *engine, int32_t flags)
void | fl_engine_request_app_exit (FlEngine *engine)
FlWindowingHandler * | fl_engine_get_windowing_handler (FlEngine *engine)
FlKeyboardManager * | fl_engine_get_keyboard_manager (FlEngine *engine)
FlTextInputHandler * | fl_engine_get_text_input_handler (FlEngine *engine)
FlMouseCursorHandler * | fl_engine_get_mouse_cursor_handler (FlEngine *engine)
FlEngine * | fl_engine_for_id (int64_t handle)

## Typedef Documentation

## ◆ FlEnginePlatformMessageHandler

typedef gboolean(* FlEnginePlatformMessageHandler) (FlEngine *engine, const gchar *channel, GBytes *message, const FlutterPlatformMessageResponseHandle *response_handle, gpointer user_data)

FlEnginePlatformMessageHandler: @engine: an #FlEngine. @channel: channel message received on. @message: message content received from Dart. @response_handle: a handle to respond to the message with. @user_data: (closure): data provided when registering this handler.

Function called when platform messages are received.

Returns: TRUE if message has been accepted.

Definition at line 47 of file fl_engine_private.h.

## Enumeration Type Documentation

## ◆ FlEngineError

enum FlEngineError

FlEngineError: Errors for #FlEngine objects to set on failures.

Enumerator
FL_ENGINE_ERROR_FAILED |

Definition at line 29 of file fl_engine_private.h.

29 {
30 FL_ENGINE_ERROR_FAILED,
31 } FlEngineError;
FlEngineError
FlEngineError
Definition: fl_engine_private.h:29
FL_ENGINE_ERROR_FAILED
@ FL_ENGINE_ERROR_FAILED
Definition: fl_engine_private.h:30

## Function Documentation

## ◆ fl_engine_add_view()

FlutterViewId fl_engine_add_view | ( | FlEngine * | engine,
|  | FlRenderable * | renderable,
|  | size_t | width,
|  | size_t | height,
|  | double | pixel_ratio,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_engine_add_view: @engine: an #FlEngine. @renderable: the object that will render this view. @width: width of view in pixels. @height: height of view in pixels. @pixel_ratio: scale factor for view. @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the view is added. @user_data: (closure): user data to pass to @callback.

Asynchronously add a new view. The returned view ID should not be used until this function completes.

Returns: the ID for the view.

Definition at line 882 of file fl_engine.cc.

889 {
890 g_return_val_if_fail(FL_IS_ENGINE(self), -1);
891
892 g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
893
894 FlutterViewId view_id = self->next_view_id;
895 self->next_view_id++;
896
897 GWeakRef* ref = g_new(GWeakRef, 1);
898 g_weak_ref_init(ref, G_OBJECT(renderable));
899 g_hash_table_insert(self->renderables_by_view_id, GINT_TO_POINTER(view_id),
900 ref);
901
902 // We don't know which display this view will open on, so set to zero and this
903 // will be updated in a following FlutterWindowMetricsEvent
904 FlutterEngineDisplayId display_id = 0;
905
906 FlutterWindowMetricsEvent metrics = {};
907 metrics.struct_size = sizeof(FlutterWindowMetricsEvent);
908 metrics.width = width;
909 metrics.height = height;
910 metrics.pixel_ratio = pixel_ratio;
911 metrics.display_id = display_id;
912 metrics.view_id = view_id;
913 FlutterAddViewInfo info;
914 info.struct_size = sizeof(FlutterAddViewInfo);
915 info.view_id = view_id;
916 info.view_metrics = &metrics;
917 info.user_data = g_object_ref(task);
918 info.add_view_callback = view_added_cb;
919 FlutterEngineResult result = self->embedder_api.AddView(self->engine, &info);
920 if (result != kSuccess) {
921 g_task_return_new_error(task, fl_engine_error_quark(),
922 FL_ENGINE_ERROR_FAILED, "AddView returned %d",
923 result);
924 // This would have been done in the callback, but that won't occur now.
925 g_object_unref(task);
926 }
927
928 return view_id;
929 }
view_added_cb
static void view_added_cb(const FlutterAddViewResult *result)
Definition: fl_engine.cc:171
fl_engine_error_quark
GQuark fl_engine_error_quark(void) G_GNUC_CONST
user_data
G_BEGIN_DECLS G_MODULE_EXPORT FlValue gpointer user_data
Definition: fl_event_channel.h:90
height
const uint8_t uint32_t uint32_t * height
Definition: fl_pixel_buffer_texture_test.cc:39
width
const uint8_t uint32_t * width
Definition: fl_pixel_buffer_texture_test.cc:38
view_id
G_BEGIN_DECLS FlutterViewId view_id
Definition: fl_view_accessible.h:49

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), height, user_data, view_added_cb(), view_id, and width.

Referenced by fl_view_new_for_engine(), and TEST().

## ◆ fl_engine_add_view_finish()

gboolean fl_engine_add_view_finish | ( | FlEngine * | engine,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_engine_add_view_finish: @engine: an #FlEngine.

Returns
  : a #GAsyncResult. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_engine_add_view().

Returns: TRUE on success.

Definition at line 931 of file fl_engine.cc.

933 {
934 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
935 return g_task_propagate_boolean(G_TASK(result), error);
936 }
error
const uint8_t uint32_t uint32_t GError ** error
Definition: fl_pixel_buffer_texture_test.cc:40

References error.

Referenced by add_view_cb(), add_view_engine_error_cb(), add_view_error_cb(), and view_added_cb().

## ◆ fl_engine_dispatch_semantics_action()

void fl_engine_dispatch_semantics_action | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | uint64_t | node_id,
|  | FlutterSemanticsAction | action,
|  | GBytes * | data
| ) |  |

fl_engine_dispatch_semantics_action: @engine: an #FlEngine. @view_id: the view that the event occured on. @node_id: the semantics action identifier. @action: the action being dispatched. @data: (allow-none): data associated with the action.

Definition at line 1364 of file fl_engine.cc.

1368 {
1369 g_return_if_fail(FL_IS_ENGINE(self));
1370
1371 if (self->engine == nullptr) {
1372 return;
1373 }
1374
1375 const uint8_t* action_data = nullptr;
1376 size_t action_data_length = 0;
1377 if (data != nullptr) {
1378 action_data = static_cast<const uint8_t*>(
1379 g_bytes_get_data(data, &action_data_length));
1380 }
1381
1382 FlutterSendSemanticsActionInfo info;
1383 info.struct_size = sizeof(FlutterSendSemanticsActionInfo);
1384 info.view_id = view_id;
1385 info.node_id = node_id;
1386 info.action = action;
1387 info.data = action_data;
1388 info.data_length = action_data_length;
1389 self->embedder_api.SendSemanticsAction(self->engine, &info);
1390 }
action
FlutterSemanticsAction action
Definition: fl_accessible_node.cc:86

References action, and view_id.

Referenced by fl_accessible_node_perform_action_impl(), and TEST().

## ◆ fl_engine_error_quark()

GQuark fl_engine_error_quark | ( | void |  | ) |

Referenced by fl_engine_add_view(), fl_engine_remove_view(), fl_engine_send_key_event(), fl_engine_send_platform_message(), fl_engine_send_platform_message_response(), fl_engine_start(), view_added_cb(), and view_removed_cb().

## ◆ fl_engine_execute_task()

void fl_engine_execute_task | ( | FlEngine * | engine,
|  | FlutterTask * | task
| ) |  |

fl_engine_execute_task: @engine: an #FlEngine. @task: a #FlutterTask to execute.

Executes given Flutter task.

Definition at line 1424 of file fl_engine.cc.

1424 {
1425 g_return_if_fail(FL_IS_ENGINE(self));
1426 self->embedder_api.RunTask(self->engine, task);
1427 }

Referenced by fl_task_runner_process_expired_tasks_locked().

## ◆ fl_engine_for_id()

FlEngine* fl_engine_for_id | ( | int64_t | handle | ) |

fl_engine_for_id: @handle: an engine identifier obtained through PlatformDispatcher.instance.engineId.

Returns Flutter engine associated with the identifier. The identifier must be valid and for a running engine otherwise the behavior is undefined. Must be called from the main thread.

Returns: a #FlEngine or NULL.

Definition at line 685 of file fl_engine.cc.

685 {
686 void* engine = reinterpret_cast<void*>(id);
687 g_return_val_if_fail(FL_IS_ENGINE(engine), nullptr);
688 return FL_ENGINE(engine);
689 }
id
int64_t id
Definition: fl_pixel_buffer_texture.cc:28

References id.

Referenced by TEST().

## ◆ fl_engine_get_display_monitor()

FlDisplayMonitor* fl_engine_get_display_monitor | ( | FlEngine * | engine | ) |

fl_engine_get_display_monitor: @engine: an #FlEngine.

Gets the display monitor used by this engine.

Returns: an #FlDisplayMonitor.

Definition at line 715 of file fl_engine.cc.

715 {
716 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
717 return self->display_monitor;
718 }

Referenced by handle_geometry_changed(), and TEST().

## ◆ fl_engine_get_embedder_api()

FlutterEngineProcTable* fl_engine_get_embedder_api | ( | FlEngine * | engine | ) |

fl_engine_get_embedder_api: @engine: an #FlEngine.

Gets the embedder API proc table, allowing modificiations for unit testing.

Returns: a mutable pointer to the embedder API proc table.

Definition at line 858 of file fl_engine.cc.

858 {
859 return &(self->embedder_api);
860 }

Referenced by TEST().

## ◆ fl_engine_get_keyboard_manager()

FlKeyboardManager* fl_engine_get_keyboard_manager | ( | FlEngine * | engine | ) |

fl_engine_get_keyboard_manager: @engine: an #FlEngine.

Gets the keyboard manager used by this engine.

Returns: an #FlKeyboardManager.

Definition at line 1456 of file fl_engine.cc.

1456 {
1457 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1458 return self->keyboard_manager;
1459 }

Referenced by handle_key_event(), sync_modifier_if_needed(), and TEST().

## ◆ fl_engine_get_mouse_cursor_handler()

FlMouseCursorHandler* fl_engine_get_mouse_cursor_handler | ( | FlEngine * | engine | ) |

fl_engine_get_mouse_cursor_handler: @engine: an #FlEngine.

Gets the mouse cursor handler used by this engine.

Returns: an #FlMouseCursorHandler.

Definition at line 1466 of file fl_engine.cc.

1466 {
1467 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1468 return self->mouse_cursor_handler;
1469 }

Referenced by cursor_changed_cb(), fl_view_dispose(), setup_cursor(), and TEST().

## ◆ fl_engine_get_opengl_manager()

FlOpenGLManager* fl_engine_get_opengl_manager | ( | FlEngine * | engine | ) |

fl_engine_get_opengl_manager: @engine: an #FlEngine.

Gets the OpenGL manager used by this engine.

Returns: an #FlOpenGLManager.

Definition at line 710 of file fl_engine.cc.

710 {
711 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
712 return self->opengl_manager;
713 }

Referenced by create_context_cb(), fl_compositor_opengl_new(), realize_cb(), and unrealize_cb().

## ◆ fl_engine_get_renderable()

FlRenderable* fl_engine_get_renderable | ( | FlEngine * | engine,
|  | FlutterViewId | view_id
| ) |  |

fl_engine_get_renderable: @engine: an #FlEngine. @view_id: ID to check.

Gets the renderable associated with the give view ID.

Returns: (transfer full): a reference to an #FlRenderable or NULL if none for this ID.

Definition at line 938 of file fl_engine.cc.

938 {
939 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
940
941 GWeakRef* ref = static_cast<GWeakRef*>(g_hash_table_lookup(
942 self->renderables_by_view_id, GINT_TO_POINTER(view_id)));
943 return FL_RENDERABLE(g_weak_ref_get(ref));
944 }

References view_id.

## ◆ fl_engine_get_renderer_type()

FlutterRendererType fl_engine_get_renderer_type | ( | FlEngine * | engine | ) |

fl_engine_get_renderer_type: @engine: an #FlEngine.

Gets the rendering type used by this engine.

Returns: type of rendering used.

Definition at line 705 of file fl_engine.cc.

705 {
706 g_return_val_if_fail(FL_IS_ENGINE(self), static_cast<FlutterRendererType>(0));
707 return self->renderer_type;
708 }

Referenced by realize_cb(), and setup_engine().

## ◆ fl_engine_get_task_runner()

FlTaskRunner* fl_engine_get_task_runner | ( | FlEngine * | engine | ) |

fl_engine_get_task_runner: @engine: an #FlEngine.

Returns
  : a #FlTaskRunner.

Returns: task runner responsible for scheduling Flutter tasks.

Definition at line 1419 of file fl_engine.cc.

1419 {
1420 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1421 return self->task_runner;
1422 }

Referenced by fl_compositor_opengl_present_layers(), fl_compositor_opengl_unblock_main_thread(), fl_compositor_opengl_wait_for_frame(), and TEST().

## ◆ fl_engine_get_text_input_handler()

FlTextInputHandler* fl_engine_get_text_input_handler | ( | FlEngine * | engine | ) |

fl_engine_get_text_input_handler: @engine: an #FlEngine.

Gets the text input handler used by this engine.

Returns: an #FlTextInputHandler.

Definition at line 1461 of file fl_engine.cc.

1461 {
1462 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1463 return self->text_input_handler;
1464 }

Referenced by fl_view_focus_in_event(), and handle_key_event().

## ◆ fl_engine_get_windowing_handler()

FlWindowingHandler* fl_engine_get_windowing_handler | ( | FlEngine * | engine | ) |

fl_engine_get_windowing_handler: @engine: an #FlEngine.

Gets the windowing handler used by this engine.

Returns: an #FlWindowingHandler.

Definition at line 1451 of file fl_engine.cc.

1451 {
1452 g_return_val_if_fail(FL_IS_ENGINE(self), nullptr);
1453 return self->windowing_handler;
1454 }

Referenced by fl_application_activate(), and TEST().

## ◆ fl_engine_mark_texture_frame_available()

gboolean fl_engine_mark_texture_frame_available | ( | FlEngine * | engine,
|  | int64_t | texture_id
| ) |  |

fl_engine_mark_texture_frame_available: @engine: an #FlEngine. @texture_id: the identifier of the texture whose frame has been updated.

Tells the Flutter engine that a new texture frame is available for the given texture.

Returns: TRUE on success.

Definition at line 1392 of file fl_engine.cc.

1393 {
1394 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1395 return self->embedder_api.MarkExternalTextureFrameAvailable(
1396 self->engine, texture_id) == kSuccess;
1397 }
texture_id
int64_t texture_id
Definition: texture_registrar_unittests.cc:24

References texture_id.

Referenced by mark_texture_frame_available().

## ◆ fl_engine_new_with_binary_messenger()

FlEngine* fl_engine_new_with_binary_messenger | ( | FlBinaryMessenger * | binary_messenger | ) |

fl_engine_new_with_binary_messenger: @binary_messenger: an #FlBinaryMessenger.

Creates a new engine with a custom binary messenger. Used for testing.

Returns: a new #FlEngine.

Definition at line 695 of file fl_engine.cc.

696 {
697 g_autoptr(FlDartProject) project = fl_dart_project_new();
698 return fl_engine_new_full(project, binary_messenger);
699 }
fl_dart_project_new
G_MODULE_EXPORT FlDartProject * fl_dart_project_new()
Definition: fl_dart_project.cc:52
fl_engine_new_full
static FlEngine * fl_engine_new_full(FlDartProject *project, FlBinaryMessenger *binary_messenger)
Definition: fl_engine.cc:649

References fl_dart_project_new(), and fl_engine_new_full().

Referenced by TEST().

## ◆ fl_engine_notify_display_update()

void fl_engine_notify_display_update | ( | FlEngine * | engine,
|  | const FlutterEngineDisplay * | displays,
|  | size_t | displays_length
| ) |  |

fl_engine_notify_display_update: @engine: an #FlEngine. @displays: displays present on the system. @displays_length: length of @displays.

Notify the current displays that are in the system.

Definition at line 862 of file fl_engine.cc.

864 {
865 g_return_if_fail(FL_IS_ENGINE(self));
866
867 FlutterEngineResult result = self->embedder_api.NotifyDisplayUpdate(
868 self->engine, kFlutterEngineDisplaysUpdateTypeStartup, displays,
869 displays_length);
870 if (result != kSuccess) {
871 g_warning("Failed to notify display update to Flutter engine: %d", result);
872 }
873 }

Referenced by notify_display_update(), and TEST().

## ◆ fl_engine_register_external_texture()

gboolean fl_engine_register_external_texture | ( | FlEngine * | engine,
|  | int64_t | texture_id
| ) |  |

fl_engine_register_external_texture: @engine: an #FlEngine. @texture_id: the identifier of the texture that is available.

Tells the Flutter engine that a new external texture is available.

Returns: TRUE on success.

Definition at line 1399 of file fl_engine.cc.

1400 {
1401 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1402 return self->embedder_api.RegisterExternalTexture(self->engine, texture_id) ==
1403 kSuccess;
1404 }

References texture_id.

Referenced by register_texture().

## ◆ fl_engine_remove_view()

void fl_engine_remove_view | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_engine_remove_view: @engine: an #FlEngine. @view_id: ID to remove. @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the view is added. @user_data: (closure): user data to pass to @callback.

Removes a view previously added with fl_engine_add_view().

Definition at line 946 of file fl_engine.cc.

950 {
951 g_return_if_fail(FL_IS_ENGINE(self));
952
953 g_hash_table_remove(self->renderables_by_view_id, GINT_TO_POINTER(view_id));
954
955 g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
956
957 FlutterRemoveViewInfo info;
958 info.struct_size = sizeof(FlutterRemoveViewInfo);
959 info.view_id = view_id;
960 info.user_data = g_object_ref(task);
961 info.remove_view_callback = view_removed_cb;
962 FlutterEngineResult result =
963 self->embedder_api.RemoveView(self->engine, &info);
964 if (result != kSuccess) {
965 g_task_return_new_error(task, fl_engine_error_quark(),
966 FL_ENGINE_ERROR_FAILED, "RemoveView returned %d",
967 result);
968 // This would have been done in the callback, but that won't occur now.
969 g_object_unref(task);
970 }
971 }
view_removed_cb
static void view_removed_cb(const FlutterRemoveViewResult *result)
Definition: fl_engine.cc:182

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), user_data, view_id, and view_removed_cb().

Referenced by fl_view_dispose(), and TEST().

## ◆ fl_engine_remove_view_finish()

gboolean fl_engine_remove_view_finish | ( | FlEngine * | engine,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_engine_remove_view_finish: @engine: an #FlEngine.

Returns
  : a #GAsyncResult. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_engine_remove_view().

Returns: TRUE on succcess.

Definition at line 973 of file fl_engine.cc.

975 {
976 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
977 return g_task_propagate_boolean(G_TASK(result), error);
978 }

References error.

Referenced by remove_view_cb(), remove_view_engine_error_cb(), and remove_view_error_cb().

## ◆ fl_engine_request_app_exit()

void fl_engine_request_app_exit | ( | FlEngine * | engine | ) |

fl_engine_request_app_exit: @engine: an #FlEngine.

Request the application exits.

Definition at line 1446 of file fl_engine.cc.

1446 {
1447 g_return_if_fail(FL_IS_ENGINE(self));
1448 fl_platform_handler_request_app_exit(self->platform_handler);
1449 }
fl_platform_handler_request_app_exit
void fl_platform_handler_request_app_exit(FlPlatformHandler *self)
Definition: fl_platform_handler.cc:267

References fl_platform_handler_request_app_exit().

Referenced by window_delete_event_cb().

## ◆ fl_engine_send_key_event()

void fl_engine_send_key_event | ( | FlEngine * | engine,
|  | const FlutterKeyEvent * | event,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_engine_send_key_event: @engine: an #FlEngine. @event: key event to send. @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied. @user_data: (closure): user data to pass to @callback.

Send a key event to the engine.

Definition at line 1324 of file fl_engine.cc.

1328 {
1329 g_return_if_fail(FL_IS_ENGINE(self));
1330
1331 g_autoptr(GTask) task = g_task_new(self, cancellable, callback, user_data);
1332
1333 if (self->engine == nullptr) {
1334 g_task_return_new_error(task, fl_engine_error_quark(),
1335 FL_ENGINE_ERROR_FAILED, "No engine");
1336 return;
1337 }
1338
1339 if (self->embedder_api.SendKeyEvent(self->engine, event, send_key_event_cb,
1340 g_object_ref(task)) != kSuccess) {
1341 g_task_return_new_error(task, fl_engine_error_quark(),
1342 FL_ENGINE_ERROR_FAILED, "Failed to send key event");
1343 g_object_unref(task);
1344 }
1345 }
send_key_event_cb
static void send_key_event_cb(bool handled, void *user_data)
Definition: fl_engine.cc:1317

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), send_key_event_cb(), and user_data.

Referenced by fl_key_embedder_responder_handle_event(), fl_key_embedder_responder_handle_event_impl(), synthesize_simple_event(), and TEST().

## ◆ fl_engine_send_key_event_finish()

gboolean fl_engine_send_key_event_finish | ( | FlEngine * | engine,
|  | GAsyncResult * | result,
|  | gboolean * | handled,
|  | GError ** | error
| ) |  |

fl_engine_send_key_event_finish: @engine: an #FlEngine.

Returns
  : a #GAsyncResult. @handled: location to write if this event was handled by the engine. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_engine_send_key_event().

Returns: TRUE on success.

Definition at line 1347 of file fl_engine.cc.

1350 {
1351 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1352 g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
1353
1354 g_autofree gboolean* return_value =
1355 static_cast<gboolean*>(g_task_propagate_pointer(G_TASK(result), error));
1356 if (return_value == nullptr) {
1357 return FALSE;
1358 }
1359
1360 *handled = *return_value;
1361 return TRUE;
1362 }
TRUE
return TRUE
Definition: fl_pixel_buffer_texture_test.cc:53

References error, and TRUE.

Referenced by TEST().

## ◆ fl_engine_send_mouse_pointer_event()

void fl_engine_send_mouse_pointer_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | FlutterPointerPhase | phase,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | FlutterPointerDeviceKind | device_kind,
|  | double | scroll_delta_x,
|  | double | scroll_delta_y,
|  | int64_t | buttons
| ) |  |

fl_engine_send_mouse_pointer_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @phase: mouse phase. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device_kind: kind of pointing device. @scroll_delta_x: x offset of scroll. @scroll_delta_y: y offset of scroll. @buttons: buttons that are pressed.

Sends a mouse pointer event to the engine.

Definition at line 1121 of file fl_engine.cc.

1130 {
1131 g_return_if_fail(FL_IS_ENGINE(self));
1132
1133 if (self->engine == nullptr) {
1134 return;
1135 }
1136
1137 FlutterPointerEvent fl_event = {};
1138 fl_event.struct_size = sizeof(fl_event);
1139 fl_event.phase = phase;
1140 fl_event.timestamp = timestamp;
1141 fl_event.x = x;
1142 fl_event.y = y;
1143 if (scroll_delta_x != 0 || scroll_delta_y != 0) {
1144 fl_event.signal_kind = kFlutterPointerSignalKindScroll;
1145 }
1146 fl_event.scroll_delta_x = scroll_delta_x;
1147 fl_event.scroll_delta_y = scroll_delta_y;
1148 fl_event.device_kind = device_kind;
1149 fl_event.buttons = buttons;
1150 fl_event.device = kMousePointerDeviceId;
1151 fl_event.view_id = view_id;
1152 self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1153 }
kMousePointerDeviceId
static constexpr int32_t kMousePointerDeviceId
Definition: fl_engine.cc:36

References kMousePointerDeviceId, and view_id.

Referenced by ensure_pointer_added(), fl_pointer_manager_handle_button_press(), fl_pointer_manager_handle_button_release(), fl_pointer_manager_handle_leave(), fl_pointer_manager_handle_motion(), fl_scrolling_manager_handle_scroll_event(), and TEST().

## ◆ fl_engine_send_platform_message()

void fl_engine_send_platform_message | ( | FlEngine * | engine,
|  | const gchar * | channel,
|  | GBytes * | message,
|  | GCancellable * | cancellable,
|  | GAsyncReadyCallback | callback,
|  | gpointer | user_data
| ) |  |

fl_engine_send_platform_message: @engine: an #FlEngine. @channel: channel to send to. @message: (allow-none): message buffer to send or NULL for an empty message @cancellable: (allow-none): a #GCancellable or NULL. @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied. @user_data: (closure): user data to pass to @callback.

Asynchronously sends a platform message.

Definition at line 1031 of file fl_engine.cc.

1036 {
1037 g_return_if_fail(FL_IS_ENGINE(self));
1038
1039 GTask* task = nullptr;
1040 FlutterPlatformMessageResponseHandle* response_handle = nullptr;
1041 if (callback != nullptr) {
1042 task = g_task_new(self, cancellable, callback, user_data);
1043
1044 if (self->engine == nullptr) {
1045 g_task_return_new_error(task, fl_engine_error_quark(),
1046 FL_ENGINE_ERROR_FAILED, "No engine to send to");
1047 return;
1048 }
1049
1050 FlutterEngineResult result =
1051 self->embedder_api.PlatformMessageCreateResponseHandle(
1052 self->engine, fl_engine_platform_message_response_cb, task,
1053 &response_handle);
1054 if (result != kSuccess) {
1055 g_task_return_new_error(task, fl_engine_error_quark(),
1056 FL_ENGINE_ERROR_FAILED,
1057 "Failed to create response handle");
1058 g_object_unref(task);
1059 return;
1060 }
1061 } else if (self->engine == nullptr) {
1062 return;
1063 }
1064
1065 FlutterPlatformMessage fl_message = {};
1066 fl_message.struct_size = sizeof(fl_message);
1067 fl_message.channel = channel;
1068 fl_message.message =
1069 message != nullptr
1070 ? static_cast<const uint8_t*>(g_bytes_get_data(message, nullptr))
1071 : nullptr;
1072 fl_message.message_size = message != nullptr ? g_bytes_get_size(message) : 0;
1073 fl_message.response_handle = response_handle;
1074 FlutterEngineResult result =
1075 self->embedder_api.SendPlatformMessage(self->engine, &fl_message);
1076
1077 if (result != kSuccess && task != nullptr) {
1078 g_task_return_new_error(task, fl_engine_error_quark(),
1079 FL_ENGINE_ERROR_FAILED,
1080 "Failed to send platform messages");
1081 g_object_unref(task);
1082 }
1083
1084 if (response_handle != nullptr) {
1085 self->embedder_api.PlatformMessageReleaseResponseHandle(self->engine,
1086 response_handle);
1087 }
1088 }
fl_engine_platform_message_response_cb
static void fl_engine_platform_message_response_cb(const uint8_t *data, size_t data_length, void *user_data)
Definition: fl_engine.cc:523

References FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), fl_engine_platform_message_response_cb(), and user_data.

Referenced by send_on_channel(), and TEST().

## ◆ fl_engine_send_platform_message_finish()

GBytes* fl_engine_send_platform_message_finish | ( | FlEngine * | engine,
|  | GAsyncResult * | result,
|  | GError ** | error
| ) |  |

fl_engine_send_platform_message_finish: @engine: an #FlEngine.

Returns
  : a #GAsyncResult. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Completes request started with fl_engine_send_platform_message().

Returns: message response on success or NULL on error.

Definition at line 1090 of file fl_engine.cc.

1092 {
1093 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1094 g_return_val_if_fail(g_task_is_valid(result, self), FALSE);
1095
1096 return static_cast<GBytes*>(g_task_propagate_pointer(G_TASK(result), error));
1097 }

References error.

Referenced by send_on_channel_finish().

## ◆ fl_engine_send_platform_message_response()

gboolean fl_engine_send_platform_message_response | ( | FlEngine * | engine,
|  | const FlutterPlatformMessageResponseHandle * | handle,
|  | GBytes * | response,
|  | GError ** | error
| ) |  |

fl_engine_send_platform_message_response: @engine: an #FlEngine. @handle: handle that was provided in FlEnginePlatformMessageHandler. @response: (allow-none): response to send or NULL for an empty response. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Responds to a platform message.

Returns: TRUE on success.

Definition at line 999 of file fl_engine.cc.

1003 {
1004 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1005 g_return_val_if_fail(handle != nullptr, FALSE);
1006
1007 if (self->engine == nullptr) {
1008 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
1009 "No engine to send response to");
1010 return FALSE;
1011 }
1012
1013 gsize data_length = 0;
1014 const uint8_t* data = nullptr;
1015 if (response != nullptr) {
1016 data =
1017 static_cast<const uint8_t*>(g_bytes_get_data(response, &data_length));
1018 }
1019 FlutterEngineResult result = self->embedder_api.SendPlatformMessageResponse(
1020 self->engine, handle, data, data_length);
1021
1022 if (result != kSuccess) {
1023 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
1024 "Failed to send platform message response");
1025 return FALSE;
1026 }
1027
1028 return TRUE;
1029 }

References error, FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), and TRUE.

Referenced by fl_engine_platform_message_cb(), send_response(), and TEST().

## ◆ fl_engine_send_pointer_pan_zoom_event()

void fl_engine_send_pointer_pan_zoom_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | FlutterPointerPhase | phase,
|  | double | pan_x,
|  | double | pan_y,
|  | double | scale,
|  | double | rotation
| ) |  |

fl_engine_send_pointer_pan_zoom_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @phase: mouse phase. @pan_x: x offset of the pan/zoom in pixels. @pan_y: y offset of the pan/zoom in pixels. @scale: scale of the pan/zoom. @rotation: rotation of the pan/zoom in radians.

Sends a pan/zoom pointer event to the engine.

Definition at line 1285 of file fl_engine.cc.

1294 {
1295 g_return_if_fail(FL_IS_ENGINE(self));
1296
1297 if (self->engine == nullptr) {
1298 return;
1299 }
1300
1301 FlutterPointerEvent fl_event = {};
1302 fl_event.struct_size = sizeof(fl_event);
1303 fl_event.timestamp = timestamp;
1304 fl_event.x = x;
1305 fl_event.y = y;
1306 fl_event.phase = phase;
1307 fl_event.pan_x = pan_x;
1308 fl_event.pan_y = pan_y;
1309 fl_event.scale = scale;
1310 fl_event.rotation = rotation;
1311 fl_event.device = kPointerPanZoomDeviceId;
1312 fl_event.device_kind = kFlutterPointerDeviceKindTrackpad;
1313 fl_event.view_id = view_id;
1314 self->embedder_api.SendPointerEvent(self->engine, &fl_event, 1);
1315 }
kPointerPanZoomDeviceId
static constexpr int32_t kPointerPanZoomDeviceId
Definition: fl_engine.cc:37

References kPointerPanZoomDeviceId, and view_id.

Referenced by fl_scrolling_manager_handle_rotation_begin(), fl_scrolling_manager_handle_rotation_end(), fl_scrolling_manager_handle_rotation_update(), fl_scrolling_manager_handle_scroll_event(), fl_scrolling_manager_handle_zoom_begin(), fl_scrolling_manager_handle_zoom_end(), fl_scrolling_manager_handle_zoom_update(), and TEST().

## ◆ fl_engine_send_touch_add_event()

void fl_engine_send_touch_add_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | int32_t | device
| ) |  |

fl_engine_send_touch_add_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch add event to the engine.

Definition at line 1233 of file fl_engine.cc.

1238 {
1239 g_return_if_fail(FL_IS_ENGINE(self));
1240
1241 if (self->engine == nullptr) {
1242 return;
1243 }
1244
1245 FlutterPointerEvent event;
1246 event.timestamp = timestamp;
1247 event.x = x;
1248 event.y = y;
1249 event.device_kind = kFlutterPointerDeviceKindTouch;
1250 event.device = device;
1251 event.buttons = 0;
1252 event.view_id = view_id;
1253 event.phase = FlutterPointerPhase::kAdd;
1254 event.struct_size = sizeof(event);
1255
1256 self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1257 }

References view_id.

Referenced by ensure_touch_added().

## ◆ fl_engine_send_touch_down_event()

void fl_engine_send_touch_down_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | int32_t | device
| ) |  |

fl_engine_send_touch_down_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch down event to the engine.

Definition at line 1181 of file fl_engine.cc.

1186 {
1187 g_return_if_fail(FL_IS_ENGINE(self));
1188
1189 if (self->engine == nullptr) {
1190 return;
1191 }
1192
1193 FlutterPointerEvent event;
1194 event.timestamp = timestamp;
1195 event.x = x;
1196 event.y = y;
1197 event.device_kind = kFlutterPointerDeviceKindTouch;
1198 event.device = device;
1199 event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1200 event.view_id = view_id;
1201 event.phase = FlutterPointerPhase::kDown;
1202 event.struct_size = sizeof(event);
1203
1204 self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1205 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

## ◆ fl_engine_send_touch_move_event()

void fl_engine_send_touch_move_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | int32_t | device
| ) |  |

fl_engine_send_touch_move_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch move event to the engine.

Definition at line 1207 of file fl_engine.cc.

1212 {
1213 g_return_if_fail(FL_IS_ENGINE(self));
1214
1215 if (self->engine == nullptr) {
1216 return;
1217 }
1218
1219 FlutterPointerEvent event;
1220 event.timestamp = timestamp;
1221 event.x = x;
1222 event.y = y;
1223 event.device_kind = kFlutterPointerDeviceKindTouch;
1224 event.device = device;
1225 event.buttons = FlutterPointerMouseButtons::kFlutterPointerButtonMousePrimary;
1226 event.view_id = view_id;
1227 event.phase = FlutterPointerPhase::kMove;
1228 event.struct_size = sizeof(event);
1229
1230 self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1231 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

## ◆ fl_engine_send_touch_remove_event()

void fl_engine_send_touch_remove_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | int32_t | device
| ) |  |

fl_engine_send_touch_remove_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch remove event to the engine.

Definition at line 1259 of file fl_engine.cc.

1264 {
1265 g_return_if_fail(FL_IS_ENGINE(self));
1266
1267 if (self->engine == nullptr) {
1268 return;
1269 }
1270
1271 FlutterPointerEvent event;
1272 event.timestamp = timestamp;
1273 event.x = x;
1274 event.y = y;
1275 event.device_kind = kFlutterPointerDeviceKindTouch;
1276 event.device = device;
1277 event.buttons = 0;
1278 event.view_id = view_id;
1279 event.phase = FlutterPointerPhase::kRemove;
1280 event.struct_size = sizeof(event);
1281
1282 self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1283 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

## ◆ fl_engine_send_touch_up_event()

void fl_engine_send_touch_up_event | ( | FlEngine * | engine,
|  | FlutterViewId | view_id,
|  | size_t | timestamp,
|  | double | x,
|  | double | y,
|  | int32_t | device
| ) |  |

fl_engine_send_touch_up_event: @engine: an #FlEngine. @view_id: the view that the event occured on. @timestamp: time when event occurred in microseconds. @x: x location of mouse cursor. @y: y location of mouse cursor. @device: device id.

Sends a touch up event to the engine.

Definition at line 1155 of file fl_engine.cc.

1160 {
1161 g_return_if_fail(FL_IS_ENGINE(self));
1162
1163 if (self->engine == nullptr) {
1164 return;
1165 }
1166
1167 FlutterPointerEvent event;
1168 event.timestamp = timestamp;
1169 event.x = x;
1170 event.y = y;
1171 event.device_kind = kFlutterPointerDeviceKindTouch;
1172 event.device = device;
1173 event.buttons = 0;
1174 event.view_id = view_id;
1175 event.phase = FlutterPointerPhase::kUp;
1176 event.struct_size = sizeof(event);
1177
1178 self->embedder_api.SendPointerEvent(self->engine, &event, 1);
1179 }

References view_id.

Referenced by fl_touch_manager_handle_touch_event().

## ◆ fl_engine_send_window_metrics_event()

void fl_engine_send_window_metrics_event | ( | FlEngine * | engine,
|  | FlutterEngineDisplayId | display_id,
|  | FlutterViewId | view_id,
|  | size_t | width,
|  | size_t | height,
|  | double | pixel_ratio
| ) |  |

fl_engine_send_window_metrics_event: @engine: an #FlEngine. @display_id: the display this view is rendering on. @view_id: the view that the event occured on. @width: width of the window in pixels. @height: height of the window in pixels. @pixel_ratio: scale factor for window.

Sends a window metrics event to the engine.

Definition at line 1099 of file fl_engine.cc.

1104 {
1105 g_return_if_fail(FL_IS_ENGINE(self));
1106
1107 if (self->engine == nullptr) {
1108 return;
1109 }
1110
1111 FlutterWindowMetricsEvent event = {};
1112 event.struct_size = sizeof(FlutterWindowMetricsEvent);
1113 event.width = width;
1114 event.height = height;
1115 event.pixel_ratio = pixel_ratio;
1116 event.display_id = display_id;
1117 event.view_id = view_id;
1118 self->embedder_api.SendWindowMetricsEvent(self->engine, &event);
1119 }

References height, view_id, and width.

Referenced by handle_geometry_changed(), and TEST().

## ◆ fl_engine_set_implicit_view()

void fl_engine_set_implicit_view | ( | FlEngine * | engine,
|  | FlRenderable * | renderable
| ) |  |

fl_engine_set_implicit_view: @engine: an #FlEngine. @renderable: the object that will render the implicit view.

Sets the object to render the implicit view.

Definition at line 875 of file fl_engine.cc.

875 {
876 GWeakRef* ref = g_new(GWeakRef, 1);
877 g_weak_ref_init(ref, G_OBJECT(renderable));
878 g_hash_table_insert(self->renderables_by_view_id,
879 GINT_TO_POINTER(flutter::kFlutterImplicitViewId), ref);
880 }

Referenced by fl_view_new(), and TEST().

## ◆ fl_engine_set_platform_message_handler()

void fl_engine_set_platform_message_handler | ( | FlEngine * | engine,
|  | FlEnginePlatformMessageHandler | handler,
|  | gpointer | user_data,
|  | GDestroyNotify | destroy_notify
| ) |  |

fl_engine_set_platform_message_handler: @engine: an #FlEngine. @handler: function to call when a platform message is received. @user_data: (closure): user data to pass to @handler. @destroy_notify: (allow-none): a function which gets called to free @user_data, or NULL.

Registers the function called when a platform message is received. Call fl_engine_send_platform_message_response() with the response to this message. Ownership of #FlutterPlatformMessageResponseHandle is transferred to the caller, and the message must be responded to avoid memory leaks.

Definition at line 980 of file fl_engine.cc.

984 {
985 g_return_if_fail(FL_IS_ENGINE(self));
986 g_return_if_fail(handler != nullptr);
987
988 if (self->platform_message_handler_destroy_notify) {
989 self->platform_message_handler_destroy_notify(
990 self->platform_message_handler_data);
991 }
992
993 self->platform_message_handler = handler;
994 self->platform_message_handler_data = user_data;
995 self->platform_message_handler_destroy_notify = destroy_notify;
996 }

References user_data.

Referenced by fl_binary_messenger_new().

## ◆ fl_engine_start()

gboolean fl_engine_start | ( | FlEngine * | engine,
|  | GError ** | error
| ) |  |

fl_engine_start: @engine: an #FlEngine. @error: (allow-none): #GError location to store the error occurring, or NULL to ignore.

Starts the Flutter engine.

Returns: TRUE on success.

Definition at line 720 of file fl_engine.cc.

720 {
721 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
722
723 FlutterRendererConfig config = {};
724 config.type = self->renderer_type;
725 switch (config.type) {
726 case kSoftware:
727 config.software.struct_size = sizeof(FlutterSoftwareRendererConfig);
728 // No action required, as this is handled in
729 // compositor_present_view_callback.
730 config.software.surface_present_callback =
731 [](void* user_data, const void* allocation, size_t row_bytes,
732 size_t height) { return true; };
733 break;
734 case kOpenGL:
735 config.open_gl.struct_size = sizeof(FlutterOpenGLRendererConfig);
736 config.open_gl.gl_proc_resolver = fl_engine_gl_proc_resolver;
737 config.open_gl.make_current = fl_engine_gl_make_current;
738 config.open_gl.clear_current = fl_engine_gl_clear_current;
739 config.open_gl.fbo_callback = fl_engine_gl_get_fbo;
740 // No action required, as this is handled in
741 // compositor_present_view_callback.
742 config.open_gl.present = [](void* user_data) { return true; };
743 config.open_gl.make_resource_current = fl_engine_gl_make_resource_current;
744 config.open_gl.gl_external_texture_frame_callback =
745 fl_engine_gl_external_texture_frame_callback;
746 break;
747 case kMetal:
748 case kVulkan:
749 default:
750 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
751 "Unsupported renderer type");
752 return FALSE;
753 }
754
755 FlutterTaskRunnerDescription platform_task_runner = {};
756 platform_task_runner.struct_size = sizeof(FlutterTaskRunnerDescription);
757 platform_task_runner.user_data = self;
758 platform_task_runner.runs_task_on_current_thread_callback =
759 fl_engine_runs_task_on_current_thread;
760 platform_task_runner.post_task_callback = fl_engine_post_task;
761 platform_task_runner.identifier = kPlatformTaskRunnerIdentifier;
762
763 FlutterCustomTaskRunners custom_task_runners = {};
764 custom_task_runners.struct_size = sizeof(FlutterCustomTaskRunners);
765 custom_task_runners.platform_task_runner = &platform_task_runner;
766
767 if (fl_dart_project_get_ui_thread_policy(self->project) ==
768 FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD) {
769 custom_task_runners.ui_task_runner = &platform_task_runner;
770 }
771
772 g_autoptr(GPtrArray) command_line_args =
773 g_ptr_array_new_with_free_func(g_free);
774 g_ptr_array_insert(command_line_args, 0, g_strdup("flutter"));
775 for (const auto& env_switch : flutter::GetSwitchesFromEnvironment()) {
776 g_ptr_array_add(command_line_args, g_strdup(env_switch.c_str()));
777 }
778
779 gchar** dart_entrypoint_args =
780 fl_dart_project_get_dart_entrypoint_arguments(self->project);
781
782 FlutterProjectArgs args = {};
783 args.struct_size = sizeof(FlutterProjectArgs);
784 args.assets_path = fl_dart_project_get_assets_path(self->project);
785 args.icu_data_path = fl_dart_project_get_icu_data_path(self->project);
786 args.command_line_argc = command_line_args->len;
787 args.command_line_argv =
788 reinterpret_cast<const char* const*>(command_line_args->pdata);
789 args.platform_message_callback = fl_engine_platform_message_cb;
790 args.update_semantics_callback2 = fl_engine_update_semantics_cb;
791 args.custom_task_runners = &custom_task_runners;
792 args.shutdown_dart_vm_when_done = true;
793 args.on_pre_engine_restart_callback = fl_engine_on_pre_engine_restart_cb;
794 args.dart_entrypoint_argc =
795 dart_entrypoint_args != nullptr ? g_strv_length(dart_entrypoint_args) : 0;
796 args.dart_entrypoint_argv =
797 reinterpret_cast<const char* const*>(dart_entrypoint_args);
798 args.engine_id = reinterpret_cast<int64_t>(self);
799
800 FlutterCompositor compositor = {};
801 compositor.struct_size = sizeof(FlutterCompositor);
802 compositor.user_data = self;
803 compositor.create_backing_store_callback =
804 compositor_create_backing_store_callback;
805 compositor.collect_backing_store_callback =
806 compositor_collect_backing_store_callback;
807 compositor.present_view_callback = compositor_present_view_callback;
808 args.compositor = &compositor;
809
810 if (self->embedder_api.RunsAOTCompiledDartCode()) {
811 FlutterEngineAOTDataSource source = {};
812 source.type = kFlutterEngineAOTDataSourceTypeElfPath;
813 source.elf_path = fl_dart_project_get_aot_library_path(self->project);
814 if (self->embedder_api.CreateAOTData(&source, &self->aot_data) !=
815 kSuccess) {
816 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
817 "Failed to create AOT data");
818 return FALSE;
819 }
820 args.aot_data = self->aot_data;
821 }
822
823 FlutterEngineResult result = self->embedder_api.Initialize(
824 FLUTTER_ENGINE_VERSION, &config, &args, self, &self->engine);
825 if (result != kSuccess) {
826 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
827 "Failed to initialize Flutter engine");
828 return FALSE;
829 }
830
831 result = self->embedder_api.RunInitialized(self->engine);
832 if (result != kSuccess) {
833 g_set_error(error, fl_engine_error_quark(), FL_ENGINE_ERROR_FAILED,
834 "Failed to run Flutter engine");
835 return FALSE;
836 }
837
838 setup_locales(self);
839
840 g_autoptr(FlSettings) settings = fl_settings_new();
841 self->settings_handler = fl_settings_handler_new(self);
842 fl_settings_handler_start(self->settings_handler, settings);
843
844 self->platform_handler = fl_platform_handler_new(self->binary_messenger);
845
846 setup_keyboard(self);
847
848 result = self->embedder_api.UpdateSemanticsEnabled(self->engine, TRUE);
849 if (result != kSuccess) {
850 g_warning("Failed to enable accessibility features on Flutter engine");
851 }
852
853 fl_display_monitor_start(self->display_monitor);
854
855 return TRUE;
856 }
fl_dart_project_get_aot_library_path
G_MODULE_EXPORT const gchar * fl_dart_project_get_aot_library_path(FlDartProject *self)
Definition: fl_dart_project.cc:74
fl_dart_project_get_dart_entrypoint_arguments
G_MODULE_EXPORT gchar ** fl_dart_project_get_dart_entrypoint_arguments(FlDartProject *self)
Definition: fl_dart_project.cc:106
fl_dart_project_get_icu_data_path
G_MODULE_EXPORT const gchar * fl_dart_project_get_icu_data_path(FlDartProject *self)
Definition: fl_dart_project.cc:100
fl_dart_project_get_assets_path
G_MODULE_EXPORT const gchar * fl_dart_project_get_assets_path(FlDartProject *self)
Definition: fl_dart_project.cc:87
fl_dart_project_get_ui_thread_policy
G_MODULE_EXPORT FlUIThreadPolicy fl_dart_project_get_ui_thread_policy(FlDartProject *project)
Definition: fl_dart_project.cc:128
FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD
@ FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD
Definition: fl_dart_project.h:143
fl_display_monitor_start
void fl_display_monitor_start(FlDisplayMonitor *self)
Definition: fl_display_monitor.cc:103
fl_engine_gl_external_texture_frame_callback
static bool fl_engine_gl_external_texture_frame_callback(void *user_data, int64_t texture_id, size_t width, size_t height, FlutterOpenGLTexture *opengl_texture)
Definition: fl_engine.cc:406
fl_engine_runs_task_on_current_thread
static bool fl_engine_runs_task_on_current_thread(void *user_data)
Definition: fl_engine.cc:447
fl_engine_on_pre_engine_restart_cb
static void fl_engine_on_pre_engine_restart_cb(void *user_data)
Definition: fl_engine.cc:513
compositor_create_backing_store_callback
static bool compositor_create_backing_store_callback(const FlutterBackingStoreConfig *config, FlutterBackingStore *backing_store_out, void *user_data)
Definition: fl_engine.cc:327
fl_engine_gl_make_current
static bool fl_engine_gl_make_current(void *user_data)
Definition: fl_engine.cc:382
compositor_present_view_callback
static bool compositor_present_view_callback(const FlutterPresentViewInfo *info)
Definition: fl_engine.cc:358
compositor_collect_backing_store_callback
static bool compositor_collect_backing_store_callback(const FlutterBackingStore *backing_store, void *user_data)
Definition: fl_engine.cc:343
fl_engine_post_task
static void fl_engine_post_task(FlutterTask task, uint64_t target_time_nanos, void *user_data)
Definition: fl_engine.cc:453
fl_engine_gl_get_fbo
static uint32_t fl_engine_gl_get_fbo(void *user_data)
Definition: fl_engine.cc:394
fl_engine_gl_proc_resolver
static void * fl_engine_gl_proc_resolver(void *user_data, const char *name)
Definition: fl_engine.cc:378
setup_keyboard
static void setup_keyboard(FlEngine *self)
Definition: fl_engine.cc:489
setup_locales
static void setup_locales(FlEngine *self)
Definition: fl_engine.cc:200
fl_engine_update_semantics_cb
static void fl_engine_update_semantics_cb(const FlutterSemanticsUpdate2 *update, void *user_data)
Definition: fl_engine.cc:482
fl_engine_gl_make_resource_current
static bool fl_engine_gl_make_resource_current(void *user_data)
Definition: fl_engine.cc:399
fl_engine_platform_message_cb
static void fl_engine_platform_message_cb(const FlutterPlatformMessage *message, void *user_data)
Definition: fl_engine.cc:462
kPlatformTaskRunnerIdentifier
static constexpr size_t kPlatformTaskRunnerIdentifier
Definition: fl_engine.cc:32
fl_engine_gl_clear_current
static bool fl_engine_gl_clear_current(void *user_data)
Definition: fl_engine.cc:388
args
G_BEGIN_DECLS G_MODULE_EXPORT FlValue * args
Definition: fl_event_channel.h:89
fl_platform_handler_new
FlPlatformHandler * fl_platform_handler_new(FlBinaryMessenger *messenger)
Definition: fl_platform_handler.cc:254
fl_settings_new
FlSettings * fl_settings_new()
Definition: fl_settings.cc:55
fl_settings_handler_start
void fl_settings_handler_start(FlSettingsHandler *self, FlSettings *settings)
Definition: fl_settings_handler.cc:88
fl_settings_handler_new
FlSettingsHandler * fl_settings_handler_new(FlEngine *engine)
Definition: fl_settings_handler.cc:74
flutter::GetSwitchesFromEnvironment
std::vector< std::string > GetSwitchesFromEnvironment()
Definition: engine_switches.cc:14

References args, compositor_collect_backing_store_callback(), compositor_create_backing_store_callback(), compositor_present_view_callback(), error, fl_dart_project_get_aot_library_path(), fl_dart_project_get_assets_path(), fl_dart_project_get_dart_entrypoint_arguments(), fl_dart_project_get_icu_data_path(), fl_dart_project_get_ui_thread_policy(), fl_display_monitor_start(), FL_ENGINE_ERROR_FAILED, fl_engine_error_quark(), fl_engine_gl_clear_current(), fl_engine_gl_external_texture_frame_callback(), fl_engine_gl_get_fbo(), fl_engine_gl_make_current(), fl_engine_gl_make_resource_current(), fl_engine_gl_proc_resolver(), fl_engine_on_pre_engine_restart_cb(), fl_engine_platform_message_cb(), fl_engine_post_task(), fl_engine_runs_task_on_current_thread(), fl_engine_update_semantics_cb(), fl_platform_handler_new(), fl_settings_handler_new(), fl_settings_handler_start(), fl_settings_new(), FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD, flutter::GetSwitchesFromEnvironment(), height, kPlatformTaskRunnerIdentifier, setup_keyboard(), setup_locales(), TRUE, and user_data.

Referenced by realize_cb(), and TEST().

## ◆ fl_engine_unregister_external_texture()

gboolean fl_engine_unregister_external_texture | ( | FlEngine * | engine,
|  | int64_t | texture_id
| ) |  |

fl_engine_unregister_external_texture: @engine: an #FlEngine. @texture_id: the identifier of the texture that is not available anymore.

Tells the Flutter engine that an existing external texture is not available anymore.

Returns: TRUE on success.

Definition at line 1406 of file fl_engine.cc.

1407 {
1408 g_return_val_if_fail(FL_IS_ENGINE(self), FALSE);
1409 return self->embedder_api.UnregisterExternalTexture(self->engine,
1410 texture_id) == kSuccess;
1411 }

References texture_id.

Referenced by unregister_texture().

## ◆ fl_engine_update_accessibility_features()

void fl_engine_update_accessibility_features | ( | FlEngine * | engine,
|  | int32_t | flags
| ) |  |

fl_engine_update_accessibility_features: @engine: an #FlEngine. @flags: the features to enable in the accessibility tree.

Tells the Flutter engine to update the flags on the accessibility tree.

Definition at line 1435 of file fl_engine.cc.

1435 {
1436 g_return_if_fail(FL_IS_ENGINE(self));
1437
1438 if (self->engine == nullptr) {
1439 return;
1440 }
1441
1442 self->embedder_api.UpdateAccessibilityFeatures(
1443 self->engine, static_cast<FlutterAccessibilityFeature>(flags));
1444 }

Referenced by update_settings().