OgreD3D9RenderWindow.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is 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 __D3D9RENDERWINDOW_H__
#define __D3D9RENDERWINDOW_H__

#include "OgreD3D9Prerequisites.h"
#include "OgreRenderWindow.h"
#include "OgreD3D9Device.h"

namespace Ogre 
{
    class _OgreD3D9Export D3D9RenderWindow : public RenderWindow
    {
    public:
        D3D9RenderWindow                        (HINSTANCE instance);
        ~D3D9RenderWindow                       (); 
        
        void                create              (const String& name, unsigned int width, unsigned int height,
                                                 bool fullScreen, const NameValuePairList *miscParams);
        void                setFullscreen       (bool fullScreen, unsigned int width, unsigned int height);
        void                destroy             (void);
        bool                isActive            () const;
        bool                isVisible           () const;
        bool                isClosed            () const { return mClosed; }
        bool                isVSync             () const { return mVSync; }
        bool                isHidden            () const { return mHidden; }
        void                setHidden           (bool hidden);
        void                setVSyncEnabled     (bool vsync);
        bool                isVSyncEnabled      () const;
        void                setVSyncInterval    (unsigned int interval);
        unsigned int        getVSyncInterval    () const;
        void                reposition          (int left, int top);
        void                resize              (unsigned int width, unsigned int height);
        void                swapBuffers         ();
        HWND                getWindowHandle     () const { return mHWnd; }              
        IDirect3DDevice9*   getD3D9Device       ();
        D3D9Device*         getDevice           ();
        void                setDevice           (D3D9Device* device);

        void                getCustomAttribute  (const String& name, void* pData);
        
        void                copyContentsToMemory    (const PixelBox &dst, FrameBuffer buffer);
        bool                requiresTextureFlipping () const { return false; }

        // Method for dealing with resize / move & 3d library
        void                windowMovedOrResized    ();
    
        void                buildPresentParameters  (D3DPRESENT_PARAMETERS* presentParams);
        

        void _beginUpdate();
    
        void _updateViewport(Viewport* viewport, bool updateStatistics = true);

        void _endUpdate();

        IDirect3DSurface9* getRenderSurface();

        bool _getSwitchingFullscreen() const;
        
        void _finishSwitchingFullscreen();
    
        bool isDepthBuffered() const;

        bool isNvPerfHUDEnable() const;

        bool _validateDevice();

        void adjustWindow(unsigned int clientWidth, unsigned int clientHeight, 
            unsigned int* winWidth, unsigned int* winHeight);

    protected:
        void updateWindowRect();

        DWORD getWindowStyle(bool fullScreen) const { if (fullScreen) return mFullscreenWinStyle; return mWindowedWinStyle; }

    protected:
        HINSTANCE                   mInstance;              // Process instance
        D3D9Device*                 mDevice;                // D3D9 device wrapper class.
        bool                        mDeviceValid;           // Device was validation succeeded.
        HWND                        mHWnd;                  // Win32 Window handle      
        bool                        mIsExternal;            // window not created by Ogre
        bool                        mClosed;                // Is this window destroyed.        
        bool                        mHidden;                // True if this is hidden render window. 
        bool                        mSwitchingFullscreen;   // Are we switching from fullscreen to windowed or vice versa       
        D3DMULTISAMPLE_TYPE         mFSAAType;              // AA type.
        DWORD                       mFSAAQuality;           // AA quality.
        UINT                        mDisplayFrequency;      // Display frequency.
        bool                        mVSync;                 // Use vertical sync or not.
        unsigned int                mVSyncInterval;         // The vsync interval.
        bool                        mUseNVPerfHUD;          // Use NV Perf HUD.
        DWORD                       mWindowedWinStyle;      // Windowed mode window style flags.
        DWORD                       mFullscreenWinStyle;    // Fullscreen mode window style flags.       
        unsigned int                mDesiredWidth;          // Desired width after resizing
        unsigned int                mDesiredHeight;         // Desired height after resizing
    };
}
#endif