RenderWindow
ReferencesProperties
Methods
Add a channel to the frame buffer in addition to the fixed Red, Green, Blue and Alpha channels.
Parameters:
| channel (RenderWindow.StandardChannels) | Channel to add |
Returns: If the channel existed then true is returned otherwise; returns true if the channel was added or false if not.
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] */
Parameters:
| doc (RhinoDoc) | The document to display |
| viewport (ViewportInfo) | The view to display |
| size (Size) | The size of the image without clipping (i.e., if you have a region, it is the size of the image before you cut the region out. |
| region (Rectangle) | The area of the rendering you want to display. This should match the size of the render window itself (i.e, - the one set using SetSize) |
Returns: Returns true if all of the wireframe channels were added successfully.
Parameters:
| ch (RenderWindow.StandardChannels) |
public void Dispose()
EnableDebugThreadCheck
#Expert use only. Note that it is critical that when you disable the check, you absolutely ensure that there can not be access to the render window from multiple threads during the period it is disabled. Set it back on as soon as possible.
Parameters:
| enabled (bool) | Sets the status of the thread check flag on the render window in debug builds |
Must be called when an asynchronous render has finished or ended for any reason.
Parameters:
| successCode (RenderWindow.RenderSuccessCode) | Completed for a correct or canceled render, Failed for errors. |
Parameters:
| sessionId (Guid) |
obsoleteThe Render Window UI now uses post effects for gamma, tone mapping, etc.
OBSOLETE. NOT IMPLEMENTED.
Get array of Guids representing the channels requested by the post effect pipeline for this RenderWindow.
Returns: Array of Guid
Get array of StandardChannels enum values representing the channels requested by the post effect pipeline for this RenderWindow.
Returns: Array of StandardChannels
public void Invalidate()
Invalidate the entire view window so that the pixels get painted.
Query if a channel is available.
Parameters:
| id (Guid) |
Returns: Returns true if the channel is available.
Query if a channel is being shown.
Parameters:
| id (Guid) |
Returns: Returns true if the channel is being shown.
Parameters:
| id (RenderWindow.StandardChannels) |
Register an instance of PostEffectExecutionControl.
Parameters:
| ec (PostEffectExecutionControl) |
Save current Dib of RenderWindow as file Helper function for debugging purposes.
Parameters:
| filename (string) |
Like RenderWindow.SaveRenderImageAs(string,Guid,bool), but with Guid set to Guid.Empty.
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.
obsoleteThe Render Window UI now uses post effects for gamma, tone mapping, etc.
OBSOLETE. NOT IMPLEMENTED.
Parameters:
| imageAdjust (RenderWindow.ImageAdjust) | OBSOLETE |
Set whether or not rendering is in progress. Added to support raytraced mode.
Parameters:
| is_rendering (bool) |
Accepts a rendering progress value to inform the user of the rendering advances.
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.
Parameters:
| rect (Rectangle) | Rectangle |
Call this method to open the RenderWindow.StandardChannels.RGBA channel and set a block of color values
Parameters:
| rectangle (Rectangle) | rectangle.X is the horizontal pixel position of the left edge. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer. rectangle.Y is the vertical pixel position of the top edge. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer. rectangle.Width is the width of the rectangle in pixels. No validation is done on this value. rectangle.Height is the height of the rectangle in pixels. No validation is done on this value. |
| colors (Color4f[]) | Array of Color4f values used to set the RenderWindow.StandardChannels.RGBA |
Call this method to open the RenderWindow.StandardChannels.RGBA channel and set a block of color values
Get the StandardChannels for the given Guid
Parameters:
| id (Guid) |