Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

# Keos::IRenderWindow Class Reference

Manages the target rendering window. More...

`#include <KeosRenderWindow.h>`

Inheritance diagram for Keos::IRenderWindow:

List of all members.

## Public Member Functions

| IRenderWindow ()
| Default constructor.
virtual void | Create (const String &strName, uint nWidth, uint nHeight, uint nColourDepth, bool bFullScreen)=0
| Creates & displays the new window.
virtual void | Destroy (void)=0
| Destroys the window.
virtual void | Resize (uint nWidth, uint nHeight)=0
| Alter the size of the window.
virtual void | Reposition (int nLeft, int nTop)=0
| Reposition the window.
virtual bool | IsClosed (void) const =0
| Indicates whether the window has been closed by the user.
virtual void | SwapBuffers (bool bWaitForVSync=true)=0
| Swaps the frame buffers to display the next frame.
virtual bool | IsFullScreen (void) const
| Returns true if window is running in fullscreen mode.
virtual void | GetMetrics (uint &nWidth, uint &nHeight, uint &nColourDepth, int &nLeft, int &nTop)
| Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

## Protected Attributes

bool | m_bIsFullScreen
| Fullscreen mode.
int | m_nLeft
| Left position.
int | m_nTop
| Top position.

## Detailed Description

Manages the target rendering window.

This class handles a window into which the contents of a scene are rendered. This class is abstract since there may be different implementations for different windowing systems.

Definition at line 37 of file KeosRenderWindow.h.

## Constructor & Destructor Documentation

Keos::IRenderWindow::IRenderWindow | ( |  | ) |

| Default constructor. Definition at line 33 of file KeosRenderWindow.cpp.

## Member Function Documentation

virtual void Keos::IRenderWindow::Create | ( | const String & | strName,
|  | uint | nWidth,
|  | uint | nHeight,
|  | uint | nColourDepth,
|  | bool | bFullScreen
| ) | `[pure virtual]`

| Creates & displays the new window.

Parameters:

  | strName | Name and title of the window.
  | nWidth | The width of the window in pixels.
  | nHeight | The height of the window in pixels.
  | nColourDepth | The colour depth in bits. Ignored if fullScreen is false since the desktop depth is used.
  | bFullScreen | If true, the window fills the screen.

Implemented in Keos::CD3D9Window, and Keos::CWin32Window.

Referenced by Keos::COGLRenderSystem::CreateRenderWindow(), and Keos::CD3D9RenderSystem::CreateRenderWindow().

virtual void Keos::IRenderWindow::Destroy | ( | void |  | ) | `[pure virtual]`

| Destroys the window. Implemented in Keos::CD3D9Window, and Keos::CWin32Window.

void Keos::IRenderWindow::GetMetrics | ( | uint & | nWidth,
|  | uint & | nHeight,
|  | uint & | nColourDepth,
|  | int & | nLeft,
|  | int & | nTop
| ) | `[virtual]`

| Overloaded version of getMetrics from RenderTarget, including extra details specific to windowing systems.

Parameters:

  | nWidth | Window's width.
  | nHeight | Window's height.
  | nColourDepth | Window's colour depth.
  | nLeft | Window's left position.
  | nTop | Window's top position.

Definition at line 39 of file KeosRenderWindow.cpp.

References m_nLeft, and m_nTop.

virtual bool Keos::IRenderWindow::IsClosed | ( | void |  | ) | const`[pure virtual]`

| Indicates whether the window has been closed by the user. Implemented in Keos::CD3D9Window, and Keos::CWin32Window. Referenced by Keos::IRenderSystem::UpdateAllRenderTargets().

bool Keos::IRenderWindow::IsFullScreen | ( | void |  | ) | const`[inline, virtual]`

| Returns true if window is running in fullscreen mode. Definition at line 119 of file KeosRenderWindow.h. References m_bIsFullScreen.

virtual void Keos::IRenderWindow::Reposition | ( | int | nLeft,
|  | int | nTop
| ) | `[pure virtual]`

| Reposition the window.

Parameters:

  | nLeft | The new left position.
  | nTop | The new top position.

Implemented in Keos::CD3D9Window, and Keos::CWin32Window.

virtual void Keos::IRenderWindow::Resize | ( | uint | nWidth,
|  | uint | nHeight
| ) | `[pure virtual]`

| Alter the size of the window.

Parameters:

  | nWidth | The new width.
  | nHeight | The new height.

Implemented in Keos::CD3D9Window, and Keos::CWin32Window.

virtual void Keos::IRenderWindow::SwapBuffers | ( | bool | bWaitForVSync = `true` | ) | `[pure virtual]`

| Swaps the frame buffers to display the next frame.

Parameters:

  | bWaitForVSync | If true, the system waits for the next vertical blank period (when the CRT beam turns off as it travels from bottom-right to top-left at the end of the pass) before flipping. If false, flipping occurs no matter what the beam position. Waiting for a vertical blank can be slower (and limits the framerate to the monitor refresh rate) but results in a steadier image with no 'tearing' (a flicker resulting from flipping buffers when the beam is in the progress of drawing the last frame).

Implemented in Keos::CD3D9Window, and Keos::CWin32Window.

Referenced by Keos::IRenderSystem::UpdateAllRenderTargets().

## Member Data Documentation

bool Keos::IRenderWindow::m_bIsFullScreen`[protected]`

| Fullscreen mode. Definition at line 106 of file KeosRenderWindow.h. Referenced by IsFullScreen().

int Keos::IRenderWindow::m_nLeft`[protected]`

| Left position. Definition at line 109 of file KeosRenderWindow.h. Referenced by GetMetrics().

int Keos::IRenderWindow::m_nTop`[protected]`

| Top position. Definition at line 111 of file KeosRenderWindow.h. Referenced by GetMetrics().

The documentation for this class was generated from the following files:

- KeosEngine/KeosRenderWindow.h
- KeosEngine/KeosRenderWindow.cpp