RenderWindow

Public Class

Inheritance Hierarchy

System.Object
Rhino.Render.RenderWindow

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class RenderWindow : IDisposable

The RenderWindow type exposes the following members.

Properties

Name

Description

---

Public Property

SessionId

---

Methods

Name

Description

---

Public Method

AddChannel

Add a channel to the frame buffer in addition to the fixed Red, Green, Blue and Alpha channels.

---

Public Method

AddWireframeChannel

This method sets the frame buffer size and adds all the necessary wireframe channels automatically. It also creates the wireframe channel data automatically so that your renderer doesn’t have to. You typically call this method only when your renderer does not support wireframe rendering itself. If you call this method, then you should not add any wireframe channels returned by GetRenderChannels(). If your renderer is capable of rendering the wireframe channels itself, you should not call this method. Instead, you must make sure you add the wireframe channels if GetRenderChannels() requests them. See IRhRdkRenderWindow::GetRenderChannels(). After the wires are rendered, the wireframe post effects will composite them into the final rendered image. Note: This method should really be called AddWireframeChannels(). [SDK_UNFREEZE] */

---

Public Method
Static Member

ChannelId

---

Public Method
Static Member

Create

---

Public Method

Dispose

Releases all resources used by the RenderWindow

---

Public Method

EndAsyncRender

Must be called when an asynchronous render has finished or ended for any reason.

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

---

Public Method
Static Member

FromSessionId

---

Public Method

GetAdjust

Obsolete.

OBSOLETE. NOT IMPLEMENTED.

---

Public Method

GetBitmap

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetRequestedRenderChannels

Get array of Guids representing the channels requested by the post effect pipeline for this RenderWindow.

---

Public Method

GetRequestedRenderChannelsAsStandardChannels

Get array of StandardChannels enum values representing the channels requested by the post effect pipeline for this RenderWindow.

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

Invalidate

Invalidate the entire view window so that the pixels get painted.

---

Public Method

InvalidateArea

---

Public Method

IsChannelAvailable

Query if a channel is available.

---

Public Method

IsChannelShown

Query if a channel is being shown.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

OpenChannel

---

Public Method

RegisterPostEffectExecutionControl

Register an instance of PostEffectExecutionControl.

---

Public Method

SaveDibAsBitmap

Save current Dib of RenderWindow as file Helper function for debugging purposes.

---

Public Method

SaveRenderImageAs(String, Boolean)

Like RenderWindow.SaveRenderImageAs(string,Guid,bool), but with Guid set to Guid.Empty.

---

Public Method

SaveRenderImageAs(String, Guid, Boolean)

Save current RenderWindow contents as an image file with the given name. The filetype will be determine. Pass in render engine Guid if an engine implements saving to a format that is not supported by Rhino. Guid.Empty if there is no need for that.

---

Public Method

SetAdjust

Obsolete.

OBSOLETE. NOT IMPLEMENTED.

---

Public Method

SetIsRendering

Set whether or not rendering is in progress. Added to support raytraced mode.

---

Public Method

SetProgress

Accepts a rendering progress value to inform the user of the rendering advances.

---

Public Method

SetRenderOutputRect

Specify a sub-rectangle of the render window to indicate where the relevant render output has been written. For example, if a renderer chooses to render at half resolution, it could write its data to the top left quadrant of the render window, which can be indicated by setting the render output rectangle. This is set to the full render window size by default. When the render window size is modified, the render output rectangle will be set to reflect the new size.

---

Public Method

SetRGBAChannelColors(Rectangle, .Color4f.)

Call this method to open the RenderWindow.StandardChannels.RGBA channel and set a block of color values

---

Public Method

SetRGBAChannelColors(Size, .Color4f.)

Call this method to open the RenderWindow.StandardChannels.RGBA channel and set a block of color values

---

Public Method

SetSize

---

Public Method

SetView

---

Public Method

Size

---

Public Method
Static Member

StandardChannelForGuid

Get the StandardChannels for the given Guid

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Events

Name

Description

---

Public Event
Static Member

Cloned

---