# RenderSettings class

Namespace: [Rhino.Render](https://developer.rhino3d.com/api/rhinocommon/namespace/rhino.render.md) · Assembly: [RhinoCommon](https://developer.rhino3d.com/api/rhinocommon/assembly/rhinocommon.md)

```cs
public class RenderSettings : CommonObject
```

Contains settings used in rendering.

## Constructors

- [RenderSettings](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/ctor.md): (2 overloads) Initialize a new instance of the RenderSettings class.

## Properties

- [AmbientLight](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/ambientlight.md): Gets or sets the ambient light color used in rendering.
- [AntialiasLevel](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/antialiaslevel.md): Gets or sets anti-alias level, used for render quality
- [BackgroundColorBottom](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/backgroundcolorbottom.md): Gets or sets the background bottom color used in rendering.
- [BackgroundColorTop](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/backgroundcolortop.md): Gets or sets the background top color used in rendering. Sets also the background color if a solid background color is set.
- [BackgroundStyle](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/backgroundstyle.md): How the viewport's background should be filled.
- [DepthCue](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/depthcue.md): 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.
- [Dithering](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/dithering.md): If this object is associated with a document, this gets the document dithering. If this object is associated with a File3dm, this gets the File3dm's dithering. Otherwise it gets a 'free-floating' dithering object.
- [FlatShade](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/flatshade.md): Gets or sets a value indicating whether to render using flat shading.
- [GroundPlane](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/groundplane.md): If this object is associated with a document, this gets the document ground plane. If this object is associated with a File3dm, this gets the File3dm's ground plane. Otherwise it gets a 'free-floating' ground plane object.
- [ImageDpi](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/imagedpi.md): Number of dots/inch (dots=pixels) to use when printing and saving bitmaps. The default is 72.0 dots/inch.
- [ImageSize](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/imagesize.md): 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.
- [ImageUnitSystem](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/imageunitsystem.md): unit system to use when converting image pixel size and DPI information into a print size. Default = inches
- [LinearWorkflow](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/linearworkflow.md): If this object is associated with a document, this gets the document linear workflow. If this object is associated with a File3dm, this gets the File3dm's linear workflow. Otherwise it gets a 'free-floating' linear workflow object.
- [NamedView](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/namedview.md): Get or set the given named view
- [PostEffects](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/posteffects.md): If this object is associated with a document, this gets the document post effect data collection. If this object is associated with a File3dm, this gets the File3dm's post effect data collection. Otherwise it gets a 'free-floating' post effect data collection object.
- [RenderAnnotations](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderannotations.md): Gets or sets a value indicating whether to instruct the rendering engine to show annotations, such as linear dimensions or angular dimensions.
- [RenderBackfaces](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderbackfaces.md): Gets or sets a value indicating whether to render back faces.
- [RenderChannels](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderchannels.md): If this object is associated with a document, this gets the document render channels. Otherwise it gets a 'free-floating' render channels object.
- [RenderCurves](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/rendercurves.md): Gets or sets a value indicating whether to instruct the rendering engine to show curves.
- [RenderIsoparams](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderisoparams.md): Gets or sets a value indicating whether to instruct the rendering engine to show isocurves.
- [RenderMeshEdges](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/rendermeshedges.md): Gets or sets a value indicating whether to instruct the rendering engine to show mesh edges.
- [RenderPoints](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderpoints.md): Gets or sets a value indicating whether to instruct the rendering engine to show points.
- [RenderSource](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/rendersource.md): Gets or sets the render source [RenderSettings.RenderingSources](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings.renderingsources.md) enumeration.
- [SafeFrame](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/safeframe.md): If this object is associated with a document, this gets the document safe-frame. If this object is associated with a File3dm, this gets the File3dm's safe-frame. Otherwise it gets a 'free-floating' safe-frame object.
- [ScaleBackgroundToFit](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/scalebackgroundtofit.md): Gets or sets a value indicating whether to scale the wallpaper in the background or not. This is meaningful only if the viewport has a wallpaper and render settings are set to render Wallpaper into the background.
- [ShadowmapLevel](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/shadowmaplevel.md): 0=none, 1=normal, 2=best.
- [Skylight](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/skylight.md): If this object is associated with a document, this gets the document skylight. If this object is associated with a File3dm, this gets the File3dm's skylight. Otherwise it gets a 'free-floating' skylight object.
- [Snapshot](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/snapshot.md): Set or get the given snapshot view
- [SpecificViewport](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/specificviewport.md): Set or get the given specific viewport
- [Sun](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/sun.md): If this object is associated with a document, this gets the document sun. If this object is associated with a File3dm, this gets the File3dm's sun. Otherwise it gets a 'free-floating' sun object.
- [TransparentBackground](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/transparentbackground.md): Gets or sets whether rendering should be done with transparent background.
- [UseHiddenLights](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/usehiddenlights.md): Gets or sets a value indicating whether to render using lights that are on layers that are off.
- [UseViewportSize](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/useviewportsize.md): Gets or sets a value indicating whether to use the resolution of the viewport being rendered or ImageSize when rendering

## Methods

- [Duplicate](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/duplicate.md): Makes a free-floating copy of the object.
- [RenderEnvironment](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderenvironment.md): Get the render environment for a particular usage. Only works if this render settings is in a document. If usage is Background and the background mode is set to 'Solid Color' or 'Gradient' (i.e., not 'Environment'), then null will be returned.
- [RenderEnvironmentId](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderenvironmentid.md): Get the id of the render environment for a particular usage. If usage is Background and the background mode is set to 'Solid Color' or 'Gradient' (i.e., not 'Environment'), then Guid.Empty will be returned.
- [RenderEnvironmentOverride](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/renderenvironmentoverride.md): For usage background, this checks if the background style is set to 'Environment'. For reflection and skylighting, it checks if the relevant custom override is enabled.
- [SetRenderEnvironment](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/setrenderenvironment.md): Set the render environment for a particular usage. Passing null for usage Skylighting or Reflection will turn the override for that usage off.
- [SetRenderEnvironmentId](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/setrenderenvironmentid.md): Set the id of the render environment for a particular usage. Passing Guid.Empty for usage Skylighting or Reflection will turn the override for that usage off.
- [SetRenderEnvironmentOverride](https://developer.rhino3d.com/api/rhinocommon/type/rhino.render.rendersettings/setrenderenvironmentoverride.md): Set the given environment override on/off. Only works for usage Reflection and Skylighting.

## Inherited Members

- From [CommonObject](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject.md): [Disposed](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/disposed.md), [HasUserData](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/hasuserdata.md), [IsDocumentControlled](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/isdocumentcontrolled.md), [IsValid](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/isvalid.md), [UserData](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/userdata.md), [UserDictionary](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/userdictionary.md), [ConstructConstObject](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/constructconstobject.md), [Dispose](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/dispose.md), [EnsurePrivateCopy](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/ensureprivatecopy.md), [GetObjectData](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/getobjectdata.md), [IsValidWithLog](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/isvalidwithlog.md), [NonConstOperation](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/nonconstoperation.md), [OnSwitchToNonConst](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/onswitchtononconst.md), [ToJSON](https://developer.rhino3d.com/api/rhinocommon/type/rhino.runtime.commonobject/tojson.md)