Key | Type/Values | Default | Description | Notes |
title | Any string | RenderTarget name | The title of the window that will appear in the title bar | |
colourDepth | 16, 32 | Desktop depth | Colour depth of the resulting rendering window; only applies if fullScreen | Win32 Specific |
left | Positive integers | Centred | Screen x coordinate from left | |
top | Positive integers | Centred | Screen y coordinate from left | |
depthBuffer | true, false | true | Use depth buffer | DirectX9 specific |
externalWindowHandle | Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*)
OS X: WindowRef for Carbon or NSWindow for Cocoa address as an integer iOS: UIWindow address as an integer | 0 (none) | External window handle, for embedding the OGRE render in an existing window | |
externalGLControl | true, false | false | Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls. | OpenGL specific |
externalGLContext | Context as Unsigned Long | 0 (create own context) | Use an externally created GL context | OpenGL Specific |
parentWindowHandle | Win32: HWND as integer
GLX: poslong:posint:poslong (display*:screen:windowHandle) or poslong:posint:poslong:poslong (display*:screen:windowHandle:XVisualInfo*) | 0 (none) | Parent window handle, for embedding the OGRE in a child of an external window | |
macAPI | String: "cocoa" or "carbon" | "carbon" | Specifies the type of rendering window on the Mac Platform. | Mac OS X Specific | |
macAPICocoaUseNSView | bool "true" or "false" | "false" | On the Mac platform the most diffused method to embed OGRE in a custom application is to use Interface Builder and add to the interface an instance of OgreView. The pointer to this instance is then used as "externalWindowHandle". However, there are cases where you are NOT using Interface Builder and you get the Cocoa NSView* of an existing interface. For example, this is happens when you want to render into a Java/AWT interface. In short, by setting this flag to "true" the Ogre::Root::createRenderWindow interprets the "externalWindowHandle" as a NSView* instead of an OgreView*. See OgreOSXCocoaView.h/mm. | Mac OS X Specific | |
contentScalingFactor | Positive Float greater than 1.0 | The default content scaling factor of the screen | Specifies the CAEAGLLayer content scaling factor. Only supported on iOS 4 or greater. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor. | iOS Specific | |
externalViewHandle | UIView pointer as an integer | 0 | External view handle, for rendering OGRE render in an existing view | iOS Specific | |
externalViewControllerHandle | UIViewController pointer as an integer | 0 | External view controller handle, for embedding OGRE in an existing view controller | iOS Specific | |
externalSharegroup | EAGLSharegroup pointer as an integer | 0 | External sharegroup, used to shared GL resources between contexts | iOS Specific | |
Full Screen | true, false | false | Specify whether to create the window in full screen mode | OS X Specific | |
FSAA | Positive integer (usually 0, 2, 4, 8, 16) | 0 | Full screen antialiasing factor | |
FSAAHint | Depends on RenderSystem and hardware. Currently supports:
"Quality": on systems that have an option to prefer higher AA quality over speed, use it | Blank | Full screen antialiasing hint | |
displayFrequency | Refresh rate in Hertz (e.g. 60, 75, 100) | Desktop vsync rate | Display frequency rate, for fullscreen mode | |
vsync | true, false | false | Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate | |
vsyncInterval | 1, 2, 3, 4 | 1 | If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30. | |
border | none, fixed, resize | resize | The type of window border (in windowed mode) | |
outerDimensions | true, false | false | Whether the width/height is expressed as the size of the outer window, rather than the content area | |
useNVPerfHUD | true, false | false | Enable the use of nVidia NVPerfHUD | |
gamma | true, false | false | Enable hardware conversion from linear colour space to gamma colour space on rendering to the window. | |
enableDoubleClick | true, false | false | Enable the window to keep track and transmit double click messages. | Win32 Specific |