RE_pipeline.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2006 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "DNA_ID.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
 
#include "BLI_implicit_sharing.h"
 
struct GPUTexture;
struct ImBuf;
struct Image;
struct ImageFormatData;
struct Main;
struct Object;
struct RenderData;
struct RenderResult;
struct ReportList;
struct Scene;
struct StampData;
struct ViewLayer;
struct bMovieHandle;
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
/* this include is what is exposed of render to outside world */
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
 
/* length of the scene name + passname */
#define RE_MAXNAME ((MAX_ID_NAME - 2) + 10)
 
/* only used as handle */
typedef struct Render Render;
 
typedef struct RenderView {
  struct RenderView *next, *prev;
  char name[64]; /* EXR_VIEW_MAXNAME */
 
  /* Image buffer of a composited layer or a sequencer output.
   * The ibuf is only allocated if it has an actual data in one of its buffers (float, byte, or
   * GPU). */
  struct ImBuf *ibuf;
} RenderView;
 
typedef struct RenderPass {
  struct RenderPass *next, *prev;
  int channels;
  char name[64];   /* amount defined in IMB_openexr.hh */
  char chan_id[8]; /* amount defined in IMB_openexr.hh */
 
  /* Image buffer which contains data of this pass.
   *
   * The data can be either CPU side stored in ibuf->float_buffer, or a GPU-side stored in
   * ibuf->gpu (during rendering, i.e.).
   *
   * The pass data storage is lazily allocated, and until data is actually provided (via either CPU
   * buffer of GPU texture) the ibuf is not allocated. */
  struct ImBuf *ibuf;
 
  int rectx, recty;
 
  char fullname[64]; /* EXR_PASS_MAXNAME */
  char view[64];     /* EXR_VIEW_MAXNAME */
  int view_id;       /* quick lookup */
 
  char _pad0[4];
} RenderPass;
 
typedef struct RenderLayer {
  struct RenderLayer *next, *prev;
 
  char name[RE_MAXNAME];
  int layflag, passflag, pass_xor;
 
  int rectx, recty;
 
  void *exrhandle;
 
  ListBase passes;
 
} RenderLayer;
 
typedef struct RenderResult {
  struct RenderResult *next, *prev;
 
  /* The number of users of this render result. Default value is 0. The result is freed when
   * #RE_FreeRenderResult is called with the render result with 0 users. In a way this is
   * off-by-one, but it is the easiest for the currently used zero-initialized state. The way to
   * think of it is the number of extra users.
   *
   * TODO: Make it an actual number of users, so the #RE_FreeRenderResult frees the result when
   * the number of users goes to 0.
   *
   * TODO: Make it atomic. Currently it is not to allow shallow copying. */
  int user_counter;
 
  /* target image size */
  int rectx, recty;
 
  /* The temporary storage to pass image data from #RE_AcquireResultImage.
   * Is null pointer when the RenderResult is not coming from the #RE_AcquireResultImage, and is
   * a pointer to an existing ibuf in either RenderView or a RenderPass otherwise. */
  struct ImBuf *ibuf;
 
  /* coordinates within final image (after cropping) */
  rcti tilerect;
  /* offset to apply to get a border render in full image */
  int xof, yof;
 
  /* the main buffers */
  ListBase layers;
 
  /* multiView maps to a StringVector in OpenEXR */
  ListBase views; /* RenderView */
 
  /* Render layer to display. */
  RenderLayer *renlay;
 
  /* for render results in Image, verify validity for sequences */
  int framenr;
 
  /* for acquire image, to indicate if it there is a combined layer */
  bool have_combined;
 
  /* render info text */
  char *text;
  char *error;
 
  struct StampData *stamp_data;
 
  bool passes_allocated;
} RenderResult;
 
typedef struct RenderStats {
  int cfra;
  bool localview;
  double starttime, lastframetime;
  const char *infostr, *statstr;
  char scene_name[MAX_ID_NAME - 2];
  float mem_used, mem_peak;
} RenderStats;
 
/* *********************** API ******************** */
 
struct Render *RE_NewRender(const char *name);
struct Render *RE_GetRender(const char *name);
 
struct Scene;
struct Render *RE_NewSceneRender(const struct Scene *scene);
struct Render *RE_GetSceneRender(const struct Scene *scene);
 
struct RenderEngineType;
struct ViewRender *RE_NewViewRender(struct RenderEngineType *engine_type);
 
/* Creates a new render for interactive compositing of the given scene. If an existing render
 * exists for the given scene, it is returned instead. See interactive_compositor_renders in
 * RenderGlobal for more information. */
struct Render *RE_NewInteractiveCompositorRender(const struct Scene *scene);
 
/* Assign default dummy callbacks. */
 
void RE_InitRenderCB(struct Render *re);
 
void RE_FreeRender(struct Render *re);
void RE_FreeViewRender(struct ViewRender *view_render);
void RE_FreeAllRender(void);
 
void RE_FreeAllRenderResults(void);
 
void RE_FreeAllPersistentData(void);
void RE_FreePersistentData(const struct Scene *scene);
 
void RE_FreeGPUTextureCaches(void);
 
void RE_FreeUnusedGPUResources(void);
 
void RE_FreeRenderResult(struct RenderResult *rr);
struct RenderResult *RE_AcquireResultRead(struct Render *re);
struct RenderResult *RE_AcquireResultWrite(struct Render *re);
void RE_ReferenceRenderResult(struct RenderResult *rr);
void RE_ReleaseResult(struct Render *re);
void RE_AcquireResultImageViews(struct Render *re, struct RenderResult *rr);
void RE_ReleaseResultImageViews(struct Render *re, struct RenderResult *rr);
 
void RE_AcquireResultImage(struct Render *re, struct RenderResult *rr, int view_id);
void RE_ReleaseResultImage(struct Render *re);
void RE_SwapResult(struct Render *re, struct RenderResult **rr);
void RE_ClearResult(struct Render *re);
struct RenderStats *RE_GetStats(struct Render *re);
 
void RE_ResultGet32(struct Render *re, unsigned int *rect);
void RE_ResultGetFloat(struct Render *re, float *rect);
 
void RE_render_result_full_channel_name(char *fullname,
                                        const char *layname,
                                        const char *passname,
                                        const char *viewname,
                                        const char *chan_id,
                                        int channel);
 
struct ImBuf *RE_render_result_rect_to_ibuf(struct RenderResult *rr,
                                            const struct ImageFormatData *imf,
                                            const float dither,
                                            int view_id);
void RE_render_result_rect_from_ibuf(struct RenderResult *rr,
                                     const struct ImBuf *ibuf,
                                     int view_id);
 
struct RenderLayer *RE_GetRenderLayer(struct RenderResult *rr, const char *name);
float *RE_RenderLayerGetPass(struct RenderLayer *rl, const char *name, const char *viewname);
struct ImBuf *RE_RenderLayerGetPassImBuf(struct RenderLayer *rl,
                                         const char *name,
                                         const char *viewname);
 
bool RE_HasSingleLayer(struct Render *re);
 
struct RenderPass *RE_create_gp_pass(struct RenderResult *rr,
                                     const char *layername,
                                     const char *viewname);
 
void RE_create_render_pass(struct RenderResult *rr,
                           const char *name,
                           int channels,
                           const char *chan_id,
                           const char *layername,
                           const char *viewname,
                           bool allocate);
 
void RE_InitState(struct Render *re,
                  struct Render *source,
                  struct RenderData *rd,
                  struct ListBase *render_layers,
                  struct ViewLayer *single_layer,
                  int winx,
                  int winy,
                  const rcti *disprect);
 
struct Object *RE_GetCamera(struct Render *re);
void RE_SetOverrideCamera(struct Render *re, struct Object *cam_ob);
void RE_SetCamera(struct Render *re, const struct Object *cam_ob);
 
void RE_GetViewPlane(struct Render *re, rctf *r_viewplane, rcti *r_disprect);
 
void RE_init_threadcount(Render *re);
 
bool RE_WriteRenderViewsMovie(struct ReportList *reports,
                              struct RenderResult *rr,
                              struct Scene *scene,
                              struct RenderData *rd,
                              struct bMovieHandle *mh,
                              void **movie_ctx_arr,
                              int totvideos,
                              bool preview);
 
void RE_RenderFrame(struct Render *re,
                    struct Main *bmain,
                    struct Scene *scene,
                    struct ViewLayer *single_layer,
                    struct Object *camera_override,
                    int frame,
                    float subframe,
                    bool write_still);
void RE_RenderAnim(struct Render *re,
                   struct Main *bmain,
                   struct Scene *scene,
                   struct ViewLayer *single_layer,
                   struct Object *camera_override,
                   int sfra,
                   int efra,
                   int tfra);
#ifdef WITH_FREESTYLE
void RE_RenderFreestyleStrokes(struct Render *re,
                               struct Main *bmain,
                               struct Scene *scene,
                               bool render);
void RE_RenderFreestyleExternal(struct Render *re);
#endif
 
void RE_SetActiveRenderView(struct Render *re, const char *viewname);
const char *RE_GetActiveRenderView(struct Render *re);
 
void RE_SetReports(struct Render *re, struct ReportList *reports);
 
void RE_PreviewRender(struct Render *re, struct Main *bmain, struct Scene *scene);
 
bool RE_ReadRenderResult(struct Scene *scene, struct Scene *scenode);
 
struct RenderResult *RE_MultilayerConvert(
    void *exrhandle, const char *colorspace, bool predivide, int rectx, int recty);
 
/* Display and event callbacks. */
 
void RE_display_init_cb(struct Render *re,
                        void *handle,
                        void (*f)(void *handle, RenderResult *rr));
void RE_display_clear_cb(struct Render *re,
                         void *handle,
                         void (*f)(void *handle, RenderResult *rr));
void RE_display_update_cb(struct Render *re,
                          void *handle,
                          void (*f)(void *handle, RenderResult *rr, struct rcti *rect));
void RE_stats_draw_cb(struct Render *re, void *handle, void (*f)(void *handle, RenderStats *rs));
void RE_progress_cb(struct Render *re, void *handle, void (*f)(void *handle, float));
void RE_draw_lock_cb(struct Render *re, void *handle, void (*f)(void *handle, bool lock));
void RE_test_break_cb(struct Render *re, void *handle, bool (*f)(void *handle));
void RE_prepare_viewlayer_cb(struct Render *re,
                             void *handle,
                             bool (*f)(void *handle, ViewLayer *vl, struct Depsgraph *depsgraph));
void RE_current_scene_update_cb(struct Render *re,
                                void *handle,
                                void (*f)(void *handle, struct Scene *scene));
 
void RE_system_gpu_context_ensure(Render *re);
void RE_system_gpu_context_free(Render *re);
void *RE_system_gpu_context_get(Render *re);
 
void *RE_blender_gpu_context_ensure(Render *re);
void RE_blender_gpu_context_free(Render *re);
 
float RE_filter_value(int type, float x);
 
bool RE_seq_render_active(struct Scene *scene, struct RenderData *rd);
 
bool RE_layers_have_name(struct RenderResult *result);
bool RE_passes_have_name(struct RenderLayer *rl);
 
struct RenderPass *RE_pass_find_by_name(struct RenderLayer *rl,
                                        const char *name,
                                        const char *viewname);
struct RenderPass *RE_pass_find_by_type(struct RenderLayer *rl,
                                        int passtype,
                                        const char *viewname);
 
void RE_pass_set_buffer_data(struct RenderPass *pass, float *data);
 
struct GPUTexture *RE_pass_ensure_gpu_texture_cache(struct Render *re, struct RenderPass *rpass);
 
/* shaded view or baking options */
#define RE_BAKE_NORMALS 0
#define RE_BAKE_DISPLACEMENT 1
#define RE_BAKE_AO 2
 
void RE_GetCameraWindow(struct Render *re, const struct Object *camera, float r_winmat[4][4]);
void RE_GetCameraWindowWithOverscan(const struct Render *re, float overscan, float r_winmat[4][4]);
void RE_GetCameraModelMatrix(const struct Render *re,
                             const struct Object *camera,
                             float r_modelmat[4][4]);
 
void RE_GetWindowMatrixWithOverscan(bool is_ortho,
                                    float clip_start,
                                    float clip_end,
                                    rctf viewplane,
                                    float overscan,
                                    float r_winmat[4][4]);
 
struct Scene *RE_GetScene(struct Render *re);
void RE_SetScene(struct Render *re, struct Scene *sce);
 
bool RE_is_rendering_allowed(struct Scene *scene,
                             struct ViewLayer *single_layer,
                             struct Object *camera_override,
                             struct ReportList *reports);
 
bool RE_allow_render_generic_object(struct Object *ob);
 
/******* defined in `render_result.cc` *********/
 
bool RE_HasCombinedLayer(const RenderResult *result);
bool RE_HasFloatPixels(const RenderResult *result);
bool RE_RenderResult_is_stereo(const RenderResult *result);
struct RenderView *RE_RenderViewGetById(struct RenderResult *rr, int view_id);
struct RenderView *RE_RenderViewGetByName(struct RenderResult *rr, const char *viewname);
 
RenderResult *RE_DuplicateRenderResult(RenderResult *rr);
 
struct ImBuf *RE_RenderPassEnsureImBuf(RenderPass *render_pass);
struct ImBuf *RE_RenderViewEnsureImBuf(const RenderResult *render_result, RenderView *render_view);
 
/* Returns true if the pass is a color (as opposite of data) and needs to be color managed. */
bool RE_RenderPassIsColor(const RenderPass *render_pass);
 
#ifdef __cplusplus
}
#endif