fl_compositor.h

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#ifndef FLUTTER_SHELL_PLATFORM_LINUX_FL_COMPOSITOR_H_
#define FLUTTER_SHELL_PLATFORM_LINUX_FL_COMPOSITOR_H_
 
#include <glib-object.h>
 
#include "flutter/shell/platform/embedder/embedder.h"
 
G_BEGIN_DECLS
 
G_DECLARE_DERIVABLE_TYPE(FlCompositor, fl_compositor, FL, COMPOSITOR, GObject)
 
struct _FlCompositorClass {
  GObjectClass parent_class;
 
  gboolean (*create_backing_store)(FlCompositor* compositor,
                                   const FlutterBackingStoreConfig* config,
                                   FlutterBackingStore* backing_store_out);
 
  gboolean (*collect_backing_store)(FlCompositor* compositor,
                                    const FlutterBackingStore* backing_store);
 
  gboolean (*present_layers)(FlCompositor* compositor,
                             FlutterViewId view_id,
                             const FlutterLayer** layers,
                             size_t layers_count);
 
  void (*wait_for_frame)(FlCompositor* compositor,
                         int target_width,
                         int target_height);
};
 
/**
 * FlCompositor:
 *
 * #FlCompositor is an abstract class that implements Flutter compositing.
 */
 
/**
 * fl_compositor_create_backing_store:
 * @compositor: an #FlCompositor.
 * @config: backing store config.
 * @backing_store_out: saves created backing store.
 *
 * Obtain a backing store for a specific #FlutterLayer.
 *
 * Returns %TRUE if successful.
 */
gboolean fl_compositor_create_backing_store(
    FlCompositor* compositor,
    const FlutterBackingStoreConfig* config,
    FlutterBackingStore* backing_store_out);
 
/**
 * fl_compositor_collect_backing_store:
 * @compositor: an #FlCompositor.
 * @backing_store: backing store to be released.
 *
 * A callback invoked by the engine to release the backing store. The
 * embedder may collect any resources associated with the backing store.
 *
 * Returns %TRUE if successful.
 */
gboolean fl_compositor_collect_backing_store(
    FlCompositor* compositor,
    const FlutterBackingStore* backing_store);
 
/**
 * fl_compositor_present_layers:
 * @compositor: an #FlCompositor.
 * @view_id: view to present.
 * @layers: layers to be composited.
 * @layers_count: number of layers.
 *
 * Callback invoked by the engine to composite the contents of each layer
 * onto the screen.
 *
 * Returns %TRUE if successful.
 */
gboolean fl_compositor_present_layers(FlCompositor* compositor,
                                      FlutterViewId view_id,
                                      const FlutterLayer** layers,
                                      size_t layers_count);
 
/**
 * fl_compositor_wait_for_frame:
 * @compositor: an #FlCompositor.
 * @target_width: width of frame being waited for
 * @target_height: height of frame being waited for
 *
 * Holds the thread until frame with requested dimensions is presented.
 * While waiting for frame Flutter platform and raster tasks are being
 * processed.
 */
void fl_compositor_wait_for_frame(FlCompositor* compositor,
                                  int target_width,
                                  int target_height);
 
G_END_DECLS
 
#endif  // FLUTTER_SHELL_PLATFORM_LINUX_FL_COMPOSITOR_H_