Blender
V5.3
source
blender
render
RE_compositor.hh
Go to the documentation of this file.
1
/* SPDX-FileCopyrightText: 2023 Blender Authors
2
*
3
* SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9
#pragma once
10
11
#include <cstdint>
12
#include <string>
13
14
namespace
blender
{
15
16
namespace
compositor
{
17
class
RenderContext
;
18
enum class
SideEffectOutputTypes
:
uint8_t
;
19
}
// namespace compositor
20
21
struct
bNodeTree
;
22
struct
Render
;
23
struct
Main
;
24
struct
RenderData
;
25
struct
Scene
;
26
27
/* ------------------------------------------------------------------------------------------------
28
* Render Compositor
29
*
30
* Implementation of the compositor for final rendering, as opposed to the viewport compositor
31
* that is part of the draw manager. The input and output of this is pre-existing RenderResult
32
* buffers in scenes, that are uploaded to and read back from the GPU. */
33
34
namespace
render
{
35
class
Compositor
;
36
37
class
CompositorInputData
{
38
public
:
39
Render
&
render
;
40
const
Main
&
main
;
41
const
Scene
&
scene
;
42
const
RenderData
&
render_data
;
43
std::string
view_name
;
44
compositor::RenderContext
*
render_context
;
45
compositor::SideEffectOutputTypes
needed_side_effects_outputs
;
46
/* Identifies if the compositor is executing due to the user making a modification or if it is
47
* executing due to playback or rendering. */
48
const
bool
triggered_by_user
=
false
;
49
};
50
51
}
// namespace render
52
53
/* Execute compositor. */
54
void
RE_compositor_execute
(
render::CompositorInputData
input_data);
55
56
/* Free compositor caches. */
57
void
RE_compositor_free
(
Render
&
render
);
58
59
}
// namespace blender
blender::compositor::RenderContext
Definition
COM_render_context.hh:98
blender::render::CompositorInputData
Definition
RE_compositor.hh:37
blender::render::CompositorInputData::needed_side_effects_outputs
compositor::SideEffectOutputTypes needed_side_effects_outputs
Definition
RE_compositor.hh:45
blender::render::CompositorInputData::scene
const Scene & scene
Definition
RE_compositor.hh:41
blender::render::CompositorInputData::render_context
compositor::RenderContext * render_context
Definition
RE_compositor.hh:44
blender::render::CompositorInputData::render_data
const RenderData & render_data
Definition
RE_compositor.hh:42
blender::render::CompositorInputData::triggered_by_user
const bool triggered_by_user
Definition
RE_compositor.hh:48
blender::render::CompositorInputData::main
const Main & main
Definition
RE_compositor.hh:40
blender::render::CompositorInputData::view_name
std::string view_name
Definition
RE_compositor.hh:43
blender::render::CompositorInputData::render
Render & render
Definition
RE_compositor.hh:39
blender::render::Compositor
Definition
render/intern/compositor.cc:766
blender::compositor
Definition
BKE_node.hh:77
blender::compositor::SideEffectOutputTypes
SideEffectOutputTypes
Definition
COM_context.hh:37
blender::render
Definition
render/hydra/camera.cc:16
blender
BMesh Iterators.
Definition
ANIM_action.hh:30
blender::RE_compositor_free
void RE_compositor_free(Render &render)
Definition
render/intern/compositor.cc:919
blender::uint8_t
unsigned char uint8_t
Definition
BKE_text.h:79
blender::RE_compositor_execute
void RE_compositor_execute(const render::CompositorInputData input_data)
Definition
render/intern/compositor.cc:914
blender::Main
Definition
BKE_main.hh:243
blender::RenderData
Definition
DNA_scene_types.h:849
blender::Render
Definition
render_types.h:104
blender::Scene
Definition
DNA_scene_types.h:2876
blender::bNodeTree
Definition
DNA_node_types.h:1891
Generated on
for Blender by
doxygen
1.18.0