sdl::video::Overlay Class Reference

Represents an overlay. More...

#include <Overlay.h>

List of all members.

Public Member Functions
	Overlay (const Rect &rect, Uint32 format, const Surface &display)
	~Overlay ()
bool	lock ()
void	unlock ()
bool	display (Rect &dstRect)

---

Detailed Description

Represents an overlay.

Definition at line 37 of file Overlay.h.

---

Constructor & Destructor Documentation

sdl::video::Overlay::Overlay	(	const Rect &	rect,
		Uint32	format,
		const Surface &	display
	)		[inline]

Constructs an Overlay.

Parameters:

rect	A rectangle describing the height and width of the Overlay.
format	The format of the Overlay.
display	The Surface on which to display the Overlay.

Definition at line 46 of file Overlay.h.

sdl::video::Overlay::~Overlay

(

)

[inline]

Destroys the Overlay.

Definition at line 52 of file Overlay.h.

---

Member Function Documentation

bool sdl::video::Overlay::display

(

Rect &

dstRect

)

[inline]

Displays the Overlay.

Parameters:

rect	The rectangle onto which to blit.

Returns:

True if successful, false otherwise.

Definition at line 73 of file Overlay.h.

bool sdl::video::Overlay::lock

(

)

[inline]

Locks the Overlay.

Returns:

True if the Overlay was locked, false otherwise.

Definition at line 59 of file Overlay.h.

void sdl::video::Overlay::unlock

(

)

[inline]

Unlocks the Overlay.

Definition at line 64 of file Overlay.h.

---

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

• video/Overlay.h