df21e20f65
Although we use GLib internally in Cogl we would rather not leak GLib api through Cogl's own api, except through explicitly namespaced cogl_glib_ / cogl_gtype_ feature apis. One of the benefits we see to not leaking GLib through Cogl's public API is that documentation for Cogl won't need to first introduce the Glib API to newcomers, thus hopefully lowering the barrier to learning Cogl. This patch provides a Cogl specific typedef for reporting runtime errors which by no coincidence matches the typedef for GError exactly. If Cogl is built with --enable-glib (default) then developers can even safely assume that a CoglError is a GError under the hood. This patch also enforces a consistent policy for when NULL is passed as an error argument and an error is thrown. In this case we log the error and abort the application, instead of silently ignoring it. In common cases where nothing has been implemented to handle a particular error and/or where applications are just printing the error and aborting themselves then this saves some typing. This also seems more consistent with language based exceptions which usually cause a program to abort if they are not explicitly caught (which passing a non-NULL error signifies in this case) Since this policy for NULL error pointers is stricter than the standard GError convention, there is a clear note in the documentation to warn developers that are used to using the GError api. Reviewed-by: Neil Roberts <neil@linux.intel.com> (cherry picked from commit b068d5ea09ab32c37e8c965fc8582c85d1b2db46) Note: Since we can't change the Cogl 1.x api the patch was changed to not rename _error_quark() functions to be _error_domain() functions and although it's a bit ugly, instead of providing our own CoglError type that's compatible with GError we simply #define CoglError to GError unless Cogl is built with glib disabled. Note: this patch does technically introduce an API break since it drops the cogl_error_get_type() symbol generated by glib-mkenum (Since the CoglError enum was replaced by a CoglSystemError enum) but for now we are assuming that this will not affect anyone currently using the Cogl API. If this does turn out to be a problem in practice then we would be able to fix this my manually copying an implementation of cogl_error_get_type() generated by glib-mkenum into a compatibility source file and we could also define the original COGL_ERROR_ enums for compatibility too. Note: another minor concern with cherry-picking this patch to the 1.14 branch is that an api scanner would be lead to believe that some APIs have changed, and for example the gobject-introspection parser which understands the semantics of GError will not understand the semantics of CoglError. We expect most people that have tried to use gobject-introspection with Cogl already understand though that it is not well suited to generating bindings of the Cogl api anyway and we aren't aware or anyone depending on such bindings for apis involving GErrors. (GnomeShell only makes very-very minimal use of Cogl via the gjs bindings for the cogl_rectangle and cogl_color apis.) The main reason we have cherry-picked this patch to the 1.14 branch even given the above concerns is that without it it would become very awkward for us to cherry-pick other beneficial patches from master.
192 lines
6.2 KiB
C
192 lines
6.2 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2010 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/>.
|
|
*
|
|
* Authors:
|
|
* Robert Bragg <robert@linux.intel.com>
|
|
*
|
|
*/
|
|
|
|
#if !defined(__COGL_H_INSIDE__) && !defined(COGL_COMPILATION)
|
|
#error "Only <cogl/cogl.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL_DISPLAY_H__
|
|
#define __COGL_DISPLAY_H__
|
|
|
|
#include <cogl/cogl-renderer.h>
|
|
#include <cogl/cogl-onscreen-template.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#ifdef COGL_HAS_EGL_PLATFORM_GDL_SUPPORT
|
|
#include <libgdl.h>
|
|
#endif
|
|
|
|
/**
|
|
* SECTION:cogl-display
|
|
* @short_description: Common aspects of a display pipeline
|
|
*
|
|
* The basic intention for this object is to let the application
|
|
* configure common display preferences before creating a context, and
|
|
* there are a few different aspects to this...
|
|
*
|
|
* Firstly there are options directly relating to the physical display
|
|
* pipeline that is currently being used including the digital to
|
|
* analogue conversion hardware and the screens the user sees.
|
|
*
|
|
* Another aspect is that display options may constrain or affect how
|
|
* onscreen framebuffers should later be configured. The original
|
|
* rationale for the display object in fact was to let us handle GLX
|
|
* and EGLs requirements that framebuffers must be "compatible" with
|
|
* the config associated with the current context meaning we have to
|
|
* force the user to describe how they would like to create their
|
|
* onscreen windows before we can choose a suitable fbconfig and
|
|
* create a GLContext.
|
|
*/
|
|
|
|
typedef struct _CoglDisplay CoglDisplay;
|
|
|
|
#define COGL_DISPLAY(OBJECT) ((CoglDisplay *)OBJECT)
|
|
|
|
/**
|
|
* cogl_display_new:
|
|
* @renderer: A #CoglRenderer
|
|
* @onscreen_template: A #CoglOnscreenTemplate
|
|
*
|
|
* Explicitly allocates a new #CoglDisplay object to encapsulate the
|
|
* common state of the display pipeline that applies to the whole
|
|
* application.
|
|
*
|
|
* <note>Many applications don't need to explicitly use
|
|
* cogl_display_new() and can just jump straight to cogl_context_new()
|
|
* and pass a %NULL display argument so Cogl will automatically
|
|
* connect and setup a renderer and display.</note>
|
|
*
|
|
* A @display can only be made for a specific choice of renderer which
|
|
* is why this takes the @renderer argument.
|
|
*
|
|
* A common use for explicitly allocating a display object is to
|
|
* define a template for allocating onscreen framebuffers which is
|
|
* what the @onscreen_template argument is for.
|
|
*
|
|
* When a display is first allocated via cogl_display_new() it is in a
|
|
* mutable configuration mode. It's designed this way so we can
|
|
* extend the apis available for configuring a display without
|
|
* requiring huge numbers of constructor arguements.
|
|
*
|
|
* When you have finished configuring a display object you can
|
|
* optionally call cogl_display_setup() to explicitly apply the
|
|
* configuration and check for errors. Alternaitvely you can pass the
|
|
* display to cogl_context_new() and Cogl will implicitly apply your
|
|
* configuration but if there are errors then the application will
|
|
* abort with a message. For simple applications with no fallback
|
|
* options then relying on the implicit setup can be fine.
|
|
*
|
|
* Return value: A newly allocated #CoglDisplay object in a mutable
|
|
* configuration mode.
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglDisplay *
|
|
cogl_display_new (CoglRenderer *renderer,
|
|
CoglOnscreenTemplate *onscreen_template);
|
|
|
|
/**
|
|
* cogl_display_get_renderer:
|
|
* @display: a #CoglDisplay
|
|
*
|
|
* Queries the #CoglRenderer associated with the given @display.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglRenderer *
|
|
cogl_display_get_renderer (CoglDisplay *display);
|
|
|
|
/**
|
|
* cogl_display_setup:
|
|
* @display: a #CoglDisplay
|
|
* @error: return location for a #CoglError
|
|
*
|
|
* Explicitly sets up the given @display object. Use of this api is
|
|
* optional since Cogl will internally setup the display if not done
|
|
* explicitly.
|
|
*
|
|
* When a display is first allocated via cogl_display_new() it is in a
|
|
* mutable configuration mode. This allows us to extend the apis
|
|
* available for configuring a display without requiring huge numbers
|
|
* of constructor arguements.
|
|
*
|
|
* Its possible to request a configuration that might not be
|
|
* supportable on the current system and so this api provides a means
|
|
* to apply the configuration explicitly but if it fails then an
|
|
* exception will be returned so you can handle the error gracefully
|
|
* and perhaps fall back to an alternative configuration.
|
|
*
|
|
* If you instead rely on Cogl implicitly calling cogl_display_setup()
|
|
* for you then if there is an error with the configuration you won't
|
|
* get an opportunity to handle that and the application may abort
|
|
* with a message. For simple applications that don't have any
|
|
* fallback options this behaviour may be fine.
|
|
*
|
|
* Return value: Returns %TRUE if there was no error, else it returns
|
|
* %FALSE and returns an exception via @error.
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglBool
|
|
cogl_display_setup (CoglDisplay *display,
|
|
CoglError **error);
|
|
|
|
#ifdef COGL_HAS_EGL_PLATFORM_GDL_SUPPORT
|
|
/**
|
|
* cogl_gdl_display_set_plane:
|
|
* @display: a #CoglDisplay
|
|
*
|
|
* Request that Cogl output to a specific GDL overlay @plane.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
void
|
|
cogl_gdl_display_set_plane (CoglDisplay *display,
|
|
gdl_plane_id_t plane);
|
|
#endif
|
|
|
|
/**
|
|
* cogl_is_display:
|
|
* @object: A #CoglObject pointer
|
|
*
|
|
* Gets whether the given object references a #CoglDisplay.
|
|
*
|
|
* Return value: %TRUE if the object references a #CoglDisplay
|
|
* and %FALSE otherwise.
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
CoglBool
|
|
cogl_is_display (void *object);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_DISPLAY_H__ */
|
|
|