Class representing a bitmap image generated by doxygen. More...

#include <src/image.h>

Classes
struct	Private

Public Member Functions
	Image (uint32_t w, uint32_t h)

	~Image ()

void	setPixel (uint32_t x, uint32_t y, uint8_t val)

uint8_t	getPixel (uint32_t x, uint32_t y) const

void	writeChar (uint32_t x, uint32_t y, char c, uint8_t fg)

void	writeString (uint32_t x, uint32_t y, const QCString &s, uint8_t fg)

void	drawHorzLine (uint32_t y, uint32_t xs, uint32_t xe, uint8_t colIndex, uint32_t mask)

void	drawHorzArrow (uint32_t y, uint32_t xs, uint32_t xe, uint8_t colIndex, uint32_t mask)

void	drawVertLine (uint32_t x, uint32_t ys, uint32_t ye, uint8_t colIndex, uint32_t mask)

void	drawVertArrow (uint32_t x, uint32_t ys, uint32_t ye, uint8_t colIndex, uint32_t mask)

void	drawRect (uint32_t x, uint32_t y, uint32_t width, uint32_t height, uint8_t colIndex, uint32_t mask)

void	fillRect (uint32_t x, uint32_t y, uint32_t width, uint32_t height, uint8_t colIndex, uint32_t mask)

bool	save (const QCString &fileName)

uint32_t	width () const

uint32_t	height () const

Static Public Member Functions
static uint32_t	stringLength (const QCString &s)

Private Attributes
std::unique_ptr< Private >	p

Friends
uint32_t	stringLength (const QCString &s)

Detailed Description

Class representing a bitmap image generated by doxygen.

Definition at line 26 of file image.h.

Constructor & Destructor Documentation

◆ Image()

Image::Image	(	uint32_t	w,
		uint32_t	h )

Definition at line 174 of file image.cpp.

                                  : p(std::make_unique<Private>())
{
  int hue   = Config_getInt(HTML_COLORSTYLE_HUE);
  int sat   = Config_getInt(HTML_COLORSTYLE_SAT);
  int gamma = Config_getInt(HTML_COLORSTYLE_GAMMA);
 
  double red1=0.0 ,green1=0.0 ,blue1=0.0;
  double red2=0.0, green2=0.0, blue2=0.0;
 
  ColoredImage::hsl2rgb(hue/360.0,                  // hue
                        sat/255.0,                  // saturation
                        pow(235/255.0,gamma/100.0), // luma (gamma corrected)
                        &red1,&green1,&blue1
                       );
 
  ColoredImage::hsl2rgb(hue/360.0,                  // hue
                        sat/255.0,                  // saturation
                        pow(138/255.0,gamma/100.0), // luma (gamma corrected)
                        &red2,&green2,&blue2
                       );
 
  p->palette[2].red   = static_cast<Byte>(red1   * 255.0);
  p->palette[2].green = static_cast<Byte>(green1 * 255.0);
  p->palette[2].blue  = static_cast<Byte>(blue1  * 255.0);
 
  p->palette[3].red   = static_cast<Byte>(red2   * 255.0);
  p->palette[3].green = static_cast<Byte>(green2 * 255.0);
  p->palette[3].blue  = static_cast<Byte>(blue2  * 255.0);
 
  p->data.resize(w*h);
  p->width = w;
  p->height = h;
}

References Config_getInt, ColoredImage::hsl2rgb(), and p.

Referenced by ~Image().

◆ ~Image()

Image::~Image ( )

default

References height(), Image(), and width().

Member Function Documentation

◆ drawHorzArrow()

void Image::drawHorzArrow	(	uint32_t	y,
		uint32_t	xs,
		uint32_t	xe,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 299 of file image.cpp.

{
  drawHorzLine(y,xs,xe,colIndex,mask);
  for (uint32_t i=0;i<6;i++)
  {
    uint32_t h=i>>1;
    drawVertLine(xe-i,y-h,y+h,colIndex,0xffffffff);
  }
}

References drawHorzLine(), and drawVertLine().

Referenced by TreeDiagram::drawConnectors().

◆ drawHorzLine()

void Image::drawHorzLine	(	uint32_t	y,
		uint32_t	xs,
		uint32_t	xe,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 289 of file image.cpp.

{
  uint32_t i=0,j=0;
  for (uint32_t x=xs;x<=xe;x++,j++)
  {
    if (j&1) i++;
    if (mask&(1<<(i&0x1f))) setPixel(x,y,colIndex);
  }
}

References setPixel().

Referenced by TreeDiagram::drawConnectors(), drawHorzArrow(), drawRect(), drawVertArrow(), and writeBitmapBox().

◆ drawRect()

void Image::drawRect	(	uint32_t	x,
		uint32_t	y,
		uint32_t	width,
		uint32_t	height,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 328 of file image.cpp.

{
  drawHorzLine(y,x,x+w-1,colIndex,mask);
  drawHorzLine(y+h-1,x,x+w-1,colIndex,mask);
  drawVertLine(x,y,y+h-1,colIndex,mask);
  drawVertLine(x+w-1,y,y+h-1,colIndex,mask);
}

References drawHorzLine(), and drawVertLine().

Referenced by writeBitmapBox().

◆ drawVertArrow()

void Image::drawVertArrow	(	uint32_t	x,
		uint32_t	ys,
		uint32_t	ye,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 318 of file image.cpp.

{
  drawVertLine(x,ys,ye,colIndex,mask);
  for (uint32_t i=0;i<6;i++)
  {
    uint32_t h=i>>1;
    drawHorzLine(ys+i,x-h,x+h,colIndex,0xffffffff);
  }
}

References drawHorzLine(), and drawVertLine().

Referenced by TreeDiagram::drawConnectors().

◆ drawVertLine()

void Image::drawVertLine	(	uint32_t	x,
		uint32_t	ys,
		uint32_t	ye,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 309 of file image.cpp.

{
  uint32_t i=0;
  for (uint32_t y=ys;y<=ye;y++,i++)
  {
    if (mask&(1<<(i&0x1f))) setPixel(x,y,colIndex);
  }
}

References setPixel().

Referenced by TreeDiagram::drawConnectors(), drawHorzArrow(), drawRect(), and drawVertArrow().

◆ fillRect()

void Image::fillRect	(	uint32_t	x,
		uint32_t	y,
		uint32_t	width,
		uint32_t	height,
		uint8_t	colIndex,
		uint32_t	mask )

Definition at line 336 of file image.cpp.

{
  for (uint32_t yp=y,yi=0;yp<y+height;yp++,yi++)
    for (uint32_t xp=x,xi=0;xp<x+width;xp++,xi++)
      if (mask&(1<<((xi+yi)&0x1f)))
        setPixel(xp,yp,colIndex);
      else
        setPixel(xp,yp,8);
}

References height(), setPixel(), and width().

Referenced by writeBitmapBox().

◆ getPixel()

uint8_t Image::getPixel	(	uint32_t	x,
		uint32_t	y ) const

Definition at line 218 of file image.cpp.

{
  return (x<p->width && y<p->height) ? p->data[y*p->width+x] : 0;
}

References height(), p, and width().

Referenced by writeChar().

◆ height()

uint32_t Image::height ( ) const

Definition at line 209 of file image.cpp.

209{ return p->height; }

References p.

Referenced by TreeDiagram::drawBoxes(), TreeDiagram::drawConnectors(), fillRect(), getPixel(), setPixel(), and ~Image().

◆ save()

bool Image::save ( const QCString & fileName )

Definition at line 346 of file image.cpp.

{
  uint8_t* buffer = nullptr;
  size_t bufferSize = 0;
  LodePNG_Encoder encoder;
  LodePNG_Encoder_init(&encoder);
  for (const auto &col : p->palette)
  {
    LodePNG_InfoColor_addPalette(&encoder.infoPng.color,
                                 col.red,col.green,col.blue,col.alpha);
  }
  encoder.infoPng.color.colorType = 3;
  encoder.infoRaw.color.colorType = 3;
  LodePNG_encode(&encoder, &buffer, &bufferSize, &p->data[0], p->width, p->height);
  LodePNG_saveFile(buffer, bufferSize, fileName.data());
  free(buffer);
  LodePNG_Encoder_cleanup(&encoder);
  return TRUE;
}

References QCString::data(), p, and TRUE.

◆ setPixel()

void Image::setPixel	(	uint32_t	x,
		uint32_t	y,
		uint8_t	val )

Definition at line 213 of file image.cpp.

{
  if (x<p->width && y<p->height) p->data[y*p->width+x] = val;
}

References height(), p, and width().

Referenced by drawHorzLine(), drawVertLine(), fillRect(), and writeChar().

◆ stringLength()

static uint32_t Image::stringLength ( const QCString & s )

static

◆ width()

uint32_t Image::width ( ) const

Definition at line 208 of file image.cpp.

208{ return p->width; }

References p.

Referenced by fillRect(), getPixel(), setPixel(), and ~Image().

◆ writeChar()

void Image::writeChar	(	uint32_t	x,
		uint32_t	y,
		char	c,
		uint8_t	fg )

Definition at line 223 of file image.cpp.

{
  if (c>=' ')
  {
    uint32_t ci=c-' ';
    uint32_t rowOffset=0;
    uint32_t cw = charWidth[ci];
    uint32_t cp = charPos[ci];
    for (uint32_t yf=0;yf<charHeight;yf++)
    {
      unsigned short bitPattern=0;
      uint32_t bitsLeft=cw;
      uint32_t byteOffset = rowOffset+(cp>>3);
      uint32_t bitOffset  = cp&7;
      // get the bit pattern for row yf of the character from the font data
      while (bitsLeft>0)
      {
        uint32_t bits=8-bitOffset;
        if (bits>bitsLeft) bits=bitsLeft;
        bitPattern<<=bits;
        bitPattern|=((fontRaw[byteOffset]<<bitOffset)&0xff)>>(8-bits);
        bitsLeft-=bits;
        bitOffset=0;
        byteOffset++;
      }
      if (cw>0 && cw<32)
      {
        uint32_t mask=(uint32_t)1<<(cw-1);
        // draw character row yf
        for (uint32_t xf=0;xf<cw;xf++)
        {
          setPixel(x+xf,y+yf,(bitPattern&mask) ? fg : getPixel(x+xf,y+yf));
          mask>>=1;
        }
        rowOffset+=charSetWidth;
      }
    }
  }
}

References charHeight, charPos, charSetWidth, charWidth, fontRaw, getPixel(), and setPixel().

Referenced by writeString().

◆ writeString()

void Image::writeString	(	uint32_t	x,
		uint32_t	y,
		const QCString &	s,
		uint8_t	fg )

Definition at line 263 of file image.cpp.

{
  if (!s.isEmpty())
  {
    const char *ps = s.data();
    char c = 0;
    while ((c=*ps++))
    {
      writeChar(x,y,c,fg);
      x+=charWidth[c-' '];
    }
  }
}

References charWidth, QCString::data(), QCString::isEmpty(), and writeChar().

Referenced by writeBitmapBox().

Friends And Related Symbol Documentation

◆ stringLength

uint32_t Image::stringLength ( const QCString & s )

friend

Definition at line 277 of file image.cpp.

{
  uint32_t w=0;
  if (!s.isEmpty())
  {
    const char *ps = s.data();
    char c = 0;
    while ((c=*ps++)) w+=charWidth[c-' '];
  }
  return w;
}

References charWidth, QCString::data(), and QCString::isEmpty().

Referenced by TreeDiagram::computeExtremes(), and writeBitmapBox().

Member Data Documentation

◆ p

std::unique_ptr<Private> Image::p

private

Definition at line 51 of file image.h.

Referenced by getPixel(), height(), Image(), save(), setPixel(), and width().

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

src/image.h
src/image.cpp

Classes

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Image()

◆ ~Image()

Member Function Documentation

◆ drawHorzArrow()

◆ drawHorzLine()

◆ drawRect()

◆ drawVertArrow()

◆ drawVertLine()

◆ fillRect()

◆ getPixel()

◆ height()

◆ save()

◆ setPixel()

◆ stringLength()

◆ width()

◆ writeChar()

◆ writeString()

Friends And Related Symbol Documentation

◆ stringLength

Member Data Documentation

◆ p