Synchronise game engine with Tuhopuu2 tree.
[blender.git] / source / blender / render / intern / source / RE_callbacks.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  * Callbacks to make the renderer interact with calling modules.
32  */
33
34 #include <stdlib.h> /* for NULL??? */
35 #include "render.h"
36 #include "render_intern.h"
37 #include "RE_callbacks.h"
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 /*
44  * The callbacks are done in three parts:
45  *
46  * - a local static pointer to the eventual function. NULL if not
47  * defined, or if the behaviour is not required.
48  *
49  * - a hook that can be called locally
50  *
51  * - a hook that can be called externally, to set an external function
52  * to provide said functionality.
53  *
54  * These might be generated from a spec such as:
55  * 
56  * callback {
57  *    local    = <local name>
58  *    external = <external name>
59  *    type     = <ret_type> (<args>,...)
60  * }
61  *
62  * Should generate:
63  * - a static var
64  * - an internal loop, plus decl.
65  * - an external setter, plus decl.
66  * 
67  */
68
69 /* Part 1: ------------------------------------------------------------- */
70
71 static int (*RE_local_test_break_function)(void) = NULL;
72
73 static void (*RE_local_timecursor_function)(int) = NULL;
74
75 static void (*RE_local_renderdisplay_function)(int i, 
76                                                                                            int j, 
77                                                                                            int k, 
78                                                                                            int l, 
79                                                                                            unsigned int *m) 
80          = NULL;
81
82 static void (*RE_local_initrenderdisplay_function)(void) = NULL;
83 static void (*RE_local_clearrenderdisplay_function)(short) = NULL;
84
85 static void (*RE_local_printrenderinfo_function)(double,int) = NULL;
86
87 static void (*RE_local_getrenderdata_function)(void) = NULL;
88 static void (*RE_local_freerenderdata_function)(void) = NULL;
89
90 /* Part 2: ------------------------------------------------------------- */
91
92 int RE_local_test_break(void) {
93         if (RE_local_test_break_function) {
94                 return RE_local_test_break_function();
95         } else {
96                 /* transparant behaviour: proceed */
97                 return 0;
98         }
99 }
100
101 void RE_local_timecursor(int i) {
102         if (RE_local_timecursor_function) RE_local_timecursor_function(i);
103 }
104
105 void RE_local_render_display(int i, int j, int k, int l, unsigned int* m) {
106         if (RE_local_renderdisplay_function) RE_local_renderdisplay_function(i, j, k, l, m);
107 }
108 void RE_local_init_render_display(void) {
109         if (RE_local_initrenderdisplay_function) RE_local_initrenderdisplay_function();
110 }
111 void RE_local_clear_render_display(short i) {
112         if (RE_local_clearrenderdisplay_function) RE_local_clearrenderdisplay_function(i);
113 }
114
115 void RE_local_printrenderinfo(double time, int i) {
116         if (RE_local_printrenderinfo_function) RE_local_printrenderinfo_function(time, i);
117 }
118
119 void RE_local_get_renderdata(void) {
120         if (RE_local_getrenderdata_function) RE_local_getrenderdata_function();
121 }
122 void RE_local_free_renderdata(void) {
123         if (RE_local_freerenderdata_function) RE_local_freerenderdata_function();
124 }
125
126 /* Part 3: ------------------------------------------------------------- */
127
128 void RE_set_test_break_callback(int (*f)(void)) {
129         RE_local_test_break_function = f;
130 }
131
132 void RE_set_timecursor_callback(void (*f)(int)) {
133         RE_local_timecursor_function = f;
134 }
135
136 void RE_set_renderdisplay_callback(void (*f)(int i, 
137                                                                                          int j, 
138                                                                                          int k, 
139                                                                                          int l, 
140                                                                                          unsigned int *)) 
141 {
142         RE_local_renderdisplay_function = f;
143 }
144
145 void RE_set_initrenderdisplay_callback(void (*f)(void)) {
146         RE_local_initrenderdisplay_function = f;
147 }
148
149 void RE_set_clearrenderdisplay_callback(void (*f)(short)) {
150         RE_local_clearrenderdisplay_function = f;
151 }
152
153 void RE_set_printrenderinfo_callback(void (*f)(double,int)) {
154         RE_local_printrenderinfo_function = f;
155 }
156
157 void RE_set_getrenderdata_callback(void (*f)(void)) {
158         RE_local_getrenderdata_function = f;
159 }
160
161 void RE_set_freerenderdata_callback(void (*f)(void)) {
162         RE_local_freerenderdata_function = f;
163 }