mirror of
https://github.com/brl/mutter.git
synced 2024-09-20 06:25:51 -04:00
54735dec84
The coding style has for a long time said to avoid using redundant glib
data types such as gint or gchar etc because we feel that they make the
code look unnecessarily foreign to developers coming from outside of the
Gnome developer community.
Note: When we tried to find the historical rationale for the types we
just found that they were apparently only added for consistent syntax
highlighting which didn't seem that compelling.
Up until now we have been continuing to use some of the platform
specific type such as gint{8,16,32,64} and gsize but this patch switches
us over to using the standard c99 equivalents instead so we can further
ensure that our code looks familiar to the widest range of C developers
who might potentially contribute to Cogl.
So instead of using the gint{8,16,32,64} and guint{8,16,32,64} types this
switches all Cogl code to instead use the int{8,16,32,64}_t and
uint{8,16,32,64}_t c99 types instead.
Instead of gsize we now use size_t
For now we are not going to use the c99 _Bool type and instead we have
introduced a new CoglBool type to use instead of gboolean.
Reviewed-by: Neil Roberts <neil@linux.intel.com>
(cherry picked from commit 5967dad2400d32ca6319cef6cb572e81bf2c15f0)
210 lines
6.8 KiB
C
210 lines
6.8 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(CLUTTER_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 #GError
|
|
*
|
|
* 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,
|
|
GError **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
|
|
|
|
#ifdef COGL_HAS_WAYLAND_EGL_SERVER_SUPPORT
|
|
/**
|
|
* cogl_wayland_display_set_compositor_display:
|
|
* @display: a #CoglDisplay
|
|
* @wayland_display: A compositor's Wayland display pointer
|
|
*
|
|
* Informs Cogl of a compositor's Wayland display pointer. This
|
|
* enables Cogl to register private wayland extensions required to
|
|
* pass buffers between the clients and compositor.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
void
|
|
cogl_wayland_display_set_compositor_display (CoglDisplay *display,
|
|
struct wl_display *wayland_display);
|
|
#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__ */
|
|
|