gramods
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
gramods::gmCore::SdlContext Class Reference

The SdlContext class initializes SDL with the specified parameters. More...

#include <SdlContext.hh>

Inheritance diagram for gramods::gmCore::SdlContext:
Inheritance graph
[legend]
Collaboration diagram for gramods::gmCore::SdlContext:
Collaboration graph
[legend]

Public Member Functions

void setUseVideo (bool on)
 Enable or disable initialization of SDL video engine. More...
 
void setUseAudio (bool on)
 Enable or disable initialization of SDL audio engine. More...
 
void initialize () override
 Called to initialize the Object. More...
 
virtual std::string getDefaultKey () override
 Returns the default key, in Configuration, for the Object. More...
 
- Public Member Functions inherited from gramods::gmCore::Object
 Object ()
 Initializes internal data. More...
 
virtual ~Object ()
 Cleaning up internal data. More...
 
virtual void accept (Visitor *visitor)
 Calls the visitors apply method with this as argument. More...
 
virtual void traverse (Visitor *visitor)
 Calls the child Object's accept method, if such exist. More...
 
bool isInitialized ()
 Returns true if the Object is initialized. More...
 

Static Public Member Functions

static bool hasVideo ()
 Returns true if context has been initialized with video support. More...
 
static bool hasAudio ()
 Returns true if context has been initialized with audio support. More...
 

Static Public Attributes

static gramods::gmCore::OFactory::OFactoryInformation _gm_ofi
 

Detailed Description

The SdlContext class initializes SDL with the specified parameters.

SDL will be closed when the object is destroyed.

Member Function Documentation

◆ getDefaultKey()

virtual std::string gramods::gmCore::SdlContext::getDefaultKey ( )
inlineoverridevirtual

Returns the default key, in Configuration, for the Object.

Reimplemented from gramods::gmCore::Object.

◆ hasAudio()

bool gramods::gmCore::SdlContext::hasAudio ( )
static

Returns true if context has been initialized with audio support.

◆ hasVideo()

bool gramods::gmCore::SdlContext::hasVideo ( )
static

Returns true if context has been initialized with video support.

◆ initialize()

void gramods::gmCore::SdlContext::initialize ( )
overridevirtual

Called to initialize the Object.

This should be called once only!

Sub classes should override this method to make use of set parameter data. They should also always call its base class' implementation as well.

Reimplemented from gramods::gmCore::Object.

◆ setUseAudio()

gramods::gmCore::OFactory::ParamSetterInsert gm_ofi_SdlContext_param_useAudio &SdlContext::_gm_ofi(& gramods::gmCore::SdlContext::setUseAudio ( bool  on)
inline

Enable or disable initialization of SDL audio engine.

Default is false.

XML-attribute: useAudio

◆ setUseVideo()

gramods::gmCore::OFactory::ParamSetterInsert gm_ofi_SdlContext_param_useVideo &SdlContext::_gm_ofi(& gramods::gmCore::SdlContext::setUseVideo ( bool  on)
inline

Enable or disable initialization of SDL video engine.

Default is false.

XML-attribute: useVideo


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