Class VolumeComponentMenu

This attribute is used to set up a path in the Add Override popup menu in Unity's Volume system. It allows you to organize and categorize your Volume components into submenus for easier access and management within the editor.

Inheritance
object
Attribute
VolumeComponentMenu
VolumeComponentMenuForRenderPipeline
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public class VolumeComponentMenu : Attribute
Remarks

Specify the name of the menu entry, and use slashes ("/") to create hierarchical submenus in the popup. This is useful for organizing large or complex sets of Volume components. To further filter the menu entries based on the active Render Pipeline, you can combine this attribute with the SupportedOnRenderPipeline attribute. This enables conditional display of Volume components depending on the Render Pipeline being used in the project.

Examples
[VolumeComponentMenu("MyVolumeCategory/LightingEffects")]
public class CustomLightingVolume : VolumeComponent { ... }

Constructors

VolumeComponentMenu(string)

Creates a new VolumeComponentMenu instance.

Declaration
public VolumeComponentMenu(string menu)
Parameters
Type Name Description
string menu

The name of the entry in the override list. You can use slashes to create sub-menus.

Fields

menu

The name of the entry in the override list. You can use slashes to create sub-menus.

Declaration
public readonly string menu
Field Value
Type Description
string

Extension Methods