kalos::Kaleidoscope Class Reference

Kaleidoscope effect generator. More...

#include <kaleidoscope.hpp>

Public Member Functions
	Kaleidoscope (int nImage, int width, int height, int nComponents, double scaleDown, double dimConst)
	Construct a new Kaleidoscope object. More...
void	processImage (uint8_t *inImg, uint8_t *outImg, size_t size, double dimConst)
	Creates kaleidoscope effect. More...
void	processImage (uint8_t *inImg, uint8_t *outImg, size_t size)
	Creates kaleidoscope effect. Uses dim constant provided in constructor. More...
	~Kaleidoscope ()
	Destroy the Kaleidoscope object. More...

Detailed Description

Kaleidoscope effect generator.

Definition at line 15 of file kaleidoscope.hpp.

Constructor & Destructor Documentation

Kaleidoscope()

kalos::Kaleidoscope::Kaleidoscope ( int  nImage, int  width, int  height, int  nComponents, double  scaleDown, double  dimConst  )

inline

Construct a new Kaleidoscope object.

Parameters

[in]	nImage	Number of images for effect
[in]	width	Image width
[in]	height	Image height
[in]	nComponents	Number of color components (eg 3 for RGB)
[in]	scaleDown	Scale down ratio to shrink image. Must be between 0.0 and 1.0
[in]	dimConst	Variable to dim background. Should be between 0.0 and 1.0

Definition at line 31 of file kaleidoscope.hpp.

            : k(dimConst)
        {
            if (initKaleidoscope(&handler, nImage, width, height, nComponents, scaleDown) != 0)
                throw std::runtime_error("Can't init kaleidoscope structure for these inputs");
        }

~Kaleidoscope()

kalos::Kaleidoscope::~Kaleidoscope ( )

inline

Destroy the Kaleidoscope object.

Definition at line 61 of file kaleidoscope.hpp.

{ deInitKaleidoscope(&handler); }

Member Function Documentation

processImage() [1/2]

void kalos::Kaleidoscope::processImage ( uint8_t *  inImg, uint8_t *  outImg, size_t  size  )

inline

Creates kaleidoscope effect. Uses dim constant provided in constructor.

Parameters

inImg	Input image
outImg	Output image
size	Size of the images

Definition at line 56 of file kaleidoscope.hpp.

{ processImage(inImg, outImg, size, k); }

processImage() [2/2]

void kalos::Kaleidoscope::processImage ( uint8_t *  inImg, uint8_t *  outImg, size_t  size, double  dimConst  )

inline

Creates kaleidoscope effect.

Parameters

inImg	Input image
outImg	Output image
size	Size of the images
dimConst	Variable to dim background. Should be between 0.0 and 1.0

Definition at line 45 of file kaleidoscope.hpp.

        {
            processKaleidoscope(&handler, dimConst, inImg, outImg);
        }

---

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

• include/kaleidoscope.hpp