/usr/include/OGRE/OgreRenderWindow.h is in libogre-1.8-dev 1.8.1+dfsg-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 | /*-------------------------------------------------------------------------
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-2012 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
{
/** \addtogroup Core
* @{
*/
/** \addtogroup RenderSystem
* @{
*/
/** Manages the target rendering window.
@remarks
This class handles a window into which the contents
of a scene are rendered. There is a many-to-1 relationship
between instances of this class an instance of RenderSystem
which controls the rendering of the scene. There may be
more than one window in the case of level editor tools etc.
This class is abstract since there may be
different implementations for different windowing systems.
@remarks
Instances are created and communicated with by the render system
although client programs can get a reference to it from
the render system if required for resizing or moving.
Note that you can have multiple viewpoints
in the window for effects like rear-view mirrors and
picture-in-picture views (see Viewport and Camera).
@author
Steven Streeting
@version
1.0
*/
class _OgreExport RenderWindow : public RenderTarget
{
public:
/** Default constructor.
*/
RenderWindow();
/** Creates & displays the new window.
@param
width The width of the window in pixels.
@param
height The height of the window in pixels.
@param
colourDepth The colour depth in bits. Ignored if
fullScreen is false since the desktop depth is used.
@param
fullScreen If true, the window fills the screen,
with no title bar or border.
@param
left The x-position of the window. Ignored if
fullScreen = true.
@param
top The y-position of the window. Ignored if
fullScreen = true.
@param
depthBuffer Specify true to include a depth-buffer.
@param
miscParam A variable number of pointers to platform-specific arguments. The
actual requirements must be defined by the implementing subclasses.
*/
virtual void create(const String& name, unsigned int width, unsigned int height,
bool fullScreen, const NameValuePairList *miscParams) = 0;
/** Alter fullscreen mode options.
@note Nothing will happen unless the settings here are different from the
current settings.
@param fullScreen Whether to use fullscreen mode or not.
@param width The new width to use
@param height The new height to use
*/
virtual void setFullscreen(bool fullScreen, unsigned int width, unsigned int height)
{ (void)fullScreen; (void)width; (void)height; }
/** Destroys the window.
*/
virtual void destroy(void) = 0;
/** Alter the size of the window.
*/
virtual void resize(unsigned int width, unsigned int height) = 0;
/** Notify that the window has been resized
@remarks
You don't need to call this unless you created the window externally.
*/
virtual void windowMovedOrResized() {}
/** Reposition the window.
*/
virtual void reposition(int left, int top) = 0;
/** Indicates whether the window is visible (not minimized or obscured)
*/
virtual bool isVisible(void) const { return true; }
/** Set the visibility state
*/
virtual void setVisible(bool visible)
{ (void)visible; }
/** Indicates whether the window was set to hidden (not displayed)
*/
virtual bool isHidden(void) const { return false; }
/** Hide (or show) the window. If called with hidden=true, this
will make the window completely invisible to the user.
@remarks
Setting a window to hidden is useful to create a dummy primary
RenderWindow hidden from the user so that you can create and
recreate your actual RenderWindows without having to recreate
all your resources.
*/
virtual void setHidden(bool hidden)
{ (void)hidden; }
/** Enable or disable vertical sync for the RenderWindow.
*/
virtual void setVSyncEnabled(bool vsync)
{ (void)vsync; }
/** Indicates whether vertical sync is activated for the window.
*/
virtual bool isVSyncEnabled() const { return false; }
/** Set the vertical sync interval. This indicates the number of vertical retraces to wait for
before swapping buffers. A value of 1 is the default.
*/
virtual void setVSyncInterval(unsigned int interval)
{ (void)interval; }
/** Returns the vertical sync interval.
*/
virtual unsigned int getVSyncInterval() const { return 1; }
/** Overridden from RenderTarget, flags invisible windows as inactive
*/
virtual bool isActive(void) const { return mActive && isVisible(); }
/** Indicates whether the window has been closed by the user.
*/
virtual bool isClosed(void) const = 0;
/** Indicates whether the window is the primary window. The
primary window is special in that it is destroyed when
ogre is shut down, and cannot be destroyed directly.
This is the case because it holds the context for vertex,
index buffers and textures.
*/
virtual bool isPrimary(void) const;
/** Returns true if window is running in fullscreen mode.
*/
virtual bool isFullScreen(void) const;
/** Overloaded version of getMetrics from RenderTarget, including extra details
specific to windowing systems.
*/
virtual void getMetrics(unsigned int& width, unsigned int& height, unsigned int& colourDepth,
int& left, int& top);
/// Override since windows don't usually have alpha
PixelFormat suggestPixelFormat() const { return PF_BYTE_RGB; }
/** Returns true if the window will automatically de-activate itself when it loses focus.
*/
bool isDeactivatedOnFocusChange() const;
/** Indicates whether the window will automatically deactivate itself when it loses focus.
* \param deactivate a value of 'true' will cause the window to deactivate itself when it loses focus. 'false' will allow it to continue to render even when window focus is lost.
* \note 'true' is the default behavior.
*/
void setDeactivateOnFocusChange(bool deactivate);
protected:
bool mIsFullScreen;
bool mIsPrimary;
bool mAutoDeactivatedOnFocusChange;
int mLeft;
int mTop;
/** Indicates that this is the primary window. Only to be called by
Ogre::Root
*/
void _setPrimary() { mIsPrimary = true; }
friend class Root;
};
/** @} */
/** @} */
} // Namespace
#endif
|