include/Win32/OgreWin32Window.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 
29 #ifndef __Win32Window_H__
30 #define __Win32Window_H__
31 
32 #include "OgreWin32Prerequisites.h"
33 #include "OgreRenderWindow.h"
34 
35 namespace Ogre {
37  {
38  public:
39  Win32Window(Win32GLSupport &glsupport);
40  ~Win32Window();
41 
42  void create(const String& name, unsigned int width, unsigned int height,
43  bool fullScreen, const NameValuePairList *miscParams);
44  void setFullscreen(bool fullScreen, unsigned int width, unsigned int height);
45  void destroy(void);
46  bool isActive(void) const;
47  bool isVisible() const;
48  bool isHidden() const { return mHidden; }
49  void setHidden(bool hidden);
50  void setVSyncEnabled(bool vsync);
51  bool isVSyncEnabled() const;
52  void setVSyncInterval(unsigned int interval);
53  unsigned int getVSyncInterval() const;
54  bool isClosed(void) const;
55  void reposition(int left, int top);
56  void resize(unsigned int width, unsigned int height);
57  void swapBuffers();
58 
60  virtual void copyContentsToMemory(const PixelBox &dst, FrameBuffer buffer);
61 
62  bool requiresTextureFlipping() const { return false; }
63 
64  HWND getWindowHandle() const { return mHWnd; }
65  HDC getHDC() const { return mHDC; }
66 
67  // Method for dealing with resize / move & 3d library
68  virtual void windowMovedOrResized(void);
69 
70  void getCustomAttribute( const String& name, void* pData );
71 
74  virtual void setActive( bool state );
75 
76  void adjustWindow(unsigned int clientWidth, unsigned int clientHeight,
77  unsigned int* winWidth, unsigned int* winHeight);
78 
79  protected:
80 
82  void updateWindowRect();
83 
85  DWORD getWindowStyle(bool fullScreen) const { if (fullScreen) return mFullscreenWinStyle; return mWindowedWinStyle; }
86 
87  protected:
89  HWND mHWnd; // Win32 Window handle
90  HDC mHDC;
91  HGLRC mGlrc;
93  char* mDeviceName;
96  bool mSizing;
97  bool mClosed;
98  bool mHidden;
99  bool mVSync;
100  unsigned int mVSyncInterval;
101  int mDisplayFrequency; // fullscreen only, to restore display
103  DWORD mWindowedWinStyle; // Windowed mode window style flags.
104  DWORD mFullscreenWinStyle; // Fullscreen mode window style flags.
105  };
106 }
107 
108 #endif
Ogre::Win32Window::mGLSupport
Win32GLSupport & mGLSupport
Definition: include/Win32/OgreWin32Window.h:88
Ogre::Win32Window::mGlrc
HGLRC mGlrc
Definition: include/Win32/OgreWin32Window.h:91
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::Win32Context
Definition: include/Win32/OgreWin32Context.h:36
Ogre::Win32Window::mIsExternalGLControl
bool mIsExternalGLControl
Definition: include/Win32/OgreWin32Window.h:94
Ogre::Win32Window::mIsExternal
bool mIsExternal
Definition: include/Win32/OgreWin32Window.h:92
Ogre::Win32Window::mHidden
bool mHidden
Definition: include/Win32/OgreWin32Window.h:98
Ogre::RenderWindow
Manages the target rendering window.
Definition: OgreRenderWindow.h:62
Ogre::Win32Window
Definition: include/Win32/OgreWin32Window.h:36
Ogre::Win32Window::mVSyncInterval
unsigned int mVSyncInterval
Definition: include/Win32/OgreWin32Window.h:100
Ogre::Win32Window::mClosed
bool mClosed
Definition: include/Win32/OgreWin32Window.h:97
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::Win32Window::mDisplayFrequency
int mDisplayFrequency
Definition: include/Win32/OgreWin32Window.h:101
Ogre::NameValuePairList
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
Definition: OgreCommon.h:550
Ogre::Win32Window::requiresTextureFlipping
bool requiresTextureFlipping() const
Definition: include/Win32/OgreWin32Window.h:62
Ogre::Win32Window::mSizing
bool mSizing
Definition: include/Win32/OgreWin32Window.h:96
_OgreGLExport
#define _OgreGLExport
Definition: OgreGLPrerequisites.h:99
Ogre::Win32Window::mHDC
HDC mHDC
Definition: include/Win32/OgreWin32Window.h:90
Ogre::Win32Window::isHidden
bool isHidden() const
Indicates whether the window was set to hidden (not displayed)
Definition: include/Win32/OgreWin32Window.h:48
Ogre::Win32Window::getHDC
HDC getHDC() const
Definition: include/Win32/OgreWin32Window.h:65
Ogre::Win32Window::mIsExternalGLContext
bool mIsExternalGLContext
Definition: include/Win32/OgreWin32Window.h:95
Ogre::Win32Window::mContext
Win32Context * mContext
Definition: include/Win32/OgreWin32Window.h:102
OgreRenderWindow.h
Ogre::Win32Window::getWindowStyle
DWORD getWindowStyle(bool fullScreen) const
Return the target window style depending on the fullscreen parameter.
Definition: include/Win32/OgreWin32Window.h:85
OgreWin32Prerequisites.h
Ogre::PixelBox
A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory.
Definition: OgrePixelFormat.h:304
Ogre::Win32Window::mWindowedWinStyle
DWORD mWindowedWinStyle
Definition: include/Win32/OgreWin32Window.h:103
Ogre::Win32Window::mVSync
bool mVSync
Definition: include/Win32/OgreWin32Window.h:99
Ogre::Win32GLSupport
Definition: include/Win32/OgreWin32GLSupport.h:38
Ogre::Win32Window::mDeviceName
char * mDeviceName
Definition: include/Win32/OgreWin32Window.h:93
Ogre::Win32Window::mFullscreenWinStyle
DWORD mFullscreenWinStyle
Definition: include/Win32/OgreWin32Window.h:104
Ogre::Win32Window::getWindowHandle
HWND getWindowHandle() const
Definition: include/Win32/OgreWin32Window.h:64
Ogre::Win32Window::mHWnd
HWND mHWnd
Definition: include/Win32/OgreWin32Window.h:89

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Apr 13 2021 08:53:15