OmegaEngine.RenderPanel Class Reference

A Panel that automatically provides an OmegaEngine.Engine instance for rendering on it, an optional timer-driver render loop, input handling, etc. More...

Inheritance diagram for OmegaEngine.RenderPanel:

Public Member Functions
Engine	Setup ()
	Initializes the OmegaEngine.Engine for rendering on this Panel. More...
void	AddInputReceiver (IInputReceiver receiver)
	Calls InputProvider.AddReceiver for all default InputProviders. More...
void	RemoveInputReceiver (IInputReceiver receiver)
	Calls InputProvider.RemoveReceiver for all default InputProviders. More...

Protected Member Functions
override void	OnPaint (PaintEventArgs e)
override void	OnResize (EventArgs eventargs)
override void	Dispose (bool disposing)

Properties
Engine	Engine [get]
	The OmegaEngine.Engine used to render graphics onto this panel. More...
KeyboardInputProvider	KeyboardInputProvider [get]
	A default Input.KeyboardInputProvider hooked up to the Panel. More...
MouseInputProvider	MouseInputProvider [get]
	A default Input.MouseInputProvider hooked up to the Panel. More...
TouchInputProvider	TouchInputProvider [get]
	A default Input.TouchInputProvider hooked up to the Panel. More...
bool	AutoRender [get, set]
	When set to true OmegaEngine.Engine.Render() is automatically called in regular intervals. More...
int	AutoRenderInterval [get, set]
	The interval in milliseconds in which OmegaEngine.Engine.Render() is automatically called. More...

Additional Inherited Members
Events inherited from NanoByte::Common::Controls::TouchPanel
EventHandler< TouchEventArgs >	TouchDown
EventHandler< TouchEventArgs >	TouchUp
EventHandler< TouchEventArgs >	TouchMove
Events inherited from NanoByte::Common::Controls::ITouchControl
EventHandler< TouchEventArgs >	TouchDown
EventHandler< TouchEventArgs >	TouchUp
EventHandler< TouchEventArgs >	TouchMove

Detailed Description

A Panel that automatically provides an OmegaEngine.Engine instance for rendering on it, an optional timer-driver render loop, input handling, etc.

Member Function Documentation

AddInputReceiver()

void OmegaEngine.RenderPanel.AddInputReceiver ( IInputReceiver  receiver )

inline

Calls InputProvider.AddReceiver for all default InputProviders.

Parameters

receiver

The object to receive the commands.

RemoveInputReceiver()

void OmegaEngine.RenderPanel.RemoveInputReceiver ( IInputReceiver  receiver )

inline

Calls InputProvider.RemoveReceiver for all default InputProviders.

Parameters

receiver

The object to no longer receive the commands.

Setup()

Engine OmegaEngine.RenderPanel.Setup ( )

inline

Initializes the OmegaEngine.Engine for rendering on this Panel.

Returns

The newly initialized Engine.

Exceptions

NotSupportedException	The graphics card does not meet the engine's minimum requirements.
Direct3D9NotFoundException	Throw if required DirectX version is missing.
Direct3DX9NotFoundException	Throw if required DirectX version is missing.
Direct3D9Exception	internal errors occurred while intiliazing the graphics card.
SlimDX.DirectSound.DirectSoundException	internal errors occurred while intiliazing the sound card.

Calling this multiple times will always return the same OmegaEngine.Engine instance.

Property Documentation

AutoRender

bool OmegaEngine.RenderPanel.AutoRender

getset

When set to true OmegaEngine.Engine.Render() is automatically called in regular intervals.

See also

AutoRenderInterval

AutoRenderInterval

int OmegaEngine.RenderPanel.AutoRenderInterval

getset

The interval in milliseconds in which OmegaEngine.Engine.Render() is automatically called.

See also

AutoRender

Engine

Engine OmegaEngine.RenderPanel.Engine

get

The OmegaEngine.Engine used to render graphics onto this panel.

KeyboardInputProvider

KeyboardInputProvider OmegaEngine.RenderPanel.KeyboardInputProvider

get

A default Input.KeyboardInputProvider hooked up to the Panel.

MouseInputProvider

MouseInputProvider OmegaEngine.RenderPanel.MouseInputProvider

get

A default Input.MouseInputProvider hooked up to the Panel.

TouchInputProvider

TouchInputProvider OmegaEngine.RenderPanel.TouchInputProvider

get

A default Input.TouchInputProvider hooked up to the Panel.

---

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

• OmegaEngine/RenderPanel.cs