• Main
• Home
• Features
• Screenshots
• Downloads
• License
• Team profile
• Documentation
• Manual
• FAQ
• Reference

Search this page:

PCMBuffer.h

Go to the documentation of this file.

//
// This source file is a part of ParCompMark
// Parallel Compositing Benchmark Framework
//
// for latest info see http://parcompmark.sourceforge.net

//
// Copyright (C) 2006 IT2 ParCompMark Dev. Team
// 
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


#ifndef __PCM_BUFFER_H__
#  define __PCM_BUFFER_H__

//
// Inner includes
//

#  include "PCMPremeditations.h"

#  include "PCMException.h"

#  include "PCMLogger.h"

#  include "PCMPointer.h"

//
// Outer includes
//

#  include <pcapi.h>

//
// Scripting bind includes (for Squirrel)
//

#  include <squirrel/squirrel.h>
#  include <squirrel/sqstdio.h>
#  include <squirrel/sqstdaux.h>
#  include <squirrel/sqplus.h>

namespace ParCompMark
{

  class Buffer
  {

        //
        // Unit test class
        //
#  ifdef PARCOMPMARK_TEST
        friend class ParCompMarkTest::TestBuffer;
#  endif

        //
        // Scripting binding (for Squirrel)
        //



   public:static void squirrelGlue()
        {
         ::SqPlus::SQClassDef < Buffer > (_T("Buffer")).func(&Buffer::getLeft, _T("getLeft")).func(&Buffer::setLeft,
                                                                                                  _T("setLeft")).
                func(&Buffer::getTop, _T("getTop")).func(&Buffer::setTop, _T("setTop")).func(&Buffer::getWidth,
                                                                                          _T("getWidth")).
                func(&Buffer::setWidth, _T("setWidth")).func(&Buffer::getHeight,
                                                          _T("getHeight")).func(&Buffer::setHeight,
                                                                                 _T("setHeight")).
                func(&Buffer::getDepthFormat, _T("getDepthFormat")).func(&Buffer::setDepthFormat, _T("setDepthFormat"));
        }


        //
        // Typedefs
        //

   public:

        typedef Pointer < Buffer,
        Mutex > Pointer;

        //
        // Variables
        //



   protected:

        Node * mParent;

        PCuint mLeft;

        PCuint mTop;

        PCuint mWidth;

        PCuint mHeight;

        bool mOwnPointers;

        PCuint *mColour;

        void *mDepth;

        PCint mDepthFormat;

        PCint mOutputRowPixel;

        bool mInitialized;


        //
        // Constructors & destructor
        //



   public:

        Buffer();

        Buffer(const PCuint & left, const PCuint & top, const PCuint & width,
                 const PCuint & height, const PCuint & depthFormat, Node * parent);

        virtual ~ Buffer();


        //
        // Getters & setters
        //



   public:

        Node * getParent() const;

        const PCuint & getLeft() const;

        void setLeft(const PCuint left);

        const PCuint & getTop() const;

        void setTop(const PCuint top);

        const PCuint & getWidth() const;

        void setWidth(const PCuint width);

        const PCuint & getHeight() const;

        void setHeight(const PCuint height);

        const bool & getOwnPointers() const;

        PCuint *getColour();

        void setColour(const PCuint * colour);

        void *getDepth();

        void setDepth(const void *depth);

        const PCint & getDepthFormat() const;

        void setDepthFormat(const PCint depthformat);

        const PCint & getOutputRowPixel() const;

        void setOutputRowPixel(const PCint & outputrowpixel);

        const bool & getInitialized() const;


        //
        // Methods
        //



   public:

        virtual void initialize();

        virtual void finalize();

        virtual void saveToFile(const std::string & filename);

   protected:

        virtual void freeBuffers();


  };

  //
  // Include header implementation
  //

#  include "PCMBuffer_impl.h"

}

// Declare Buffer class (and its enums) for SqPlus binding
DECLARE_INSTANCE_TYPE_NAME(ParCompMark::Buffer, Buffer);

#endif

© Copyright - 2006 (IT)² ParCompMark Dev. Team