source/blender/render/extern/include/RE_engine.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) 2006 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  * The Original Code is: all of this file.
  22  *
  23  * Contributor(s): none yet.
  24  *
  25  * ***** END GPL LICENSE BLOCK *****
  26  */
  27
  28 /** \file RE_engine.h
  29  *  \ingroup render
  30  */
  31
  32 #ifndef __RE_ENGINE_H__
  33 #define __RE_ENGINE_H__
  34
  35 #include "DNA_listBase.h"
  36 #include "DNA_scene_types.h"
  37 #include "RNA_types.h"
  38 #include "RE_bake.h"
  39
  40 struct bNode;
  41 struct bNodeTree;
  42 struct Depsgraph;
  43 struct IDProperty;
  44 struct Main;
  45 struct Object;
  46 struct Render;
  47 struct RenderData;
  48 struct RenderEngine;
  49 struct RenderEngineType;
  50 struct RenderLayer;
  51 struct RenderResult;
  52 struct ReportList;
  53 struct Scene;
  54 struct BakePixel;
  55
  56 /* External Engine */
  57
  58 /* RenderEngineType.flag */
  59 #define RE_INTERNAL                             1
  60 #define RE_GAME                                 2
  61 #define RE_USE_PREVIEW                  4
  62 #define RE_USE_POSTPROCESS              8
  63 #define RE_USE_SHADING_NODES    16
  64 #define RE_USE_EXCLUDE_LAYERS   32
  65 #define RE_USE_SAVE_BUFFERS             64
  66 #define RE_USE_TEXTURE_PREVIEW          128
  67 #define RE_USE_SHADING_NODES_CUSTOM     256
  68 #define RE_USE_SPHERICAL_STEREO 512
  69 #define RE_USE_LEGACY_PIPELINE  1024 /* XXX Temporary flag, to be removed once draw manager is finished. */
  70
  71 /* RenderEngine.flag */
  72 #define RE_ENGINE_ANIMATION             1
  73 #define RE_ENGINE_PREVIEW               2
  74 #define RE_ENGINE_DO_DRAW               4
  75 #define RE_ENGINE_DO_UPDATE             8
  76 #define RE_ENGINE_RENDERING             16
  77 #define RE_ENGINE_HIGHLIGHT_TILES       32
  78 #define RE_ENGINE_USED_FOR_VIEWPORT     64
  79
  80 /* RenderEngine.update_flag, used by internal now */
  81 #define RE_ENGINE_UPDATE_MA                     1
  82 #define RE_ENGINE_UPDATE_OTHER          2
  83 #define RE_ENGINE_UPDATE_DATABASE       4
  84
  85 extern ListBase R_engines;
  86
  87 typedef struct RenderEngineType {
  88         struct RenderEngineType *next, *prev;
  89
  90         /* type info */
  91         char idname[64]; // best keep the same size as BKE_ST_MAXNAME
  92         char name[64];
  93         int flag;
  94
  95         void (*update)(struct RenderEngine *engine, struct Main *bmain, struct Scene *scene);
  96         void (*render_to_image)(struct RenderEngine *engine, struct Depsgraph *depsgraph);
  97         void (*bake)(struct RenderEngine *engine, struct Depsgraph *depsgraph,
  98                      struct Scene *scene, struct Object *object, const int pass_type,
  99                      const int pass_filter, const int object_id, const struct BakePixel *pixel_array, const int num_pixels,
 100                      const int depth, void *result);
 101
 102         void (*view_update)(struct RenderEngine *engine, const struct bContext *context);
 103         void (*render_to_view)(struct RenderEngine *engine, const struct bContext *context);
 104
 105         void (*update_script_node)(struct RenderEngine *engine, struct bNodeTree *ntree, struct bNode *node);
 106         void (*update_render_passes)(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer);
 107
 108         void (*collection_settings_create)(struct RenderEngine *engine, struct IDProperty *props);
 109         void (*render_settings_create)(struct RenderEngine *engine, struct IDProperty *props);
 110
 111         struct DrawEngineType *draw_engine;
 112
 113         /* RNA integration */
 114         ExtensionRNA ext;
 115 } RenderEngineType;
 116
 117 typedef struct RenderEngine {
 118         RenderEngineType *type;
 119         void *py_instance;
 120
 121         int flag;
 122         struct Object *camera_override;
 123         unsigned int layer_override;
 124
 125         int tile_x;
 126         int tile_y;
 127
 128         struct Render *re;
 129         ListBase fullresult;
 130         char text[512]; /* IMA_MAX_RENDER_TEXT */
 131
 132         int resolution_x, resolution_y;
 133
 134         struct ReportList *reports;
 135
 136         /* for blender internal only */
 137         int update_flag;
 138         int job_update_flag;
 139
 140         rctf last_viewplane;
 141         rcti last_disprect;
 142         float last_viewmat[4][4];
 143         int last_winx, last_winy;
 144 } RenderEngine;
 145
 146 RenderEngine *RE_engine_create(RenderEngineType *type);
 147 RenderEngine *RE_engine_create_ex(RenderEngineType *type, bool use_for_viewport);
 148 void RE_engine_free(RenderEngine *engine);
 149
 150 void RE_layer_load_from_file(struct RenderLayer *layer, struct ReportList *reports, const char *filename, int x, int y);
 151 void RE_result_load_from_file(struct RenderResult *result, struct ReportList *reports, const char *filename);
 152
 153 struct RenderResult *RE_engine_begin_result(RenderEngine *engine, int x, int y, int w, int h, const char *layername, const char *viewname);
 154 void RE_engine_update_result(RenderEngine *engine, struct RenderResult *result);
 155 void RE_engine_add_pass(RenderEngine *engine, const char *name, int channels, const char *chan_id, const char *layername);
 156 void RE_engine_end_result(RenderEngine *engine, struct RenderResult *result, int cancel, int highlight, int merge_results);
 157 struct RenderResult *RE_engine_get_result(struct RenderEngine *engine);
 158
 159 const char *RE_engine_active_view_get(RenderEngine *engine);
 160 void RE_engine_active_view_set(RenderEngine *engine, const char *viewname);
 161 float RE_engine_get_camera_shift_x(RenderEngine *engine, struct Object *camera, int use_spherical_stereo);
 162 void RE_engine_get_camera_model_matrix(RenderEngine *engine, struct Object *camera, int use_spherical_stereo, float *r_modelmat);
 163 int RE_engine_get_spherical_stereo(RenderEngine *engine, struct Object *camera);
 164
 165 int RE_engine_test_break(RenderEngine *engine);
 166 void RE_engine_update_stats(RenderEngine *engine, const char *stats, const char *info);
 167 void RE_engine_update_progress(RenderEngine *engine, float progress);
 168 void RE_engine_update_memory_stats(RenderEngine *engine, float mem_used, float mem_peak);
 169 void RE_engine_report(RenderEngine *engine, int type, const char *msg);
 170 void RE_engine_set_error_message(RenderEngine *engine, const char *msg);
 171
 172 int RE_engine_render(struct Render *re, int do_all);
 173
 174 bool RE_engine_is_external(struct Render *re);
 175
 176 void RE_engine_frame_set(struct RenderEngine *engine, int frame, float subframe);
 177
 178 void RE_engine_register_pass(struct RenderEngine *engine, struct Scene *scene, struct ViewLayer *view_layer,
 179                              const char *name, int channels, const char *chanid, int type);
 180
 181 /* Engine Types */
 182
 183 void RE_engines_init(void);
 184 void RE_engines_exit(void);
 185 void RE_engines_register(struct Main *bmain, RenderEngineType *render_type);
 186
 187 bool RE_engine_is_opengl(RenderEngineType *render_type);
 188
 189 RenderEngineType *RE_engines_find(const char *idname);
 190
 191 rcti* RE_engine_get_current_tiles(struct Render *re, int *r_total_tiles, bool *r_needs_free);
 192 struct RenderData *RE_engine_get_render_data(struct Render *re);
 193 void RE_bake_engine_set_engine_parameters(
 194         struct Render *re, struct Main *bmain, struct Scene *scene);
 195
 196 #endif /* __RE_ENGINE_H__ */
 197