sdl::subsystem::Subsystem< T, Base > Struct Template Reference

Represents a SDL subsystem. More...

#include <Subsystem.h>

List of all members.

Public Member Functions
Subsystem &	open ()
Subsystem &	close ()
Static Public Member Functions
static Subsystem &	instance ()
static bool	isOpen ()
Protected Member Functions
Subsystem &	init ()
Subsystem &	quit ()
	Subsystem ()
	Subsystem (const Subsystem &rhs)
	~Subsystem ()
Subsystem &	operator= (const Subsystem &rhs)

---

Detailed Description

template<int T, class Base>
struct sdl::subsystem::Subsystem< T, Base >

Represents a SDL subsystem.

Template Parameters:

T	The SDL subsystem type.
Base	The Subsystem base class.

Definition at line 43 of file Subsystem.h.

---

Constructor & Destructor Documentation

template<int T, class Base >

sdl::subsystem::Subsystem< T, Base >::Subsystem

(

)

[inline, protected]

Constructs a Subsystem.

Definition at line 109 of file Subsystem.h.

template<int T, class Base >

sdl::subsystem::Subsystem< T, Base >::Subsystem

(

const Subsystem< T, Base > &

rhs

)

[inline, protected]

Copy constructs a Subsystem.

Parameters:

rhs	The Subsystem to copy.

Definition at line 116 of file Subsystem.h.

template<int T, class Base >

sdl::subsystem::Subsystem< T, Base >::~Subsystem

(

)

[inline, protected]

Destroys the Subsystem.

Definition at line 121 of file Subsystem.h.

---

Member Function Documentation

template<int T, class Base >

Subsystem& sdl::subsystem::Subsystem< T, Base >::close

(

)

[inline]

Closes the Subsystem.

Returns:

A reference to this Subsystem.

Definition at line 77 of file Subsystem.h.

template<int T, class Base >

Subsystem& sdl::subsystem::Subsystem< T, Base >::init

(

)

[inline, protected]

Initializes the Subsystem.

Returns:

A reference to this Subsystem.

Exceptions:

runtime_error

Throws a runtime_error if unable to initialize subsystem.

Definition at line 90 of file Subsystem.h.

template<int T, class Base >

static Subsystem& sdl::subsystem::Subsystem< T, Base >::instance

(

)

[inline, static]

Returns a reference to the Subsystem instance.

Returns:

A reference to the Subsystem.

Definition at line 50 of file Subsystem.h.

template<int T, class Base >

static bool sdl::subsystem::Subsystem< T, Base >::isOpen

(

)

[inline, static]

Determines if the Subsystem is open.

Returns:

True if the subsystem is open, false otherwise.

Definition at line 60 of file Subsystem.h.

template<int T, class Base >

Subsystem& sdl::subsystem::Subsystem< T, Base >::open

(

)

[inline]

Opens the Subsystem.

Returns:

A reference to this Subsystem.

Definition at line 67 of file Subsystem.h.

template<int T, class Base >

Subsystem& sdl::subsystem::Subsystem< T, Base >::operator=

(

const Subsystem< T, Base > &

rhs

)

[inline, protected]

The assignment operator.

Parameters:

rhs	The Subsystem from which to assign.

Returns:

A reference to this Subsystem.

Definition at line 130 of file Subsystem.h.

template<int T, class Base >

Subsystem& sdl::subsystem::Subsystem< T, Base >::quit

(

)

[inline, protected]

Quits the Subsystem.

Returns:

A reference to this Subsystem.

Definition at line 101 of file Subsystem.h.

---

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

• subsystem/Subsystem.h