fl_framebuffer.h File Reference

#include <epoxy/gl.h>
#include <glib-object.h>

Go to the source code of this file.

Functions
G_BEGIN_DECLS FlFramebuffer *	fl_framebuffer_new (GLint format, size_t width, size_t height, gboolean shareable)
gboolean	fl_framebuffer_get_shareable (FlFramebuffer *framebuffer)
FlFramebuffer *	fl_framebuffer_create_sibling (FlFramebuffer *framebuffer)
GLuint	fl_framebuffer_get_id (FlFramebuffer *framebuffer)
GLuint	fl_framebuffer_get_texture_id (FlFramebuffer *framebuffer)
size_t	fl_framebuffer_get_width (FlFramebuffer *framebuffer)
size_t	fl_framebuffer_get_height (FlFramebuffer *framebuffer)

Function Documentation

fl_framebuffer_create_sibling()

FlFramebuffer* fl_framebuffer_create_sibling

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_create_sibling: @framebuffer: an #FlFramebuffer.

Creates a new framebuffer with the same backing texture as the original. This uses EGLImage to share the texture and allows a framebuffer created in one OpenGL context to be used in another.

Returns: a new #FlFramebuffer.

Definition at line 120 of file fl_framebuffer.cc.

                                                                  {
  g_return_val_if_fail(FL_IS_FRAMEBUFFER(self), nullptr);
  g_return_val_if_fail(self->image != nullptr, nullptr);
 
  FlFramebuffer* sibling =
      FL_FRAMEBUFFER(g_object_new(fl_framebuffer_get_type(), nullptr));
 
  sibling->width = self->width;
  sibling->height = self->height;
  sibling->image = self->image;
 
  // Make texture from existing image.
  glGenTextures(1, &sibling->texture_id);
  glBindTexture(GL_TEXTURE_2D, sibling->texture_id);
  glEGLImageTargetTexture2DOES(GL_TEXTURE_2D, self->image);
 
  // Make framebuffer that uses this texture.
  glGenFramebuffers(1, &sibling->framebuffer_id);
  GLint saved_framebuffer_binding;
  glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &saved_framebuffer_binding);
  glBindFramebuffer(GL_DRAW_FRAMEBUFFER, sibling->framebuffer_id);
  glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D,
                         sibling->texture_id, 0);
  glBindFramebuffer(GL_DRAW_FRAMEBUFFER, saved_framebuffer_binding);
 
  return sibling;
}

Referenced by fl_compositor_opengl_render(), and TEST().

fl_framebuffer_get_height()

size_t fl_framebuffer_get_height

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_get_height: @framebuffer: an #FlFramebuffer.

Gets the height of the framebuffer in pixels.

Returns: height in pixels.

Definition at line 160 of file fl_framebuffer.cc.

                                                      {
  return self->height;
}

Referenced by composite_layer(), fl_compositor_opengl_present_layers(), and fl_compositor_opengl_render().

fl_framebuffer_get_id()

GLuint fl_framebuffer_get_id

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_get_id: @framebuffer: an #FlFramebuffer.

Gets the ID for this framebuffer.

Returns: OpenGL framebuffer id or 0 if creation failed.

Definition at line 148 of file fl_framebuffer.cc.

                                                  {
  return self->framebuffer_id;
}

Referenced by create_opengl_backing_store(), and fl_compositor_opengl_present_layers().

fl_framebuffer_get_shareable()

gboolean fl_framebuffer_get_shareable

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_get_shareable: @framebuffer: an #FlFramebuffer.

Checks if this framebuffer can be shared between contexts (using fl_framebuffer_create_sibling).

Returns: TRUE if this framebuffer can be shared.

Definition at line 115 of file fl_framebuffer.cc.

                                                           {
  g_return_val_if_fail(FL_IS_FRAMEBUFFER(self), FALSE);
  return self->image != nullptr;
}

Referenced by fl_compositor_opengl_render().

fl_framebuffer_get_texture_id()

GLuint fl_framebuffer_get_texture_id

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_get_texture_id: @framebuffer: an #FlFramebuffer.

Gets the ID of the texture associated with this framebuffer.

Returns: OpenGL texture id or 0 if creation failed.

Definition at line 152 of file fl_framebuffer.cc.

                                                          {
  return self->texture_id;
}

Referenced by composite_layer(), and fl_compositor_opengl_render().

fl_framebuffer_get_width()

size_t fl_framebuffer_get_width

(

FlFramebuffer *

framebuffer

)

fl_framebuffer_get_width: @framebuffer: an #FlFramebuffer.

Gets the width of the framebuffer in pixels.

Returns: width in pixels.

Definition at line 156 of file fl_framebuffer.cc.

                                                     {
  return self->width;
}

Referenced by composite_layer(), fl_compositor_opengl_present_layers(), and fl_compositor_opengl_render().

fl_framebuffer_new()

G_BEGIN_DECLS FlFramebuffer* fl_framebuffer_new	(	GLint	format,
		size_t	width,
		size_t	height,
		gboolean	shareable
	)

FlFramebuffer:

#FlFramebuffer creates framebuffers and their backing textures for use by the Flutter compositor. fl_framebuffer_new: @format: format, e.g. GL_RGB, GL_BGR @width: width of texture. @height: height of texture. @shareable: TRUE if this framebuffer can be shared between contexts (requires EGL).

Creates a new frame buffer. Requires a valid OpenGL context to create.

Returns: a new #FlFramebuffer.

Definition at line 69 of file fl_framebuffer.cc.

                                                      {
  FlFramebuffer* self =
      FL_FRAMEBUFFER(g_object_new(fl_framebuffer_get_type(), nullptr));
 
  self->width = width;
  self->height = height;
 
  glGenTextures(1, &self->texture_id);
  glGenFramebuffers(1, &self->framebuffer_id);
 
  glBindFramebuffer(GL_FRAMEBUFFER, self->framebuffer_id);
 
  glBindTexture(GL_TEXTURE_2D, self->texture_id);
  glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
  glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
  glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
  glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
  glTexImage2D(GL_TEXTURE_2D, 0, format, width, height, 0, format,
               GL_UNSIGNED_BYTE, NULL);
  glBindTexture(GL_TEXTURE_2D, 0);
 
  if (shareable) {
    self->image = create_egl_image(self->texture_id);
  }
 
  glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D,
                         self->texture_id, 0);
 
  glGenRenderbuffers(1, &self->depth_stencil);
  glBindRenderbuffer(GL_RENDERBUFFER, self->depth_stencil);
  glRenderbufferStorage(GL_RENDERBUFFER,      // target
                        GL_DEPTH24_STENCIL8,  // internal format
                        width,                // width
                        height                // height
  );
  glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_ATTACHMENT,
                            GL_RENDERBUFFER, self->depth_stencil);
  glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
                            GL_RENDERBUFFER, self->depth_stencil);
 
  return self;
}

References create_egl_image(), format, height, shareable, and width.

Referenced by create_opengl_backing_store(), fl_compositor_opengl_present_layers(), and TEST().