SpaceVIL.WindowManager Class Reference

WindowManager is a static class that is designed to manage instances of a window and entire application. Provides control for changing render frequency, render type, vertical sync, adding/closing windows, exiting the app and more. More...

Static Public Member Functions
static void	SetRenderFrequency (RedrawFrequency level)
	Setting the frequency of redrawing scene in idle state. The higher the level, the more computer resources are used. Default: SpaceVIL.Core.RedrawFrequency.Low Can be: VeryLow - 1 frame per second, Low - up to 10 frames per second, Medium - up to 30 frames per second, High - up to 60 frames per second, Ultra - up to 120 frames per second, More...
static RedrawFrequency	GetRenderFrequency ()
	Getting the current render frequency. More...
static void	EnableVSync (int value)
	Setting the vsync value. If value is 0 - vsync is OFF, if other value - vsync is ON. The total amount of FPS calculated by the formula: 1.0 / Math.Abs(value) * DisplayRefreshRate, so if value is 2 (or -2) and dysplay refresh rate is 60 then 1.0 / 2 * 60 = 30 fps. Default: 1 - ENABLE. More...
static int	GetVSyncValue ()
	Getting the current vsync value. If value is 0 - vsync is OFF, if other value - vsync is ON. The total amount of FPS calculated by the formula: 1.0 / Math.Abs(value) * DisplayRefreshRate, so if value is 2 (or -2) and dysplay refresh rate is 60 then 1.0 / 2 * 60 = 30 fps. Default: 1 - ENABLE. More...
static void	SetRenderType (RenderType type)
	Setting the common render type. Default: SpaceVIL.Core.RenderType.Periodic. Can be: IfNeeded - the scene is redrawn only if any input event occurs (mouse move, mouse click, keyboard key press, window resizing and etc.), Periodic - the scene is redrawn according to the current render frequency type (See SetRenderFrequency(type)) in idle and every time when any input event occurs, Always - the scene is constantly being redrawn. More...
static void	AddWindow (CoreWindow wnd)
	Adding a window to rendering queue. After adding the window shows up immediately. More...
static void	CloseWindow (CoreWindow wnd)
	Closing the specified window if it exist in render queue. More...
static void	StartWith (params CoreWindow[] windows)
	Launching the applications and showing all specified windows. More...
static void	AppExit ()
	Exiting the current application. All windows will be closed and all their EventClose will be executed. More...

Detailed Description

WindowManager is a static class that is designed to manage instances of a window and entire application. Provides control for changing render frequency, render type, vertical sync, adding/closing windows, exiting the app and more.

Member Function Documentation

AddWindow()

static void SpaceVIL.WindowManager.AddWindow ( CoreWindow  wnd )

static

Adding a window to rendering queue. After adding the window shows up immediately.

Parameters

wnd	Any CoreWindow instance.

AppExit()

static void SpaceVIL.WindowManager.AppExit ( )

static

Exiting the current application. All windows will be closed and all their EventClose will be executed.

CloseWindow()

static void SpaceVIL.WindowManager.CloseWindow ( CoreWindow  wnd )

static

Closing the specified window if it exist in render queue.

Parameters

wnd	Any CoreWindow instance.

EnableVSync()

static void SpaceVIL.WindowManager.EnableVSync ( int  value )

static

Setting the vsync value. If value is 0 - vsync is OFF, if other value - vsync is ON. The total amount of FPS calculated by the formula: 1.0 / Math.Abs(value) * DisplayRefreshRate, so if value is 2 (or -2) and dysplay refresh rate is 60 then 1.0 / 2 * 60 = 30 fps. Default: 1 - ENABLE.

Parameters

value

Value of vsync.

GetRenderFrequency()

static RedrawFrequency SpaceVIL.WindowManager.GetRenderFrequency ( )

static

Getting the current render frequency.

Returns

The current render frequency as SpaceVIL.Core.RedrawFrequency.

GetVSyncValue()

static int SpaceVIL.WindowManager.GetVSyncValue ( )

static

Getting the current vsync value. If value is 0 - vsync is OFF, if other value - vsync is ON. The total amount of FPS calculated by the formula: 1.0 / Math.Abs(value) * DisplayRefreshRate, so if value is 2 (or -2) and dysplay refresh rate is 60 then 1.0 / 2 * 60 = 30 fps. Default: 1 - ENABLE.

Returns

The current vsync value

SetRenderFrequency()

static void SpaceVIL.WindowManager.SetRenderFrequency ( RedrawFrequency  level )

static

Setting the frequency of redrawing scene in idle state. The higher the level, the more computer resources are used. Default: SpaceVIL.Core.RedrawFrequency.Low Can be: VeryLow - 1 frame per second, Low - up to 10 frames per second, Medium - up to 30 frames per second, High - up to 60 frames per second, Ultra - up to 120 frames per second,

Parameters

level

A frequency level as SpaceVIL.Core.RedrawFrequency

SetRenderType()

static void SpaceVIL.WindowManager.SetRenderType ( RenderType  type )

static

Setting the common render type. Default: SpaceVIL.Core.RenderType.Periodic. Can be: IfNeeded - the scene is redrawn only if any input event occurs (mouse move, mouse click, keyboard key press, window resizing and etc.), Periodic - the scene is redrawn according to the current render frequency type (See SetRenderFrequency(type)) in idle and every time when any input event occurs, Always - the scene is constantly being redrawn.

Parameters

type	A render type as SpaceVIL.Core.RenderType.

StartWith()

static void SpaceVIL.WindowManager.StartWith ( params CoreWindow[]  windows )

static

Launching the applications and showing all specified windows.

Parameters

windows

A sequence of any amount of CoreWindow instances.

---

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

• WindowManager.cs