ScummVM API documentation
ScalerPluginObject Class Referenceabstract
Inheritance diagram for ScalerPluginObject:
PluginObject

Public Member Functions

virtual ScalercreateInstance (const Graphics::PixelFormat &format) const =0
 
const Common::Array< uint > & getFactors () const
 
bool hasFactor (uint factor) const
 
virtual uint extraPixels () const =0
 
virtual bool canDrawCursor () const =0
 
virtual const char * getPrettyName () const =0
 
virtual uint getDefaultFactor () const
 
virtual bool useOldSource () const
 
- Public Member Functions inherited from PluginObject
virtual const char * getName () const =0
 

Protected Attributes

Common::Array< uint > _factors
 

Member Function Documentation

◆ extraPixels()

virtual uint ScalerPluginObject::extraPixels ( ) const
pure virtual

Indicates how far outside the scaling region this scaler "looks"

Returns
The number of pixels in any direction

◆ canDrawCursor()

virtual bool ScalerPluginObject::canDrawCursor ( ) const
pure virtual

Some scalers are not suitable for scaling the cursor. Blurring scalers should return false.

◆ getPrettyName()

virtual const char* ScalerPluginObject::getPrettyName ( ) const
pure virtual

This value will be displayed on the GUI.

◆ getDefaultFactor()

virtual uint ScalerPluginObject::getDefaultFactor ( ) const
inlinevirtual

The default scale factor.

◆ useOldSource()

virtual bool ScalerPluginObject::useOldSource ( ) const
inlinevirtual

Computationally intense scalers can benefit from comparing new and old source images and updating only the pixels necessary. If the function returns true, this scaler prefers this method and the backend can optionally use it.

See also
enableSource
setSource

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