LUMIERA.clone/src/backend/enginefacade.hpp

63 lines
2 KiB
C++

/*
ENGINEFACADE.hpp - access point for communicating with the render engine
Copyright (C) Lumiera.org
2008, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef BACKEND_INTERFACE_ENGINEFACADE_H
#define BACKEND_INTERFACE_ENGINEFACADE_H
#include "common/subsys.hpp"
namespace backend {
/******************************************************************
* Interface to the backend layer (render engine subsystem):
* Global access point for starting the render engine subsystem and
* for defining the public interface(s) for talking with the engine.
*
* While the engine is partially implemented relying on Proc-Layer
* operations, the general access point and the playback/render
* controller is considered part of the backend. This results in
* a "W"-shaped control flow: from GUI to backend to proc to
* backend, feeding resulting data to output.
*
*/
struct EngineFacade
{
/** provide a descriptor for lumiera::AppState,
* wired accordingly to allow main to pull up and
* shut down the renderengine. */
static lumiera::Subsys& getDescriptor();
//////////////////TODO: define the global access interface for the engine
//////////////////TODO: provide a function for accessing this interface
};
} // namespace backend
#endif