diff options
Diffstat (limited to 'source/blender/compositor/operations/COM_BokehImageOperation.h')
| -rw-r--r-- | source/blender/compositor/operations/COM_BokehImageOperation.h | 52 |
1 files changed, 26 insertions, 26 deletions
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. |