Class HDROutputUtils

Utility class for outputting to an HDR display.

Inheritance

object

HDROutputUtils

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 HDROutputUtils

Methods

ConfigureHDROutput(ComputeShader, ColorGamut, Operation)

Configures the compute shader keywords to use HDR output parameters.

Declaration

public static void ConfigureHDROutput(ComputeShader computeShader, ColorGamut gamut, HDROutputUtils.Operation operations)

Parameters

Type	Name	Description
ComputeShader	computeShader	The compute shader used with HDR output.
ColorGamut	gamut	Color gamut (a combination of color space and encoding) queried from the device.
HDROutputUtils.Operation	operations	HDR color operations the shader applies.

ConfigureHDROutput(Material, ColorGamut, Operation)

Configures the Material keywords to use HDR output parameters.

Declaration

public static void ConfigureHDROutput(Material material, ColorGamut gamut, HDROutputUtils.Operation operations)

Parameters

Type	Name	Description
Material	material	The Material used with HDR output.
ColorGamut	gamut	Color gamut (a combination of color space and encoding) queried from the device.
HDROutputUtils.Operation	operations	HDR color operations the shader applies.

ConfigureHDROutput(Material, Operation)

Configures the Material keywords to use HDR output parameters.

Declaration

public static void ConfigureHDROutput(Material material, HDROutputUtils.Operation operations)

Parameters

Type	Name	Description
Material	material	The Material used with HDR output.
HDROutputUtils.Operation	operations	HDR color operations the shader applies.

ConfigureHDROutput(MaterialPropertyBlock, ColorGamut)

Configures the Material Property Block variables to use HDR output parameters.

Declaration

public static void ConfigureHDROutput(MaterialPropertyBlock properties, ColorGamut gamut)

Parameters

Type	Name	Description
MaterialPropertyBlock	properties	The Material Property Block used with HDR output.
ColorGamut	gamut	Color gamut (a combination of color space and encoding) queried from the device.

GetColorEncodingForGamut(ColorGamut, out int)

Extracts the encoding part of the ColorGamut

Declaration

public static bool GetColorEncodingForGamut(ColorGamut gamut, out int encoding)

Parameters

Type	Name	Description
ColorGamut	gamut	Color gamut (a combination of color space and encoding) queried from the device.
int	encoding	The HDREncoding value the color gamut contains as an int.

Returns

Type	Description
bool	Returns true if there was a valid HDREncoding for the ColorGamut, false otherwise

GetColorSpaceForGamut(ColorGamut, out int)

Extracts the color space part of the ColorGamut

Declaration

public static bool GetColorSpaceForGamut(ColorGamut gamut, out int colorspace)

Parameters

Type	Name	Description
ColorGamut	gamut	Color gamut (a combination of color space and encoding) queried from the device.
int	colorspace	The HDRColorspace value the color gamut contains as an int.

Returns

Type	Description
bool	Returns true if there was a valid HDRColorspace for the ColorGamut, false otherwise

IsShaderVariantValid(ShaderKeywordSet, bool)

Returns true if the given set of keywords is valid for HDR output.

Declaration

public static bool IsShaderVariantValid(ShaderKeywordSet shaderKeywordSet, bool isHDREnabled)

Parameters

Type	Name	Description
ShaderKeywordSet	shaderKeywordSet	Shader keywords combination that represents a shader variant.
bool	isHDREnabled	Whether HDR output shader variants are required.

Returns

Type	Description
bool	True if the shader variant is valid and should not be stripped.