#include <CSurface8.h>

Collaboration diagram for CSurface8:

Public Member Functions
	CSurface8 ()

	~CSurface8 ()

	CSurface8 (int iWdt, int iHgt)

bool	HasOwnPal ()

void	HLine (int iX, int iX2, int iY, int iCol)

void	Box (int iX, int iY, int iX2, int iY2, int iCol)

void	Circle (int x, int y, int r, BYTE col)

void	ClearBox8Only (int iX, int iY, int iWdt, int iHgt)

void	SetPix (int iX, int iY, BYTE byCol)

void	_SetPix (int iX, int iY, BYTE byCol)

BYTE	GetPix (int iX, int iY) const

BYTE	_GetPix (int x, int y) const

bool	Create (int iWdt, int iHgt)

void	MoveFrom (C4Surface *psfcFrom)

void	Clear ()

void	Clip (int iX, int iY, int iX2, int iY2)

void	NoClip ()

bool	Read (class CStdStream &hGroup)

bool	Save (const char szFilename, CStdPalette =nullptr)

void	GetSurfaceSize (int &irX, int &irY) const

void	AllowColor (BYTE iRngLo, BYTE iRngHi, bool fAllowZero=false)

void	SetBuffer (BYTE *pbyToBuf, int Wdt, int Hgt, int Pitch)

void	ReleaseBuffer ()

Public Attributes
int	Wdt

int	Hgt

int	Pitch

int	ClipX

int	ClipY

int	ClipX2

int	ClipY2

BYTE *	Bits

CStdPalette *	pPal

Protected Member Functions
void	MapBytes (BYTE *bpMap)

bool	ReadBytes (BYTE *lpbpData, void bpTarget, int iSize)

Detailed Description

Definition at line 21 of file CSurface8.h.

Constructor & Destructor Documentation

◆ CSurface8() [1/2]

CSurface8::CSurface8 ( )

Definition at line 26 of file CSurface8.cpp.

 {
     Wdt=Hgt=Pitch=0;
     ClipX=ClipY=ClipX2=ClipY2=0;
     Bits=nullptr;
     pPal=nullptr;
 }

References Bits, ClipX, ClipX2, ClipY, ClipY2, Hgt, Pitch, pPal, and Wdt.

◆ ~CSurface8()

CSurface8::~CSurface8 ( )

Definition at line 43 of file CSurface8.cpp.

 {
     Clear();
 }

References Clear().

Here is the call graph for this function:

◆ CSurface8() [2/2]

CSurface8::CSurface8	(	int	iWdt,
		int	iHgt
	)

Definition at line 34 of file CSurface8.cpp.

 {
     Wdt=Hgt=Pitch=0;
     ClipX=ClipY=ClipX2=ClipY2=0;
     Bits=nullptr;
     pPal=nullptr;
     Create(iWdt, iHgt);
 }

References Bits, ClipX, ClipX2, ClipY, ClipY2, Create(), Hgt, Pitch, pPal, and Wdt.

Here is the call graph for this function:

Member Function Documentation

◆ _GetPix()

BYTE CSurface8::_GetPix	(	int	x,
		int	y
	)		const

inline

Definition at line 54 of file CSurface8.h.

     {
         return Bits[y*Pitch+x];
     }

References Bits, and Pitch.

Referenced by C4Landscape::P::ChunkOZoom(), C4Landscape::P::CreateDefaultBkgSurface(), C4TextureShape::Draw(), and C4SolidMask::DensityProvider::GetDensity().

Here is the caller graph for this function:

◆ _SetPix()

void CSurface8::_SetPix	(	int	iX,
		int	iY,
		BYTE	byCol
	)

inline

Definition at line 44 of file CSurface8.h.

     {
         // set pix in local copy without bounds or surface checks
         Bits[iY*Pitch+iX]=byCol;
     }

References Bits, and Pitch.

Referenced by C4Landscape::P::CreateDefaultBkgSurface(), and C4TextureShape::Load().

Here is the caller graph for this function:

◆ AllowColor()

void CSurface8::AllowColor	(	BYTE	iRngLo,
		BYTE	iRngHi,
		bool	fAllowZero = `false`
	)

Definition at line 222 of file CSurface8.cpp.

 {
     // change colors
     int xcnt,ycnt;
     if (iRngHi<iRngLo) return;
     for (ycnt=0; ycnt<Hgt; ycnt++)
     {
         for (xcnt=0; xcnt<Wdt; xcnt++)
         {
             BYTE px=GetPix(xcnt,ycnt);
             if (px || !fAllowZero)
                 if ((px<iRngLo) || (px>iRngHi))
                     SetPix(xcnt, ycnt, iRngLo + px % (iRngHi-iRngLo+1));
         }
     }
 }

References GetPix(), Hgt, SetPix(), and Wdt.

Here is the call graph for this function:

◆ Box()

void CSurface8::Box	(	int	iX,
		int	iY,
		int	iX2,
		int	iY2,
		int	iCol
	)

Definition at line 57 of file CSurface8.cpp.

 {
     for (int cy=iY; cy<=iY2; cy++) HLine(iX,iX2,cy,iCol);
 }

References HLine().

Here is the call graph for this function:

◆ Circle()

void CSurface8::Circle	(	int	x,
		int	y,
		int	r,
		BYTE	col
	)

Definition at line 212 of file CSurface8.cpp.

 {
     for (int ycnt=-r; ycnt<r; ycnt++)
     {
         int lwdt = (int) sqrt(float(r*r-ycnt*ycnt));
         for (int xcnt = 2 * lwdt - 1; xcnt >= 0; xcnt--)
             SetPix(x - lwdt + xcnt, y + ycnt, col);
     }
 }

References SetPix().

Here is the call graph for this function:

◆ Clear()

void CSurface8::Clear ( )

Definition at line 48 of file CSurface8.cpp.

 {
     // clear bitmap-copy
     delete [] Bits; Bits=nullptr;
     // clear pal
     delete pPal;
     pPal=nullptr;
 }

References Bits, and pPal.

Referenced by C4TextureShape::Clear(), Create(), Read(), ReleaseBuffer(), SetBuffer(), and ~CSurface8().

Here is the caller graph for this function:

◆ ClearBox8Only()

void CSurface8::ClearBox8Only	(	int	iX,
		int	iY,
		int	iWdt,
		int	iHgt
	)

Definition at line 202 of file CSurface8.cpp.

 {
     // clear rect; assume clip already
     for (int y=iY; y<iY+iHgt; ++y)
         for (int x=iX; x<iX+iWdt; ++x)
             Bits[y*Pitch+x] = 0;
     // done
 }

References Bits, and Pitch.

Referenced by C4MapCreator::Create().

Here is the caller graph for this function:

◆ Clip()

void CSurface8::Clip	(	int	iX,
		int	iY,
		int	iX2,
		int	iY2
	)

Definition at line 67 of file CSurface8.cpp.

 {
     ClipX=Clamp(iX,0,Wdt-1); ClipY=Clamp(iY,0,Hgt-1);
     ClipX2=Clamp(iX2,0,Wdt-1); ClipY2=Clamp(iY2,0,Hgt-1);
 }

References Clamp(), ClipX, ClipX2, ClipY, ClipY2, Hgt, and Wdt.

Here is the call graph for this function:

◆ Create()

bool CSurface8::Create	(	int	iWdt,
		int	iHgt
	)

Definition at line 78 of file CSurface8.cpp.

 {
     Clear();
     // check size
     if (!iWdt || !iHgt) return false;
     Wdt=iWdt; Hgt=iHgt;
  
     // create pal
     pPal = new CStdPalette;
     if (!pPal) return false;
     memset(pPal->Colors, 0, sizeof(pPal->Colors));
  
     Bits=new BYTE[Wdt*Hgt];
     if (!Bits) return false;
     memset(Bits, 0, Wdt*Hgt);
     Pitch=Wdt;
     // update clipping
     NoClip();
     return true;
 }

References Bits, Clear(), CStdPalette::Colors, Hgt, NoClip(), Pitch, pPal, and Wdt.

Referenced by CSurface8(), C4TextureShape::Load(), and Read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPix()

BYTE CSurface8::GetPix	(	int	iX,
		int	iY
	)		const

inline

Definition at line 49 of file CSurface8.h.

     {
         if (iX<0 || iY<0 || iX>=Wdt || iY>=Hgt) return 0;
         return Bits ? Bits[iY*Pitch+iX] : 0;
     }

References Bits, Hgt, Pitch, and Wdt.

Referenced by AllowColor(), C4Draw::Blit8Fast(), C4Landscape::P::ChunkOZoom(), C4TextureShape::Draw(), C4MapCreator::GetPix(), and MapBytes().

Here is the caller graph for this function:

◆ GetSurfaceSize()

void CSurface8::GetSurfaceSize	(	int &	irX,
		int &	irY
	)		const

Definition at line 195 of file CSurface8.cpp.

 {
     // simply assign stored values
     irX=Wdt;
     irY=Hgt;
 }

References Hgt, and Wdt.

Referenced by C4Landscape::P::ChunkOZoom(), and C4Landscape::P::MapToLandscape().

Here is the caller graph for this function:

◆ HasOwnPal()

bool CSurface8::HasOwnPal ( )

◆ HLine()

void CSurface8::HLine	(	int	iX,
		int	iX2,
		int	iY,
		int	iCol
	)

Definition at line 73 of file CSurface8.cpp.

 {
     for (int cx=iX; cx<=iX2; cx++) SetPix(cx,iY,iCol);
 }

References SetPix().

Referenced by Box().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MapBytes()

void CSurface8::MapBytes ( BYTE * bpMap )

protected

Definition at line 189 of file CSurface8.cpp.

 {
     if (!bpMap) return;
     for (int cnt=0; cnt<Wdt*Hgt; cnt++) SetPix(cnt%Wdt, cnt/Wdt, bpMap[GetPix(cnt%Wdt, cnt/Wdt)]);
 }

References GetPix(), Hgt, SetPix(), and Wdt.

Here is the call graph for this function:

◆ MoveFrom()

void CSurface8::MoveFrom ( C4Surface * psfcFrom )

◆ NoClip()

void CSurface8::NoClip ( )

Definition at line 62 of file CSurface8.cpp.

 {
     ClipX=0; ClipY=0; ClipX2=Wdt-1; ClipY2=Hgt-1;
 }

References ClipX, ClipX2, ClipY, ClipY2, Hgt, and Wdt.

Referenced by Create(), and SetBuffer().

Here is the caller graph for this function:

◆ Read()

bool CSurface8::Read ( class CStdStream & hGroup )

Definition at line 99 of file CSurface8.cpp.

 {
     int cnt,lcnt;
     C4BMP256Info BitmapInfo;
     // read bmpinfo-header
     if (!hGroup.Read(&BitmapInfo,sizeof(C4BMPInfo))) return false;
     // is it 8bpp?
     if (BitmapInfo.Info.biBitCount == 8)
     {
         if (!hGroup.Read(((BYTE *) &BitmapInfo)+sizeof(C4BMPInfo),sizeof(BitmapInfo)-sizeof(C4BMPInfo))) return false;
         if (!hGroup.Advance(BitmapInfo.FileBitsOffset())) return false;
     }
     else
     {
         // read 24bpp
         if (BitmapInfo.Info.biBitCount != 24) return false;
         if (!hGroup.Advance(((C4BMPInfo) BitmapInfo).FileBitsOffset())) return false;
     }
  
     // Create and lock surface
     if (!Create(BitmapInfo.Info.biWidth,BitmapInfo.Info.biHeight)) return false;
  
     if (BitmapInfo.Info.biBitCount == 8)
     {
         // Copy palette
         for (cnt=0; cnt<256; cnt++)
         {
             pPal->Colors[cnt] = C4RGB(BitmapInfo.Colors[cnt].rgbRed,
                                       BitmapInfo.Colors[cnt].rgbGreen,
                                       BitmapInfo.Colors[cnt].rgbBlue);
         }
     }
  
     // create line buffer
     int iBufSize=DWordAligned(BitmapInfo.Info.biWidth*BitmapInfo.Info.biBitCount/8);
     BYTE *pBuf = new BYTE[iBufSize];
     // Read lines
     for (lcnt=Hgt-1; lcnt>=0; lcnt--)
     {
         if (!hGroup.Read(pBuf, iBufSize))
             { Clear(); delete [] pBuf; return false; }
         BYTE *pPix=pBuf;
         for (int x=0; x<BitmapInfo.Info.biWidth; ++x)
             switch (BitmapInfo.Info.biBitCount)
             {
             case 8:
                 SetPix(x, lcnt, *pPix++);
                 break;
             case 24:
                 return false;
                 break;
             }
     }
     // free buffer again
     delete [] pBuf;
  
     return true;
 }

References CStdStream::Advance(), tagBITMAPINFOHEADER::biBitCount, tagBITMAPINFOHEADER::biHeight, tagBITMAPINFOHEADER::biWidth, C4RGB, Clear(), C4BMP256Info::Colors, CStdPalette::Colors, Create(), DWordAligned(), Hgt, C4BMPInfo::Info, pPal, CStdStream::Read(), tagRGBQUAD::rgbBlue, tagRGBQUAD::rgbGreen, tagRGBQUAD::rgbRed, and SetPix().

Here is the call graph for this function:

◆ ReadBytes()

bool CSurface8::ReadBytes	(	BYTE **	lpbpData,
		void *	bpTarget,
		int	iSize
	)

protected

◆ ReleaseBuffer()

void CSurface8::ReleaseBuffer ( )

Definition at line 251 of file CSurface8.cpp.

 {
     this->Bits = nullptr;
     Clear();
 }

References Bits, and Clear().

Here is the call graph for this function:

◆ Save()

bool CSurface8::Save	(	const char *	szFilename,
		CStdPalette *	bpPalette = `nullptr`
	)

Definition at line 158 of file CSurface8.cpp.

 {
     C4BMP256Info BitmapInfo;
     BitmapInfo.Set(Wdt,Hgt, bpPalette ? bpPalette : pPal);
  
     // Create file & write info
     CStdFile hFile;
  
     if ( !hFile.Create(szFilename)
          || !hFile.Write(&BitmapInfo,sizeof(BitmapInfo)) )
         { return false; }
  
     // Write lines
     char bpEmpty[4]; ZeroMem(bpEmpty, 4);
     const int iEmpty = DWordAligned(Wdt)-Wdt;
     for (int cnt=Hgt-1; cnt>=0; cnt--)
     {
         if (!hFile.Write(Bits+(Pitch*cnt),Wdt))
             { return false; }
         if (iEmpty)
             if (!hFile.Write(bpEmpty,iEmpty))
                 { return false; }
     }
  
     // Close file
     hFile.Close();
  
     // Success
     return true;
 }

References Bits, CStdFile::Close(), CStdFile::Create(), DWordAligned(), Hgt, Pitch, pPal, C4BMP256Info::Set(), Wdt, CStdFile::Write(), and ZeroMem().

Referenced by C4FoWAmbient::UpdateFromLandscape().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBuffer()

void CSurface8::SetBuffer	(	BYTE *	pbyToBuf,
		int	Wdt,
		int	Hgt,
		int	Pitch
	)

Definition at line 239 of file CSurface8.cpp.

 {
     // release old
     Clear();
     // set new
     this->Wdt=Wdt;
     this->Hgt=Hgt;
     this->Pitch=Pitch;
     this->Bits = pbyToBuf;
     NoClip();
 }

References Bits, Clear(), Hgt, NoClip(), Pitch, and Wdt.

Here is the call graph for this function:

◆ SetPix()

void CSurface8::SetPix	(	int	iX,
		int	iY,
		BYTE	byCol
	)

inline

Definition at line 37 of file CSurface8.h.

     {
         // clip
         if ((iX<ClipX) || (iX>ClipX2) || (iY<ClipY) || (iY>ClipY2)) return;
         // set pix in local copy...
         if (Bits) Bits[iY*Pitch+iX]=byCol;
     }

References Bits, ClipX, ClipX2, ClipY, ClipY2, and Pitch.

Referenced by AllowColor(), Circle(), HLine(), C4SolidMask::LoadMaskFromFile(), MapBytes(), Read(), C4MapCreator::SetPix(), and C4FoWAmbient::UpdateFromLandscape().

Here is the caller graph for this function:

Member Data Documentation

◆ Bits

BYTE* CSurface8::Bits

Definition at line 30 of file CSurface8.h.

Referenced by _GetPix(), _SetPix(), Clear(), ClearBox8Only(), Create(), CSurface8(), GetPix(), C4SolidMask::Put(), ReleaseBuffer(), C4MapCreatorS2::Render(), Save(), SetBuffer(), and SetPix().

◆ ClipX

int CSurface8::ClipX

Definition at line 29 of file CSurface8.h.

Referenced by Clip(), CSurface8(), NoClip(), and SetPix().

◆ ClipX2

int CSurface8::ClipX2

Definition at line 29 of file CSurface8.h.

Referenced by Clip(), CSurface8(), NoClip(), and SetPix().

◆ ClipY

int CSurface8::ClipY

Definition at line 29 of file CSurface8.h.

Referenced by Clip(), CSurface8(), NoClip(), and SetPix().

◆ ClipY2

int CSurface8::ClipY2

Definition at line 29 of file CSurface8.h.

Referenced by Clip(), CSurface8(), NoClip(), and SetPix().

◆ Hgt

int CSurface8::Hgt

Definition at line 28 of file CSurface8.h.

Referenced by AllowColor(), C4Object::CheckSolidMaskRect(), Clip(), C4MapCreator::Create(), Create(), C4Landscape::P::CreateDefaultBkgSurface(), CSurface8(), C4TextureShape::Draw(), C4TextureShape::GetHeight(), GetPix(), GetSurfaceSize(), C4TextureShape::Load(), MapBytes(), NoClip(), Read(), Save(), and SetBuffer().

◆ Pitch

int CSurface8::Pitch

Definition at line 28 of file CSurface8.h.

Referenced by _GetPix(), _SetPix(), ClearBox8Only(), Create(), CSurface8(), GetPix(), C4SolidMask::Put(), C4MapCreatorS2::Render(), Save(), SetBuffer(), and SetPix().

◆ pPal

CStdPalette* CSurface8::pPal

Definition at line 31 of file CSurface8.h.

Referenced by C4Draw::Blit8Fast(), Clear(), Create(), CSurface8(), Read(), and Save().

◆ Wdt

int CSurface8::Wdt

Definition at line 28 of file CSurface8.h.

Referenced by AllowColor(), C4Object::CheckSolidMaskRect(), Clip(), C4MapCreator::Create(), Create(), C4Landscape::P::CreateDefaultBkgSurface(), CSurface8(), C4TextureShape::Draw(), GetPix(), GetSurfaceSize(), C4TextureShape::GetWidth(), C4TextureShape::Load(), MapBytes(), NoClip(), Save(), and SetBuffer().

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

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CSurface8() [1/2]

◆ ~CSurface8()

◆ CSurface8() [2/2]

Member Function Documentation

◆ _GetPix()

◆ _SetPix()

◆ AllowColor()

◆ Box()

◆ Circle()

◆ Clear()

◆ ClearBox8Only()

◆ Clip()

◆ Create()

◆ GetPix()

◆ GetSurfaceSize()

◆ HasOwnPal()

◆ HLine()

◆ MapBytes()

◆ MoveFrom()

◆ NoClip()

◆ Read()

◆ ReadBytes()

◆ ReleaseBuffer()

◆ Save()

◆ SetBuffer()

◆ SetPix()

Member Data Documentation

◆ Bits

◆ ClipX

◆ ClipX2

◆ ClipY

◆ ClipY2

◆ Hgt

◆ Pitch

◆ pPal

◆ Wdt