OgreRenderWindow.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
This source file is a part of OGRE
(Object-oriented Graphics Rendering Engine)

For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License (LGPL) as 
published by the Free Software Foundation; either version 2.1 of the 
License, or (at your option) any later version.

This library 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 Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public License 
along with this library; if not, write to the Free Software Foundation, 
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA or go to
http://www.gnu.org/copyleft/lesser.txt
-------------------------------------------------------------------------*/
#ifndef __RenderWindow_H__
#define __RenderWindow_H__

#include "OgrePrerequisites.h"

#include "OgreRenderTarget.h"

namespace Ogre
{
    class _OgreExport RenderWindow : public RenderTarget
    {

    public:
        RenderWindow();

        virtual void create(const String& name, unsigned int width, unsigned int height,
                bool fullScreen, const NameValuePairList *miscParams) = 0;
        
        virtual void destroy(void) = 0;

        virtual void resize(unsigned int width, unsigned int height) = 0;

        virtual void windowMovedOrResized() {}

        virtual void reposition(int left, int top) = 0;

        virtual bool isVisible(void) const { return true; }

        virtual bool isActive(void) const { return mActive && isVisible(); }

        virtual bool isClosed(void) const = 0;
        
        virtual bool isPrimary(void) const;

        virtual void swapBuffers(bool waitForVSync = true) = 0;

        virtual void update(void);

        virtual bool isFullScreen(void) const;

        virtual void getMetrics(unsigned int& width, unsigned int& height, unsigned int& colourDepth, 
            int& left, int& top);

    protected:
        bool mIsFullScreen;
        bool mIsPrimary;
        int mLeft;
        int mTop;
        
        void _setPrimary() { mIsPrimary = true; }
        
        friend class Root;
    };

    typedef void (*DLL_CREATERENDERWINDOW)(RenderWindow** ppWindow);

} // Namespace
#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:51 2006