As much as possible, consider using strong typing.
Classes | |
| class | CommonModule |
| Root of all OSDL modules. More... | |
| class | CDTrack |
| Describes a CD track, it is just an object-oriented view of an actual track. More... | |
| class | CDROMDrive |
| A CD-ROM drive allows to control a particular CD-ROM device attached to the system. More... | |
| class | CDROMDriveException |
| Exception returned whenever an error concerning a CD-ROM drive occured. More... | |
| class | CDROMDriveHandler |
| A CD-ROM drive handler manages all CD-ROM device attached to the system, so they can be used easily and safely, by ensuring at most one CD-ROM drive object is associated to an actual device. More... | |
| class | Exception |
| OSDL exception. More... | |
| class | TestException |
| Test class for OSDL::Exception. More... | |
Namespaces | |
| namespace | Audio |
| namespace | Engine |
| namespace | Events |
| Deals with all events of interest for a multimedia engine. | |
| namespace | MVC |
| namespace | Rendering |
| namespace | Utils |
| Various convenient helpers are defined here. | |
| namespace | Video |
Typedefs | |
| typedef Ceylan::Count | TrackNumber |
| typedef Ceylan::Uint32 | FrameCount |
| Describes a number of CD frames. | |
| typedef Ceylan::Count | CDROMDriveNumber |
| CD-ROM drive numbers are mainly used to identify a CD-ROM drive. | |
Enumerations | |
| enum | TrackType { audioTrack, dataTrack } |
| Describes the different kinds of tracks. More... | |
Functions | |
| const Ceylan::LibtoolVersion & | GetVersion () throw () |
| Returns the version of the OSDL library currently linked. | |
| CommonModule & | getCommonModule (Flags flags) throw () |
| bool | hasExistingCommonModule () throw () |
| Tells whether there already exists a common module. | |
| CommonModule & | getExistingCommonModule () throw () |
| This function is intended to be the usual means of getting a reference to the common module, which must already exist. | |
| void | stop () throw () |
| Shutdowns all OSDL services. | |
| OSDL_DLL CommonModule & | getCommonModule (Ceylan::Flags flags) throw () |
| This friend function is intended to be the initial means of getting a reference to the common module : this is the entry point to the whole OSDL system. | |
Variables | |
| OSDL_DLL const std::string | actualOSDLHeaderLibtoolVersion = "0.4.0" |
| This is the libtool version of the OSDL headers, as defined in the configure step. | |
| typedef Ceylan::Count OSDL::CDROMDriveNumber |
CD-ROM drive numbers are mainly used to identify a CD-ROM drive.
They range from 0 (included) to n, 0 being the default drive, if any.
Definition at line 37 of file OSDLCDROMDriveHandler.h.
| typedef Ceylan::Uint32 OSDL::FrameCount |
| typedef Ceylan::Count OSDL::TrackNumber |
Definition at line 28 of file OSDLCDROMDrive.h.
| enum OSDL::TrackType |
| OSDL_DLL CommonModule& OSDL::getCommonModule | ( | Ceylan::Flags | flags | ) | throw () |
This friend function is intended to be the initial means of getting a reference to the common module : this is the entry point to the whole OSDL system.
| flags | The requested flags for this common root module, any OR'd combination of CommonModule static flags, so that associated subsystems are instanciated. |
This method is not static to avoid pitfalls of static initializer ordering.
| CommonModule& OSDL::getCommonModule | ( | Flags | flags | ) | throw () |
Definition at line 591 of file OSDLBasic.cc.
References OSDL::CommonModule::_CurrentCommonModule, OSDL::CommonModule::AutoCorrectFlags(), and OSDL::Video::Pixels::toString().
| OSDL_DLL CommonModule & OSDL::getExistingCommonModule | ( | ) | throw () |
This function is intended to be the usual means of getting a reference to the common module, which must already exist.
If not, a fatal error will be triggered (not an exception to avoid handling it in all user methods).
Definition at line 664 of file OSDLBasic.cc.
References OSDL::CommonModule::_CurrentCommonModule.
Referenced by OSDL::Events::EventsModule::enterBasicMainLoop(), OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Video::VideoModule::IsDisplayInitialized(), OSDL::Events::EventsModule::onResizedWindow(), OSDL::Events::EventsModule::onScreenNeedsRedraw(), OSDL::Video::Overlay::Overlay(), OSDL::Engine::Scheduler::schedule(), and smarterKeyHandler().
| OSDL_DLL const Ceylan::LibtoolVersion & OSDL::GetVersion | ( | ) | throw () |
Returns the version of the OSDL library currently linked.
Definition at line 44 of file OSDLBasic.cc.
References OSDL_LIBTOOL_VERSION.
Referenced by OSDL::CommonModule::toString().
| OSDL_DLL bool OSDL::hasExistingCommonModule | ( | ) | throw () |
Tells whether there already exists a common module.
Definition at line 656 of file OSDLBasic.cc.
References OSDL::CommonModule::_CurrentCommonModule.
Referenced by OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Video::VideoModule::IsDisplayInitialized(), and OSDL::Video::Overlay::Overlay().
| OSDL_DLL void OSDL::stop | ( | ) | throw () |
Shutdowns all OSDL services.
Definition at line 676 of file OSDLBasic.cc.
References OSDL::CommonModule::_CurrentCommonModule.
Referenced by OSDL::Engine::Scheduler::onScheduleFailure().
| OSDL_DLL const std::string OSDL::actualOSDLHeaderLibtoolVersion = "0.4.0" |
This is the libtool version of the OSDL headers, as defined in the configure step.
Allows to detect run-time mismatches between the OSDL headers a program or a library was compiled with, and the actual OSDL library it is then linked to.
Definition at line 21 of file OSDLHeaderVersion.h.
1.5.1