Class STP

Interface to the Spatial-Temporal Post-Processing Upscaler (STP). This class allows users to configure and execute STP via render graph.

Inheritance

object

STP

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.Rendering

Assembly: solution.dll

Syntax

public static class STP

Properties

debugViewDescriptions

Array of debug view descriptions expected to be used in the rendering debugger UI

Declaration

public static GUIContent[] debugViewDescriptions { get; }

Property Value

Type	Description
GUIContent[]

debugViewIndices

Array of debug view indices expected to be used in the rendering debugger UI

Declaration

public static int[] debugViewIndices { get; }

Property Value

Type	Description
int[]

perViewConfigs

Static allocation of per-view configurations Users are expected to populate this during STP configuration and then assign it to the relevant configuration structure field(s) to avoid unnecessary allocations.

Declaration

public static STP.PerViewConfig[] perViewConfigs { get; set; }

Property Value

Type	Description
PerViewConfig[]

stpRuntimeResources

Contains all runtime resources in need during STP's passes

Declaration

public static StpRuntimeResources stpRuntimeResources { get; set; }

Property Value

Type	Description
StpRuntimeResources

Methods

Execute(CommandBuffer, ref RenderFeatureConfig, RTHandle, RTHandle, RTHandle)

Executes the STP technique using the provided configuration within render feature

Declaration

public static void Execute(CommandBuffer cmd, ref STP.RenderFeatureConfig config, RTHandle interColor, RTHandle interConvergence, RTHandle interWeights)

Parameters

Type	Name	Description
CommandBuffer	cmd	command buffer to execute STP within
STP.RenderFeatureConfig	config	configuration parameters for STP
RTHandle	interColor
RTHandle	interConvergence
RTHandle	interWeights

Execute(RenderGraph, ref Config)

Executes the STP technique using the provided configuration in the target render graph

Declaration

public static TextureHandle Execute(RenderGraph renderGraph, ref STP.Config config)

Parameters

Type	Name	Description
RenderGraph	renderGraph	render graph to execute STP within
STP.Config	config	configuration parameters for STP

Returns

Type	Description
TextureHandle	Texture handle that contains the upscaled color output

IsSupported()

Returns true if STP is supported on the current device. Otherwise, false. STP requires compute shaders

Declaration

public static bool IsSupported()

Returns

Type	Description
bool	True if supported

Jit16(int)

Helper function that calculates the STP-specific jitter pattern associated with the provided frame index.

Declaration

public static Vector2 Jit16(int frameIndex)

Parameters

Type	Name	Description
int	frameIndex	Index of the current frame

Returns

Type	Description
Vector2	Jitter pattern for the provided frame index