#include <embedder.h>

Public Attributes
size_t	struct_size
	This size of this struct. Must be sizeof(FlutterCompositor).

void *	user_data

FlutterBackingStoreCreateCallback	create_backing_store_callback

FlutterBackingStoreCollectCallback	collect_backing_store_callback

FlutterLayersPresentCallback	present_layers_callback

bool	avoid_backing_store_cache

FlutterPresentViewCallback	present_view_callback

Detailed Description

Definition at line 2195 of file embedder.h.

Member Data Documentation

◆ avoid_backing_store_cache

bool FlutterCompositor::avoid_backing_store_cache

Avoid caching backing stores provided by this compositor.

The engine has an internal backing store cache. Instead of creating & destroying backing stores for every frame, created backing stores are automatically reused for subsequent frames.

If you wish to change this behavior and destroy backing stores after they've been used once, and create new backing stores for every frame, you can set this bool to true.

Definition at line 2241 of file embedder.h.

◆ collect_backing_store_callback

FlutterBackingStoreCollectCallback FlutterCompositor::collect_backing_store_callback

A callback invoked by the engine to release the backing store. The embedder may collect any resources associated with the backing store.

The callback should return true if the operation was successful.

Definition at line 2218 of file embedder.h.

Referenced by CreateEmbedderRenderTarget(), fl_engine_start(), and flutter::testing::TEST_F().

◆ create_backing_store_callback

FlutterBackingStoreCreateCallback FlutterCompositor::create_backing_store_callback

A callback invoked by the engine to obtain a backing store for a specific FlutterLayer.

On ABI stability: Callers must take care to restrict access within FlutterBackingStore::struct_size when specifying a new backing store to the engine. This only matters if the embedder expects to be used with engines older than the version whose headers it used during compilation.

The callback should return true if the operation was successful.

Definition at line 2213 of file embedder.h.

Referenced by CreateEmbedderRenderTarget(), fl_engine_start(), and flutter::testing::TEST_F().

◆ present_layers_callback

FlutterLayersPresentCallback FlutterCompositor::present_layers_callback

Callback invoked by the engine to composite the contents of each layer onto the implicit view.

DEPRECATED: Use present_view_callback to support multiple views. If this callback is provided, FlutterEngineAddView and FlutterEngineRemoveView should not be used.

Only one of present_layers_callback and present_view_callback may be provided. Providing both is an error and engine initialization will terminate.

The callback should return true if the operation was successful.

Definition at line 2231 of file embedder.h.

◆ present_view_callback

FlutterPresentViewCallback FlutterCompositor::present_view_callback

Callback invoked by the engine to composite the contents of each layer onto the specified view.

Only one of present_layers_callback and present_view_callback may be provided. Providing both is an error and engine initialization will terminate.

The callback should return true if the operation was successful.

Definition at line 2250 of file embedder.h.

Referenced by fl_engine_start(), and flutter::testing::TEST_F().