#include <COM_MovieClipOperation.h>

Inherits blender::compositor::MultiThreadedOperation.

Inherited by blender::compositor::MovieClipAlphaOperation, and blender::compositor::MovieClipOperation.

Public Member Functions
	MovieClipBaseOperation ()

void	init_execution () override

void	deinit_execution () override

void	set_movie_clip (MovieClip *image)

void	set_movie_clip_user (MovieClipUser *imageuser)

void	set_cache_frame (bool value)

void	set_framenumber (int framenumber)

void	update_memory_buffer_partial (MemoryBuffer output, const rcti &area, Span< MemoryBuffer > inputs) override

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 float *	get_constant_elem_default (const float *default_elem)

const NodeOperationFlags	get_flags () const

std::optional< NodeOperationHash >	generate_hash ()

unsigned int	get_number_of_input_sockets () const

unsigned int	get_number_of_output_sockets () const

NodeOperationOutput *	get_output_socket (unsigned int index=0)

NodeOperationInput *	get_input_socket (unsigned int index)

NodeOperation *	get_input_operation (int index)

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 ()

void	set_canvas (const rcti &canvas_area)

const rcti &	get_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 MemoryBuffer *	get_input_memory_buffer (MemoryBuffer **)

virtual std::unique_ptr< MetaData >	get_meta_data ()

void	render (MemoryBuffer output_buf, Span< rcti > areas, Span< MemoryBuffer > inputs_bufs)

virtual void	get_area_of_interest (int input_idx, const rcti &output_area, rcti &r_input_area)
	Get input operation area being read by this operation on rendering given output area.

void	get_area_of_interest (NodeOperation *input_op, const rcti &output_area, rcti &r_input_area)

Protected Member Functions
void	determine_canvas (const rcti &preferred_area, rcti &r_area) override

Protected Member Functions inherited from blender::compositor::MultiThreadedOperation
	MultiThreadedOperation ()

virtual void	update_memory_buffer_started (MemoryBuffer , const rcti &, Span< MemoryBuffer >)

virtual void	update_memory_buffer_finished (MemoryBuffer , const rcti &, Span< MemoryBuffer >)

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)

SocketReader *	get_input_socket_reader (unsigned int index)

Protected Attributes
MovieClip *	movie_clip_

MovieClipUser *	movie_clip_user_

ImBuf *	movie_clip_buffer_

int	movie_clipheight_

int	movie_clipwidth_

int	framenumber_

bool	cache_frame_

Protected Attributes inherited from blender::compositor::MultiThreadedOperation
int	num_passes_

int	current_pass_

Protected Attributes inherited from blender::compositor::NodeOperation
rcti	canvas_ = COM_AREA_NONE

NodeOperationFlags	flags_

ExecutionSystem *	exec_system_

Additional Inherited Members
Static Protected Member Functions inherited from blender::compositor::NodeOperation
static void	combine_hashes (size_t &combined, size_t other)

Detailed Description

Base class for movie clip

Definition at line 17 of file COM_MovieClipOperation.h.

Constructor & Destructor Documentation

◆ MovieClipBaseOperation()

blender::compositor::MovieClipBaseOperation::MovieClipBaseOperation ( )

Definition at line 15 of file COM_MovieClipOperation.cc.

References framenumber_, movie_clip_, movie_clip_buffer_, movie_clip_user_, movie_clipheight_, and movie_clipwidth_.

Member Function Documentation

◆ deinit_execution()

void blender::compositor::MovieClipBaseOperation::deinit_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 49 of file COM_MovieClipOperation.cc.

References IMB_freeImBuf(), and movie_clip_buffer_.

◆ determine_canvas()

void blender::compositor::MovieClipBaseOperation::determine_canvas	(	const rcti &	preferred_area,
		rcti &	r_area )

overrideprotectedvirtual

Determine the output resolution. The resolution is retrieved from the Renderer

Reimplemented from blender::compositor::NodeOperation.

Definition at line 58 of file COM_MovieClipOperation.cc.

References BKE_movieclip_get_size(), BLI_rcti_init(), blender::compositor::COM_AREA_NONE, movie_clip_, and movie_clip_user_.

◆ init_execution()

void blender::compositor::MovieClipBaseOperation::init_execution ( )

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 25 of file COM_MovieClipOperation.cc.

References BKE_movieclip_get_ibuf(), BKE_movieclip_get_ibuf_flag(), BKE_movieclip_user_set_frame(), cache_frame_, ImBufFloatBuffer::data, MovieClip::flag, ImBuf::float_buffer, framenumber_, IB_RECT_INVALID, IMB_float_from_rect(), movie_clip_, movie_clip_buffer_, movie_clip_user_, MOVIECLIP_CACHE_SKIP, and ImBuf::userflags.

◆ set_cache_frame()

void blender::compositor::MovieClipBaseOperation::set_cache_frame ( bool value )

inline

Definition at line 45 of file COM_MovieClipOperation.h.

References cache_frame_.

Referenced by blender::compositor::MovieClipNode::convert_to_operations().

◆ set_framenumber()

void blender::compositor::MovieClipBaseOperation::set_framenumber ( int framenumber )

inline

Definition at line 50 of file COM_MovieClipOperation.h.

References framenumber_.

Referenced by blender::compositor::MovieClipNode::convert_to_operations().

◆ set_movie_clip()

void blender::compositor::MovieClipBaseOperation::set_movie_clip ( MovieClip * image )

inline

Definition at line 37 of file COM_MovieClipOperation.h.

References image(), and movie_clip_.

Referenced by blender::compositor::MovieClipNode::convert_to_operations().

◆ set_movie_clip_user()

void blender::compositor::MovieClipBaseOperation::set_movie_clip_user ( MovieClipUser * imageuser )

inline

Definition at line 41 of file COM_MovieClipOperation.h.

References movie_clip_user_.

Referenced by blender::compositor::MovieClipNode::convert_to_operations().

◆ update_memory_buffer_partial()

void blender::compositor::MovieClipBaseOperation::update_memory_buffer_partial	(	MemoryBuffer *	output,
		const rcti &	area,
		Span< MemoryBuffer * >	inputs )

overridevirtual

Executes operation updating a memory buffer area. Multi-threaded calls.

Implements blender::compositor::MultiThreadedOperation.

Definition at line 68 of file COM_MovieClipOperation.cc.

References blender::compositor::COM_COLOR_TRANSPARENT, and movie_clip_buffer_.

Member Data Documentation

◆ cache_frame_

bool blender::compositor::MovieClipBaseOperation::cache_frame_

protected

Definition at line 25 of file COM_MovieClipOperation.h.

Referenced by init_execution(), and set_cache_frame().

◆ framenumber_

int blender::compositor::MovieClipBaseOperation::framenumber_

protected

Definition at line 24 of file COM_MovieClipOperation.h.

Referenced by init_execution(), MovieClipBaseOperation(), and set_framenumber().

◆ movie_clip_

MovieClip* blender::compositor::MovieClipBaseOperation::movie_clip_

protected

Definition at line 19 of file COM_MovieClipOperation.h.

Referenced by determine_canvas(), init_execution(), MovieClipBaseOperation(), and set_movie_clip().

◆ movie_clip_buffer_

ImBuf* blender::compositor::MovieClipBaseOperation::movie_clip_buffer_

protected

Definition at line 21 of file COM_MovieClipOperation.h.

Referenced by deinit_execution(), init_execution(), MovieClipBaseOperation(), blender::compositor::MovieClipAlphaOperation::update_memory_buffer_partial(), and update_memory_buffer_partial().

◆ movie_clip_user_

MovieClipUser* blender::compositor::MovieClipBaseOperation::movie_clip_user_

protected

Definition at line 20 of file COM_MovieClipOperation.h.

Referenced by determine_canvas(), init_execution(), MovieClipBaseOperation(), and set_movie_clip_user().

◆ movie_clipheight_

int blender::compositor::MovieClipBaseOperation::movie_clipheight_

protected

Definition at line 22 of file COM_MovieClipOperation.h.

Referenced by MovieClipBaseOperation().

◆ movie_clipwidth_

int blender::compositor::MovieClipBaseOperation::movie_clipwidth_

protected

Definition at line 23 of file COM_MovieClipOperation.h.

Referenced by MovieClipBaseOperation().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MovieClipBaseOperation()

Member Function Documentation

◆ deinit_execution()

◆ determine_canvas()

◆ init_execution()

◆ set_cache_frame()

◆ set_framenumber()

◆ set_movie_clip()

◆ set_movie_clip_user()

◆ update_memory_buffer_partial()

Member Data Documentation

◆ cache_frame_

◆ framenumber_

◆ movie_clip_

◆ movie_clip_buffer_

◆ movie_clip_user_

◆ movie_clipheight_

◆ movie_clipwidth_