Beatmup::SingleByteMaskReader Class Reference

Mask reqding interface to single byte bitmap. More...

#include <mask_bitmap_access.h>

Inheritance diagram for Beatmup::SingleByteMaskReader:

Public Member Functions
unsigned char	getValue () const
	Returns 0..MAX_UNNORM_VALUE value at current position. More...
unsigned char	getValue (int i) const
	Returns 0..MAX_UNNORM_VALUE value at position shifted by i pixels in scanline order with respect to the current position. More...
unsigned char	getValue (int x, int y) const
	Returns 0..MAX_UNNORM_VALUE value at (x,y) position. More...
pixint1	operator() () const
	Returns 0..255 value at current position. More...
pixint1	operator() (int x, int y) const
	Returns 0..255 value at (x,y) position. More...
const pixint1	operator[] (int i) const
	Returns 0..255 value at position shifted by i pixels in scanline order with respect to the current position. More...
void	operator++ (int)
	Move the current position ONE PIXEL forward. More...
void	operator+= (const int N)
	Move the current position N pixels forward. More...
void	goTo (int x, int y)
	Changes current position. More...
	SingleByteMaskReader (const AbstractBitmap &bitmap, int x=0, int y=0)
Public Member Functions inherited from Beatmup::MaskScanner< 8 >
bool	operator< (const MaskScanner &another) const
pixtype *	operator* () const
int	getWidth () const
	Returns bitmap width in pixels. More...
int	getHeight () const
	Returns bitmap height in pixels. More...

Additional Inherited Members
Public Types inherited from Beatmup::MaskScanner< 8 >
typedef unsigned char	pixvaltype
typedef pixint1	pixtype
Public Attributes inherited from Beatmup::MaskScanner< 8 >
const int	NUMBER_OF_CHANNELS
const int	NUMBER_OF_BITS
const int	MAX_VALUE
const int	MAX_UNNORM_VALUE
Protected Member Functions inherited from Beatmup::MaskScanner< 8 >
	MaskScanner (const AbstractBitmap &bitmap)
Protected Attributes inherited from Beatmup::MaskScanner< 8 >
unsigned char *	data
	all bitmap data More...
unsigned char *	ptr
	pointer to current pixel More...
unsigned char	bit
	current position bit More...
int	width
int	height
	bitmap size in pixels More...

Detailed Description

Mask reqding interface to single byte bitmap.

Definition at line 288 of file mask_bitmap_access.h.

Constructor & Destructor Documentation

SingleByteMaskReader()

Beatmup::SingleByteMaskReader::SingleByteMaskReader ( const AbstractBitmap &  bitmap, int  x = 0, int  y = 0  )

inline

Definition at line 359 of file mask_bitmap_access.h.

                                                                                :
            MaskScanner<8>(bitmap)
        {
            goTo(x, y);
        }

Member Function Documentation

getValue() [1/3]

unsigned char Beatmup::SingleByteMaskReader::getValue ( ) const

inline

Returns 0..MAX_UNNORM_VALUE value at current position.

Definition at line 293 of file mask_bitmap_access.h.

                                              {
            return *ptr;
        }

getValue() [2/3]

unsigned char Beatmup::SingleByteMaskReader::getValue ( int  i ) const

inline

Returns 0..MAX_UNNORM_VALUE value at position shifted by i pixels in scanline order with respect to the current position.

Definition at line 301 of file mask_bitmap_access.h.

                                                   {
            return ptr[i];
        }

getValue() [3/3]

unsigned char Beatmup::SingleByteMaskReader::getValue ( int  x, int  y  ) const

inline

Returns 0..MAX_UNNORM_VALUE value at (x,y) position.

Definition at line 308 of file mask_bitmap_access.h.

                                                          {
            return data[width*y + x];
        }

operator()() [1/2]

pixint1 Beatmup::SingleByteMaskReader::operator() ( ) const

inline

Returns 0..255 value at current position.

Definition at line 315 of file mask_bitmap_access.h.

                                          {
            return pixint1{ getValue() };
        }

operator()() [2/2]

pixint1 Beatmup::SingleByteMaskReader::operator() ( int  x, int  y  ) const

inline

Returns 0..255 value at (x,y) position.

Definition at line 322 of file mask_bitmap_access.h.

                                                      {
            return pixint1{ getValue(x, y) };
        }

operator[]()

const pixint1 Beatmup::SingleByteMaskReader::operator[] ( int  i ) const

inline

Returns 0..255 value at position shifted by i pixels in scanline order with respect to the current position.

Definition at line 329 of file mask_bitmap_access.h.

                                                     {
            return pixint1{ getValue(i) };
        }

operator++()

void Beatmup::SingleByteMaskReader::operator++ ( int  )

inline

Move the current position ONE PIXEL forward.

Definition at line 336 of file mask_bitmap_access.h.

                                     {
            // int argument here is to declare the postfix increment (a C++ convention)
            ptr++;
        }

operator+=()

void Beatmup::SingleByteMaskReader::operator+= ( const int  N )

inline

Move the current position N pixels forward.

Definition at line 344 of file mask_bitmap_access.h.

                                             {
            ptr += N;
        }

goTo()

void Beatmup::SingleByteMaskReader::goTo ( int  x, int  y  )

inline

Changes current position.

Definition at line 351 of file mask_bitmap_access.h.

                                       {
#ifdef BEATMUP_DEBUG
            DebugAssertion::check(x >= 0 && y >= 0 && x < width && y < height,
                "Coordinates outside of image: %d %d (width=%d, height=%d)", x, y, width, height);
#endif
            ptr = data + (width*y + x);
        }

---

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

• core/bitmap/mask_bitmap_access.h