#include <COM_KeyingClipOperation.h>

Inherits blender::compositor::NodeOperation.

Public Member Functions
	KeyingClipOperation ()

void	setClipBlack (float value)

void	setClipWhite (float value)

void	setKernelRadius (int value)

void	setKernelTolerance (float value)

void	setIsEdgeMatte (bool value)

void *	initializeTileData (rcti *rect) override

void	executePixel (float output[4], int x, int y, void *data) override
	calculate a single pixel More...

bool	determineDependingAreaOfInterest (rcti input, ReadBufferOperation readOperation, rcti *output) 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 NodeOperationFlags	get_flags () const

unsigned int	getNumberOfInputSockets () const

unsigned int	getNumberOfOutputSockets () const

NodeOperationOutput *	getOutputSocket (unsigned int index=0)

NodeOperationInput *	getInputSocket (unsigned int index)

virtual void	determineResolution (unsigned int resolution[2], unsigned int preferredResolution[2])
	determine the resolution of this node More...

virtual bool	isOutputOperation (bool) const
	isOutputOperation determines whether this operation is an output of the ExecutionSystem during rendering or editing. More...

void	setbNodeTree (const bNodeTree *tree)

virtual void	initExecution ()

virtual void	executeRegion (rcti *, unsigned int)
	when a chunk is executed by a CPUDevice, this method is called More...

virtual void	executeOpenCLRegion (OpenCLDevice , rcti , unsigned int, MemoryBuffer *, MemoryBuffer )
	when a chunk is executed by an OpenCLDevice, this method is called More...

virtual void	executeOpenCL (OpenCLDevice , MemoryBuffer , cl_mem, MemoryBuffer *, std::list< cl_mem > , std::list< cl_kernel > *)
	custom handle to add new tasks to the OpenCL command queue in order to execute a chunk on an GPUDevice. More...

virtual void	deinitExecution ()

void	setResolution (unsigned int resolution[2])
	set the resolution More...

virtual bool	isActiveViewerOutput () 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). More...

void	setResolutionInputSocketIndex (unsigned int index)
	set the index of the input socket that will determine the resolution of this operation More...

virtual eCompositorPriority	getRenderPriority () const
	get the render priority of this node. More...

bool	isBraked () const

void	updateDraw ()

unsigned int	getWidth () const

unsigned int	getHeight () const

void	readSampled (float result[4], float x, float y, PixelSampler sampler)

void	readFiltered (float result[4], float x, float y, float dx[2], float dy[2])

void	read (float result[4], int x, int y, void *chunkData)

virtual void	deinitializeTileData (rcti , void )

virtual MemoryBuffer *	getInputMemoryBuffer (MemoryBuffer **)

virtual std::unique_ptr< MetaData >	getMetaData ()

Protected Attributes
float	m_clipBlack

float	m_clipWhite

int	m_kernelRadius

float	m_kernelTolerance

bool	m_isEdgeMatte

Protected Attributes inherited from blender::compositor::NodeOperation
unsigned int	m_width

unsigned int	m_height

NodeOperationFlags	flags

Additional Inherited Members
Protected Member Functions inherited from blender::compositor::NodeOperation
	NodeOperation ()

void	addInputSocket (DataType datatype, ResizeMode resize_mode=ResizeMode::Center)

void	addOutputSocket (DataType datatype)

void	setWidth (unsigned int width)

void	setHeight (unsigned int height)

SocketReader *	getInputSocketReader (unsigned int inputSocketindex)

NodeOperation *	getInputOperation (unsigned int inputSocketindex)

void	deinitMutex ()

void	initMutex ()

void	lockMutex ()

void	unlockMutex ()

void	setComplex (bool complex)
	set whether this operation is complex More...

virtual void	executePixelSampled (float[4], float, float, PixelSampler)
	calculate a single pixel More...

virtual void	executePixelFiltered (float[4], float, float, float[2], float[2])
	calculate a single pixel using an EWA filter More...

Detailed Description

Class with implementation of black/white clipping for keying node

Definition at line 28 of file COM_KeyingClipOperation.h.

Constructor & Destructor Documentation

◆ KeyingClipOperation()

blender::compositor::KeyingClipOperation::KeyingClipOperation ( )

Definition at line 28 of file COM_KeyingClipOperation.cc.

References blender::compositor::NodeOperation::addInputSocket(), blender::compositor::NodeOperation::addOutputSocket(), blender::compositor::NodeOperationFlags::complex, blender::compositor::NodeOperation::flags, m_clipBlack, m_clipWhite, m_isEdgeMatte, m_kernelRadius, m_kernelTolerance, and blender::compositor::Value.

Member Function Documentation

◆ determineDependingAreaOfInterest()

bool blender::compositor::KeyingClipOperation::determineDependingAreaOfInterest	(	rcti *	input,
		ReadBufferOperation *	readOperation,
		rcti *	output
	)

overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 119 of file COM_KeyingClipOperation.cc.

References blender::compositor::NodeOperation::determineDependingAreaOfInterest(), m_kernelRadius, output, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

◆ executePixel()

void blender::compositor::KeyingClipOperation::executePixel	(	float	output[4],
		int	x,
		int	y,
		void *
	)

overridevirtual

calculate a single pixel

Note: this method is called for complex

Parameters

result	is a float[4] array to store the result
x	the x-coordinate of the pixel to calculate in image space
y	the y-coordinate of the pixel to calculate in image space
inputBuffers	chunks that can be read by their ReadBufferOperation.
chunkData	chunk specific data a during execution time.