Renderer application class. More...
#include <RendererApplication.h>
Protected Member Functions | |
| virtual PLRENDERER_API bool | OnStart () override |
| Initialization function that is called prior to OnInit() | |
| virtual PLRENDERER_API void | OnStop () override |
| De-initialization function that is called after OnDeInit() | |
| virtual PLRENDERER_API void | OnFullscreenMode () override |
| Called when the fullscreen mode was changed. | |
| virtual PLRENDERER_API void | OnDraw () override |
| Called to let the frontend draw into it's window. | |
| virtual PLRENDERER_API void | OnUpdate () override |
| Called to let the frontend update it's states. | |
| virtual PLRENDERER_API void | OnCreateRendererContext () |
| Function that is called to create the application's renderer context. | |
| virtual PLRENDERER_API void | OnCreatePainter () |
| Function that is called to create the application's surface painter. | |
Protected Attributes | |
| PLCore::String | m_sSurfacePainter |
| PLRenderer::RendererContext * | m_pRendererContext |
| PLRenderer::DisplayMode * | m_pDisplayMode |
Detailed Description
Renderer application class.
- Remarks:
- An application class for programs that open a single widget to render into.
Member Function Documentation
| virtual PLRENDERER_API bool PLRenderer::RendererApplication::OnStart | ( | ) | [override, protected, virtual] |
Initialization function that is called prior to OnInit()
- Returns:
- 'true' if all went fine, else 'false' which will stop the application
- Remarks:
- The default implementation does the following tasks:
- Everything that PLCore::CoreApplication::OnStart() does
- Call OnCreateRendererContext()
- Call OnCreatePainter()
- Return and go on with OnInit()
Reimplemented from PLCore::CoreApplication.
Reimplemented in PLEngine::EngineApplication, and PLScene::SceneApplication.
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnStop | ( | ) | [override, protected, virtual] |
De-initialization function that is called after OnDeInit()
- Remarks:
- The default implementation does the following tasks:
- Save renderer related configuration
- Destroy renderer context
- Everything that FrontendApplication::OnStop() does
Reimplemented from PLCore::FrontendApplication.
Reimplemented in PLEngine::EngineApplication, and PLScene::SceneApplication.
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnFullscreenMode | ( | ) | [override, protected, virtual] |
Called when the fullscreen mode was changed.
- Remarks:
- The default implementation does the following tasks:
- Everything that PLCore::FrontendApplication::OnFullscreenMode() does
- Update renderer surface
Reimplemented from PLCore::FrontendApplication.
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnDraw | ( | ) | [override, protected, virtual] |
Called to let the frontend draw into it's window.
- Remarks:
- The default implementation does the following tasks:
- Everything that PLCore::FrontendApplication::OnDraw() does
- Draw renderer surface
Reimplemented from PLCore::FrontendApplication.
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnUpdate | ( | ) | [override, protected, virtual] |
Called to let the frontend update it's states.
- Remarks:
- The default implementation does the following tasks:
- Everything that PLCore::FrontendApplication::OnUpdate() does
- Update renderer context
Reimplemented from PLCore::FrontendApplication.
Reimplemented in PLEngine::EngineApplication, PLEngine::ScriptApplication, and PLScene::SceneApplication.
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnCreateRendererContext | ( | ) | [protected, virtual] |
Function that is called to create the application's renderer context.
- Note:
- Part of the application framework initialization function "OnStart()"
- The default implementation is using the "PLRenderer::Config"-configuration to get the settings to use
| virtual PLRENDERER_API void PLRenderer::RendererApplication::OnCreatePainter | ( | ) | [protected, virtual] |
Function that is called to create the application's surface painter.
- Remarks:
- The default implementation does the following tasks:
- Sets the default painter
- Note:
- Part of the application framework initialization function "OnStart()"
Member Data Documentation
Surface painter class to use
The renderer context, can be a null pointer
Display mode, always valid!
The documentation for this class was generated from the following files:
