diff options
Diffstat (limited to 'source/blender/compositor/operations')
24 files changed, 97 insertions, 97 deletions
diff --git a/source/blender/compositor/operations/COM_AntiAliasOperation.h b/source/blender/compositor/operations/COM_AntiAliasOperation.h index 34243cd34b6..25781196b1f 100644 --- a/source/blender/compositor/operations/COM_AntiAliasOperation.h +++ b/source/blender/compositor/operations/COM_AntiAliasOperation.h @@ -26,14 +26,14 @@ #include "DNA_node_types.h" /** - * @brief AntiAlias operations + * \brief AntiAlias operations * it only supports anti aliasing on BW buffers. - * @ingroup operation + * \ingroup operation */ class AntiAliasOperation : public NodeOperation { protected: /** - * @brief Cached reference to the reader + * \brief Cached reference to the reader */ SocketReader *m_valueReader; public: diff --git a/source/blender/compositor/operations/COM_BokehImageOperation.h b/source/blender/compositor/operations/COM_BokehImageOperation.h index c6ca7054352..d26f3f7066c 100644 --- a/source/blender/compositor/operations/COM_BokehImageOperation.h +++ b/source/blender/compositor/operations/COM_BokehImageOperation.h @@ -25,7 +25,7 @@ #include "COM_NodeOperation.h" /** - * @brief The BokehImageOperation class is an operation that creates an image useful to mimic the internals + * \brief The BokehImageOperation class is an operation that creates an image useful to mimic the internals *of a camera. * * features: @@ -53,91 +53,91 @@ class BokehImageOperation : public NodeOperation { private: /** - * @brief Settings of the bokeh image + * \brief Settings of the bokeh image */ NodeBokehImage *m_data; /** - * @brief precalced center of the image + * \brief precalced center of the image */ float m_center[2]; /** - * @brief 1.0-rounding + * \brief 1.0-rounding */ float m_inverseRounding; /** - * @brief distance of a full circle lens + * \brief distance of a full circle lens */ float m_circularDistance; /** - * @brief radius when the first flap starts + * \brief radius when the first flap starts */ float m_flapRad; /** - * @brief radians of a single flap + * \brief radians of a single flap */ float m_flapRadAdd; /** - * @brief should the m_data field by deleted when this operation is finished + * \brief should the m_data field by deleted when this operation is finished */ bool m_deleteData; /** - * @brief determine the coordinate of a flap cornder + * \brief determine the coordinate of a flap cornder * - * @param r result in bokehimage space are stored [x,y] - * @param flapNumber the flap number to calculate - * @param distance the lens distance is used to simulate lens shifts + * \param r result in bokehimage space are stored [x,y] + * \param flapNumber the flap number to calculate + * \param distance the lens distance is used to simulate lens shifts */ void detemineStartPointOfFlap(float r[2], int flapNumber, float distance); /** - * @brief Determine if a coordinate is inside the bokeh image + * \brief Determine if a coordinate is inside the bokeh image * - * @param distance the distance that will be used. This parameter is modified a bit to mimic lens shifts - * @param x the x coordinate of the pixel to evaluate - * @param y the y coordinate of the pixel to evaluate - * @return float range 0..1 0 is completely outside + * \param distance the distance that will be used. This parameter is modified a bit to mimic lens shifts + * \param x the x coordinate of the pixel to evaluate + * \param y the y coordinate of the pixel to evaluate + * \return float range 0..1 0 is completely outside */ float isInsideBokeh(float distance, float x, float y); public: BokehImageOperation(); /** - * @brief the inner loop of this program + * \brief the inner loop of this program */ void executePixelSampled(float output[4], float x, float y, PixelSampler sampler); /** - * @brief Initialize the execution + * \brief Initialize the execution */ void initExecution(); /** - * @brief Deinitialize the execution + * \brief Deinitialize the execution */ void deinitExecution(); /** - * @brief determine the resolution of this operation. currently fixed at [COM_BLUR_BOKEH_PIXELS, COM_BLUR_BOKEH_PIXELS] - * @param resolution - * @param preferredResolution + * \brief determine the resolution of this operation. currently fixed at [COM_BLUR_BOKEH_PIXELS, COM_BLUR_BOKEH_PIXELS] + * \param resolution + * \param preferredResolution */ void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); /** - * @brief set the node data - * @param data + * \brief set the node data + * \param data */ void setData(NodeBokehImage *data) { this->m_data = data; } /** - * @brief deleteDataOnFinish + * \brief deleteDataOnFinish * * There are cases that the compositor uses this operation on its own (see defocus node) * the deleteDataOnFinish must only be called when the data has been created by the compositor. diff --git a/source/blender/compositor/operations/COM_CalculateMeanOperation.h b/source/blender/compositor/operations/COM_CalculateMeanOperation.h index 1872cb738b2..265057b6536 100644 --- a/source/blender/compositor/operations/COM_CalculateMeanOperation.h +++ b/source/blender/compositor/operations/COM_CalculateMeanOperation.h @@ -26,13 +26,13 @@ #include "DNA_node_types.h" /** - * @brief base class of CalculateMean, implementing the simple CalculateMean - * @ingroup operation + * \brief base class of CalculateMean, implementing the simple CalculateMean + * \ingroup operation */ class CalculateMeanOperation : public NodeOperation { protected: /** - * @brief Cached reference to the reader + * \brief Cached reference to the reader */ SocketReader *m_imageReader; diff --git a/source/blender/compositor/operations/COM_CalculateStandardDeviationOperation.h b/source/blender/compositor/operations/COM_CalculateStandardDeviationOperation.h index 7089e40b210..2d357f30f7b 100644 --- a/source/blender/compositor/operations/COM_CalculateStandardDeviationOperation.h +++ b/source/blender/compositor/operations/COM_CalculateStandardDeviationOperation.h @@ -26,8 +26,8 @@ #include "DNA_node_types.h" #include "COM_CalculateMeanOperation.h" /** - * @brief base class of CalculateStandardDeviation, implementing the simple CalculateStandardDeviation - * @ingroup operation + * \brief base class of CalculateStandardDeviation, implementing the simple CalculateStandardDeviation + * \ingroup operation */ class CalculateStandardDeviationOperation : public CalculateMeanOperation { protected: diff --git a/source/blender/compositor/operations/COM_CompositorOperation.h b/source/blender/compositor/operations/COM_CompositorOperation.h index 19ed3180ace..2645c69579d 100644 --- a/source/blender/compositor/operations/COM_CompositorOperation.h +++ b/source/blender/compositor/operations/COM_CompositorOperation.h @@ -29,58 +29,58 @@ struct Scene; /** - * @brief Compositor output operation + * \brief Compositor output operation */ class CompositorOperation : public NodeOperation { private: const struct Scene *m_scene; /** - * @brief Scene name, used for getting the render output, includes 'SC' prefix. + * \brief Scene name, used for getting the render output, includes 'SC' prefix. */ char m_sceneName[MAX_ID_NAME]; /** - * @brief local reference to the scene + * \brief local reference to the scene */ const RenderData *m_rd; /** - * @brief reference to the output float buffer + * \brief reference to the output float buffer */ float *m_outputBuffer; /** - * @brief reference to the output depth float buffer + * \brief reference to the output depth float buffer */ float *m_depthBuffer; /** - * @brief local reference to the input image operation + * \brief local reference to the input image operation */ SocketReader *m_imageInput; /** - * @brief local reference to the input alpha operation + * \brief local reference to the input alpha operation */ SocketReader *m_alphaInput; /** - * @brief local reference to the depth operation + * \brief local reference to the depth operation */ SocketReader *m_depthInput; /** - * @brief Ignore any alpha input + * \brief Ignore any alpha input */ bool m_useAlphaInput; /** - * @brief operation is active for calculating final compo result + * \brief operation is active for calculating final compo result */ bool m_active; /** - * @brief View name, used for multiview + * \brief View name, used for multiview */ const char *m_viewName; public: diff --git a/source/blender/compositor/operations/COM_ConvertColorProfileOperation.h b/source/blender/compositor/operations/COM_ConvertColorProfileOperation.h index 3dc7b67df8d..3b7272e86f6 100644 --- a/source/blender/compositor/operations/COM_ConvertColorProfileOperation.h +++ b/source/blender/compositor/operations/COM_ConvertColorProfileOperation.h @@ -37,17 +37,17 @@ private: SocketReader *m_inputOperation; /** - * @brief color profile where to convert from + * \brief color profile where to convert from */ int m_fromProfile; /** - * @brief color profile where to convert to + * \brief color profile where to convert to */ int m_toProfile; /** - * @brief is color predivided + * \brief is color predivided */ bool m_predivided; public: diff --git a/source/blender/compositor/operations/COM_DotproductOperation.cpp b/source/blender/compositor/operations/COM_DotproductOperation.cpp index e2e54ee4aa7..a0cde948d25 100644 --- a/source/blender/compositor/operations/COM_DotproductOperation.cpp +++ b/source/blender/compositor/operations/COM_DotproductOperation.cpp @@ -43,7 +43,7 @@ void DotproductOperation::deinitExecution() this->m_input2Operation = NULL; } -/** @todo: current implementation is the inverse of a dotproduct. not 'logically' correct +/** \todo: current implementation is the inverse of a dotproduct. not 'logically' correct */ void DotproductOperation::executePixelSampled(float output[4], float x, float y, PixelSampler sampler) { diff --git a/source/blender/compositor/operations/COM_GaussianAlphaXBlurOperation.h b/source/blender/compositor/operations/COM_GaussianAlphaXBlurOperation.h index 985f56e3ef6..50b3d68426c 100644 --- a/source/blender/compositor/operations/COM_GaussianAlphaXBlurOperation.h +++ b/source/blender/compositor/operations/COM_GaussianAlphaXBlurOperation.h @@ -38,17 +38,17 @@ public: GaussianAlphaXBlurOperation(); /** - * @brief the inner loop of this program + * \brief the inner loop of this program */ void executePixel(float output[4], int x, int y, void *data); /** - * @brief initialize the execution + * \brief initialize the execution */ void initExecution(); /** - * @brief Deinitialize the execution + * \brief Deinitialize the execution */ void deinitExecution(); diff --git a/source/blender/compositor/operations/COM_GaussianAlphaYBlurOperation.h b/source/blender/compositor/operations/COM_GaussianAlphaYBlurOperation.h index 3935dcd6568..30672ad5ab2 100644 --- a/source/blender/compositor/operations/COM_GaussianAlphaYBlurOperation.h +++ b/source/blender/compositor/operations/COM_GaussianAlphaYBlurOperation.h @@ -43,7 +43,7 @@ public: void executePixel(float output[4], int x, int y, void *data); /** - * @brief initialize the execution + * \brief initialize the execution */ void initExecution(); diff --git a/source/blender/compositor/operations/COM_GaussianXBlurOperation.h b/source/blender/compositor/operations/COM_GaussianXBlurOperation.h index 88d8ed44de6..6e7c9adbd9b 100644 --- a/source/blender/compositor/operations/COM_GaussianXBlurOperation.h +++ b/source/blender/compositor/operations/COM_GaussianXBlurOperation.h @@ -37,7 +37,7 @@ public: GaussianXBlurOperation(); /** - * @brief the inner loop of this program + * \brief the inner loop of this program */ void executePixel(float output[4], int x, int y, void *data); @@ -47,12 +47,12 @@ public: list<cl_kernel> *clKernelsToCleanUp); /** - * @brief initialize the execution + * \brief initialize the execution */ void initExecution(); /** - * @brief Deinitialize the execution + * \brief Deinitialize the execution */ void deinitExecution(); diff --git a/source/blender/compositor/operations/COM_GaussianYBlurOperation.h b/source/blender/compositor/operations/COM_GaussianYBlurOperation.h index 5df77eb28ce..00f9ebcd21f 100644 --- a/source/blender/compositor/operations/COM_GaussianYBlurOperation.h +++ b/source/blender/compositor/operations/COM_GaussianYBlurOperation.h @@ -47,7 +47,7 @@ public: list<cl_kernel> *clKernelsToCleanUp); /** - * @brief initialize the execution + * \brief initialize the execution */ void initExecution(); diff --git a/source/blender/compositor/operations/COM_GlareBaseOperation.h b/source/blender/compositor/operations/COM_GlareBaseOperation.h index 3fa676f4d31..413d495f670 100644 --- a/source/blender/compositor/operations/COM_GlareBaseOperation.h +++ b/source/blender/compositor/operations/COM_GlareBaseOperation.h @@ -39,12 +39,12 @@ typedef float fRGB[4]; class GlareBaseOperation : public SingleThreadedOperation { private: /** - * @brief Cached reference to the inputProgram + * \brief Cached reference to the inputProgram */ SocketReader *m_inputProgram; /** - * @brief settings of the glare node. + * \brief settings of the glare node. */ NodeGlare *m_settings; public: diff --git a/source/blender/compositor/operations/COM_GlareThresholdOperation.h b/source/blender/compositor/operations/COM_GlareThresholdOperation.h index 9a922a5889c..7934dd20524 100644 --- a/source/blender/compositor/operations/COM_GlareThresholdOperation.h +++ b/source/blender/compositor/operations/COM_GlareThresholdOperation.h @@ -28,12 +28,12 @@ class GlareThresholdOperation : public NodeOperation { private: /** - * @brief Cached reference to the inputProgram + * \brief Cached reference to the inputProgram */ SocketReader *m_inputProgram; /** - * @brief settings of the glare node. + * \brief settings of the glare node. */ NodeGlare *m_settings; public: diff --git a/source/blender/compositor/operations/COM_ImageOperation.h b/source/blender/compositor/operations/COM_ImageOperation.h index 60172eb6413..40928484dbb 100644 --- a/source/blender/compositor/operations/COM_ImageOperation.h +++ b/source/blender/compositor/operations/COM_ImageOperation.h @@ -35,7 +35,7 @@ extern "C" { } /** - * @brief Base class for all image operations + * \brief Base class for all image operations */ class BaseImageOperation : public NodeOperation { protected: diff --git a/source/blender/compositor/operations/COM_MapValueOperation.h b/source/blender/compositor/operations/COM_MapValueOperation.h index 33513c6f39c..c057ffe606a 100644 --- a/source/blender/compositor/operations/COM_MapValueOperation.h +++ b/source/blender/compositor/operations/COM_MapValueOperation.h @@ -58,7 +58,7 @@ public: void deinitExecution(); /** - * @brief set the TexMapping settings + * \brief set the TexMapping settings */ void setSettings(TexMapping *settings) { this->m_settings = settings; } diff --git a/source/blender/compositor/operations/COM_NormalizeOperation.h b/source/blender/compositor/operations/COM_NormalizeOperation.h index de1a23926f4..cebfad5dd17 100644 --- a/source/blender/compositor/operations/COM_NormalizeOperation.h +++ b/source/blender/compositor/operations/COM_NormalizeOperation.h @@ -25,18 +25,18 @@ #include "DNA_node_types.h" /** - * @brief base class of normalize, implementing the simple normalize - * @ingroup operation + * \brief base class of normalize, implementing the simple normalize + * \ingroup operation */ class NormalizeOperation : public NodeOperation { protected: /** - * @brief Cached reference to the reader + * \brief Cached reference to the reader */ SocketReader *m_imageReader; /** - * @brief temporarily cache of the execution storage + * \brief temporarily cache of the execution storage * it stores x->min and y->mult */ NodeTwoFloats *m_cachedInstance; diff --git a/source/blender/compositor/operations/COM_PixelateOperation.h b/source/blender/compositor/operations/COM_PixelateOperation.h index 5b08cb429f4..59337f11b54 100644 --- a/source/blender/compositor/operations/COM_PixelateOperation.h +++ b/source/blender/compositor/operations/COM_PixelateOperation.h @@ -26,7 +26,7 @@ #include "COM_NodeOperation.h" /** - * @brief Pixelate operation + * \brief Pixelate operation * * The Tile compositor is by default sub-pixel accurate. * For some setups you don want this. @@ -35,32 +35,32 @@ class PixelateOperation : public NodeOperation { private: /** - * @brief cached reference to the input operation + * \brief cached reference to the input operation */ SocketReader *m_inputOperation; public: /** - * @brief PixelateOperation - * @param dataType the datatype to create this operator for (saves datatype conversions) + * \brief PixelateOperation + * \param dataType the datatype to create this operator for (saves datatype conversions) */ PixelateOperation(DataType dataType); /** - * @brief initialization of the execution + * \brief initialization of the execution */ void initExecution(); /** - * @brief de-initialization of the execution + * \brief de-initialization of the execution */ void deinitExecution(); /** - * @brief executePixel - * @param output result - * @param x x-coordinate - * @param y y-coordinate - * @param sampler sampler + * \brief executePixel + * \param output result + * \param x x-coordinate + * \param y y-coordinate + * \param sampler sampler */ void executePixelSampled(float output[4], float x, float y, PixelSampler sampler); }; diff --git a/source/blender/compositor/operations/COM_PreviewOperation.h b/source/blender/compositor/operations/COM_PreviewOperation.h index 75317748897..cf447dd8e99 100644 --- a/source/blender/compositor/operations/COM_PreviewOperation.h +++ b/source/blender/compositor/operations/COM_PreviewOperation.h @@ -33,7 +33,7 @@ protected: unsigned char *m_outputBuffer; /** - * @brief holds reference to the SDNA bNode, where this nodes will render the preview image for + * \brief holds reference to the SDNA bNode, where this nodes will render the preview image for */ bNodePreview *m_preview; SocketReader *m_input; diff --git a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp index 6e7a32ba5a9..277b3606ff9 100644 --- a/source/blender/compositor/operations/COM_ReadBufferOperation.cpp +++ b/source/blender/compositor/operations/COM_ReadBufferOperation.cpp @@ -44,7 +44,7 @@ void ReadBufferOperation::determineResolution(unsigned int resolution[2], unsign operation->determineResolution(resolution, preferredResolution); operation->setResolution(resolution); - /// @todo: may not occur!, but does with blur node + /// \todo: may not occur!, but does with blur node if (this->m_memoryProxy->getExecutor()) { this->m_memoryProxy->getExecutor()->setResolution(resolution); } diff --git a/source/blender/compositor/operations/COM_RenderLayersProg.h b/source/blender/compositor/operations/COM_RenderLayersProg.h index 2a0f7efc9f8..b5946d44f74 100644 --- a/source/blender/compositor/operations/COM_RenderLayersProg.h +++ b/source/blender/compositor/operations/COM_RenderLayersProg.h @@ -36,7 +36,7 @@ extern "C" { /** * Base class for all renderlayeroperations * - * @todo: rename to operation. + * \todo: rename to operation. */ class RenderLayersProg : public NodeOperation { protected: @@ -68,7 +68,7 @@ protected: int m_elementsize; /** - * @brief render data used for active rendering + * \brief render data used for active rendering */ const RenderData *m_rd; @@ -90,7 +90,7 @@ public: RenderLayersProg(const char *passName, DataType type, int elementsize); /** * setter for the scene field. Will be called from - * @see RenderLayerNode to set the actual scene where + * \see RenderLayerNode to set the actual scene where * the data will be retrieved from. */ void setScene(Scene *scene) { this->m_scene = scene; } diff --git a/source/blender/compositor/operations/COM_TextureOperation.h b/source/blender/compositor/operations/COM_TextureOperation.h index 9f0f539800d..434f590a65d 100644 --- a/source/blender/compositor/operations/COM_TextureOperation.h +++ b/source/blender/compositor/operations/COM_TextureOperation.h @@ -37,7 +37,7 @@ extern "C" { /** * Base class for all renderlayeroperations * - * @todo: rename to operation. + * \todo: rename to operation. */ class TextureBaseOperation : public NodeOperation { private: diff --git a/source/blender/compositor/operations/COM_TonemapOperation.h b/source/blender/compositor/operations/COM_TonemapOperation.h index 2b07ded7305..c205785b023 100644 --- a/source/blender/compositor/operations/COM_TonemapOperation.h +++ b/source/blender/compositor/operations/COM_TonemapOperation.h @@ -26,8 +26,8 @@ #include "DNA_node_types.h" /** - * @brief temporarily storage during execution of Tonemap - * @ingroup operation + * \brief temporarily storage during execution of Tonemap + * \ingroup operation */ typedef struct AvgLogLum { float al; @@ -38,23 +38,23 @@ typedef struct AvgLogLum { } AvgLogLum; /** - * @brief base class of tonemap, implementing the simple tonemap - * @ingroup operation + * \brief base class of tonemap, implementing the simple tonemap + * \ingroup operation */ class TonemapOperation : public NodeOperation { protected: /** - * @brief Cached reference to the reader + * \brief Cached reference to the reader */ SocketReader *m_imageReader; /** - * @brief settings of the Tonemap + * \brief settings of the Tonemap */ NodeTonemap *m_data; /** - * @brief temporarily cache of the execution storage + * \brief temporarily cache of the execution storage */ AvgLogLum *m_cachedInstance; @@ -85,9 +85,9 @@ public: }; /** - * @brief class of tonemap, implementing the photoreceptor tonemap + * \brief class of tonemap, implementing the photoreceptor tonemap * most parts have already been done in TonemapOperation - * @ingroup operation + * \ingroup operation */ class PhotoreceptorTonemapOperation : public TonemapOperation { diff --git a/source/blender/compositor/operations/COM_VectorBlurOperation.h b/source/blender/compositor/operations/COM_VectorBlurOperation.h index a33761166c6..fe8e9f20edb 100644 --- a/source/blender/compositor/operations/COM_VectorBlurOperation.h +++ b/source/blender/compositor/operations/COM_VectorBlurOperation.h @@ -29,14 +29,14 @@ class VectorBlurOperation : public NodeOperation, public QualityStepHelper { private: /** - * @brief Cached reference to the inputProgram + * \brief Cached reference to the inputProgram */ SocketReader *m_inputImageProgram; SocketReader *m_inputSpeedProgram; SocketReader *m_inputZProgram; /** - * @brief settings of the glare node. + * \brief settings of the glare node. */ NodeBlurData *m_settings; diff --git a/source/blender/compositor/operations/COM_WriteBufferOperation.h b/source/blender/compositor/operations/COM_WriteBufferOperation.h index 583d58e7b99..639d1ba1d98 100644 --- a/source/blender/compositor/operations/COM_WriteBufferOperation.h +++ b/source/blender/compositor/operations/COM_WriteBufferOperation.h @@ -27,8 +27,8 @@ #include "COM_MemoryProxy.h" #include "COM_SocketReader.h" /** - * @brief NodeOperation to write to a tile - * @ingroup Operation + * \brief NodeOperation to write to a tile + * \ingroup Operation */ class WriteBufferOperation : public NodeOperation { MemoryProxy *m_memoryProxy; |