doxygen: editor entry
[blender.git] / source / blender / editors / include / ED_render.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file ED_render.h
25  *  \ingroup editors
26  */
27
28 #ifndef ED_RENDER_H
29 #define ED_RENDER_H
30
31 #include "DNA_vec_types.h"
32
33 struct bContext;
34 struct ID;
35 struct Main;
36 struct MTex;
37 struct Render;
38 struct RenderInfo;
39
40 /* render_ops.c */
41
42 void ED_operatortypes_render(void);
43
44 /* render_shading.c */
45
46 void ED_render_id_flush_update(struct Main *bmain, struct ID *id);
47
48 /* render_preview.c */
49
50 /* stores rendered preview  - is also used for icons */
51 typedef struct RenderInfo {
52         int pr_rectx;
53         int pr_recty;
54         short curtile, tottile, status;
55         rcti disprect;                  /* storage for view3d preview rect */
56         unsigned int* rect;             
57         struct Render *re;              /* persistant render */
58 } RenderInfo;
59
60 /* ri->status */
61 #define PR_DBASE                        1
62 #define PR_DISPRECT                     2
63 #define PR_PROJECTED            4
64 #define PR_ROTATED                      8
65
66 /* Render the preview
67
68 pr_method:
69 - PR_BUTS_RENDER: preview is rendered for buttons window
70 - PR_ICON_RENDER: preview is rendered for icons. hopefully fast enough for at least 32x32 
71 - PR_NODE_RENDER: preview is rendered for node editor.
72 */
73
74 #define PR_BUTS_RENDER  0
75 #define PR_ICON_RENDER  1
76 #define PR_NODE_RENDER  2
77
78 void ED_preview_init_dbase(void);
79 void ED_preview_free_dbase(void);
80
81 void ED_preview_shader_job(const struct bContext *C, void *owner, struct ID *id, struct ID *parent, struct MTex *slot, int sizex, int sizey, int method);
82 void ED_preview_icon_job(const struct bContext *C, void *owner, struct ID *id, unsigned int *rect, int sizex, int sizey);
83 void ED_preview_kill_jobs(const struct bContext *C);
84
85 void ED_preview_draw(const struct bContext *C, void *idp, void *parentp, void *slot, rcti *rect);
86
87 void ED_render_clear_mtex_copybuf(void);
88
89 #endif