Inheritance diagram for Bagel::CBofBitmap:

Public Member Functions
	CBofBitmap ()

	CBofBitmap (int dx, int dy, CBofPalette pPalette, bool bOwnPalette=false, byte pPrivateBuff=nullptr)

	CBofBitmap (const char pszFileName, CBofPalette pPalette=nullptr, bool bOwnPalette=false)

virtual	~CBofBitmap ()

ErrorCode	buildBitmap (CBofPalette *pPalette)

ErrorCode	loadBitmap (const char pszFileName, CBofPalette pPalette)

void	releaseBitmap ()

void	setPalette (CBofPalette *pPalette, bool bOwnPalette=false)

CBofPalette *	getPalette ()

void	setIsOwnPalette (bool own)

byte *	getPixelAddress (int x, int y)

byte *	getPixelAddress (CBofPoint *pPoint)

CBofSize	getSize ()

CBofRect	getRect ()

void	setReadOnly (bool bReadOnly)

bool	getReadOnly ()

bool	isTopDown ()

int	width ()

int	widthBytes ()

int	height ()

	operator Graphics::ManagedSurface & ()

Graphics::ManagedSurface	getSurface ()

const char *	getFileName ()

ErrorCode	paint (CBofWindow pWnd, int x, int y, CBofRect pSrcRect=nullptr, int nMaskColor=-1)

ErrorCode	paint (CBofWindow pWnd, CBofRect pDstRect=nullptr, CBofRect *pSrcRect=nullptr, int nMaskColor=-1)

ErrorCode	paintMaskBackdrop (CBofWindow pWnd, CBofRect pDstRect=nullptr, CBofRect *pSrcRect=nullptr, int nMaskColor=-1)

ErrorCode	paint (CBofBitmap pBmp, int x, int y, CBofRect pSrcRect=nullptr, int nMaskColor=-1)

ErrorCode	paint (CBofBitmap pBmp, CBofRect pDstRect=nullptr, CBofRect *pSrcRect=nullptr, int nMaskColor=-1)

ErrorCode	paintStretch4 (CBofBitmap pBmp, CBofRect pDstRect, CBofRect *pSrcRect)
	The Destination rectangle MUST be divisible by 4. Both bitmaps must be Bottom-Up. The Source must be smaller than the Destination. More...

ErrorCode	paintStretchOpt (CBofBitmap pBmp, CBofRect pDstRect, CBofRect *pSrcRect, int nOptSize)

ErrorCode	paint1To1 (CBofBitmap *pBmp)

ErrorCode	captureScreen (CBofWindow pWnd, CBofRect pSrcRect, CBofRect *pDstRect=nullptr)

ErrorCode	fadeIn (CBofWindow *pWnd, int x=0, int y=0, int nMaskColor=-1, int nBlockSize=4, int nSpeed=10)

ErrorCode	curtain (CBofWindow *pWnd, int nSpeed=8, int nMaskColor=-1)

ErrorCode	fadeLines (CBofWindow *pWnd, int nSpeed=32, int nMaskColor=-1)

byte	readPixel (int x, int y)

void	writePixel (int x, int y, byte iColor)

void	circle (int x, int y, uint16 nRadius, byte iColor)

void	line (int nSrcX, int nSrcY, int nDstX, int nDstY, byte iColor)

void	line (CBofPoint pSrc, CBofPoint pDest, byte iColor)

void	drawRect (CBofRect *cRect, byte iColor)

void	fillRect (CBofRect *cRect, byte iColor)

ErrorCode	scrollRight (int nPixels, CBofRect *pRect=nullptr)

ErrorCode	scrollLeft (int nPixels, CBofRect *pRect=nullptr)

ErrorCode	scrollUp (int nPixels)

Public Member Functions inherited from Bagel::CBofError
void	reportError (ErrorCode errCode, const char *format,...)

bool	errorOccurred () const

ErrorCode	getErrorCode () const

void	clearError ()

Public Member Functions inherited from Bagel::CCache
	CCache ()

virtual	~CCache ()

void	load ()

bool	release ()

void	lock ()

void	unlock ()

bool	isLocked ()

Static Public Member Functions
static void	setUseBackdrop (bool b)

static bool	getUseBackdrop ()

Static Public Member Functions inherited from Bagel::CBofError
static void	fatalError (ErrorCode errCode, const char *format,...)

static void	initialize ()

static int	getErrorCount ()

Static Public Member Functions inherited from Bagel::CBofObject
static bool	isValidObject (const CBofObject *pObject)

Static Public Member Functions inherited from Bagel::CCache
static void	initialize ()

static bool	flush ()

static bool	optimize (uint32 lRequestedFreeSpace)

Protected Member Functions
bool	alloc () override

void	free () override

Protected Member Functions inherited from Bagel::CBofError
virtual void	bofMessageBox (const Common::String &content, const Common::String &title)

Protected Attributes
char	_szFileName [MAX_FNAME]

Graphics::ManagedSurface	_bitmap

byte *	_pBits = nullptr

CBofPalette *	_pPalette = nullptr

int	_nScanDX = 0

int	_nDX = 0

int	_nDY = 0

bool	_bTopDown = false

bool	_bOwnPalette = false

bool	_bReadOnly = false

bool	_bInitialized = false

Protected Attributes inherited from Bagel::CBofError
ErrorCode	_errCode

Static Protected Attributes
static bool	_bUseBackdrop

Static Protected Attributes inherited from Bagel::CBofError
static int	_count

Constructor & Destructor Documentation

◆ CBofBitmap() [1/3]

Bagel::CBofBitmap::CBofBitmap ( )

Default constructor

◆ CBofBitmap() [2/3]

Bagel::CBofBitmap::CBofBitmap	(	int	dx,
		int	dy,
		CBofPalette *	pPalette,
		bool	bOwnPalette = `false`,
		byte *	pPrivateBuff = `nullptr`
	)

Constructs a CBofBitmap

Parameters

dx	Width of new bitmap
dy	Height of new bitmap
pPalette	Palette to use for this bitmap
bOwnPalette	true if destructor should delete palette
pPrivateBuff

◆ CBofBitmap() [3/3]

Bagel::CBofBitmap::CBofBitmap	(	const char *	pszFileName,
		CBofPalette *	pPalette = `nullptr`,
		bool	bOwnPalette = `false`
	)

Constructs a CBofBitmap

Parameters

pszFileName	Path and Filename for Bitmap on disk
pPalette	Palette to use for this bitmap
bOwnPalette	true if destructor should delete palette

◆ ~CBofBitmap()

virtual Bagel::CBofBitmap::~CBofBitmap ( )

virtual

Destructor

Member Function Documentation

◆ alloc()

bool Bagel::CBofBitmap::alloc ( )

overrideprotectedvirtual

Does the actual allocation for this bitmap

Returns: true is this bitmap was successfully loaded into the cache

Implements Bagel::CCache.

◆ free()

void Bagel::CBofBitmap::free ( )

overrideprotectedvirtual

Frees the data used by this bitmap (removes from cache)

Implements Bagel::CCache.

◆ buildBitmap()

ErrorCode Bagel::CBofBitmap::buildBitmap ( CBofPalette * pPalette )

Allocates the structures needed for a CBofBitmap

Parameters

pPalette Palette to be assigned into this bitmap

◆ loadBitmap()

ErrorCode Bagel::CBofBitmap::loadBitmap	(	const char *	pszFileName,
		CBofPalette *	pPalette
	)

Loads the specified bitmap from disk

Parameters

pszFileName	Filename
pPalette	Palette

Returns: Error return code

◆ releaseBitmap()

void Bagel::CBofBitmap::releaseBitmap ( )

Frees the data used by this bitmap

◆ setPalette()

void Bagel::CBofBitmap::setPalette	(	CBofPalette *	pPalette,
		bool	bOwnPalette = `false`
	)

Assigns specified palette to this bitmap

Parameters

pPalette	Pointer to CBofPalette to be assigned
bOwnPalette	true if bitmap is to own this palette

◆ getPixelAddress()

byte* Bagel::CBofBitmap::getPixelAddress	(	int	x,
		int	y
	)

Returns the bit address of the (x, y) location in this bmp

Parameters

x	Column in _pBits
y	Row in _pBits

Returns: Address of (x,y) in bitmap surface

◆ getFileName()

const char* Bagel::CBofBitmap::getFileName ( )

Returns current bitmap's filename (if any)

Returns: Pointer to bitmap's filename

◆ paint() [1/4]

ErrorCode Bagel::CBofBitmap::paint	(	CBofWindow *	pWnd,
		int	x,
		int	y,
		CBofRect *	pSrcRect = `nullptr`,
		int	nMaskColor = `-1`
	)

Paints some or all of the bitmap directly to the screen

Parameters

pWnd	Destination device for painting
x	Destination column
y	Destination row
pSrcRect	Source rectangle from bitmap
nMaskColor	Transparency color

Returns: error return code

◆ paint() [2/4]

ErrorCode Bagel::CBofBitmap::paint	(	CBofWindow *	pWnd,
		CBofRect *	pDstRect = `nullptr`,
		CBofRect *	pSrcRect = `nullptr`,
		int	nMaskColor = `-1`
	)

Paints some or all of the bitmap directly to the screen

Parameters

pWnd	Destination Device to paint to
pDstRect	Destination rectangle (for stretching)
pSrcRect	Source rectangle from bitmap
nMaskColor	transparency color

Returns: Error return code

◆ paintMaskBackdrop()

ErrorCode Bagel::CBofBitmap::paintMaskBackdrop	(	CBofWindow *	pWnd,
		CBofRect *	pDstRect = `nullptr`,
		CBofRect *	pSrcRect = `nullptr`,
		int	nMaskColor = `-1`
	)

Paints some or all of the bitmap directly to the screen

Parameters

pWnd	Destination Device to paint to
pDstRect	Destination rectangle (for stretching)
pSrcRect	Source rectangle from bitmap
nMaskColor	Transparency color

Returns: Error return code

◆ paint() [3/4]

ErrorCode Bagel::CBofBitmap::paint	(	CBofBitmap *	pBmp,
		int	x,
		int	y,
		CBofRect *	pSrcRect = `nullptr`,
		int	nMaskColor = `-1`
	)

Paints some or all of the bitmap directly to the screen

Parameters

pBmp	Destination bitmap to paint to
x	Destination column
y	Destination row
pSrcRect	Source rectangle from bitmap
nMaskColor	Transparency color

Returns: Error return code

◆ paint() [4/4]

ErrorCode Bagel::CBofBitmap::paint	(	CBofBitmap *	pBmp,
		CBofRect *	pDstRect = `nullptr`,
		CBofRect *	pSrcRect = `nullptr`,
		int	nMaskColor = `-1`
	)

Paints some or all of the bitmap directly to the screen

Parameters

pBmp	Destination bitmap to paint to
pDstRect	Destination rectangle (for stretching)
pSrcRect	Source rectangle from bitmap
nMaskColor	Transparency color

Returns: Error return code.

◆ paintStretch4()

ErrorCode Bagel::CBofBitmap::paintStretch4	(	CBofBitmap *	pBmp,
		CBofRect *	pDstRect,
		CBofRect *	pSrcRect
	)

The Destination rectangle MUST be divisible by 4. Both bitmaps must be Bottom-Up. The Source must be smaller than the Destination.

Stretches 4 pixel wide strips from source to destination

Parameters

pBmp	Destination bitmap to paint to
pDstRect	Destination rectangle (for stretching)
pSrcRect	Source rectangle from bitmap

Returns: Error return code

◆ paintStretchOpt()

ErrorCode Bagel::CBofBitmap::paintStretchOpt	(	CBofBitmap *	pBmp,
		CBofRect *	pDstRect,
		CBofRect *	pSrcRect,
		int	nOptSize
	)

Stretches a multiple of 4 pixel wide strips from source to destination

Parameters

pBmp	Destination bitmap to paint to
pDstRect	Destination rectangle (for stretching)
pSrcRect	Source rectangle from bitmap
nOptSize

Returns: Error return code

◆ paint1To1()

ErrorCode Bagel::CBofBitmap::paint1To1 ( CBofBitmap * pBmp )

Paints some or all of the bitmap directly to the screen

Parameters

pBmp	Destination bitmap to paint to

Returns: Error return code

◆ captureScreen()

ErrorCode Bagel::CBofBitmap::captureScreen	(	CBofWindow *	pWnd,
		CBofRect *	pSrcRect,
		CBofRect *	pDstRect = `nullptr`
	)

Copy specified section of screen (or window) to bitmap.

Parameters

pWnd	Window to capture
pSrcRect	Source rectangle in window
pDstRect	Destination area to copy image to

Returns: Error return code

◆ fadeIn()

ErrorCode Bagel::CBofBitmap::fadeIn	(	CBofWindow *	pWnd,
		int	x = `0`,
		int	y = `0`,
		int	nMaskColor = `-1`,
		int	nBlockSize = `4`,
		int	nSpeed = `10`
	)

Performs a "Fade" onto the specified window

Parameters

pWnd	Pointer to window to fade into
x	Fade upper left X
y	Fade upper left Y
nMaskColor	Transparency color (if any)
nBlockSize	Size of Fade Blocks
nSpeed	Speed for fade (not implemented yet)

Returns: Error return code

◆ readPixel()

byte Bagel::CBofBitmap::readPixel	(	int	x,
		int	y
	)

Returns the color at the (x, y) location in this bmp

Parameters

x	X position
y	Y position

Returns: Color Index of specified (x,y) location in _pBits

◆ writePixel()

void Bagel::CBofBitmap::writePixel	(	int	x,
		int	y,
		byte	iColor
	)

Assigns the specified color to the (x, y) location

Parameters

x	X position
y	Y position
iColor	Pixel value

◆ circle()

void Bagel::CBofBitmap::circle	(	int	x,
		int	y,
		uint16	nRadius,
		byte	iColor
	)

Writes a circle into this bitmap

Parameters

x	X center position
y	Y center position
nRadius	Radius of circle
iColor	Pixel value

◆ line() [1/2]

void Bagel::CBofBitmap::line	(	int	nSrcX,
		int	nSrcY,
		int	nDstX,
		int	nDstY,
		byte	iColor
	)

Writes a line into this bitmap

Parameters

nSrcX	Endpoint 1 x
nSrcY	Endpoint 1 y
nDstX	Endpoint 2 x
nDstY	Endpoint 2 y
iColor	Pixel value

◆ line() [2/2]

void Bagel::CBofBitmap::line	(	CBofPoint *	pSrc,
		CBofPoint *	pDest,
		byte	iColor
	)

Writes a line into this bitmap

Parameters

pSrc	Endpoint 1
pDest	Endpoint 2
iColor	Pixel value

◆ drawRect()

void Bagel::CBofBitmap::drawRect	(	CBofRect *	cRect,
		byte	iColor
	)

Writes a Rectangle into this bitmap

Parameters

cRect	Pointer to rectangle Coordinates
iColor	Color of rectangle

◆ fillRect()

void Bagel::CBofBitmap::fillRect	(	CBofRect *	cRect,
		byte	iColor
	)

Writes a filled in Rectangle to this bitmap

Parameters

cRect	Pointer to rectangle Coordinates
iColor	Color of rectangle

◆ scrollRight()

ErrorCode Bagel::CBofBitmap::scrollRight	(	int	nPixels,
		CBofRect *	pRect = `nullptr`
	)

Scrolls current bitmap horizontally

Parameters

nPixels	Number of pixels to scroll by
pRect	Section of bitmap to scroll

Returns: Error return code

◆ scrollUp()

ErrorCode Bagel::CBofBitmap::scrollUp ( int nPixels )

Scrolls current bitmap vertically

Parameters

nPixels Number of pixels to scroll by

Returns: Error return code

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

engines/bagel/boflib/gfx/bitmap.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ CBofBitmap() [1/3]

◆ CBofBitmap() [2/3]

◆ CBofBitmap() [3/3]

◆ ~CBofBitmap()

Member Function Documentation

◆ alloc()

◆ free()

◆ buildBitmap()

◆ loadBitmap()

◆ releaseBitmap()

◆ setPalette()

◆ getPixelAddress()

◆ getFileName()

◆ paint() [1/4]

◆ paint() [2/4]

◆ paintMaskBackdrop()

◆ paint() [3/4]

◆ paint() [4/4]

◆ paintStretch4()

◆ paintStretchOpt()

◆ paint1To1()

◆ captureScreen()

◆ fadeIn()

◆ readPixel()

◆ writePixel()

◆ circle()

◆ line() [1/2]

◆ line() [2/2]

◆ drawRect()

◆ fillRect()

◆ scrollRight()

◆ scrollUp()