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-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE
-------------------------------------------------------------------------*/
#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 setFullscreen(bool fullScreen, unsigned int width, unsigned int height)
                { (void)fullScreen; (void)width; (void)height; }
        
        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 void setVisible(bool visible)
        { (void)visible; }

        virtual bool isHidden(void) const { return false; }

        virtual void setHidden(bool hidden)
        { (void)hidden; }

        virtual void setVSyncEnabled(bool vsync)
        { (void)vsync; }

        virtual bool isVSyncEnabled() const { return false; }

        virtual void setVSyncInterval(unsigned int interval)
        { (void)interval; }

        virtual unsigned int getVSyncInterval() const { return 1; }
        

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

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

        virtual bool isFullScreen(void) const;

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

        PixelFormat suggestPixelFormat() const { return PF_BYTE_RGB; }

        bool isDeactivatedOnFocusChange() const;

        void setDeactivateOnFocusChange(bool deactivate);

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