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

#include <COM_OutputFileOperation.h>

Inherits blender::compositor::NodeOperation.

Inherited by blender::compositor::OutputOpenExrSingleLayerMultiViewOperation, and blender::compositor::OutputStereoOperation.

Public Member Functions

 OutputSingleLayerOperation (const RenderData *rd, const bNodeTree *tree, DataType datatype, ImageFormatData *format, const char *path, const ColorManagedViewSettings *viewSettings, const ColorManagedDisplaySettings *displaySettings, const char *viewName, const bool saveAsRender)
 
void executeRegion (rcti *rect, unsigned int tileNumber) override
 when a chunk is executed by a CPUDevice, this method is called More...
 
bool isOutputOperation (bool) const override
 isOutputOperation determines whether this operation is an output of the ExecutionSystem during rendering or editing. More...
 
void initExecution () override
 
void deinitExecution () override
 
eCompositorPriority getRenderPriority () const override
 get the render priority of this node. 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...
 
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 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...
 
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

const RenderDatam_rd
 
const bNodeTreem_tree
 
ImageFormatDatam_format
 
char m_path [FILE_MAX]
 
floatm_outputBuffer
 
DataType m_datatype
 
SocketReaderm_imageInput
 
const ColorManagedViewSettingsm_viewSettings
 
const ColorManagedDisplaySettingsm_displaySettings
 
const char * m_viewName
 
bool m_saveAsRender
 
- 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 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...
 

Detailed Description

Definition at line 33 of file COM_OutputFileOperation.h.

Constructor & Destructor Documentation

◆ OutputSingleLayerOperation()

blender::compositor::OutputSingleLayerOperation::OutputSingleLayerOperation ( const RenderData rd,
const bNodeTree tree,
DataType  datatype,
ImageFormatData format,
const char *  path,
const ColorManagedViewSettings viewSettings,
const ColorManagedDisplaySettings displaySettings,
const char *  viewName,
const bool  saveAsRender 
)

Member Function Documentation

◆ deinitExecution()

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

◆ executeRegion()

void blender::compositor::OutputSingleLayerOperation::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 246 of file COM_OutputFileOperation.cc.

References blender::compositor::NodeOperation::getWidth(), m_datatype, m_imageInput, m_outputBuffer, m_tree, and blender::compositor::write_buffer_rect().

◆ getRenderPriority()

eCompositorPriority blender::compositor::OutputSingleLayerOperation::getRenderPriority ( ) const
inlineoverridevirtual

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 69 of file COM_OutputFileOperation.h.

References blender::compositor::Low.

◆ initExecution()

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

◆ isOutputOperation()

bool blender::compositor::OutputSingleLayerOperation::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 63 of file COM_OutputFileOperation.h.

Member Data Documentation

◆ m_datatype

DataType blender::compositor::OutputSingleLayerOperation::m_datatype
protected

◆ m_displaySettings

const ColorManagedDisplaySettings* blender::compositor::OutputSingleLayerOperation::m_displaySettings
protected

◆ m_format

ImageFormatData* blender::compositor::OutputSingleLayerOperation::m_format
protected

◆ m_imageInput

SocketReader* blender::compositor::OutputSingleLayerOperation::m_imageInput
protected

◆ m_outputBuffer

float* blender::compositor::OutputSingleLayerOperation::m_outputBuffer
protected

◆ m_path

char blender::compositor::OutputSingleLayerOperation::m_path[FILE_MAX]
protected

◆ m_rd

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

◆ m_saveAsRender

bool blender::compositor::OutputSingleLayerOperation::m_saveAsRender
protected

Definition at line 49 of file COM_OutputFileOperation.h.

Referenced by deinitExecution(), and OutputSingleLayerOperation().

◆ m_tree

const bNodeTree* blender::compositor::OutputSingleLayerOperation::m_tree
protected

Definition at line 36 of file COM_OutputFileOperation.h.

Referenced by executeRegion(), and OutputSingleLayerOperation().

◆ m_viewName

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

◆ m_viewSettings

const ColorManagedViewSettings* blender::compositor::OutputSingleLayerOperation::m_viewSettings
protected

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