1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* Cogl
*
* A Low-Level GPU Graphics and Utilities API
*
* Copyright (C) 2011 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#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>
COGL_BEGIN_DECLS
/**
* cogl_win32_renderer_handle_event:
* @renderer: a #CoglRenderer
* @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:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data passed to @func when called
*
* 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:
* @renderer: a #CoglRenderer
* @func: the callback function
* @data: user data given when the callback was installed
*
* 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);
/**
* cogl_win32_renderer_set_event_retrieval_enabled:
* @renderer: a #CoglRenderer
* @enable: The new value
*
* Sets whether Cogl should automatically retrieve messages from
* Windows. It defaults to %TRUE. It can be set to %FALSE if the
* application wants to handle its own message retrieval. Note that
* Cogl still needs to see all of the messages to function properly so
* the application should call cogl_win32_renderer_handle_event() for
* each message if it disables automatic event retrieval.
*
* Since: 1.16
* Stability: unstable
*/
void
cogl_win32_renderer_set_event_retrieval_enabled (CoglRenderer *renderer,
CoglBool enable);
COGL_END_DECLS
#endif /* __COGL_WIN32_RENDERER_H__ */
|
