Class PipelineHelpURLAttribute

Use this attribute to define a documentation URL that is only active when a specific Render Pipeline is in use.

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

The URL will only be generated if the active Scriptable Render Pipeline Asset's type name exactly matches the pipelineName provided.

Examples
[PipelineHelpURL("HDRenderPipelineAsset", "hdrp-page-name")]
[PipelineHelpURL("UniversalRenderPipelineAsset", "urp-page-name")]
public class MyHDRPComponent : MonoBehaviour { /* ... */ }

Constructors

PipelineHelpURLAttribute(string, string, string)

Initializes the attribute to link to a specific documentation page for a named Render Pipeline.

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

The exact Type name of the Render Pipeline Asset (e.g., "UniversalRenderPipelineAsset", "HDRenderPipelineAsset") for which this URL is valid.
string pageName

The name of the documentation page.
string pageHash

Optional. The specific section anchor (#) on the documentation page.
See Also

Properties

URL

Returns the URL to the specified page within the documentation for the designated Render Pipeline, but only if that pipeline is currently active.

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

Checks if a Scriptable Render Pipeline is enabled and if its asset type name matches the pipelineName provided in the constructor. If conditions are met and package info is found, constructs the URL. Otherwise, returns an empty string.

See Also

Extension Methods

See Also