1
0
Fork 0
mutter-performance-source/cogl/cogl-win32-renderer.h
Robert Bragg 13f228fe69 Remove all remaining _EXP suffix defines
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)
2013-01-18 10:53:29 +00:00

92 lines
3 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_H_INSIDE__) && !defined(COGL_COMPILATION)
#error "Only <cogl/cogl.h> can be included directly."
#endif
#ifndef __COGL_WIN32_RENDERER_H__
#define __COGL_WIN32_RENDERER_H__
#include <cogl/cogl-types.h>
#include <cogl/cogl-renderer.h>
G_BEGIN_DECLS
/**
* cogl_win32_renderer_handle_event:
* @message: A pointer to a win32 MSG struct
*
* 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_win32_renderer_handle_event (CoglRenderer *renderer,
MSG *message);
/**
* CoglWin32FilterFunc:
* @message: A pointer to a win32 MSG struct
* @data: The data that was given when the filter was added
*
* A callback function that can be registered with
* cogl_win32_renderer_add_filter(). The function should return
* %COGL_FILTER_REMOVE if it wants to prevent further processing or
* %COGL_FILTER_CONTINUE otherwise.
*/
typedef CoglFilterReturn (* CoglWin32FilterFunc) (MSG *message,
void *data);
/**
* cogl_win32_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_win32_renderer_add_filter (CoglRenderer *renderer,
CoglWin32FilterFunc func,
void *data);
/**
* cogl_win32_renderer_remove_filter:
*
* Removes a callback that was previously added with
* cogl_win32_renderer_add_filter().
*/
void
cogl_win32_renderer_remove_filter (CoglRenderer *renderer,
CoglWin32FilterFunc func,
void *data);
G_END_DECLS
#endif /* __COGL_WIN32_RENDERER_H__ */