diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_SocketReader.h')
-rw-r--r-- | source/blender/compositor/intern/COM_SocketReader.h | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/source/blender/compositor/intern/COM_SocketReader.h b/source/blender/compositor/intern/COM_SocketReader.h index af6b891e7ab..170b9e1bd35 100644 --- a/source/blender/compositor/intern/COM_SocketReader.h +++ b/source/blender/compositor/intern/COM_SocketReader.h @@ -37,31 +37,31 @@ typedef enum PixelSampler { class MemoryBuffer; /** - * @brief Helper class for reading socket data. + * \brief Helper class for reading socket data. * Only use this class for dispatching (un-ary and n-ary) executions. - * @ingroup Execution + * \ingroup Execution */ class SocketReader { private: protected: /** - * @brief Holds the width of the output of this operation. + * \brief Holds the width of the output of this operation. */ unsigned int m_width; /** - * @brief Holds the height of the output of this operation. + * \brief Holds the height of the output of this operation. */ unsigned int m_height; /** - * @brief calculate a single pixel - * @note this method is called for non-complex - * @param result is a float[4] array to store the result - * @param x the x-coordinate of the pixel to calculate in image space - * @param y the y-coordinate of the pixel to calculate in image space - * @param inputBuffers chunks that can be read by their ReadBufferOperation. + * \brief calculate a single pixel + * \note this method is called for non-complex + * \param result is a float[4] array to store the result + * \param x the x-coordinate of the pixel to calculate in image space + * \param y the y-coordinate of the pixel to calculate in image space + * \param inputBuffers chunks that can be read by their ReadBufferOperation. */ virtual void executePixelSampled(float /*output*/[4], float /*x*/, @@ -69,27 +69,27 @@ protected: PixelSampler /*sampler*/) { } /** - * @brief calculate a single pixel - * @note this method is called for complex - * @param result is a float[4] array to store the result - * @param x the x-coordinate of the pixel to calculate in image space - * @param y the y-coordinate of the pixel to calculate in image space - * @param inputBuffers chunks that can be read by their ReadBufferOperation. - * @param chunkData chunk specific data a during execution time. + * \brief calculate a single pixel + * \note this method is called for complex + * \param result is a float[4] array to store the result + * \param x the x-coordinate of the pixel to calculate in image space + * \param y the y-coordinate of the pixel to calculate in image space + * \param inputBuffers chunks that can be read by their ReadBufferOperation. + * \param chunkData chunk specific data a during execution time. */ virtual void executePixel(float output[4], int x, int y, void * /*chunkData*/) { executePixelSampled(output, x, y, COM_PS_NEAREST); } /** - * @brief calculate a single pixel using an EWA filter - * @note this method is called for complex - * @param result is a float[4] array to store the result - * @param x the x-coordinate of the pixel to calculate in image space - * @param y the y-coordinate of the pixel to calculate in image space - * @param dx - * @param dy - * @param inputBuffers chunks that can be read by their ReadBufferOperation. + * \brief calculate a single pixel using an EWA filter + * \note this method is called for complex + * \param result is a float[4] array to store the result + * \param x the x-coordinate of the pixel to calculate in image space + * \param y the y-coordinate of the pixel to calculate in image space + * \param dx + * \param dy + * \param inputBuffers chunks that can be read by their ReadBufferOperation. */ virtual void executePixelFiltered(float /*output*/[4], float /*x*/, float /*y*/, |