Initial revision
[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 /*
40  * The callbacks are done in three parts:
41  *
42  * - a local static pointer to the eventual function. NULL if not
43  * defined, or if the behaviour is not required.
44  *
45  * - a hook that can be called locally
46  *
47  * - a hook that can be called externally, to set an external function
48  * to provide said functionality.
49  *
50  * These might be generated from a spec such as:
51  * 
52  * callback {
53  *    local    = <local name>
54  *    external = <external name>
55  *    type     = <ret_type> (<args>,...)
56  * }
57  *
58  * Should generate:
59  * - a static var
60  * - an internal loop, plus decl.
61  * - an external setter, plus decl.
62  * 
63  */
64
65 /* Part 1: ------------------------------------------------------------- */
66
67 static int (*RE_local_test_break_function)(void) = NULL;
68
69 static void (*RE_local_timecursor_function)(int) = NULL;
70
71 static void (*RE_local_renderdisplay_function)(int i, 
72                                                                                            int j, 
73                                                                                            int k, 
74                                                                                            int l, 
75                                                                                            unsigned int *m) 
76          = NULL;
77
78 static void (*RE_local_initrenderdisplay_function)(void) = NULL;
79 static void (*RE_local_clearrenderdisplay_function)(short) = NULL;
80
81 static void (*RE_local_printrenderinfo_function)(double,int) = NULL;
82
83 static void (*RE_local_getrenderdata_function)(void) = NULL;
84 static void (*RE_local_freerenderdata_function)(void) = NULL;
85
86 /* Part 2: ------------------------------------------------------------- */
87
88 int RE_local_test_break(void) {
89         if (RE_local_test_break_function) {
90                 return RE_local_test_break_function();
91         } else {
92                 /* transparant behaviour: proceed */
93                 return 0;
94         }
95 }
96
97 void RE_local_timecursor(int i) {
98         if (RE_local_timecursor_function) RE_local_timecursor_function(i);
99 }
100
101 void RE_local_render_display(int i, int j, int k, int l, unsigned int* m) {
102         if (RE_local_renderdisplay_function) RE_local_renderdisplay_function(i, j, k, l, m);
103 }
104 void RE_local_init_render_display(void) {
105         if (RE_local_initrenderdisplay_function) RE_local_initrenderdisplay_function();
106 }
107 void RE_local_clear_render_display(short i) {
108         if (RE_local_clearrenderdisplay_function) RE_local_clearrenderdisplay_function(i);
109 }
110
111 void RE_local_printrenderinfo(double time, int i) {
112         if (RE_local_printrenderinfo_function) RE_local_printrenderinfo_function(time, i);
113 }
114
115 void RE_local_get_renderdata(void) {
116         if (RE_local_getrenderdata_function) RE_local_getrenderdata_function();
117 }
118 void RE_local_free_renderdata(void) {
119         if (RE_local_freerenderdata_function) RE_local_freerenderdata_function();
120 }
121
122 /* Part 3: ------------------------------------------------------------- */
123
124 void RE_set_test_break_callback(int (*f)(void)) {
125         RE_local_test_break_function = f;
126 }
127
128 void RE_set_timecursor_callback(void (*f)(int)) {
129         RE_local_timecursor_function = f;
130 }
131
132 void RE_set_renderdisplay_callback(void (*f)(int i, 
133                                                                                          int j, 
134                                                                                          int k, 
135                                                                                          int l, 
136                                                                                          unsigned int *)) 
137 {
138         RE_local_renderdisplay_function = f;
139 }
140
141 void RE_set_initrenderdisplay_callback(void (*f)(void)) {
142         RE_local_initrenderdisplay_function = f;
143 }
144
145 void RE_set_clearrenderdisplay_callback(void (*f)(short)) {
146         RE_local_clearrenderdisplay_function = f;
147 }
148
149 void RE_set_printrenderinfo_callback(void (*f)(double,int)) {
150         RE_local_printrenderinfo_function = f;
151 }
152
153 void RE_set_getrenderdata_callback(void (*f)(void)) {
154         RE_local_getrenderdata_function = f;
155 }
156
157 void RE_set_freerenderdata_callback(void (*f)(void)) {
158         RE_local_freerenderdata_function = f;
159 }