ShRecord.hpp

Go to the documentation of this file.

// Sh: A GPU metaprogramming language.
//
// Copyright 2003-2005 Serious Hack Inc.
// 
// 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 SHRECORD_HPP
#define SHRECORD_HPP

#include <list>
#include "ShDllExport.hpp"
#include "ShVariable.hpp"

namespace SH {

class
SH_DLLEXPORT ShRecord {
public:
  typedef std::list<ShVariable> VarList; 
  typedef VarList::iterator iterator;
  typedef VarList::const_iterator const_iterator;

  ShRecord();
  ShRecord(const ShVariable &var);
  
  const_iterator begin() const;
  const_iterator end() const;
  iterator begin();
  iterator end();
  size_t size() const;

  void append(const ShVariable& variable);
  void prepend(const ShVariable& variable);

  void append(const ShRecord& rec);
  void prepend(const ShRecord& rec);

  // Assigns one record to another.
  // In retained mode, this inserts assignment statements into the current
  // ShProgram.  
  ShRecord& operator=(const ShRecord &other);

  // Execute fully bound record program and place results in record.
  ShRecord& operator=(const ShProgram& program);

  // Converts a ShRecord containing only uniforms into a stream
  // (Must be unswizzled uniforms (and not constants), as this uses the variable's
  // variant arrays directly as the channel memory
  //
  // If you change any of the values here, you must call 
  // update_all on the nodes
  //ShStream toStream();
  
private:
  VarList m_vars;
};

SH_DLLEXPORT
ShRecord combine(const ShVariable &left, const ShVariable &right);

SH_DLLEXPORT
ShRecord combine(const ShRecord& left, const ShVariable& right);

SH_DLLEXPORT
ShRecord combine(const ShVariable& left, const ShRecord& right);

SH_DLLEXPORT
ShRecord combine(const ShRecord& left, const ShRecord& right);

SH_DLLEXPORT
ShRecord operator&(const ShVariable& left, const ShVariable& right);

SH_DLLEXPORT
ShRecord operator&(const ShRecord& left, const ShVariable& right);

SH_DLLEXPORT
ShRecord operator&(const ShVariable& left, const ShRecord& right);

SH_DLLEXPORT
ShRecord operator&(const ShRecord& left, const ShRecord& right);

SH_DLLEXPORT
ShProgram connect(const ShRecord& rec, const ShProgram& program);

SH_DLLEXPORT
ShProgram operator<<(const ShProgram& program, const ShRecord& rec);

SH_DLLEXPORT
ShProgram connect(const ShProgram& program, const ShRecord& rec);

SH_DLLEXPORT
ShProgram operator<<(const ShRecord& rec, const ShProgram& program);

}

#endif

---