mirror of
https://github.com/brl/mutter.git
synced 2024-11-26 10:00:45 -05:00
13f228fe69
To delimit which symbols were considered experimental we used to use some preprocessor defines to gives experimental symbols an _EXP suffix so that anyone monitoring the ABI for changes would easily be able to discount changes made to clearly experimental functions. These days we simply rely on the gtk-doc "Stability: unstable" annotation to serve this purpose because changing the actual symbol name made it slightly more awkward to debug Cogl using GDB and was an extra mechanical step we decided we could do without. This patch removes the last remaining _EXP suffix defines in Cogl (cherry picked from commit 5a1c4a979e00accd492097cfb8f6a8d0fd8331bc)
146 lines
4.7 KiB
C
146 lines
4.7 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, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#if !defined(__COGL_XLIB_H_INSIDE__) && !defined(COGL_COMPILATION)
|
|
#error "Only <cogl/cogl-xlib.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __COGL_XLIB_RENDERER_H__
|
|
#define __COGL_XLIB_RENDERER_H__
|
|
|
|
#include <X11/Xlib.h>
|
|
#include <glib.h>
|
|
|
|
#define __COGL_H_INSIDE__
|
|
#include <cogl/cogl-renderer.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/*
|
|
* cogl_xlib_renderer_handle_event:
|
|
* @event: pointer to an XEvent structure
|
|
*
|
|
* This function processes a single event; it can be used to hook into
|
|
* external event retrieval (for example that done by Clutter or
|
|
* GDK).
|
|
*
|
|
* Return value: #CoglFilterReturn. %COGL_FILTER_REMOVE indicates that
|
|
* Cogl has internally handled the event and the caller should do no
|
|
* further processing. %COGL_FILTER_CONTINUE indicates that Cogl is
|
|
* either not interested in the event, or has used the event to update
|
|
* internal state without taking any exclusive action.
|
|
*/
|
|
CoglFilterReturn
|
|
cogl_xlib_renderer_handle_event (CoglRenderer *renderer,
|
|
XEvent *event);
|
|
|
|
/*
|
|
* CoglXlibFilterFunc:
|
|
* @event: pointer to an XEvent structure
|
|
* @data: The data that was given when the filter was added
|
|
*
|
|
* A callback function that can be registered with
|
|
* cogl_xlib_renderer_add_filter(). The function should return
|
|
* %COGL_FILTER_REMOVE if it wants to prevent further processing or
|
|
* %COGL_FILTER_CONTINUE otherwise.
|
|
*/
|
|
typedef CoglFilterReturn (* CoglXlibFilterFunc) (XEvent *event,
|
|
void *data);
|
|
|
|
/*
|
|
* cogl_xlib_renderer_add_filter:
|
|
*
|
|
* Adds a callback function that will receive all native events. The
|
|
* function can stop further processing of the event by return
|
|
* %COGL_FILTER_REMOVE.
|
|
*/
|
|
void
|
|
cogl_xlib_renderer_add_filter (CoglRenderer *renderer,
|
|
CoglXlibFilterFunc func,
|
|
void *data);
|
|
|
|
/*
|
|
* cogl_xlib_renderer_remove_filter:
|
|
*
|
|
* Removes a callback that was previously added with
|
|
* cogl_xlib_renderer_add_filter().
|
|
*/
|
|
void
|
|
cogl_xlib_renderer_remove_filter (CoglRenderer *renderer,
|
|
CoglXlibFilterFunc func,
|
|
void *data);
|
|
|
|
/*
|
|
* cogl_xlib_renderer_get_foreign_display:
|
|
*
|
|
* Return value: the foreign Xlib display that will be used by any Xlib based
|
|
* winsys backend. The display needs to be set with
|
|
* cogl_xlib_renderer_set_foreign_display() before this function is called.
|
|
*/
|
|
Display *
|
|
cogl_xlib_renderer_get_foreign_display (CoglRenderer *renderer);
|
|
|
|
/*
|
|
* cogl_xlib_renderer_set_foreign_display:
|
|
*
|
|
* Sets a foreign Xlib display that Cogl will use for and Xlib based winsys
|
|
* backend.
|
|
*
|
|
* Note that calling this function will automatically call
|
|
* cogl_xlib_renderer_set_event_retrieval_enabled() to disable Cogl's
|
|
* event retrieval. Cogl still needs to see all of the X events so the
|
|
* application should also use cogl_xlib_renderer_handle_event() if it
|
|
* uses this function.
|
|
*/
|
|
void
|
|
cogl_xlib_renderer_set_foreign_display (CoglRenderer *renderer,
|
|
Display *display);
|
|
|
|
/**
|
|
* cogl_xlib_renderer_set_event_retrieval_enabled:
|
|
* @renderer: A #CoglRenderer
|
|
* @enable: The new value
|
|
*
|
|
* Sets whether Cogl should automatically retrieve events from the X
|
|
* display. This defaults to %TRUE unless
|
|
* cogl_xlib_renderer_set_foreign_display() is called. It can be set
|
|
* to %FALSE if the application wants to handle its own event
|
|
* retrieval. Note that Cogl still needs to see all of the X events to
|
|
* function properly so the application should call
|
|
* cogl_xlib_renderer_handle_event() for each event if it disables
|
|
* automatic event retrieval.
|
|
*
|
|
* Since: 1.10
|
|
* Stability: unstable
|
|
*/
|
|
void
|
|
cogl_xlib_renderer_set_event_retrieval_enabled (CoglRenderer *renderer,
|
|
CoglBool enable);
|
|
|
|
Display *
|
|
cogl_xlib_renderer_get_display (CoglRenderer *renderer);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __COGL_XLIB_RENDERER_H__ */
|