irendererprovider.h

Go to the documentation of this file.

/*
 * Copyright (c) since 2021 by PopolonY2k and Leidson Campos A. Ferreira
 * 
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#ifndef __IRENDERERPROVIDER_H__
#define __IRENDERERPROVIDER_H__
 
#include <string>
#include "renderer/rendererconfig.h"
 
namespace SunLight  {
    namespace TileMap  { class ITileMap; }
    namespace DrawSurface  { class IDrawSurface; }
}
 
namespace Scarab  {
    namespace Engine  {
 
        class IRendererProvider  {
 
            public:
 
            enum Origin  {
                ORIGIN_NONE = 0,       // no renderer yet
                ORIGIN_CREATED,        // an explicit CreateRenderer (renderer_create)
                ORIGIN_LAZY_DEFAULT,   // implicitly, by the first call that needed a window
                ORIGIN_LAST
            };
 
            virtual ~IRendererProvider( void ) {}
 
            virtual SunLight :: TileMap :: ITileMap* GetTileMap( const char *szTrigger ) = 0;
 
            virtual SunLight :: DrawSurface :: IDrawSurface* GetDrawSurface( const char *szTrigger ) = 0;
 
            virtual SunLight :: DrawSurface :: IDrawSurface* PeekDrawSurface( void ) = 0;
 
            virtual bool CreateRenderer( const SunLight :: Renderer :: RendererConfig &config, std :: string *pError ) = 0;
 
            virtual Origin GetOrigin( void ) = 0;
 
            virtual bool IsHeadless( void ) = 0;
 
            virtual SunLight :: Renderer :: RendererConfig GetDefaultConfig( void ) = 0;
 
            virtual SunLight :: Renderer :: RendererConfig GetEffectiveConfig( void ) = 0;
 
            virtual void NoteWindowTitle( const std :: string &strTitle ) = 0;
        };
    }
}
 
#endif  /* __IRENDERERPROVIDER_H__ */