T_Rhino_Render_RenderSettings - mcneel/rhinocommon-api-docs GitHub Wiki

RenderSettings Class

Contains settings used in rendering.

Inheritance Hierarchy

System.Object
  Rhino.Render.RenderSettings
Namespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public class RenderSettings : IDisposable

VB

Public Class RenderSettings
	Implements IDisposable

The RenderSettings type exposes the following members.

Constructors

 

Name Description
Public method RenderSettings Initializes a new instance of the RenderSettings class.
  Back to Top

Properties

 

Name Description
Public property AmbientLight Gets or sets the ambient light color used in rendering.
Public property AntialiasLevel Gets or sets antialias level, used for render quality
Public property BackgroundColorBottom Gets or sets the background bottom color used in rendering.
Public property BackgroundColorTop Gets or sets the background top color used in rendering. Sets also the background color if a solid background color is set.
Public property BackgroundStyle How the viewport's backgroun should be filled.
Public property DepthCue Gets or sets a value indicating whether to render using depth cues. These are clues to help the perception of position and orientation of objects in the image.
Public property FlatShade Gets or sets a value indicating whether to render using flat shading.
Public property ImageSize Gets or sets a value indicating the size of the rendering result if UseViewportSize is set to false. If UseViewportSize is set to true, then this value is ignored.
Public property RenderAnnotations Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.
Public property RenderBackfaces Gets or sets a value indicating whether to render back faces.
Public property RenderCurves Gets or sets a value indicating whether to instruct the rendering engine to show curves.
Public property RenderIsoparams Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.
Public property RenderMeshEdges Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.
Public property RenderPoints Gets or sets a value indicating whether to instruct the rendering engine to show points.
Public property ShadowmapLevel 0=none, 1=normal, 2=best.
Public property UseHiddenLights Gets or sets a value indicating whether to render using lights that are on layers that are off.
Public property UseViewportSize Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering
  Back to Top

Methods

 

Name Description
Public method Dispose() Actively reclaims unmanaged resources that this instance uses.
Protected method Dispose(Boolean) For derived class implementers. This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Passively reclaims unmanaged resources when the class user did not explicitly call Dispose(). (Overrides Object.Finalize().)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Version Information

Supported in: 5D58w

See Also

Reference

Rhino.Render Namespace

⚠️ **GitHub.com Fallback** ⚠️