Render Window Class. More...
#include <deRenderWindow.h>
Public Member Functions | |
Constructors and Destructors | |
| deRenderWindow (deRenderWindowManager *manager) | |
| Creates a new render window object with the given resource manager. | |
| ~deRenderWindow () | |
| Cleans up the render window. | |
Management | |
| int | GetHostWindow () const |
| Retrieves the hosting render window or NULL if not set. | |
| void | SetHostWindow (int window) |
| Sets the hosting render window or NULL in which case the graphic system creates a top level window to render in. | |
| int | GetWindow () const |
| Retrieves the render window. | |
| void | SetWindow (int window) |
| Sets the render window. | |
| int | GetWidth () const |
| Retrieves the width of the render window. | |
| int | GetHeight () const |
| Retrieves the height of the render window. | |
| void | SetSize (int width, int height) |
| Sets the size of the render window. | |
| bool | GetFullScreen () const |
| Determines if the window is full screen. | |
| void | SetFullScreen (bool fullscreen) |
| Sets if the window is full screen. | |
| bool | GetNotifyScriptOnResize () const |
| Determines if the script is notified about the window changing size. | |
| void | SetNotifyScriptOnResize (bool notify) |
| Sets if the script is notified about the window chaning size. | |
| const char * | GetTitle () const |
| Retrieves the render window title. | |
| void | SetTitle (const char *title) |
| Sets the render window title. | |
| deRenderTarget * | GetPrimaryRenderTarget () const |
| Retrieves the primary render target. | |
System Peers | |
| deBaseGraphicRenderWindow * | GetGraphicRenderWindow () const |
| Retrieves the graphic system peer object. | |
| void | SetGraphicRenderWindow (deBaseGraphicRenderWindow *graRenWnd) |
| Sets the graphic system peer object. | |
Detailed Description
Render Window Class.
Render windows are used by hosting applications to redirect the rendered output of an embedded engine session into one or more sub windows. The graphic module decides how the window is used for rendering. The window is peered so changing the graphic module is not a problem. The only actions required by the hosting application is to notify the render window about size changes so the graphic module can take the necessary steps.
- Hosting Window Handle
- For working with the hosting window handle you can use two different ways. You can either specify the hosting window using a generic function which mangles the window handle into an integer value or use an OS specific function. The generic function has the advantage that you do not have to worry about the operating system your application is running on. Most GUI toolkits provide a generic access to the window handles so you can simply carry over the value. The OS specific functions are convenient if you work with only one OS or you need specific code anyways.
- Version:
- 1.0
- Date:
- 2008
Constructor & Destructor Documentation
| deRenderWindow::deRenderWindow | ( | deRenderWindowManager * | manager ) |
Creates a new render window object with the given resource manager.
| deRenderWindow::~deRenderWindow | ( | ) |
Cleans up the render window.
Member Function Documentation
| bool deRenderWindow::GetFullScreen | ( | ) | const [inline] |
Determines if the window is full screen.
| deBaseGraphicRenderWindow* deRenderWindow::GetGraphicRenderWindow | ( | ) | const [inline] |
Retrieves the graphic system peer object.
| int deRenderWindow::GetHeight | ( | ) | const [inline] |
Retrieves the height of the render window.
| int deRenderWindow::GetHostWindow | ( | ) | const [inline] |
Retrieves the hosting render window or NULL if not set.
This is the generic function to work with hosting windows.
| bool deRenderWindow::GetNotifyScriptOnResize | ( | ) | const [inline] |
Determines if the script is notified about the window changing size.
| deRenderTarget* deRenderWindow::GetPrimaryRenderTarget | ( | ) | const [inline] |
Retrieves the primary render target.
| const char* deRenderWindow::GetTitle | ( | ) | const [inline] |
Retrieves the render window title.
| int deRenderWindow::GetWidth | ( | ) | const [inline] |
Retrieves the width of the render window.
| int deRenderWindow::GetWindow | ( | ) | const [inline] |
Retrieves the render window.
This is the generic function.
| void deRenderWindow::SetFullScreen | ( | bool | fullscreen ) |
Sets if the window is full screen.
| void deRenderWindow::SetGraphicRenderWindow | ( | deBaseGraphicRenderWindow * | graRenWnd ) |
Sets the graphic system peer object.
| void deRenderWindow::SetHostWindow | ( | int | window ) |
Sets the hosting render window or NULL in which case the graphic system creates a top level window to render in.
This is the generic function to work with hosting windows.
| void deRenderWindow::SetNotifyScriptOnResize | ( | bool | notify ) |
Sets if the script is notified about the window chaning size.
| void deRenderWindow::SetSize | ( | int | width, |
| int | height | ||
| ) |
Sets the size of the render window.
| void deRenderWindow::SetTitle | ( | const char * | title ) |
Sets the render window title.
| void deRenderWindow::SetWindow | ( | int | window ) |
Sets the render window.
This is for the graphic module only and should not be called otherwise.
The documentation for this class was generated from the following file:
