Blender  V2.93
Public Member Functions | Protected Attributes | List of all members
blender::compositor::KeyingDespillOperation Class Reference

#include <COM_KeyingDespillOperation.h>

Inherits blender::compositor::NodeOperation.

Public Member Functions

 KeyingDespillOperation ()
 
void initExecution () override
 
void deinitExecution () override
 
void setDespillFactor (float value)
 
void setColorBalance (float value)
 
void executePixelSampled (float output[4], float x, float y, PixelSampler sampler) override
 calculate a single pixel More...
 
- 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
 
NodeOperationOutputgetOutputSocket (unsigned int index=0)
 
NodeOperationInputgetInputSocket (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 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...
 
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...
 
virtual bool determineDependingAreaOfInterest (rcti *input, ReadBufferOperation *readOperation, rcti *output)
 
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 * initializeTileData (rcti *)
 
virtual void deinitializeTileData (rcti *, void *)
 
virtual MemoryBuffergetInputMemoryBuffer (MemoryBuffer **)
 
virtual std::unique_ptr< MetaDatagetMetaData ()
 

Protected Attributes

SocketReaderm_pixelReader
 
SocketReaderm_screenReader
 
float m_despillFactor
 
float m_colorBalance
 
- 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)
 
SocketReadergetInputSocketReader (unsigned int inputSocketindex)
 
NodeOperationgetInputOperation (unsigned int inputSocketindex)
 
void deinitMutex ()
 
void initMutex ()
 
void lockMutex ()
 
void unlockMutex ()
 
void setComplex (bool complex)
 set whether this operation is complex More...
 
virtual void executePixel (float output[4], int x, int y, void *)
 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 keying despill node

Definition at line 28 of file COM_KeyingDespillOperation.h.

Constructor & Destructor Documentation

◆ KeyingDespillOperation()

blender::compositor::KeyingDespillOperation::KeyingDespillOperation ( )

Member Function Documentation

◆ deinitExecution()

void blender::compositor::KeyingDespillOperation::deinitExecution ( )
overridevirtual

Reimplemented from blender::compositor::NodeOperation.

Definition at line 47 of file COM_KeyingDespillOperation.cc.

References m_pixelReader, and m_screenReader.

◆ executePixelSampled()

void blender::compositor::KeyingDespillOperation::executePixelSampled ( float  [4],
float  ,
float  ,
PixelSampler   
)
overridevirtual

calculate a single pixel

Note
this method is called for non-complex
Parameters
resultis a float[4] array to store the result
xthe x-coordinate of the pixel to calculate in image space
ythe y-coordinate of the pixel to calculate in image space
inputBufferschunks that can be read by their ReadBufferOperation.

Reimplemented from blender::compositor::NodeOperation.

Definition at line 53 of file COM_KeyingDespillOperation.cc.

References copy_v4_v4(), m_colorBalance, m_despillFactor, m_pixelReader, m_screenReader, MAX2, max_axis_v3(), MIN2, output, blender::compositor::NodeOperation::readSampled(), x, and y.

◆ initExecution()

void blender::compositor::KeyingDespillOperation::initExecution ( )
overridevirtual

◆ setColorBalance()

void blender::compositor::KeyingDespillOperation::setColorBalance ( float  value)
inline

◆ setDespillFactor()

void blender::compositor::KeyingDespillOperation::setDespillFactor ( float  value)
inline

Member Data Documentation

◆ m_colorBalance

float blender::compositor::KeyingDespillOperation::m_colorBalance
protected

Definition at line 33 of file COM_KeyingDespillOperation.h.

Referenced by executePixelSampled(), and KeyingDespillOperation().

◆ m_despillFactor

float blender::compositor::KeyingDespillOperation::m_despillFactor
protected

Definition at line 32 of file COM_KeyingDespillOperation.h.

Referenced by executePixelSampled(), and KeyingDespillOperation().

◆ m_pixelReader

SocketReader* blender::compositor::KeyingDespillOperation::m_pixelReader
protected

◆ m_screenReader

SocketReader* blender::compositor::KeyingDespillOperation::m_screenReader
protected

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