ScummVM API documentation
Cine::FWRenderer Class Reference

#include <gfx.h>

Inheritance diagram for Cine::FWRenderer:
Common::NonCopyable Cine::OSRenderer

Public Member Functions

virtual bool initialize ()
 
virtual bool ready ()
 
virtual unsigned int currentBg ()
 
virtual unsigned int scrollBg ()
 
virtual bool useTransparentDialogBoxes ()
 
virtual void clear ()
 
void drawFrame (bool wait=false)
 
void drawCommand ()
 
void setCommand (Common::String cmd)
 
Common::String getCommand ()
 
virtual void blit ()
 
virtual void blitBackBuffer ()
 
virtual void incrustMask (const BGIncrust &incrust, uint8 color=0)
 
virtual void incrustSprite (const BGIncrust &incrust)
 
virtual bool hasSavedBackBuffer (BackBufferSource source)
 
virtual void saveBackBuffer (BackBufferSource source)
 
virtual void popSavedBackBuffer (BackBufferSource source)
 
virtual void restoreSavedBackBuffer (BackBufferSource source)
 
virtual void removeSavedBackBuffer (BackBufferSource source)
 
virtual int16 addBackground (const char *bgName, uint16 bgIdx)
 
virtual void loadBg16 (const byte *bg, const char *name, unsigned int idx=0)
 
virtual void loadCt16 (const byte *ct, const char *name)
 
virtual void loadBg256 (const byte *bg, const char *name, unsigned int idx=0)
 
virtual void loadCt256 (const byte *ct, const char *name)
 
virtual void selectBg (unsigned int idx)
 
virtual void selectScrollBg (unsigned int idx)
 
virtual void setScroll (unsigned int shift)
 
virtual uint getScroll () const
 
virtual void removeBg (unsigned int idx)
 
virtual void saveBgNames (Common::OutSaveFile &fHandle)
 
virtual const char * getBgName (uint idx=0) const
 
virtual void setBlackPalette (bool updateChangePal)
 
virtual void setPalette ()
 
virtual void restorePalette (Common::SeekableReadStream &fHandle, int version)
 
virtual void savePalette (Common::OutSaveFile &fHandle)
 
virtual void rotatePalette (int firstIndex, int lastIndex, int mode)
 
virtual void transformPalette (int first, int last, int r, int g, int b)
 
void pushMenu (Menu *menu)
 
MenupopMenu ()
 
void clearMenuStack ()
 
virtual uint fadeDelayMs ()
 
virtual uint fadeToBlackMinMs ()
 
virtual void fadeToBlack ()
 
virtual void fadeFromBlack ()
 
void showCollisionPage (bool state)
 
void drawString (const char *string, byte param)
 
int getStringWidth (const char *str)
 

Public Attributes

uint16 _messageBg
 Message box background color.
 
uint16 _cmdY
 Player command string position on screen.
 

Protected Member Functions

virtual const Cine::PalettegetFadeInSourcePalette ()
 
void fillSprite (const ObjectStruct &obj, uint8 color=0)
 
void drawMaskedSprite (const ObjectStruct &obj, const byte *mask)
 
virtual void drawSprite (const ObjectStruct &obj)
 
int drawMessage (const char *str, int x, int y, int width, int color, bool draw=true)
 
void drawPlainBox (int x, int y, int width, int height, byte color)
 
byte transparentDialogBoxStartColor ()
 
void drawTransparentBox (int x, int y, int width, int height)
 
void drawBorder (int x, int y, int width, int height, byte color)
 
void drawDoubleBorder (int x, int y, int width, int height, byte color)
 
virtual int drawChar (char character, int x, int y, bool draw=true)
 
virtual int undrawChar (char character, int x, int y)
 
void drawLine (int x, int y, int width, int height, byte color)
 
void remaskSprite (byte *mask, Common::List< overlay >::iterator it)
 
virtual void drawBackground ()
 
virtual void clearBackBuffer ()
 
virtual void removeSavedBackBuffers ()
 
virtual void renderOverlay (const Common::List< overlay >::iterator &it)
 
void drawOverlays ()
 
virtual void blit (bool useCollisionPage)
 

Protected Attributes

byte * _backBuffer
 Screen backbuffer.
 
Cine::Palette _backupPal
 The backup color palette.
 
Cine::Palette _activePal
 The active color palette.
 
Common::Stack< Menu * > _menuStack
 All displayed menus.
 
int _changePal
 Load active palette to video backend on next frame.
 
bool _showCollisionPage
 Should we show the collision page instead of the back buffer? Used for debugging.
 
uint32 _fadeToBlackLastCalledMs
 

Static Protected Attributes

static const int _screenSize = 320 * 200
 Screen size.
 
static const int _screenWidth = 320
 Screen width.
 
static const int _screenHeight = 200
 Screen height.
 

Detailed Description

Future Wars renderer

Screen backbuffer is not cleared between frames.

Member Function Documentation

◆ ready()

virtual bool Cine::FWRenderer::ready ( )
inlinevirtual

Test if renderer is ready to draw

Reimplemented in Cine::OSRenderer.

◆ saveBackBuffer()

virtual void Cine::FWRenderer::saveBackBuffer ( BackBufferSource  source)
virtual

Saves back buffer content without palette.

◆ restoreSavedBackBuffer()

virtual void Cine::FWRenderer::restoreSavedBackBuffer ( BackBufferSource  source)
virtual

Restores back buffer content without palette.


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