Blender V4.3
blender::compositor::GlareBaseOperation Class Referenceabstract

#include <COM_GlareBaseOperation.h>

Inherits blender::compositor::NodeOperation.

Inherited by blender::compositor::GlareBloomOperation, blender::compositor::GlareFogGlowOperation, blender::compositor::GlareGhostOperation, blender::compositor::GlareSimpleStarOperation, and blender::compositor::GlareStreaksOperation.

Public Member Functions

void set_glare_settings (const NodeGlare *settings)
 
void get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area) final
 Get input operation area being read by this operation on rendering given output area.
 
void update_memory_buffer (MemoryBuffer *output, const rcti &area, Span< MemoryBuffer * > inputs) final
 
- Public Member Functions inherited from blender::compositor::NodeOperation
virtual ~NodeOperation ()
 
void set_name (const std::string name)
 
const std::string get_name () const
 
void set_id (const int id)
 
const int get_id () const
 
const void set_node_instance_key (const bNodeInstanceKey &node_instance_key)
 
const bNodeInstanceKey get_node_instance_key () const
 
float get_constant_value_default (float default_value)
 
const floatget_constant_elem_default (const float *default_elem)
 
const NodeOperationFlags get_flags () const
 
std::optional< NodeOperationHashgenerate_hash ()
 
unsigned int get_number_of_input_sockets () const
 
unsigned int get_number_of_output_sockets () const
 
NodeOperationOutputget_output_socket (unsigned int index=0)
 
NodeOperationInputget_input_socket (unsigned int index)
 
NodeOperationget_input_operation (int index)
 
virtual void determine_canvas (const rcti &preferred_area, rcti &r_area)
 
virtual bool is_output_operation (bool) const
 is_output_operation determines whether this operation is an output of the ExecutionSystem during rendering or editing.
 
void set_bnodetree (const bNodeTree *tree)
 
void set_execution_system (ExecutionSystem *system)
 
virtual void init_data ()
 
virtual void init_execution ()
 
virtual void deinit_execution ()
 
void set_canvas (const rcti &canvas_area)
 
const rctiget_canvas () const
 
void unset_canvas ()
 
virtual bool is_active_viewer_output () const
 is this operation the active viewer output user can select an ViewerNode to be active (the result of this node will be drawn on the backdrop).
 
void set_canvas_input_index (unsigned int index)
 set the index of the input socket that will determine the canvas of this operation
 
void set_determined_canvas_modifier (std::function< void(rcti &canvas)> fn)
 
virtual eCompositorPriority get_render_priority () const
 get the render priority of this node.
 
bool is_braked () const
 
void update_draw ()
 
unsigned int get_width () const
 
unsigned int get_height () const
 
virtual MemoryBufferget_input_memory_buffer (MemoryBuffer **)
 
virtual std::unique_ptr< MetaDataget_meta_data ()
 
void render (MemoryBuffer *output_buf, Span< rcti > areas, Span< MemoryBuffer * > inputs_bufs)
 
void get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)
 

Protected Member Functions

 GlareBaseOperation ()
 
virtual void generate_glare (float *data, MemoryBuffer *input_tile, const NodeGlare *settings)=0
 
- Protected Member Functions inherited from blender::compositor::NodeOperation
 NodeOperation ()
 
virtual void hash_output_params ()
 
template<typename T >
void hash_param (T param)
 
template<typename T1 , typename T2 >
void hash_params (T1 param1, T2 param2)
 
template<typename T1 , typename T2 , typename T3 >
void hash_params (T1 param1, T2 param2, T3 param3)
 
void add_input_socket (DataType datatype, ResizeMode resize_mode=ResizeMode::Center)
 
void add_output_socket (DataType datatype)
 
SocketReaderget_input_socket_reader (unsigned int index)
 

Additional Inherited Members

- Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void combine_hashes (size_t &combined, size_t other)
 
- Protected Attributes inherited from blender::compositor::NodeOperation
rcti canvas_ = COM_AREA_NONE
 
NodeOperationFlags flags_
 
ExecutionSystemexec_system_
 

Detailed Description

Definition at line 26 of file COM_GlareBaseOperation.h.

Constructor & Destructor Documentation

◆ GlareBaseOperation()

Member Function Documentation

◆ generate_glare()

virtual void blender::compositor::GlareBaseOperation::generate_glare ( float * data,
MemoryBuffer * input_tile,
const NodeGlare * settings )
protectedpure virtual

◆ get_area_of_interest()

void blender::compositor::GlareBaseOperation::get_area_of_interest ( int input_idx,
const rcti & output_area,
rcti & r_input_area )
finalvirtual

Get input operation area being read by this operation on rendering given output area.

Implementation don't need to ensure r_input_area is within input operation bounds. The caller must clamp it. TODO: See if it's possible to use parameter overloading (input_id for example).

Parameters
input_idxInput operation index for which we want to calculate the area being read.
output_areaArea being rendered by this operation.
r_input_areaReturned input operation area that needs to be read in order to render given output area.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 18 of file COM_GlareBaseOperation.cc.

References BLI_assert, blender::compositor::NodeOperation::get_height(), blender::compositor::NodeOperation::get_width(), UNUSED_VARS_NDEBUG, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ set_glare_settings()

void blender::compositor::GlareBaseOperation::set_glare_settings ( const NodeGlare * settings)
inline

◆ update_memory_buffer()

void blender::compositor::GlareBaseOperation::update_memory_buffer ( MemoryBuffer * ,
const rcti & ,
Span< MemoryBuffer * >  )
finalvirtual

Executes operation updating output memory buffer. Single-threaded calls.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 30 of file COM_GlareBaseOperation.cc.

References copy_v4_v4(), generate_glare(), and blender::compositor::MemoryBuffer::get_buffer().


The documentation for this class was generated from the following files: