860fb00fdc
Add a new BUFFER_AGE winsys feature and a get_buffer_age method to cogl-onscreen that allows to query the value. https://bugzilla.gnome.org/show_bug.cgi?id=669122 Reviewed-by: Neil Roberts <neil@linux.intel.com> Reviewed-by: Robert Bragg <robert@linux.intel.com> Note: When landing the patch I made some gtk-doc updates and changed _get_buffer_age to return an age of 0 always if the age feature isn't support instead of using _COGL_RETURN_VAL_IF_FAIL. -- Robert Bragg (cherry picked from commit 427b1038051e9b53a071d8c229b363b075bb1dc0)
471 lines
14 KiB
C
471 lines
14 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2011 Intel Corporation.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include "cogl-util.h"
|
|
#include "cogl-onscreen-private.h"
|
|
#include "cogl-framebuffer-private.h"
|
|
#include "cogl-onscreen-template-private.h"
|
|
#include "cogl-context-private.h"
|
|
#include "cogl-object-private.h"
|
|
#include "cogl1-context.h"
|
|
|
|
static void _cogl_onscreen_free (CoglOnscreen *onscreen);
|
|
|
|
COGL_OBJECT_DEFINE_WITH_CODE (Onscreen, onscreen,
|
|
_cogl_onscreen_class.virt_unref =
|
|
_cogl_framebuffer_unref);
|
|
|
|
static void
|
|
_cogl_onscreen_init_from_template (CoglOnscreen *onscreen,
|
|
CoglOnscreenTemplate *onscreen_template)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
|
|
COGL_TAILQ_INIT (&onscreen->swap_callbacks);
|
|
COGL_TAILQ_INIT (&onscreen->resize_callbacks);
|
|
|
|
framebuffer->config = onscreen_template->config;
|
|
cogl_object_ref (framebuffer->config.swap_chain);
|
|
}
|
|
|
|
/* XXX: While we still have backend in Clutter we need a dummy object
|
|
* to represent the CoglOnscreen framebuffer that the backend
|
|
* creates... */
|
|
CoglOnscreen *
|
|
_cogl_onscreen_new (void)
|
|
{
|
|
CoglOnscreen *onscreen = g_new0 (CoglOnscreen, 1);
|
|
|
|
_COGL_GET_CONTEXT (ctx, NULL);
|
|
|
|
_cogl_framebuffer_init (COGL_FRAMEBUFFER (onscreen),
|
|
ctx,
|
|
COGL_FRAMEBUFFER_TYPE_ONSCREEN,
|
|
COGL_PIXEL_FORMAT_RGBA_8888_PRE,
|
|
0x1eadbeef, /* width */
|
|
0x1eadbeef); /* height */
|
|
/* NB: make sure to pass positive width/height numbers here
|
|
* because otherwise we'll hit input validation assertions!*/
|
|
|
|
_cogl_onscreen_init_from_template (onscreen, ctx->display->onscreen_template);
|
|
|
|
COGL_FRAMEBUFFER (onscreen)->allocated = TRUE;
|
|
|
|
/* XXX: Note we don't initialize onscreen->winsys in this case. */
|
|
|
|
return _cogl_onscreen_object_new (onscreen);
|
|
}
|
|
|
|
CoglOnscreen *
|
|
cogl_onscreen_new (CoglContext *ctx, int width, int height)
|
|
{
|
|
CoglOnscreen *onscreen;
|
|
|
|
/* FIXME: We are assuming onscreen buffers will always be
|
|
premultiplied so we'll set the premult flag on the bitmap
|
|
format. This will usually be correct because the result of the
|
|
default blending operations for Cogl ends up with premultiplied
|
|
data in the framebuffer. However it is possible for the
|
|
framebuffer to be in whatever format depending on what
|
|
CoglPipeline is used to render to it. Eventually we may want to
|
|
add a way for an application to inform Cogl that the framebuffer
|
|
is not premultiplied in case it is being used for some special
|
|
purpose. */
|
|
|
|
onscreen = g_new0 (CoglOnscreen, 1);
|
|
_cogl_framebuffer_init (COGL_FRAMEBUFFER (onscreen),
|
|
ctx,
|
|
COGL_FRAMEBUFFER_TYPE_ONSCREEN,
|
|
COGL_PIXEL_FORMAT_RGBA_8888_PRE,
|
|
width, /* width */
|
|
height); /* height */
|
|
|
|
_cogl_onscreen_init_from_template (onscreen, ctx->display->onscreen_template);
|
|
|
|
return _cogl_onscreen_object_new (onscreen);
|
|
}
|
|
|
|
static void
|
|
_cogl_onscreen_free (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
CoglResizeNotifyEntry *resize_entry;
|
|
CoglSwapBuffersNotifyEntry *swap_entry;
|
|
|
|
while ((resize_entry = COGL_TAILQ_FIRST (&onscreen->resize_callbacks)))
|
|
{
|
|
COGL_TAILQ_REMOVE (&onscreen->resize_callbacks, resize_entry, list_node);
|
|
g_slice_free (CoglResizeNotifyEntry, resize_entry);
|
|
}
|
|
|
|
while ((swap_entry = COGL_TAILQ_FIRST (&onscreen->swap_callbacks)))
|
|
{
|
|
COGL_TAILQ_REMOVE (&onscreen->swap_callbacks, swap_entry, list_node);
|
|
g_slice_free (CoglSwapBuffersNotifyEntry, swap_entry);
|
|
}
|
|
|
|
if (framebuffer->context->window_buffer == COGL_FRAMEBUFFER (onscreen))
|
|
framebuffer->context->window_buffer = NULL;
|
|
|
|
winsys->onscreen_deinit (onscreen);
|
|
_COGL_RETURN_IF_FAIL (onscreen->winsys == NULL);
|
|
|
|
/* Chain up to parent */
|
|
_cogl_framebuffer_free (framebuffer);
|
|
|
|
g_free (onscreen);
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_swap_buffers (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys;
|
|
|
|
_COGL_RETURN_IF_FAIL (framebuffer->type == COGL_FRAMEBUFFER_TYPE_ONSCREEN);
|
|
|
|
/* FIXME: we shouldn't need to flush *all* journals here! */
|
|
cogl_flush ();
|
|
winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
winsys->onscreen_swap_buffers (COGL_ONSCREEN (framebuffer));
|
|
cogl_framebuffer_discard_buffers (framebuffer,
|
|
COGL_BUFFER_BIT_COLOR |
|
|
COGL_BUFFER_BIT_DEPTH |
|
|
COGL_BUFFER_BIT_STENCIL);
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_swap_region (CoglOnscreen *onscreen,
|
|
const int *rectangles,
|
|
int n_rectangles)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys;
|
|
|
|
_COGL_RETURN_IF_FAIL (framebuffer->type == COGL_FRAMEBUFFER_TYPE_ONSCREEN);
|
|
|
|
/* FIXME: we shouldn't need to flush *all* journals here! */
|
|
cogl_flush ();
|
|
|
|
winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
|
|
/* This should only be called if the winsys advertises
|
|
COGL_WINSYS_FEATURE_SWAP_REGION */
|
|
_COGL_RETURN_IF_FAIL (winsys->onscreen_swap_region != NULL);
|
|
|
|
winsys->onscreen_swap_region (COGL_ONSCREEN (framebuffer),
|
|
rectangles,
|
|
n_rectangles);
|
|
|
|
cogl_framebuffer_discard_buffers (framebuffer,
|
|
COGL_BUFFER_BIT_COLOR |
|
|
COGL_BUFFER_BIT_DEPTH |
|
|
COGL_BUFFER_BIT_STENCIL);
|
|
}
|
|
|
|
int
|
|
cogl_onscreen_get_buffer_age (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys;
|
|
|
|
_COGL_RETURN_VAL_IF_FAIL (framebuffer->type == COGL_FRAMEBUFFER_TYPE_ONSCREEN, 0);
|
|
|
|
winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
|
|
if (!winsys->onscreen_get_buffer_age)
|
|
return 0;
|
|
|
|
return winsys->onscreen_get_buffer_age (onscreen);
|
|
}
|
|
|
|
#ifdef COGL_HAS_X11_SUPPORT
|
|
void
|
|
cogl_x11_onscreen_set_foreign_window_xid (CoglOnscreen *onscreen,
|
|
uint32_t xid,
|
|
CoglOnscreenX11MaskCallback update,
|
|
void *user_data)
|
|
{
|
|
/* We don't wan't applications to get away with being lazy here and not
|
|
* passing an update callback... */
|
|
_COGL_RETURN_IF_FAIL (update);
|
|
|
|
onscreen->foreign_xid = xid;
|
|
onscreen->foreign_update_mask_callback = update;
|
|
onscreen->foreign_update_mask_data = user_data;
|
|
}
|
|
|
|
uint32_t
|
|
cogl_x11_onscreen_get_window_xid (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
|
|
if (onscreen->foreign_xid)
|
|
return onscreen->foreign_xid;
|
|
else
|
|
{
|
|
const CoglWinsysVtable *winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
|
|
/* This should only be called for x11 onscreens */
|
|
_COGL_RETURN_VAL_IF_FAIL (winsys->onscreen_x11_get_window_xid != NULL, 0);
|
|
|
|
return winsys->onscreen_x11_get_window_xid (onscreen);
|
|
}
|
|
}
|
|
|
|
uint32_t
|
|
cogl_x11_onscreen_get_visual_xid (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
XVisualInfo *visinfo;
|
|
uint32_t id;
|
|
|
|
/* This should only be called for xlib based onscreens */
|
|
_COGL_RETURN_VAL_IF_FAIL (winsys->xlib_get_visual_info != NULL, 0);
|
|
|
|
visinfo = winsys->xlib_get_visual_info ();
|
|
id = (uint32_t)visinfo->visualid;
|
|
|
|
XFree (visinfo);
|
|
return id;
|
|
}
|
|
#endif /* COGL_HAS_X11_SUPPORT */
|
|
|
|
#ifdef COGL_HAS_WIN32_SUPPORT
|
|
|
|
void
|
|
cogl_win32_onscreen_set_foreign_window (CoglOnscreen *onscreen,
|
|
HWND hwnd)
|
|
{
|
|
onscreen->foreign_hwnd = hwnd;
|
|
}
|
|
|
|
HWND
|
|
cogl_win32_onscreen_get_window (CoglOnscreen *onscreen)
|
|
{
|
|
if (onscreen->foreign_hwnd)
|
|
return onscreen->foreign_hwnd;
|
|
else
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys =
|
|
_cogl_framebuffer_get_winsys (framebuffer);
|
|
|
|
/* This should only be called for win32 onscreens */
|
|
_COGL_RETURN_VAL_IF_FAIL (winsys->onscreen_win32_get_window != NULL, 0);
|
|
|
|
return winsys->onscreen_win32_get_window (onscreen);
|
|
}
|
|
}
|
|
|
|
#endif /* COGL_HAS_WIN32_SUPPORT */
|
|
|
|
unsigned int
|
|
cogl_onscreen_add_swap_buffers_callback (CoglOnscreen *onscreen,
|
|
CoglSwapBuffersNotify callback,
|
|
void *user_data)
|
|
{
|
|
CoglSwapBuffersNotifyEntry *entry = g_slice_new0 (CoglSwapBuffersNotifyEntry);
|
|
static int next_swap_buffers_callback_id = 0;
|
|
|
|
entry->callback = callback;
|
|
entry->user_data = user_data;
|
|
entry->id = next_swap_buffers_callback_id++;
|
|
|
|
COGL_TAILQ_INSERT_TAIL (&onscreen->swap_callbacks, entry, list_node);
|
|
|
|
return entry->id;
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_remove_swap_buffers_callback (CoglOnscreen *onscreen,
|
|
unsigned int id)
|
|
{
|
|
CoglSwapBuffersNotifyEntry *entry;
|
|
|
|
COGL_TAILQ_FOREACH (entry, &onscreen->swap_callbacks, list_node)
|
|
{
|
|
if (entry->id == id)
|
|
{
|
|
COGL_TAILQ_REMOVE (&onscreen->swap_callbacks, entry, list_node);
|
|
g_slice_free (CoglSwapBuffersNotifyEntry, entry);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_set_swap_throttled (CoglOnscreen *onscreen,
|
|
CoglBool throttled)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
framebuffer->config.swap_throttled = throttled;
|
|
if (framebuffer->allocated)
|
|
{
|
|
const CoglWinsysVtable *winsys =
|
|
_cogl_framebuffer_get_winsys (framebuffer);
|
|
winsys->onscreen_update_swap_throttled (onscreen);
|
|
}
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_show (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
const CoglWinsysVtable *winsys;
|
|
|
|
if (!framebuffer->allocated)
|
|
{
|
|
if (!cogl_framebuffer_allocate (framebuffer, NULL))
|
|
return;
|
|
}
|
|
|
|
winsys = _cogl_framebuffer_get_winsys (framebuffer);
|
|
if (winsys->onscreen_set_visibility)
|
|
winsys->onscreen_set_visibility (onscreen, TRUE);
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_hide (CoglOnscreen *onscreen)
|
|
{
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
|
|
if (framebuffer->allocated)
|
|
{
|
|
const CoglWinsysVtable *winsys =
|
|
_cogl_framebuffer_get_winsys (framebuffer);
|
|
if (winsys->onscreen_set_visibility)
|
|
winsys->onscreen_set_visibility (onscreen, FALSE);
|
|
}
|
|
}
|
|
|
|
void
|
|
_cogl_onscreen_notify_swap_buffers (CoglOnscreen *onscreen)
|
|
{
|
|
CoglSwapBuffersNotifyEntry *entry, *tmp;
|
|
|
|
COGL_TAILQ_FOREACH_SAFE (entry,
|
|
&onscreen->swap_callbacks,
|
|
list_node,
|
|
tmp)
|
|
entry->callback (COGL_FRAMEBUFFER (onscreen), entry->user_data);
|
|
}
|
|
|
|
void
|
|
_cogl_onscreen_notify_resize (CoglOnscreen *onscreen)
|
|
{
|
|
CoglResizeNotifyEntry *entry, *tmp;
|
|
CoglFramebuffer *framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
|
|
COGL_TAILQ_FOREACH_SAFE (entry,
|
|
&onscreen->resize_callbacks,
|
|
list_node,
|
|
tmp)
|
|
entry->callback (onscreen,
|
|
framebuffer->width,
|
|
framebuffer->height,
|
|
entry->user_data);
|
|
}
|
|
|
|
void
|
|
_cogl_framebuffer_winsys_update_size (CoglFramebuffer *framebuffer,
|
|
int width, int height)
|
|
{
|
|
if (framebuffer->width == width && framebuffer->height == height)
|
|
return;
|
|
|
|
framebuffer->width = width;
|
|
framebuffer->height = height;
|
|
|
|
cogl_framebuffer_set_viewport (framebuffer, 0, 0, width, height);
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_set_resizable (CoglOnscreen *onscreen,
|
|
CoglBool resizable)
|
|
{
|
|
CoglFramebuffer *framebuffer;
|
|
const CoglWinsysVtable *winsys;
|
|
|
|
if (onscreen->resizable == resizable)
|
|
return;
|
|
|
|
onscreen->resizable = resizable;
|
|
|
|
framebuffer = COGL_FRAMEBUFFER (onscreen);
|
|
if (framebuffer->allocated)
|
|
{
|
|
winsys = _cogl_framebuffer_get_winsys (COGL_FRAMEBUFFER (onscreen));
|
|
|
|
if (winsys->onscreen_set_resizable)
|
|
winsys->onscreen_set_resizable (onscreen, resizable);
|
|
}
|
|
}
|
|
|
|
CoglBool
|
|
cogl_onscreen_get_resizable (CoglOnscreen *onscreen)
|
|
{
|
|
return onscreen->resizable;
|
|
}
|
|
|
|
unsigned int
|
|
cogl_onscreen_add_resize_handler (CoglOnscreen *onscreen,
|
|
CoglOnscreenResizeCallback callback,
|
|
void *user_data)
|
|
{
|
|
CoglResizeNotifyEntry *entry = g_slice_new (CoglResizeNotifyEntry);
|
|
static int next_resize_callback_id = 0;
|
|
|
|
entry->callback = callback;
|
|
entry->user_data = user_data;
|
|
entry->id = next_resize_callback_id++;
|
|
|
|
COGL_TAILQ_INSERT_TAIL (&onscreen->resize_callbacks, entry, list_node);
|
|
|
|
return entry->id;
|
|
}
|
|
|
|
void
|
|
cogl_onscreen_remove_resize_handler (CoglOnscreen *onscreen,
|
|
unsigned int id)
|
|
{
|
|
CoglResizeNotifyEntry *entry;
|
|
|
|
COGL_TAILQ_FOREACH (entry, &onscreen->resize_callbacks, list_node)
|
|
{
|
|
if (entry->id == id)
|
|
{
|
|
COGL_TAILQ_REMOVE (&onscreen->resize_callbacks, entry, list_node);
|
|
g_slice_free (CoglResizeNotifyEntry, entry);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|