Class UpscalerRegistry

Registry of the upscaler implementations available to the pipeline, and of the options type each one uses.

Inheritance

object

UpscalerRegistry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Rendering

Assembly: Unity.RenderPipelines.Core.Runtime.dll

Syntax

public static class UpscalerRegistry

Fields

s_RegisteredUpscalers

The registered upscalers, keyed by upscaler ID.

Declaration

public static readonly Dictionary<string, (Type UpscalerType, Type? OptionsType, string DisplayName)> s_RegisteredUpscalers

Field Value

Type	Description
Dictionary<string, (Type UpscalerType, Type OptionsType, string DisplayName)>

Methods

Register<TUpscaler>(string, string)

Registers an IUpscaler type without any custom options type.

Declaration

public static void Register<TUpscaler>(string upscalerId, string displayName) where TUpscaler : IUpscaler, new()

Parameters

Type	Name	Description
string	upscalerId	Stable identifier for the upscaler, serialized by render pipeline assets.
string	displayName	Name shown for the upscaler in the editor.

Type Parameters

Name	Description
TUpscaler	The type of upscaler to register.

Register<TUpscaler, TOptions>(string, string)

Registers an IUpscaler type with its custom options type.

Declaration

public static void Register<TUpscaler, TOptions>(string upscalerId, string displayName) where TUpscaler : IUpscaler where TOptions : UpscalerOptions

Parameters

Type	Name	Description
string	upscalerId	Stable identifier for the upscaler, serialized by render pipeline assets.
string	displayName	Name shown for the upscaler in the editor.

Type Parameters

Name	Description
TUpscaler	The type of upscaler to register.
TOptions	The type of upscaler options to register.