FlutterCompositor Struct Reference

#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
	Avoid caching backing stores provided by this compositor.
FlutterPresentViewCallback	present_view_callback

Detailed Description

Definition at line 1883 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.

Definition at line 1921 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 1906 of file embedder.h.

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 1901 of file embedder.h.

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 1919 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 1930 of file embedder.h.

struct_size

size_t FlutterCompositor::struct_size

This size of this struct. Must be sizeof(FlutterCompositor).

Definition at line 1885 of file embedder.h.

user_data

void* FlutterCompositor::user_data

A baton that in not interpreted by the engine in any way. If it passed back to the embedder in FlutterCompositor.create_backing_store_callback, FlutterCompositor.collect_backing_store_callback, FlutterCompositor.present_layers_callback, and FlutterCompositor.present_view_callback.

Definition at line 1891 of file embedder.h.

---

The documentation for this struct was generated from the following file:

• shell/platform/embedder/embedder.h