ScummVM API documentation
Graphics::DirtyRectList Class Reference

#include <dirtyrects.h>

Public Types

typedef Common::List< Common::Rect >::const_iterator const_iterator
 

Public Member Functions

void merge ()
 
bool empty () const
 
void clear ()
 
template<class... TArgs>
void emplace_back (TArgs &&...args)
 
void push_back (const Common::Rect &r)
 
void push_back (Common::Rect &&r)
 
const_iterator begin () const
 
const_iterator end () const
 

Protected Member Functions

bool unionRectangle (Common::Rect &destRect, const Common::Rect &src1, const Common::Rect &src2)
 

Protected Attributes

Common::List< Common::Rect_dirtyRects
 

Detailed Description

This class keeps track of any areas of a surface that are updated by drawing calls.

Member Typedef Documentation

◆ const_iterator

Member Function Documentation

◆ unionRectangle()

bool Graphics::DirtyRectList::unionRectangle ( Common::Rect destRect,
const Common::Rect src1,
const Common::Rect src2 
)
protected

Returns the union of two dirty area rectangles

◆ merge()

void Graphics::DirtyRectList::merge ( )

Merges together overlapping dirty areas of the screen

◆ empty()

bool Graphics::DirtyRectList::empty ( ) const
inline

Returns true if there are no pending screen updates (dirty areas)

◆ clear()

void Graphics::DirtyRectList::clear ( )
inline

Clear the current dirty rects list

◆ emplace_back()

template<class... TArgs>
void Graphics::DirtyRectList::emplace_back ( TArgs &&...  args)
inline

Adds a rectangle to the list of modified areas of the screen during the current frame

◆ push_back() [1/2]

void Graphics::DirtyRectList::push_back ( const Common::Rect r)
inline

Adds a rectangle to the list of modified areas of the screen during the current frame

◆ push_back() [2/2]

void Graphics::DirtyRectList::push_back ( Common::Rect &&  r)
inline

Adds a rectangle to the list of modified areas of the screen during the current frame

◆ begin()

const_iterator Graphics::DirtyRectList::begin ( ) const
inline

Return a const iterator to the start of the list. This can be used, for example, to iterate from the first element of the list to the last element of the list.

◆ end()

const_iterator Graphics::DirtyRectList::end ( ) const
inline

Return a const iterator to the end of the list.

Member Data Documentation

◆ _dirtyRects

Common::List<Common::Rect> Graphics::DirtyRectList::_dirtyRects
protected

List of affected areas of the screen


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