Class CurrentPipelineHelpURLAttribute

Use this attribute to define documentation url for the current Render Pipeline.

Inheritance
object
Attribute
HelpURLAttribute
CurrentPipelineHelpURLAttribute
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Conditional("UNITY_EDITOR")]
[AttributeUsage(AttributeTargets.Class|AttributeTargets.Enum, AllowMultiple = false)]
public class CurrentPipelineHelpURLAttribute : HelpURLAttribute
Examples

[CurrentPipelineHelpURLAttribute("Volume")] public class Volume : MonoBehaviour

Constructors

CurrentPipelineHelpURLAttribute(string, string)

The constructor of the attribute

Declaration
public CurrentPipelineHelpURLAttribute(string pageName, string pageHash = "")
Parameters
Type Name Description
string pageName

The name of the documentation page.
string pageHash

The name of the section on the documentation page.

Properties

URL

Returns the URL to the given page in the current Render Pipeline package documentation site.

Declaration
public override string URL { get; }
Property Value
Type Description
string
Overrides

Extension Methods