Class UniversalRenderPipelineVolumeComponentEditor

The default VolumeComponentEditor implementation for the Universal Render Pipeline (URP). This editor manages custom UI for volume components in the URP context. It handles rendering feature checks and UI warnings for missing features needed by the volume component.

Inheritance

object

Object

ScriptableObject

Editor

VolumeComponentEditor

UniversalRenderPipelineVolumeComponentEditor

Inherited Members

VolumeComponentEditor.m_Inspector

VolumeComponentEditor.BeginAdditionalPropertiesScope()

VolumeComponentEditor.EndAdditionalPropertiesScope()

VolumeComponentEditor.Repaint()

VolumeComponentEditor.OnDisable()

VolumeComponentEditor.OnInspectorGUI()

VolumeComponentEditor.GetDisplayTitle()

VolumeComponentEditor.Unpack(SerializedProperty)

VolumeComponentEditor.PropertyField(SerializedDataParameter)

VolumeComponentEditor.DrawHeader(string)

VolumeComponentEditor.PropertyField(SerializedDataParameter, GUIContent)

VolumeComponentEditor.ColorFieldLinear(SerializedDataParameter)

VolumeComponentEditor.DrawOverrideCheckbox(SerializedDataParameter)

VolumeComponentEditor.DrawOverrideCheckbox(SerializedDataParameter, VolumeParameterDrawer)

VolumeComponentEditor.expanded

VolumeComponentEditor.volumeComponent

VolumeComponentEditor.activeProperty

VolumeComponentEditor.hasAdditionalProperties

VolumeComponentEditor.showAdditionalProperties

VolumeComponentEditor.volume

VolumeComponentEditor.enableOverrides

Editor.SaveChanges()

Editor.DiscardChanges()

Editor.CreateEditorWithContext(Object[], Object, Type)

Editor.CreateEditorWithContext(Object[], Object)

Editor.CreateCachedEditorWithContext(Object, Object, Type, ref Editor)

Editor.CreateCachedEditorWithContext(Object[], Object, Type, ref Editor)

Editor.CreateCachedEditor(Object, Type, ref Editor)

Editor.CreateCachedEditor(Object[], Type, ref Editor)

Editor.CreateEditor(Object)

Editor.CreateEditor(Object, Type)

Editor.CreateEditor(Object[])

Editor.CreateEditor(Object[], Type)

Editor.DrawPropertiesExcluding(SerializedObject, params string[])

Editor.DrawDefaultInspector()

Editor.CreateInspectorGUI()

Editor.RequiresConstantRepaint()

Editor.DrawHeader()

Editor.OnHeaderGUI()

Editor.ShouldHideOpenButton()

Editor.DrawFoldoutInspector(Object, ref Editor)

Editor.HasPreviewGUI()

Editor.CreatePreview(VisualElement)

Editor.GetPreviewTitle()

Editor.RenderStaticPreview(string, Object[], int, int)

Editor.OnPreviewGUI(Rect, GUIStyle)

Editor.OnInteractivePreviewGUI(Rect, GUIStyle)

Editor.OnPreviewSettings()

Editor.GetInfoString()

Editor.DrawPreview(Rect)

Editor.ReloadPreviewInstances()

Editor.UseDefaultMargins()

Editor.MoveNextTarget()

Editor.ResetTarget()

Editor.hasUnsavedChanges

Editor.saveChangesMessage

Editor.target

Editor.targets

Editor.serializedObject

Editor.finishedDefaultHeaderGUI

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEditor.Rendering.Universal

Assembly: Unity.RenderPipelines.Universal.Editor.dll

Syntax

[SupportedOnRenderPipeline(typeof(UniversalRenderPipelineAsset))]
[CustomEditor(typeof(VolumeComponent), true)]
public class UniversalRenderPipelineVolumeComponentEditor : VolumeComponentEditor

Remarks

This editor class is designed to work with volume components in Unity's URP. It extends the VolumeComponentEditor to customize the inspector UI for volume components and add checks for required renderer features.

When using this editor, ensure that the relevant renderer features for the volume are enabled in the active URP renderer asset. If any required features are missing, a warning will be displayed with an option to open the relevant renderer settings.

Methods

OnBeforeInspectorGUI()

Displays the UI for the volume component and checks for missing renderer features required by the volume.

Declaration

protected override void OnBeforeInspectorGUI()

Overrides

VolumeComponentEditor.OnBeforeInspectorGUI()

Remarks

This method draws the inspector UI for the volume component and checks whether the necessary renderer features are enabled in the active URP asset. If any required features are missing, a warning box will be displayed. The warning includes a button that opens the active renderer asset for quick modification.

Examples

The OnBeforeInspectorGUI() method is called before rendering the inspector GUI for the volume component, ensuring that feature checks are performed and UI warnings are shown before displaying the inspector.

See Also

VolumeComponentEditor

UniversalRenderPipelineAsset

GraphicsSettings

CoreEditorUtils

OnEnable()

Initializes the editor. It caches the VolumeRequiresRendererFeatures attribute from the target component.

Declaration

public override void OnEnable()

Overrides

VolumeComponentEditor.OnEnable()

Remarks

The OnEnable() method caches the renderer features attribute for the volume component. This ensures that UI elements relying on these features are updated efficiently. This method is called when the editor is first enabled.

Examples

The OnEnable() method is automatically called when the editor is initialized, making it suitable for setting up references and caching.

See Also

VolumeComponentEditor

UniversalRenderPipelineAsset

GraphicsSettings

CoreEditorUtils

See Also

VolumeComponentEditor

UniversalRenderPipelineAsset

GraphicsSettings

CoreEditorUtils