Go to the documentation of this file.
26 #ifndef __RenderWindow_H__
27 #define __RenderWindow_H__
82 virtual void create(
const String& name,
unsigned int width,
unsigned int height,
92 virtual void setFullscreen(
bool fullScreen,
unsigned int width,
unsigned int height)
93 { (void)fullScreen; (void)width; (void)height; }
101 virtual void resize(
unsigned int width,
unsigned int height) = 0;
124 virtual bool isHidden(
void)
const {
return false; }
159 virtual bool isActive(
void)
const {
return mActive && isVisible(); }
180 virtual void getMetrics(
unsigned int& width,
unsigned int& height,
unsigned int& colourDepth,
181 int& left,
int& top);
virtual void setVSyncEnabled(bool vsync)
Enable or disable vertical sync for the RenderWindow.
virtual bool isHidden(void) const
Indicates whether the window was set to hidden (not displayed)
virtual unsigned int getVSyncInterval() const
Returns the vertical sync interval.
Manages the target rendering window.
The root class of the Ogre system.
@ PF_BYTE_RGB
3 byte pixel format, 1 byte for red, 1 byte for green, 1 byte for blue
virtual bool isActive(void) const
Overridden from RenderTarget, flags invisible windows as inactive.
map< String, String >::type NameValuePairList
Name / value parameter pair (first = name, second = value)
virtual bool isFullScreen(void) const
Returns true if window is running in fullscreen mode.
bool mAutoDeactivatedOnFocusChange
virtual void create(const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams)=0
Creates & displays the new window.
A 'canvas' which can receive the results of a rendering operation.
PixelFormat
The pixel format used for images, textures, and render surfaces.
virtual void windowMovedOrResized()
Notify that the window has been resized.
virtual void reposition(int left, int top)=0
Reposition the window.
bool isDeactivatedOnFocusChange() const
Returns true if the window will automatically de-activate itself when it loses focus.
virtual void setHidden(bool hidden)
Hide (or show) the window.
virtual void setFullscreen(bool fullScreen, unsigned int width, unsigned int height)
Alter fullscreen mode options.
virtual void setVisible(bool visible)
Set the visibility state.
virtual bool isClosed(void) const =0
Indicates whether the window has been closed by the user.
PixelFormat suggestPixelFormat() const
Override since windows don't usually have alpha.
virtual void setVSyncInterval(unsigned int interval)
Set the vertical sync interval.
virtual bool isVisible(void) const
Indicates whether the window is visible (not minimized or obscured)
virtual void getMetrics(unsigned int &width, unsigned int &height, unsigned int &colourDepth, int &left, int &top)
Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing sys...
virtual void resize(unsigned int width, unsigned int height)=0
Alter the size of the window.
virtual void destroy(void)=0
Destroys the window.
void _setPrimary()
Indicates that this is the primary window.
void setDeactivateOnFocusChange(bool deactivate)
Indicates whether the window will automatically deactivate itself when it loses focus.
RenderWindow()
Default constructor.
virtual bool isPrimary(void) const
Indicates whether the window is the primary window.
virtual bool isVSyncEnabled() const
Indicates whether vertical sync is activated for the window.
Copyright © 2012 Torus Knot Software Ltd

This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.