Graphics::SurfaceObject Class Reference

Describes a target surface and corresponding source location. More...

#include <Object.h>

Inheritance diagram for Graphics::SurfaceObject:
Collaboration diagram for Graphics::SurfaceObject:

Public Member Functions

 SurfaceObject (Surface &surface, const Rect &dest, Point source)
 Constructor. More...
 
RenderercreateRenderer (const Location &location) const override
 Create a software renderer for this object. More...
 
void write (MetaWriter &meta) const override
 
- Public Member Functions inherited from Graphics::ObjectTemplate< Object::Kind::Surface >
Kind kind () const override
 
- Public Member Functions inherited from Graphics::Object
bool operator== (const Object &other) const
 
virtual String getTypeStr () const
 
- Public Member Functions inherited from LinkedObjectTemplate< Object >
Object * getNext () const
 
bool insertAfter (Object *object)
 
Iterator begin () const
 
Iterator end () const
 
Iterator cbegin () const
 
Iterator cend () const
 
- Public Member Functions inherited from LinkedObject
virtual ~LinkedObject ()
 
virtual LinkedObjectnext () const
 
bool insertAfter (LinkedObject *object)
 
bool operator== (const LinkedObject &other) const
 
bool operator!= (const LinkedObject &other) const
 

Public Attributes

Surfacesurface
 
Rect dest
 
Point source
 

Additional Inherited Members

- Public Types inherited from Graphics::Object
enum class  Kind { XX }
 
using List = LinkedObjectListTemplate< Object >
 
using OwnedList = OwnedLinkedObjectListTemplate< Object >
 
- Public Types inherited from LinkedObjectTemplate< Object >
using Iterator = IteratorTemplate< Object, Object *, Object & >
 
using ConstIterator = IteratorTemplate< const Object, const Object *, const Object & >
 

Detailed Description

Describes a target surface and corresponding source location.

Used in surface copy operations to read display memory contents.

Constructor & Destructor Documentation

◆ SurfaceObject()

Graphics::SurfaceObject::SurfaceObject ( Surface surface,
const Rect dest,
Point  source 
)
inline

Constructor.

Parameters
surface
destWhere on the surface to write
sourceStart position of source

Member Function Documentation

◆ createRenderer()

Renderer* Graphics::SurfaceObject::createRenderer ( const Location location) const
overridevirtual

Create a software renderer for this object.

Parameters
location
Return values
rendererReturned renderer object

Return nullptr if object cannot/should not be rendered

Implements Graphics::Object.

◆ write()

void Graphics::SurfaceObject::write ( MetaWriter meta) const
overridevirtual

Implements Graphics::Object.

Member Data Documentation

◆ dest

Rect Graphics::SurfaceObject::dest

◆ source

Point Graphics::SurfaceObject::source

◆ surface

Surface& Graphics::SurfaceObject::surface

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