ui::Renderable Struct Reference

An abstract interface for arbitrary renderable objects. More...

#include <renderable.hpp>

Inheritance diagram for ui::Renderable:

Public Member Functions
virtual void	renderAt (const Coords &coords, const shader_t &shader=0) const =0
	Display the renderable directly onto the screen.
virtual Size	getSize () const =0
	Get the size of the renderable.

Detailed Description

An abstract interface for arbitrary renderable objects.

Renderable objects can include constructs like images, animations, etc.

Member Function Documentation

getSize()

virtual Size ui::Renderable::getSize ( ) const

pure virtual

Get the size of the renderable.

Returns

The size of the renderable in pixels.

Implemented in ui::Bitmap, ui::TransparencyMap, ui::Bmp, ui::Jpeg, ui::Png, ui::Circle, ui::Ellipse, ui::Polygon, and ui::Spiral.

renderAt()

virtual void ui::Renderable::renderAt ( const Coords &  coords, const shader_t &  shader = 0  ) const

pure virtual

Display the renderable directly onto the screen.

Parameters

coords	The coordinates to render the first pixel [0,0] of the renderable.
shader	An optional pixel shader to apply to each pixel of the renderable.

Implemented in ui::Circle, ui::Ellipse, ui::Polygon, ui::Spiral, ui::Bitmap, ui::CompressedTransparencyMap, ui::TransparencyMap, ui::TransparentBitmap, ui::Bmp, ui::Jpeg, and ui::Png.

---

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

• src/ui/core/renderable.hpp