Version: 2021.3
LanguageEnglish
  • C#

GraphicsSettings

class in UnityEngine.Rendering

/

Inherits from:Object

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Script interface for Graphics Settings.

Static Properties

allConfiguredRenderPipelinesAn array containing the RenderPipelineAsset instances that describe the default render pipeline and any quality level overrides.
currentRenderPipelineThe RenderPipelineAsset that defines the active render pipeline for the current quality level.
defaultRenderingLayerMaskStores the default value for the RenderingLayerMask property of newly created Renderers.
defaultRenderPipelineThe RenderPipelineAsset that defines the default render pipeline.
disableBuiltinCustomRenderTextureUpdateDisables the built-in update loop for Custom Render Textures, so that you can write your own update loop.
lightsUseColorTemperatureWhether to use a Light's color temperature when calculating the final color of that Light."
lightsUseLinearIntensityIf this is true, Light intensity is multiplied against linear color values. If it is false, gamma color values are used.
logWhenShaderIsCompiledIf this is true, a log entry is made each time a shader is compiled at application runtime.
realtimeDirectRectangularAreaLightsIs the current render pipeline capable of rendering direct lighting for rectangular area Lights?
renderPipelineAssetDeprecated, use GraphicsSettings.defaultRenderPipeline instead.
transparencySortAxisAn axis that describes the direction along which the distances of objects are measured for the purpose of sorting.
transparencySortModeTransparent object sorting mode.
useScriptableRenderPipelineBatchingEnable/Disable SRP batcher (experimental) at runtime.
videoShadersIncludeModeIf and when to include video shaders in the build.

Static Methods

GetCustomShaderGet custom shader used instead of a built-in shader.
GetGraphicsSettingsProvides a reference to the GraphicSettings object.
GetSettingsForRenderPipelineGet the registered RenderPipelineGlobalSettings for the given RenderPipeline.
GetShaderModeGet built-in shader mode.
HasShaderDefineReturns true if shader define was set when compiling shaders for current GraphicsTier. Graphics Tiers are only available in the Built-in Render Pipeline.
RegisterRenderPipelineSettingsRegister a RenderPipelineGlobalSettings instance for a given RenderPipeline. A RenderPipeline can have only one registered RenderPipelineGlobalSettings instance.
SetCustomShaderSet custom shader to use instead of a built-in shader.
SetShaderModeSet built-in shader mode.
UnregisterRenderPipelineSettingsThe method removes the association between the given RenderPipeline and the RenderPipelineGlobalSettings asset from GraphicsSettings.

Inherited Members

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.