Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

RenderPipelineAsset

class in UnityEngine.Experimental.Rendering

/

Inherits from:ScriptableObject

/

Implemented in:UnityEngine.CoreModule


Implements interfaces:IRenderPipelineAsset

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.

Public Methods

CreatePipelineCreate a IRenderPipeline specific to this asset.
DestroyCreatedInstancesDestroys all cached data and created IRenderLoop's.
GetDefault2DMaterialReturn the default 2D Material for this pipeline.
GetDefaultLineMaterialReturn the default Line Material for this pipeline.
GetDefaultMaterialReturn the default Material for this pipeline.
GetDefaultParticleMaterialReturn the default particle Material for this pipeline.
GetDefaultShaderReturn the default Shader for this pipeline.
GetDefaultTerrainMaterialReturn the default Terrain Material for this pipeline.
GetDefaultUIETC1SupportedMaterialReturn the default UI ETC1 Material for this pipeline.
GetDefaultUIMaterialReturn the default UI Material for this pipeline.
GetDefaultUIOverdrawMaterialReturn the default UI overdraw Material for this pipeline.
GetTerrainBrushPassIndexThe render index for the terrain brush in the editor.

Protected Methods

CreatedInstancesReturns the list of current IRenderPipeline's created by the asset.
InternalCreatePipelineCreate 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

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active 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.

Did you find this page useful? Please give it a rating: