ScummVM API documentation
Wintermute::BaseRenderer Class Referenceabstract
Inheritance diagram for Wintermute::BaseRenderer:
Wintermute::BaseClass Wintermute::BaseRenderer3D Wintermute::BaseRenderOSystem

Public Member Functions

void dumpData (const char *filename)
 
virtual BaseImagetakeScreenshot (int newWidth=0, int newHeight=0)=0
 
virtual bool setViewport (int left, int top, int right, int bottom)
 
virtual bool setViewport (Common::Rect32 *rect)
 
virtual bool setScreenViewport ()
 
virtual void setWindowed (bool windowed)=0
 
virtual Graphics::PixelFormat getPixelFormat () const =0
 
virtual bool fade (uint16 alpha)=0
 
virtual bool fadeToColor (byte r, byte g, byte b, byte a)=0
 
virtual bool drawLine (int x1, int y1, int x2, int y2, uint32 color)
 
virtual bool drawRect (int x1, int y1, int x2, int y2, uint32 color, int width=1)
 
virtual bool fillRect (int x, int y, int w, int h, uint32 color)
 
 BaseRenderer (BaseGame *inGame=nullptr)
 
virtual bool setProjection ()
 
virtual bool windowedBlt ()
 
virtual bool clear ()=0
 
virtual void onWindowChange ()
 
virtual bool initRenderer (int width, int height, bool windowed)
 
virtual bool flip ()=0
 
virtual bool indicatorFlip (int32 x, int32 y, int32 width, int32 height)=0
 
virtual bool forcedFlip ()=0
 
virtual void initLoop ()
 
virtual bool setup2D (bool force=false)
 
virtual Common::String getName () const =0
 
virtual bool displayDebugInfo ()
 
virtual bool drawShaderQuad ()
 
virtual float getScaleRatioX () const
 
virtual float getScaleRatioY () const
 
virtual BaseSurfacecreateSurface ()=0
 
bool clipCursor ()
 
bool unclipCursor ()
 
BaseObjectgetObjectAt (int x, int y)
 
void deleteRectList ()
 
virtual bool startSpriteBatch ()
 
virtual bool endSpriteBatch ()
 
bool pointInViewport (Common::Point32 *P)
 
bool isReady () const
 
bool isWindowed () const
 
int32 getBPP () const
 
int32 getWidth () const
 
int32 getHeight () const
 
virtual void endSaveLoad ()
 
- Public Member Functions inherited from Wintermute::BaseClass
bool setEditorProp (const Common::String &propName, const Common::String &propValue)
 
Common::String getEditorProp (const Common::String &propName, const Common::String &initVal=Common::String())
 
 BaseClass (TDynamicConstructor, TDynamicConstructor)
 
bool parseEditorProperty (char *buffer, bool complete=true)
 
virtual bool saveAsText (BaseDynamicBuffer *buffer, int indent=0)
 
 BaseClass (BaseGame *gameOwner)
 
virtual const char * getClassName ()
 
virtual bool persist (BasePersistenceManager *persistMgr)
 

Public Attributes

int _realWidth
 
int _realHeight
 
int _drawOffsetX
 
int _drawOffsetY
 
uint32 _forceAlphaColor
 
uint32 _window
 
uint32 _clipperWindow
 
bool _active
 
bool _ready
 
bool _windowed
 
Common::Rect32 _windowRect
 
Common::Rect32 _viewportRect
 
Common::Rect32 _screenRect
 
Common::Rect32 _monitorRect
 
int32 _bPP
 
int32 _height
 
int32 _width
 
BaseArray< BaseActiveRect * > _rectList
 
- Public Attributes inherited from Wintermute::BaseClass
bool _persistable
 
BaseGame_game
 
Common::HashMap< Common::String, Common::String_editorProps
 
Common::HashMap< Common::String, Common::String >::iterator _editorPropsIter
 

Detailed Description

interface for the rendering portion of WME this interface is mainly intended to wrap away any differencies between software-rendering/hardware-rendering.

Member Function Documentation

◆ takeScreenshot()

virtual BaseImage* Wintermute::BaseRenderer::takeScreenshot ( int  newWidth = 0,
int  newHeight = 0 
)
pure virtual

Take a screenshot of the current screenstate

Returns
a BaseImage containing the current screen-buffer.

Implemented in Wintermute::BaseRenderOSystem.

◆ fade()

virtual bool Wintermute::BaseRenderer::fade ( uint16  alpha)
pure virtual

Fade the screen to black

Parameters
alphaamount to fade by (alpha value of black)

Implemented in Wintermute::BaseRenderer3D, and Wintermute::BaseRenderOSystem.

◆ fadeToColor()

virtual bool Wintermute::BaseRenderer::fadeToColor ( byte  r,
byte  g,
byte  b,
byte  a 
)
pure virtual

Fade a portion of the screen to a specific color

Parameters
rthe red component to fade too.
gthe green component to fade too.
bthe blue component to fade too.
athe alpha component to fade too.
rectthe portion of the screen to fade (if nullptr, the entire screen will be faded).

Implemented in Wintermute::BaseRenderOSystem.

◆ clear()

virtual bool Wintermute::BaseRenderer::clear ( )
pure virtual

Clear the screen

Implemented in Wintermute::BaseRenderOSystem.

◆ flip()

virtual bool Wintermute::BaseRenderer::flip ( )
pure virtual

Flip the backbuffer onto the screen-buffer The screen will NOT be updated before calling this function.

Returns
true if successful, false on error.

Implemented in Wintermute::BaseRenderer3D, and Wintermute::BaseRenderOSystem.

◆ indicatorFlip()

virtual bool Wintermute::BaseRenderer::indicatorFlip ( int32  x,
int32  y,
int32  width,
int32  height 
)
pure virtual

Special flip for the indicator drawn during save/load essentially, just copies the region defined by the indicator rectangle.

Implemented in Wintermute::BaseRenderer3D, and Wintermute::BaseRenderOSystem.

◆ getName()

virtual Common::String Wintermute::BaseRenderer::getName ( ) const
pure virtual

Get the name of the current renderer

Returns
the name of the renderer.

Implemented in Wintermute::BaseRenderOSystem.

◆ createSurface()

virtual BaseSurface* Wintermute::BaseRenderer::createSurface ( )
pure virtual

Create a Surface fit for use with the renderer. As diverse implementations of BaseRenderer might have different solutions for storing surfaces this allows for a common interface for creating surface-handles. (Mostly useful to ease future implementation of hw-accelerated rendering, or readding 3D-support at some point).

Returns
a surface that can be used with this renderer

Implemented in Wintermute::BaseRenderOSystem.


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