diff options
Diffstat (limited to 'source/blender/freestyle/intern/image')
| -rw-r--r-- | source/blender/freestyle/intern/image/GaussianFilter.h | 8 | ||||
| -rw-r--r-- | source/blender/freestyle/intern/image/Image.h | 36 | ||||
| -rw-r--r-- | source/blender/freestyle/intern/image/ImagePyramid.h | 12 |
3 files changed, 28 insertions, 28 deletions
diff --git a/source/blender/freestyle/intern/image/GaussianFilter.h b/source/blender/freestyle/intern/image/GaussianFilter.h index ff765e619a8..2cb3e7d7ac5 100644 --- a/source/blender/freestyle/intern/image/GaussianFilter.h +++ b/source/blender/freestyle/intern/image/GaussianFilter.h @@ -54,7 +54,7 @@ class GaussianFilter { GaussianFilter &operator=(const GaussianFilter &); virtual ~GaussianFilter(); - /*! Returns the value for pixel x,y of image "map" after a gaussian blur, made using the sigma + /** Returns the value for pixel x,y of image "map" after a gaussian blur, made using the sigma * value. The sigma value determines the mask size (~ 2 x sigma). * \param map: The image we wish to work on. * The Map template must implement the following methods: @@ -70,12 +70,12 @@ class GaussianFilter { */ template<class Map> float getSmoothedPixel(Map *map, int x, int y); - /*! Compute the mask size and returns the REAL mask size ((2*_maskSize)-1) + /** Compute the mask size and returns the REAL mask size ((2*_maskSize)-1) * This method is provided for convenience. */ static int computeMaskSize(float sigma); - /*! accessors */ + /** accessors */ inline float sigma() const { return _sigma; @@ -91,7 +91,7 @@ class GaussianFilter { return _bound; } - /*! modifiers */ + /** modifiers */ void setSigma(float sigma); #if 0 void SetMaskSize(int size) diff --git a/source/blender/freestyle/intern/image/Image.h b/source/blender/freestyle/intern/image/Image.h index 385e243a1a2..21cb435b13a 100644 --- a/source/blender/freestyle/intern/image/Image.h +++ b/source/blender/freestyle/intern/image/Image.h @@ -34,14 +34,14 @@ namespace Freestyle { // /////////////////////////////////////////////////////////////////////////////// -/*! This class allows the storing of part of an image, while allowing a normal access to its pixel +/** This class allows the storing of part of an image, while allowing a normal access to its pixel * values. You can for example only a rectangle of sw*sh, whose lower-left corner is at (ox, oy), * of an image of size w*h, and access these pixels using x,y coordinates specified in the whole * image coordinate system. */ class FrsImage { public: - /*! Default constructor */ + /** Default constructor */ FrsImage() { _storedWidth = 0; @@ -52,7 +52,7 @@ class FrsImage { _Oy = 0; } - /*! Copy constructor */ + /** Copy constructor */ FrsImage(const FrsImage &brother) { _storedWidth = brother._storedWidth; @@ -63,7 +63,7 @@ class FrsImage { _Oy = brother._Oy; } - /*! Builds an FrsImage from its width and height. + /** Builds an FrsImage from its width and height. * The memory is allocated consequently. */ FrsImage(unsigned w, unsigned h) @@ -76,7 +76,7 @@ class FrsImage { _Oy = 0; } - /*! Builds a partial-storing image. + /** Builds a partial-storing image. * \param w: * The width of the complete image * \param h: @@ -100,7 +100,7 @@ class FrsImage { _Oy = oy; } - /*! Operator= */ + /** Operator= */ FrsImage &operator=(const FrsImage &brother) { _width = brother._width; @@ -112,27 +112,27 @@ class FrsImage { return *this; } - /*! Destructor */ + /** Destructor */ virtual ~FrsImage() { } - /*! Returns the width of the complete image */ + /** Returns the width of the complete image */ inline unsigned width() const { return _width; } - /*! Returns the height of the complete image */ + /** Returns the height of the complete image */ inline unsigned height() const { return _height; } - /*! Returns the gray value for pixel x,y */ + /** Returns the gray value for pixel x,y */ virtual float pixel(unsigned x, unsigned y) const = 0; - /*! Sets the array. + /** Sets the array. * \param array: * The array containing the values we wish to store. * Its size is sw*sh. @@ -160,7 +160,7 @@ class FrsImage { unsigned y, bool copy = true) = 0; - /*! Returns the array containing the pixels values. + /** Returns the array containing the pixels values. * Its size is sw*sh, i.e. potentially a smaller rectangular part of the complete image. */ virtual float *getArray() = 0; @@ -206,7 +206,7 @@ class RGBImage : public FrsImage { memcpy(_rgb, rgb, 3 * _width * _height * sizeof(float)); } - /*! Builds an RGB partial image from the useful part buffer. + /** Builds an RGB partial image from the useful part buffer. * \param rgb: * The array of size 3*sw*sh containing the RGB values of the sw*sh pixels we need to stored. * These sw*sh pixels constitute a rectangular part of a bigger @@ -279,7 +279,7 @@ class RGBImage : public FrsImage { return res / 32.0f; } - /*! Sets the RGB array. + /** Sets the RGB array. * copy * If true, the array is copied, otherwise the pointer is copied */ @@ -333,7 +333,7 @@ class GrayImage : public FrsImage { memcpy(_lvl, brother._lvl, _storedWidth * _storedHeight * sizeof(*_lvl)); } - /*! Builds an empty gray image */ + /** Builds an empty gray image */ GrayImage(unsigned w, unsigned h) : FrsImage(w, h) { _lvl = new float[_width * _height]; @@ -345,7 +345,7 @@ class GrayImage : public FrsImage { memcpy(_lvl, lvl, _width * _height * sizeof(*_lvl)); } - /*! Builds a partial image from the useful part buffer. + /** Builds a partial image from the useful part buffer. * \param lvl: * The array of size sw*sh containing the gray values of the sw*sh pixels we need to stored. * These sw*sh pixels constitute a rectangular part of a bigger @@ -391,7 +391,7 @@ class GrayImage : public FrsImage { return _lvl[(y - _Oy) * _storedWidth + (x - _Ox)]; } - /*! Sets the array. + /** Sets the array. * copy * If true, the array is copied, otherwise the pounsigneder is copied */ @@ -418,7 +418,7 @@ class GrayImage : public FrsImage { memcpy(_lvl, lvl, _storedWidth * _storedHeight * sizeof(float)); } - /*! Returns the array containing the gray values. */ + /** Returns the array containing the gray values. */ virtual float *getArray() { return _lvl; diff --git a/source/blender/freestyle/intern/image/ImagePyramid.h b/source/blender/freestyle/intern/image/ImagePyramid.h index 3b4e5eda52a..66df1ec728a 100644 --- a/source/blender/freestyle/intern/image/ImagePyramid.h +++ b/source/blender/freestyle/intern/image/ImagePyramid.h @@ -45,17 +45,17 @@ class ImagePyramid { // ImagePyramid(const GrayImage& level0, unsigned nbLevels); virtual ~ImagePyramid(); - /*! Builds the pyramid. + /** Builds the pyramid. * must be overloaded by inherited classes. * if nbLevels==0, the complete pyramid is built */ virtual void BuildPyramid(const GrayImage &level0, unsigned nbLevels) = 0; - /*! Builds a pyramid without copying the base level */ + /** Builds a pyramid without copying the base level */ virtual void BuildPyramid(GrayImage *level0, unsigned nbLevels) = 0; virtual GrayImage *getLevel(int l); - /*! Returns the pixel x,y using bilinear interpolation. + /** Returns the pixel x,y using bilinear interpolation. * \param x: * the abscissa specified in the finest level coordinate system * \param y: @@ -65,13 +65,13 @@ class ImagePyramid { */ virtual float pixel(int x, int y, int level = 0); - /*! Returns the width of the level-th level image */ + /** Returns the width of the level-th level image */ virtual int width(int level = 0); - /*! Returns the height of the level-th level image */ + /** Returns the height of the level-th level image */ virtual int height(int level = 0); - /*! Returns the number of levels in the pyramid */ + /** Returns the number of levels in the pyramid */ inline int getNumberOfLevels() const { return _levels.size(); |