state.hpp

Go to the documentation of this file.

/*
  STATE.hpp  -  Key Interface representing a render process and encapsulating state

  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 STEAM_INTERFACE_STATE_H
#define STEAM_INTERFACE_STATE_H


#include "lib/error.hpp"
#include "lib/frameid.hpp"
#include "steam/engine/buffhandle.hpp"

#include <cstddef>


namespace steam {
namespace engine { 
  
  using lumiera::FrameID;
  using lumiera::NodeID;

  class StateAdapter;
  class BuffTableStorage;
  
  
  class State
    {
    public:
      virtual BuffHandle allocateBuffer (const lumiera::StreamType*)  =0;
      
      virtual void releaseBuffer (BuffHandle&)  =0;
      
      virtual void is_calculated (BuffHandle const&)  =0;
      
      virtual FrameID const& genFrameID (NodeID const&, uint chanNo)  =0;
      
      virtual BuffHandle fetch (FrameID const&)  =0;
      
      virtual BuffTableStorage& getBuffTableStorage()  =0; 
      
      
    protected:
      virtual ~State() {};
      
      virtual State& getCurrentImplementation () =0;
      
      friend class engine::StateAdapter;
    };
  
}} // namespace steam::engine



namespace proc_interface {

  using steam::engine::State;
    
    
} // namespace proc_interface
#endif