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 <cairo.h>
#include <gdk/gdk.h>
 
#include "flutter/shell/platform/embedder/embedder.h"
 
G_BEGIN_DECLS
 
// Maximum time to wait for a frame to be ready before giving up and rendering.
constexpr gint64 kCompositorRenderTimeoutMicroseconds = 100000;  // 100ms
 
G_DECLARE_DERIVABLE_TYPE(FlCompositor, fl_compositor, FL, COMPOSITOR, GObject)
 
struct _FlCompositorClass {
  GObjectClass parent_class;
 
  gboolean (*present_layers)(FlCompositor* compositor,
                             const FlutterLayer** layers,
                             size_t layers_count);
 
  void (*get_frame_size)(FlCompositor* compositor,
                         size_t* width,
                         size_t* height);
 
  gboolean (*render)(FlCompositor* compositor,
                     cairo_t* cr,
                     GdkWindow* window,
                     gboolean wait_for_frame);
};
 
/**
 * FlCompositor:
 *
 * #FlCompositor is an abstract class that implements Flutter compositing.
 */
 
/**
 * fl_compositor_present_layers:
 * @compositor: an #FlCompositor.
 * @layers: layers to be composited.
 * @layers_count: number of layers.
 *
 * Composite layers. Called from the Flutter rendering thread.
 *
 * Returns %TRUE if successful.
 */
gboolean fl_compositor_present_layers(FlCompositor* compositor,
                                      const FlutterLayer** layers,
                                      size_t layers_count);
 
/**
 * fl_compositor_get_frame_size:
 * @compositor: an #FlCompositor.
 * @width: location to write frame width in pixels.
 * @height: location to write frame height in pixels.
 *
 * Get the size of the layer ready for rendering.
 */
void fl_compositor_get_frame_size(FlCompositor* compositor,
                                  size_t* width,
                                  size_t* height);
 
/**
 * fl_compositor_render:
 * @compositor: an #FlCompositor.
 * @cr: a Cairo rendering context.
 * @window: window being rendered into.
 * @wait_for_frame: if the available frame is not the size of the window block
 * until a new frame is received.
 *
 * Renders the current frame. Called from the GTK thread.
 *
 * Returns %TRUE if successful.
 */
gboolean fl_compositor_render(FlCompositor* compositor,
                              cairo_t* cr,
                              GdkWindow* window,
                              gboolean wait_for_frame);
 
G_END_DECLS
 
#endif  // FLUTTER_SHELL_PLATFORM_LINUX_FL_COMPOSITOR_H_