Interface IRenderCanvasImp

Implementation agnostic representation of a render canvas.

Namespace: Fusee.Engine.Common

Assembly: Fusee.Engine.Common.dll

Syntax

public interface IRenderCanvasImp

Properties

Caption

Implementation Tasks: Gets and sets the caption of the Application(Window Title).

Declaration

string Caption { get; set; }

Property Value

Type	Description
System.String	The caption.

DeltaTime

Implementation Tasks: Gets the delta time. The delta time is the time it took the last frame to render in milliseconds.

Declaration

float DeltaTime { get; }

Property Value

Type	Description
System.Single	The delta time.

DeltaTimeUpdate

Implementation Tasks: Gets the delta time. The delta time is the time it took the last frame to update in milliseconds.

Declaration

float DeltaTimeUpdate { get; }

Property Value

Type	Description
System.Single	The delta time.

Fullscreen

Implementation Tasks: Gets and sets a value indicating whether this IRenderCanvasImp is in fullscreen mode. This option can not be applied to all plattforms.

Declaration

bool Fullscreen { get; set; }

Property Value

Type	Description
System.Boolean	true if fullscreen; otherwise, false.

Height

Implementation Tasks: Gets and sets the height(pixel units) of the Canvas.

Declaration

int Height { get; set; }

Property Value

Type	Description
System.Int32	The height.

VerticalSync

Implementation Tasks: Gets and sets a value indicating whether vertical synchronization is enabled. This option is used to reduce "Glitches" during rendering.

Declaration

bool VerticalSync { get; set; }

Property Value

Type	Description
System.Boolean	true if [vertical sync]; otherwise, false.

Width

Implementation Tasks: Gets and sets the width(pixel units) of the Canvas.

Declaration

int Width { get; set; }

Property Value

Type	Description
System.Int32	The width.

WindowHandle

Cross-platform window handle for the window the engine renders to.

Declaration

IWindowHandle WindowHandle { get; }

Property Value

Type	Description
IWindowHandle

Methods

CloseGameWindow()

Closes the GameWindow with a call to opentk.

Declaration

void CloseGameWindow()

DoInit()

Does the initialize of this instance.

Declaration

void DoInit()

DoRender()

Does the render of this instance.

Declaration

void DoRender()

DoResize(Int32, Int32)

Does the resize on this instance.

Declaration

void DoResize(int width, int height)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height

DoUnLoad()

Does the unload of this instance.

Declaration

void DoUnLoad()

DoUpdate()

Does the update of this instance.

Declaration

void DoUpdate()

OpenLink(String)

Opens the given URL in the user's standard web browser. The link MUST start with "http://".

Declaration

void OpenLink(string link)

Parameters

Type	Name	Description
System.String	link	The URL to open

Present()

Implementation Tasks: Presents the final rendered image. The FrameBuffer needs to be cleared afterwards. The delta time needs to be recalculated when this function is called.

Declaration

void Present()

Run()

Runs this instance. This function should not be called more than once as its only for initilization purposes.

Declaration

void Run()

SetCursor(CursorType)

Set the cursor (the mouse pointer image) to one of the pre-defined types

Declaration

void SetCursor(CursorType cursorType)

Parameters

Type	Name	Description
CursorType	cursorType	The type of the cursor to set.

SetWindowSize(Int32, Int32, Int32, Int32, Boolean)

Sets the size of the output window for desktop development.

Declaration

void SetWindowSize(int width, int height, int posx = -1, int posy = -1, bool borderHidden = false)

Parameters

Type	Name	Description
System.Int32	width	The width of the window.
System.Int32	height	The height of the window.
System.Int32	posx	The x position of the window.
System.Int32	posy	The y position of the window.
System.Boolean	borderHidden	Show the window border or not.

Events

Init

Occurs when [init] is called. Implementation Tasks: Handle the Initialization process

Declaration

event EventHandler<InitEventArgs> Init

Event Type

Type	Description
System.EventHandler<InitEventArgs>

Render

Occurs when [Render] is called.

Declaration

event EventHandler<RenderEventArgs> Render

Event Type

Type	Description
System.EventHandler<RenderEventArgs>

Resize

Occurs when [Resize] is called.

Declaration

event EventHandler<ResizeEventArgs> Resize

Event Type

Type	Description
System.EventHandler<ResizeEventArgs>

UnLoad

Occurs when [UnLoad] is called.

Declaration

event EventHandler<InitEventArgs> UnLoad

Event Type

Type	Description
System.EventHandler<InitEventArgs>

Update

Occurs when [Update] is called.

Declaration

event EventHandler<RenderEventArgs> Update

Event Type

Type	Description
System.EventHandler<RenderEventArgs>