Blender V5.3
blender::bke::compositor Namespace Reference

Classes

struct  Cache

Enumerations

enum class  ExecutionMode : uint8_t { Render , Preview }

Functions

bool is_enabled (const Scene &scene, ExecutionMode mode)
SceneCompositorEffect * get_effect (const Scene &scene, StringRef name)
SceneCompositorEffect * get_active_effect (const Scene &scene)
bool is_effect_enabled (const SceneCompositorEffect &effect, ExecutionMode mode)
void set_active_effect (const Scene &scene, SceneCompositorEffect &effect)
void rename_effect (Scene &scene, SceneCompositorEffect &effect, StringRef new_name, bool update_animation_data=true)
SceneCompositorEffect & new_effect (Scene &scene, StringRef name)
SceneCompositorEffect & duplicate_effect (Scene &scene, SceneCompositorEffect &source_effect)
void free_effect (Scene &scene, SceneCompositorEffect &effect)
void remove_effect (Scene &scene, SceneCompositorEffect &effect)
void copy_effects (Scene &target_scene, const Scene &source_scene, const int flags)
void free_effects (Scene &scene)
void clear_effects (Scene &scene)
void for_each_id_in_effects (const Scene &scene, LibraryForeachIDData &data)
void write_effects (const Scene &scene, BlendWriter &writer)
void read_effects (Scene &scene, BlendDataReader &reader)
const SceneCompositorEffect * get_effect_from_property (const PointerRNA &property_ptr)
void update_effect_node_group_interface (Main &main, Scene &scene, SceneCompositorEffect &effect)
Set< std::string > get_used_passes (const Scene &scene, const ViewLayer *view_layer, ExecutionMode mode)
bool is_viewport_compositor_enabled (const View3D &view_3d, const RegionView3D &region_view_3d)
bool is_viewport_compositor_used (const bContext &context)
void add_depsgraph_relations (Scene &scene, const SceneCompositorEffect &effect, DepsNodeHandle *compositor_output_depsgraph_node)
const ComputeContext * get_zone_viewer_compute_context (const bNode &node, const bke::bNodeTreeZone *zone, const ComputeContext &compute_context, bke::ComputeContextCache &compute_context_cache)
const ComputeContext * compute_viewer_compute_context (const Scene &scene, bke::ComputeContextCache &compute_context_cache)
const ComputeContext * compute_viewer_compute_context (const Scene &scene, const bNodeTree &root_node_group, bke::ComputeContextCache &compute_context_cache)
static void free_effect (SceneCompositorEffect &effect, const bool decrement_user_count)
static void add_passes_used_by_render_layer_node (const bNode *node, Set< std::string > &used_passes)
static void add_passes_used_by_group_input_node (const bNode *node, Set< std::string > &used_passes)
static void add_passes_used_by_cryptomatte_node (const bNode *node, const ViewLayer *view_layer, Set< std::string > &used_passes)
static void add_used_passes_recursive (const bNodeTree *node_tree, const ViewLayer *view_layer, const bool is_root_tree_of_first_effect, Set< const bNodeTree * > &node_trees_already_searched, Set< std::string > &used_passes)
static const ComputeContext * compute_viewer_compute_context_recursive (const bNodeTree &node_group, const ComputeContext &compute_context, const bNodeInstanceKey instance_key, const bNodeInstanceKey active_node_group_instance_key, bke::ComputeContextCache &compute_context_cache)

Enumeration Type Documentation

◆ ExecutionMode

Enumerator
Render 
Preview 

Definition at line 112 of file BKE_compositor.hh.

Function Documentation

◆ add_depsgraph_relations()

◆ add_passes_used_by_cryptomatte_node()

◆ add_passes_used_by_group_input_node()

void blender::bke::compositor::add_passes_used_by_group_input_node ( const bNode * node,
Set< std::string > & used_passes )
static

◆ add_passes_used_by_render_layer_node()

void blender::bke::compositor::add_passes_used_by_render_layer_node ( const bNode * node,
Set< std::string > & used_passes )
static

◆ add_used_passes_recursive()

void blender::bke::compositor::add_used_passes_recursive ( const bNodeTree * node_tree,
const ViewLayer * view_layer,
const bool is_root_tree_of_first_effect,
Set< const bNodeTree * > & node_trees_already_searched,
Set< std::string > & used_passes )
static

◆ clear_effects()

void blender::bke::compositor::clear_effects ( Scene & scene)

◆ compute_viewer_compute_context() [1/2]

◆ compute_viewer_compute_context() [2/2]

◆ compute_viewer_compute_context_recursive()

const ComputeContext * blender::bke::compositor::compute_viewer_compute_context_recursive ( const bNodeTree & node_group,
const ComputeContext & compute_context,
const bNodeInstanceKey instance_key,
const bNodeInstanceKey active_node_group_instance_key,
bke::ComputeContextCache & compute_context_cache )
static

◆ copy_effects()

void blender::bke::compositor::copy_effects ( Scene & target_scene,
const Scene & source_scene,
const int flags )

◆ duplicate_effect()

◆ for_each_id_in_effects()

◆ free_effect() [1/2]

◆ free_effect() [2/2]

void blender::bke::compositor::free_effect ( SceneCompositorEffect & effect,
const bool decrement_user_count )
static

◆ free_effects()

void blender::bke::compositor::free_effects ( Scene & scene)

◆ get_active_effect()

◆ get_effect()

◆ get_effect_from_property()

◆ get_used_passes()

◆ get_zone_viewer_compute_context()

◆ is_effect_enabled()

◆ is_enabled()

◆ is_viewport_compositor_enabled()

◆ is_viewport_compositor_used()

◆ new_effect()

◆ read_effects()

◆ remove_effect()

◆ rename_effect()

◆ set_active_effect()

◆ update_effect_node_group_interface()

◆ write_effects()