Version: Unity 6.2 (6000.2)
LanguageEnglish
  • C#
Method group is Obsolete

HDROutputSettings.SetPaperWhiteInNits

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete SetPaperWhiteInNits is deprecated, please use paperWhiteNits instead.

Declaration

public static void SetPaperWhiteInNits(float paperWhite);

Parameters

Parameter Description
paperWhite The brightness of paper white in nits.

Description

Sets the base luminance of a white paper surface in nits or candela per square meter (cd/m2).

The base luminance of a white paper surface in nits or candela per square meter (cd/m2). Unity uses this value if HDROutputSettings.automaticHDRTonemapping is true. The higher this value, the brighter the resulting image appears on the HDR display.

This method has been deprecated. Please use HDROutputSettings.paperWhiteNits instead.