RealtimeDisplayMode.StartRenderer Method

RealtimeDisplayModeStartRenderer Method

Override to start your render engine. Note that before using the RenderWindow you *must* call SetSize to properly initialize the underlying DIB.

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
public abstract bool StartRenderer(
	int w,
	int h,
	RhinoDoc doc,
	ViewInfo view,
	ViewportInfo viewportInfo,
	bool forCapture,
	RenderWindow renderWindow
)
Public MustOverride Function StartRenderer ( 
	w As Integer,
	h As Integer,
	doc As RhinoDoc,
	view As ViewInfo,
	viewportInfo As ViewportInfo,
	forCapture As Boolean,
	renderWindow As RenderWindow
) As Boolean

Parameters

w
Type: SystemInt32
Width of resolution
h
Type: SystemInt32
Height of resolution
doc
Type: RhinoRhinoDoc
Rhino document
view
Type: Rhino.DocObjectsViewInfo
active view
viewportInfo
Type: Rhino.DocObjectsViewportInfo
active viewport info
forCapture
Type: SystemBoolean
true if renderer is started for capture purposes (ViewCaptureTo*), false for regular interactive rendering
renderWindow
Type: Rhino.RenderRenderWindow
RenderWindow to hold render results in.

Return Value

Type: Boolean
Return true when your render engine started correctly, false when that failed
Version Information

Rhino for Windows

Supported in: 6.14
See Also

M:Rhino.Render.RealtimeDisplayMode.StartRenderer(System.Int32,System.Int32,Rhino.RhinoDoc,Rhino.DocObjects.ViewInfo,Rhino.DocObjects.ViewportInfo,System.Boolean,Rhino.Render.RenderWindow)