Arcade architecture
Public Member Functions | List of all members
IDisplayModule Class Referenceabstract

Interface for display modules. More...

#include <IDisplayModule.hpp>

Inheritance diagram for IDisplayModule:
Inheritance graph
[legend]

Public Member Functions

virtual ~IDisplayModule ()=default
 Virtual destructor. More...
 
virtual void init ()=0
 Initialize the display module. More...
 
virtual void stop ()=0
 Stop the display module. More...
 
virtual const std::string & getName () const =0
 Retrieves the name of the display module. More...
 

Detailed Description

Interface for display modules.

The IDisplayModule interface defines the methods that must be implemented by any display module in the barcade project. These methods include initialization, stopping, and retrieving the module's name.

Constructor & Destructor Documentation

◆ ~IDisplayModule()

virtual IDisplayModule::~IDisplayModule ( )
virtualdefault

Virtual destructor.

Ensures proper cleanup of derived classes.

Member Function Documentation

◆ getName()

virtual const std::string & IDisplayModule::getName ( ) const
pure virtual

Retrieves the name of the display module.

This function returns a constant reference to a string representing the name of the display module. It is a pure virtual function and must be implemented by any class inheriting from this interface.

Returns
const std::string& A constant reference to the name of the display module.

Implemented in arcadeCaca, arcadeSdl2, arcadeSfml, and DisplayModule.

◆ init()

virtual void IDisplayModule::init ( )
pure virtual

Initialize the display module.

This method is responsible for setting up any necessary resources or configurations required by the display module.

Implemented in arcadeCaca, arcadeSdl2, arcadeSfml, and DisplayModule.

◆ stop()

virtual void IDisplayModule::stop ( )
pure virtual

Stop the display module.

This method is responsible for releasing any resources or configurations used by the display module.

Implemented in arcadeCaca, arcadeSdl2, arcadeSfml, and DisplayModule.

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