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

Base class for all image operations. More...

#include <COM_ImageOperation.h>

Inherits blender::compositor::NodeOperation.

Inherited by blender::compositor::ImageAlphaOperation, blender::compositor::ImageDepthOperation, blender::compositor::ImageOperation, and blender::compositor::MultilayerBaseOperation.

Public Member Functions

void initExecution () override
 
void deinitExecution () override
 
void setImage (Image *image)
 
void setImageUser (ImageUser *imageuser)
 
void setRenderData (const RenderData *rd)
 
void setViewName (const char *viewName)
 
void setFramenumber (int framenumber)
 
- 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 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 Member Functions

 BaseImageOperation ()
 
void determineResolution (unsigned int resolution[2], unsigned int preferredResolution[2]) override
 
virtual ImBufgetImBuf ()
 
- 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 executePixelSampled (float[4], float, float, PixelSampler)
 calculate a single pixel 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...
 

Protected Attributes

ImBufm_buffer
 
Imagem_image
 
ImageUserm_imageUser
 
floatm_imageFloatBuffer
 
unsigned int * m_imageByteBuffer
 
floatm_depthBuffer
 
int m_imageheight
 
int m_imagewidth
 
int m_framenumber
 
int m_numberOfChannels
 
const RenderDatam_rd
 
const char * m_viewName
 
- Protected Attributes inherited from blender::compositor::NodeOperation
unsigned int m_width
 
unsigned int m_height
 
NodeOperationFlags flags
 

Detailed Description

Base class for all image operations.

Definition at line 35 of file COM_ImageOperation.h.

Constructor & Destructor Documentation

◆ BaseImageOperation()

blender::compositor::BaseImageOperation::BaseImageOperation ( )
protected

Member Function Documentation

◆ deinitExecution()

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

◆ determineResolution()

void blender::compositor::BaseImageOperation::determineResolution ( unsigned int  resolution[2],
unsigned int  preferredResolution[2] 
)
overrideprotectedvirtual

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

Reimplemented from blender::compositor::NodeOperation.

Definition at line 107 of file COM_ImageOperation.cc.

References BKE_image_release_ibuf(), getImBuf(), m_image, ImBuf::x, and ImBuf::y.

◆ getImBuf()

ImBuf * blender::compositor::BaseImageOperation::getImBuf ( )
protectedvirtual

◆ initExecution()

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

◆ setFramenumber()

void blender::compositor::BaseImageOperation::setFramenumber ( int  framenumber)
inline

◆ setImage()

void blender::compositor::BaseImageOperation::setImage ( Image image)
inline

◆ setImageUser()

void blender::compositor::BaseImageOperation::setImageUser ( ImageUser imageuser)
inline

◆ setRenderData()

void blender::compositor::BaseImageOperation::setRenderData ( const RenderData rd)
inline

◆ setViewName()

void blender::compositor::BaseImageOperation::setViewName ( const char *  viewName)
inline

Member Data Documentation

◆ m_buffer

ImBuf* blender::compositor::BaseImageOperation::m_buffer
protected

◆ m_depthBuffer

float* blender::compositor::BaseImageOperation::m_depthBuffer
protected

◆ m_framenumber

int blender::compositor::BaseImageOperation::m_framenumber
protected

Definition at line 45 of file COM_ImageOperation.h.

Referenced by BaseImageOperation().

◆ m_image

Image* blender::compositor::BaseImageOperation::m_image
protected

◆ m_imageByteBuffer

unsigned int* blender::compositor::BaseImageOperation::m_imageByteBuffer
protected

◆ m_imageFloatBuffer

float* blender::compositor::BaseImageOperation::m_imageFloatBuffer
protected

◆ m_imageheight

int blender::compositor::BaseImageOperation::m_imageheight
protected

Definition at line 43 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and initExecution().

◆ m_imageUser

ImageUser* blender::compositor::BaseImageOperation::m_imageUser
protected

◆ m_imagewidth

int blender::compositor::BaseImageOperation::m_imagewidth
protected

Definition at line 44 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and initExecution().

◆ m_numberOfChannels

int blender::compositor::BaseImageOperation::m_numberOfChannels
protected

◆ m_rd

const RenderData* blender::compositor::BaseImageOperation::m_rd
protected

Definition at line 47 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and getImBuf().

◆ m_viewName

const char* blender::compositor::BaseImageOperation::m_viewName
protected

Definition at line 48 of file COM_ImageOperation.h.

Referenced by BaseImageOperation(), and getImBuf().


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