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

#include <COM_ViewerOperation.h>

Inherits blender::compositor::NodeOperation.

Public Member Functions

 ViewerOperation ()
 
void initExecution () override
 
void deinitExecution () override
 
void executeRegion (rcti *rect, unsigned int tileNumber) override
 when a chunk is executed by a CPUDevice, this method is called More...
 
void determineResolution (unsigned int resolution[2], unsigned int preferredResolution[2]) override
 determine the resolution of this node More...
 
bool isOutputOperation (bool) const override
 isOutputOperation determines whether this operation is an output of the ExecutionSystem during rendering or editing. More...
 
void setImage (Image *image)
 
void setImageUser (ImageUser *imageUser)
 
bool isActiveViewerOutput () const override
 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 setActive (bool active)
 
void setCenterX (float centerX)
 
void setCenterY (float centerY)
 
void setChunkOrder (ChunkOrdering tileOrder)
 
float getCenterX () const
 
float getCenterY () const
 
ChunkOrdering getChunkOrder () const
 
eCompositorPriority getRenderPriority () const override
 get the render priority of this node. More...
 
void setUseAlphaInput (bool value)
 
void setRenderData (const RenderData *rd)
 
void setViewName (const char *viewName)
 
void setViewSettings (const ColorManagedViewSettings *viewSettings)
 
void setDisplaySettings (const ColorManagedDisplaySettings *displaySettings)
 
- 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)
 
void setbNodeTree (const bNodeTree *tree)
 
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 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...
 
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 ()
 

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 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 inherited from blender::compositor::NodeOperation
unsigned int m_width
 
unsigned int m_height
 
NodeOperationFlags flags
 

Detailed Description

Definition at line 28 of file COM_ViewerOperation.h.

Constructor & Destructor Documentation

◆ ViewerOperation()

blender::compositor::ViewerOperation::ViewerOperation ( )

Member Function Documentation

◆ deinitExecution()

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

Reimplemented from blender::compositor::NodeOperation.

Definition at line 75 of file COM_ViewerOperation.cc.

◆ determineResolution()

void blender::compositor::ViewerOperation::determineResolution ( unsigned int  resolution[2],
unsigned int  preferredResolution[2] 
)
overridevirtual

determine the resolution of this node

Note
this method will not set the resolution, this is the responsibility of the caller
Parameters
resolutionthe result of this operation
preferredResolutionthe preferable resolution as no resolution could be determined

Reimplemented from blender::compositor::NodeOperation.

Definition at line 125 of file COM_ViewerOperation.cc.

References blender::compositor::NodeOperation::determineResolution(), RenderData::size, RenderData::xsch, and RenderData::ysch.

◆ executeRegion()

void blender::compositor::ViewerOperation::executeRegion ( rcti ,
unsigned int   
)
overridevirtual

when a chunk is executed by a CPUDevice, this method is called

Parameters
rectthe rectangle of the chunk (location and size)
chunkNumberthe chunkNumber to be calculated
memoryBuffersall input MemoryBuffer's needed

Reimplemented from blender::compositor::NodeOperation.

Definition at line 83 of file COM_ViewerOperation.cc.

References alpha, buffer, blender::compositor::NodeOperation::getWidth(), blender::compositor::NodeOperation::isBraked(), blender::compositor::Nearest, blender::compositor::NodeOperation::readSampled(), x, x2, rcti::xmax, rcti::xmin, y, y1, rcti::ymax, and rcti::ymin.

◆ getCenterX()

float blender::compositor::ViewerOperation::getCenterX ( ) const
inline

Definition at line 93 of file COM_ViewerOperation.h.

◆ getCenterY()

float blender::compositor::ViewerOperation::getCenterY ( ) const
inline

Definition at line 97 of file COM_ViewerOperation.h.

◆ getChunkOrder()

ChunkOrdering blender::compositor::ViewerOperation::getChunkOrder ( ) const
inline

Definition at line 101 of file COM_ViewerOperation.h.

◆ getRenderPriority()

eCompositorPriority blender::compositor::ViewerOperation::getRenderPriority ( ) const
overridevirtual

get the render priority of this node.

Note
only applicable for output operations like ViewerOperation
Returns
eCompositorPriority

Reimplemented from blender::compositor::NodeOperation.

Definition at line 212 of file COM_ViewerOperation.cc.

References blender::compositor::High, isActiveViewerOutput(), and blender::compositor::Low.

◆ initExecution()

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

◆ isActiveViewerOutput()

bool blender::compositor::ViewerOperation::isActiveViewerOutput ( ) const
inlineoverridevirtual

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

Returns
[true:false]
See also
BaseViewerOperation

Reimplemented from blender::compositor::NodeOperation.

Definition at line 73 of file COM_ViewerOperation.h.

Referenced by getRenderPriority(), initExecution(), and isOutputOperation().

◆ isOutputOperation()

bool blender::compositor::ViewerOperation::isOutputOperation ( bool  ) const
inlineoverridevirtual

isOutputOperation determines whether this operation is an output of the ExecutionSystem during rendering or editing.

Default behavior if not overridden, this operation will not be evaluated as being an output of the ExecutionSystem.

See also
ExecutionSystem
Parameters
rendering[true false] true: rendering false: editing
Returns
bool the result of this method

Reimplemented from blender::compositor::NodeOperation.

Definition at line 58 of file COM_ViewerOperation.h.

References G, and isActiveViewerOutput().

◆ setActive()

void blender::compositor::ViewerOperation::setActive ( bool  active)
inline

◆ setCenterX()

void blender::compositor::ViewerOperation::setCenterX ( float  centerX)
inline

◆ setCenterY()

void blender::compositor::ViewerOperation::setCenterY ( float  centerY)
inline

◆ setChunkOrder()

void blender::compositor::ViewerOperation::setChunkOrder ( ChunkOrdering  tileOrder)
inline

◆ setDisplaySettings()

void blender::compositor::ViewerOperation::setDisplaySettings ( const ColorManagedDisplaySettings displaySettings)
inline

◆ setImage()

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

◆ setImageUser()

void blender::compositor::ViewerOperation::setImageUser ( ImageUser imageUser)
inline

◆ setRenderData()

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

◆ setUseAlphaInput()

void blender::compositor::ViewerOperation::setUseAlphaInput ( bool  value)
inline

◆ setViewName()

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

◆ setViewSettings()

void blender::compositor::ViewerOperation::setViewSettings ( const ColorManagedViewSettings viewSettings)
inline

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