Show / Hide Table of Contents

Class RenderCanvasImp

This is a default render canvas implementation creating its own rendering window.

Inheritance
System.Object
RenderCanvasImp
Implements
IRenderCanvasImp
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Fusee.Engine.Imp.Graphics.Android
Assembly: Fusee.Engine.Imp.Graphics.Android.dll
Syntax
public class RenderCanvasImp : IRenderCanvasImp

Constructors

RenderCanvasImp(Context, IAttributeSet, Action)

Initializes a new instance of the RenderCanvasImp class.

Declaration
public RenderCanvasImp(Context context, IAttributeSet attrs, Action run)
Parameters
Type Name Description
Android.Content.Context context
Android.Util.IAttributeSet attrs
System.Action run

Properties

Caption

Gets and sets the caption(title of the window).

Declaration
public string Caption { get; set; }
Property Value
Type Description
System.String

The caption.

DeltaTime

Gets the delta time. The delta time is the time that was required to render the last frame in milliseconds. This value can be used to determine the frames per second of the application.

Declaration
public float DeltaTime { get; }
Property Value
Type Description
System.Single

The delta time in milliseconds.

DeltaTimeUpdate

Gets the delta time. The delta time is the time that was required to render the last frame in milliseconds. This value can be used to determine the frames per second of the application.

Declaration
public float DeltaTimeUpdate { get; }
Property Value
Type Description
System.Single

The delta time in milliseconds.

Focused

Gets a value indicating whether [focused]. This property is used to identify if this application is the active window of the user.

Declaration
public bool Focused { get; }
Property Value
Type Description
System.Boolean

true if [focused]; otherwise, false.

Fullscreen

Gets and sets a value indicating whether [fullscreen] is enabled.

Declaration
public bool Fullscreen { get; set; }
Property Value
Type Description
System.Boolean

true if [fullscreen]; otherwise, false.

Height

Gets and sets the height in pixel units.

Declaration
public int Height { get; set; }
Property Value
Type Description
System.Int32

The height.

TryptMonitorSetupHorizontal

This represents the number of the monitors in a horizontal row.

Declaration
public int TryptMonitorSetupHorizontal { get; set; }
Property Value
Type Description
System.Int32

TryptMonitorSetupVertical

This represents the number of the monitors in a vertical column.

Declaration
public int TryptMonitorSetupVertical { get; set; }
Property Value
Type Description
System.Int32

VerticalSync

Gets and sets a value indicating whether [vertical synchronize]. This option is used to reduce "Glitches" during rendering.

Declaration
public bool VerticalSync { get; set; }
Property Value
Type Description
System.Boolean

true if [vertical synchronize]; otherwise, false.

VideoWallMode

Activates (true) or deactivates (false) the video wall feature.

Declaration
public bool VideoWallMode { get; set; }
Property Value
Type Description
System.Boolean

View

Gets and sets the android view.

Declaration
public View View { get; }
Property Value
Type Description
Android.Views.View

The view.

Width

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

Declaration
public int Width { get; set; }
Property Value
Type Description
System.Int32

The width.

WindowHandle

Window handle for the window the engine renders to.

Declaration
public IWindowHandle WindowHandle { get; }
Property Value
Type Description
IWindowHandle

Methods

CloseGameWindow()

Closes the GameWindow with a call to ÓpenTk.

Declaration
public void CloseGameWindow()

DoInit()

Does the initialize of this instance.

Declaration
public void DoInit()

DoRender()

Does the render of this instance.

Declaration
public void DoRender()

DoResize(Int32, Int32)

Does the resize on this instance.

Declaration
public void DoResize(int width, int height)
Parameters
Type Name Description
System.Int32 width
System.Int32 height

DoUnLoad()

Does the unload of this instance.

Declaration
public void DoUnLoad()

DoUpdate()

Does the update of this instance.

Declaration
public void DoUpdate()

OpenLink(String)

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

Declaration
public void OpenLink(string link)
Parameters
Type Name Description
System.String link

The URL to open

Present()

Presents this application instance. Call this function after rendering to show the final image. After Present is called the render buffers get flushed.

Declaration
public void Present()

Run()

Implementation Tasks: Runs this application instance. This function should not be called more than once as it is only for initialization purposes.

Declaration
public void Run()

SetCursor(CursorType)

Set the cursor (the mouse pointer image) to one of the predefined types

Declaration
public 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
public 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.

VideoWall(Int32, Int32, Boolean, Boolean)

Changes the window of the application to video wall mode.

Declaration
public void VideoWall(int monitorsHor = 1, int monitorsVert = 1, bool activate = true, bool borderHidden = false)
Parameters
Type Name Description
System.Int32 monitorsHor

Number of monitors on horizontal axis.

System.Int32 monitorsVert

Number of monitors on vertical axis.

System.Boolean activate

Start the window in activated state-

System.Boolean borderHidden

Start the window with a hidden windows border.

Events

Init

Occurs when [initialize].

Declaration
public event EventHandler<InitEventArgs> Init
Event Type
Type Description
System.EventHandler<InitEventArgs>

Render

Occurs when [render].

Declaration
public event EventHandler<RenderEventArgs> Render
Event Type
Type Description
System.EventHandler<RenderEventArgs>

Resize

Occurs when [resize].

Declaration
public event EventHandler<ResizeEventArgs> Resize
Event Type
Type Description
System.EventHandler<ResizeEventArgs>

UnLoad

Occurs when [unload].

Declaration
public event EventHandler<InitEventArgs> UnLoad
Event Type
Type Description
System.EventHandler<InitEventArgs>

Update

Occurs when [update].

Declaration
public event EventHandler<RenderEventArgs> Update
Event Type
Type Description
System.EventHandler<RenderEventArgs>

Implements

IRenderCanvasImp
Generated by DocFX
GitHub Repo
Back to top