fl_view_renderer.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_VIEW_RENDERER_H_
#define FLUTTER_SHELL_PLATFORM_LINUX_FL_VIEW_RENDERER_H_
 
#include <gtk/gtk.h>
 
#include "flutter/shell/platform/embedder/embedder.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_engine.h"
 
G_BEGIN_DECLS
 
G_DECLARE_FINAL_TYPE(FlViewRenderer,
                     fl_view_renderer,
                     FL,
                     VIEW_RENDERER,
                     GtkDrawingArea)
 
/**
 * FlViewRenderer:
 *
 * #FlViewRenderer is a GTK widget that renders the contents of a Flutter view.
 * It owns the compositor and OpenGL context used to draw frames produced by the
 * Flutter engine. Input handling and other view responsibilities are handled by
 * #FlView.
 */
 
/**
 * fl_view_renderer_new:
 * @engine: the #FlEngine to render.
 * @sized_to_content: %TRUE if the view size is controlled by Flutter.
 *
 * Creates a new widget that renders Flutter frames.
 *
 * Returns: a new #FlViewRenderer.
 */
FlViewRenderer* fl_view_renderer_new(FlEngine* engine,
                                     gboolean sized_to_content);
 
/**
 * fl_view_renderer_set_background_color:
 * @renderer: an #FlViewRenderer.
 * @color: the background color.
 *
 * Sets the background color drawn behind the Flutter frame.
 */
void fl_view_renderer_set_background_color(FlViewRenderer* renderer,
                                           const GdkRGBA* color);
 
/**
 * fl_view_renderer_present_layers:
 * @renderer: an #FlViewRenderer.
 * @layers: layers to draw.
 * @layers_count: number of layers.
 *
 * Composites a frame into the renderer. This method can be called from any
 * thread.
 */
void fl_view_renderer_present_layers(FlViewRenderer* renderer,
                                     const FlutterLayer** layers,
                                     size_t layers_count);
 
G_END_DECLS
 
#endif  // FLUTTER_SHELL_PLATFORM_LINUX_FL_VIEW_RENDERER_H_