Version: 2021.1
LanguageEnglish
  • C#

How do you use documentation throughout your workflow? Share your experience with us by taking this survey.

RenderPipelineAsset

class in UnityEngine.Rendering

/

Inherits from:ScriptableObject

/

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

An asset that produces a specific IRenderPipeline.

Default implementation of IRenderPipelineAsset. This manages the lifecylces of inherited types, as well as ensures that created IRenderPipeline's are invalidated when the asset is changed.

See Also: IRenderPipelineAsset.

Properties

autodeskInteractiveMaskedShaderRetrieves the default Autodesk Interactive masked Shader for this pipeline.
autodeskInteractiveShaderRetrieves the default Autodesk Interactive Shader for this pipeline.
autodeskInteractiveTransparentShaderRetrieves the default Autodesk Interactive transparent Shader for this pipeline.
default2DMaterialReturn the default 2D Material for this pipeline.
defaultLineMaterialReturn the default Line Material for this pipeline.
defaultMaterialReturn the default Material for this pipeline.
defaultParticleMaterialReturn the default particle Material for this pipeline.
defaultShaderReturn the default Shader for this pipeline.
defaultSpeedTree7ShaderReturn the default SpeedTree v7 Shader for this pipeline.
defaultSpeedTree8ShaderReturn the default SpeedTree v8 Shader for this pipeline.
defaultTerrainMaterialReturn the default Terrain Material for this pipeline.
defaultUIETC1SupportedMaterialReturn the default UI ETC1 Material for this pipeline.
defaultUIMaterialReturn the default UI Material for this pipeline.
defaultUIOverdrawMaterialReturn the default UI overdraw Material for this pipeline.
renderingLayerMaskNamesReturns the list of names used to display Rendering Layer Mask UI for this pipeline.
terrainBrushPassIndexThe render index for the terrain brush in the editor.
terrainDetailGrassBillboardShaderReturn the detail grass billboard Shader for this pipeline.
terrainDetailGrassShaderReturn the detail grass Shader for this pipeline.
terrainDetailLitShaderReturn the detail lit Shader for this pipeline.

Protected Methods

CreatePipelineCreate a IRenderPipeline specific to this asset.
OnDisableDefault implementation of OnDisable for RenderPipelineAsset. See ScriptableObject.OnDisable
OnValidateDefault implementation of OnValidate for RenderPipelineAsset. See MonoBehaviour.OnValidate

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.
CreateInstanceCreates an instance of a scriptable object.

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.

Messages

AwakeThis function is called when the ScriptableObject script is started.
OnDestroyThis function is called when the scriptable object will be destroyed.
OnEnableThis function is called when the object is loaded.
ResetReset to default values.