Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GraphicsSettings

Script interface for Graphics Settings.
Read time 6 minutesLast updated 2 days ago

Definition

public sealed class GraphicsSettings : Object

Static Properties

Property

Description

allConfiguredRenderPipelinesAn array containing the RenderPipelineAsset instances that describe the default render pipeline and any quality level overrides.
cameraRelativeLightCullingEnable or disable using the camera position as the reference point for culling lights.
cameraRelativeShadowCullingEnable or disable using the camera position as the reference point for culling shadows.
currentRenderPipelineThe RenderPipelineAsset that defines the active render pipeline for the current quality level.
currentRenderPipelineAssetTypeThe type of the currently active RenderPipelineAsset, or
null
if there's no currently active Asset.
defaultGateFitModeStores the default value for the GateFit property of newly created Cameras.
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.
isScriptableRenderPipelineEnabledIf the value is
true
, a Scriptable Render Pipeline is active.
lightProbeOutsideHullStrategyDefines the way Unity chooses a probe to light a Renderer that is lit by Light Probes but positioned outside the bounds of the Light Probe tetrahedral hull.
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?
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

Method

Description

ForEachExecutes the given callback for each IRenderPipelineGraphicsSettings.
GetCustomShaderGet custom shader used instead of a built-in shader.
GetGraphicsSettingsProvides a reference to the GraphicSettings object.
GetRenderPipelineSettingsGets the RenderPipelineGlobalSettings asset assigned to the given RenderPipeline asset.
GetSettingsForRenderPipelineGet the registered RenderPipelineGlobalSettings for the given RenderPipeline.
GetShaderModeGet built-in shader mode.
HasShaderDefineReturns true if shader define was set when compiling shaders for a given GraphicsTier. Graphics Tiers are only available in the Built-in Render Pipeline.
SetCustomShaderSet custom shader to use instead of a built-in shader.
SetShaderModeSet built-in shader mode.
SubscribeSubscribe to changes of properties in the IRenderPipelineGraphicsSettings.
TryGetCurrentRenderPipelineGlobalSettingsObtains the current active pipeline RenderPipelineGlobalSettings.
TryGetRenderPipelineSettingsGets a IRenderPipelineGraphicsSettings from the GraphicsSettings and returns if the setting is found.
TrySetCurrentRenderPipelineGlobalSettingsAttempts to set the active RenderPipelineGlobalSettings at runtime.
UnsubscribeCancels any subscription to changes of properties of a settings object implemented with the IRenderPipelineGraphicsSettings interface.

Inheritance

Inherited Members

Operators

Operator

Description

operator ==Compares two object references to see if they refer to the same object.
boolDetermines whether the object exists.
operator !=Compares if two objects refer to a different object.