【Unity】EmissionのIntensityについて

Question

使用バージョン　Unity2019.4.13f1

EmissionのIntensityをスクリプトから調整したいのですが、調べると出てくるSet("_EmissionColor", ColorCode * intensityValue)を試していますが、intenstiyValueに渡した数値通りになりません。

例えば4を渡してマテリアルのintensityの実数値を確認すると4ではなく2.416924となっていました。
８を渡せば４になるのかと思えば、3.416925となっていました。
調べた中では渡すintensityをMathf.Pow(2,intensity)とすると書いてある場合もありましたが、これも試してみましたが値が近付きはするものの同じ値にはなりませんでした。

何か方法が間違っているのでしょうか？どのようにすればEmissionのIntensityを指定した値と同じ値に変更できるでしょうか。

Answer 1

Intensityのセットについては、Mathf.Pow(2,intensity)の方を使うのが適切だろうと思います。
カラーピッカーで見てみたときの値の狂いについては、おそらくカラーピッカーがHDRカラーをベースカラーとIntensityに分解するときの計算方法のせいじゃないでしょうかね?

たとえば下図では、EmissionとしてRGBがすべて255の白色、Intensityが2の色をセットしているのですが、カラーピッカーをいったん閉じて開き直すとRGBが191に暗くなり、代わりにIntensityは2.416924に上昇してしまいました。
ご質問者さんの場合も、もしかしてIntensityだけではなくベースカラーの方も本来のColorCodeとは違う値になってはいませんでしょうか?

以前別の方の「Unity マテリアルのEmission intensityについて」とのご質問に回答しました際に調べたところによると、どうやらこのHDRカラーの分解はColorMutatorが行っているようでしたが、下記引用のように...

  	  internal static void DecomposeHdrColor(Color linearColorHdr, out Color32 baseLinearColor, out float exposure)
  	  {
  		  baseLinearColor = linearColorHdr;
  		  var maxColorComponent = linearColorHdr.maxColorComponent;
  		  // replicate Photoshops's decomposition behaviour
  		  if (maxColorComponent == 0f || maxColorComponent <= 1f && maxColorComponent >= 1 / 255f)
  		  {
  			  exposure = 0f;

  			  baseLinearColor.r = (byte)Mathf.RoundToInt(linearColorHdr.r * 255f);
  			  baseLinearColor.g = (byte)Mathf.RoundToInt(linearColorHdr.g * 255f);
  			  baseLinearColor.b = (byte)Mathf.RoundToInt(linearColorHdr.b * 255f);
  		  }
  		  else
  		  {
  			  // calibrate exposure to the max float color component
  			  var scaleFactor = k_MaxByteForOverexposedColor / maxColorComponent;
  			  exposure = Mathf.Log(255f / scaleFactor) / Mathf.Log(2f);

  			  // maintain maximal integrity of byte values to prevent off-by-one errors when scaling up a color one component at a time
  			  baseLinearColor.r = Math.Min(k_MaxByteForOverexposedColor, (byte)Mathf.CeilToInt(scaleFactor * linearColorHdr.r));
  			  baseLinearColor.g = Math.Min(k_MaxByteForOverexposedColor, (byte)Mathf.CeilToInt(scaleFactor * linearColorHdr.g));
  			  baseLinearColor.b = Math.Min(k_MaxByteForOverexposedColor, (byte)Mathf.CeilToInt(scaleFactor * linearColorHdr.b));
  		  }
  	  }

入力されたHDRカラーがLDRカラーで表現できない（明度が1/255を下回っているか、1を超えている）場合、元のHDRカラーの明度が191/255に（k_MaxByteForOverexposedColorとして定義されている値に）なるようスケーリングしたものをベースカラーとして決めて、それに合わせたIntensityを計算しているらしいですね。

カラーピッカー上の値とスクリプト上の値の不整合を解消するとなると、おそらくスクリプト側の値の方をカラーピッカー側の値に合わせる...つまりColorMutatorと同じ計算式で色を矯正して、ColorCodeとintensityValueの方をカラーピッカーと一致するよう書き換えることになるんじゃないかと思います。

スクリプト側の値を矯正する例

下記のようなスクリプトをオブジェクトにアタッチして...

using UnityEngine;

[RequireComponent(typeof(Renderer))]
public class EmissionController : MonoBehaviour
{
	private static readonly int EmissionColorProperty = Shader.PropertyToID("_EmissionColor");

	[ColorUsage(false)] public Color ColorCode = Color.black;
	public float intensityValue;

	private Color previousColorCode;
	private float previousIntensityValue = float.NaN;
	private new Renderer renderer;

	private void Update()
	{
		if (this.renderer == null)
		{
			this.renderer = this.GetComponent<Renderer>();
		}

		// ColorCodeもintensityValueも前フレームから変わっていなければ
		// Emission更新の必要はないと見なして何もしない
		if ((this.ColorCode == this.previousColorCode) && (this.intensityValue == this.previousIntensityValue))
		{
			return;
		}

		// まずColorCodeをintensityValueに応じて増幅し、Emissionにセットするべき色を決める
		var hdrColor = this.ColorCode * Mathf.Pow(2.0f, this.intensityValue);
		hdrColor.a = this.ColorCode.a;

		// EmissionにhdrColorをセットする
		var material = this.renderer.material;
		if (material != null)
		{
			material.EnableKeyword("_EMISSION");
			material.SetColor(EmissionColorProperty, hdrColor);
		}

		// そしてhdrColorをベースカラーとIntensityに分解する
		// まずhdrColorのRGBのうち最も大きい成分の値を取得する
		var maxComponent = hdrColor.maxColorComponent;

		// intensityValueはひとまず0にする
		this.intensityValue = 0.0f;

		// その最大成分が0なら完全な黒なのでLDRで表現でき、分解の必要はない
		// また、1/255以上1以下ならLDRで表現でき、分解の必要はない
		if ((maxComponent != 0.0f) && ((maxComponent < (1.0f / 255.0f)) || (maxComponent > 1.0f)))
		{
			// そうでないならば、まずmaxComponentに対する191/255の倍率を求める
			var scale = 191.0f / (maxComponent * 255.0f);

			// そしてそのスケールを使ってColorCodeのRGBを矯正する
			this.ColorCode = hdrColor * scale;
			this.ColorCode.a = hdrColor.a;

			// また、scaleの逆数の2を底とする対数を求め、intensityValueとする
			this.intensityValue = Mathf.Log(1.0f / scale, 2.0f);
		}

		// 最後に、次のフレームに備えて現在のColorCodeとintensityValueを保存しておく
		this.previousColorCode = this.ColorCode;
		this.previousIntensityValue = this.intensityValue;
	}
}

ゲーム実行時にスクリプト側のColorCodeとintensityValueを設定したところ、ColorCodeは少し暗く、intensityValueは少し大きく変化しました。
そして、マテリアル側のEmissionもスクリプト側と同じ設定値になりました。

カラーピッカー側の値を矯正しようとするとどうなるか

たとえばスクリプトを下記のようなものに変更した場合（なんだかマルウェア的な変なことをしていて気持ち悪いかもしれませんが、あくまでも実験ということでご容赦ください）...

using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using UnityEngine;
#if UNITY_EDITOR
using UnityEditor;
#endif

[RequireComponent(typeof(Renderer))]
public class EmissionController2 : MonoBehaviour
{
	private static readonly int EmissionColorProperty = Shader.PropertyToID("_EmissionColor");

	[ColorUsage(false)] public Color ColorCode = Color.black;
	public float intensityValue;

	private readonly byte[] decomposeHdrColorBackup = new byte[5];
	private IntPtr decomposeHdrColorPointer;
	private Color previousColorCode;
	private float previousIntensityValue = float.NaN;
	private new Renderer renderer;

	private void Update()
	{
		if (this.renderer == null)
		{
			this.renderer = this.GetComponent<Renderer>();
		}

		// ColorCodeもintensityValueも前フレームから変わっていなければ
		// Emission更新の必要はないと見なして何もしない
		if ((this.ColorCode == this.previousColorCode) && (this.intensityValue == this.previousIntensityValue))
		{
			return;
		}

		// まずColorCodeをintensityValueに応じて増幅し、Emissionにセットするべき色を決める
		var hdrColor = this.ColorCode * Mathf.Pow(2.0f, this.intensityValue);
		hdrColor.a = this.ColorCode.a;

		// EmissionにhdrColorをセットする
		var material = this.renderer.material;
		if (material != null)
		{
			material.EnableKeyword("_EMISSION");
			material.SetColor(EmissionColorProperty, hdrColor);
		}

		// ColorMutator.DecomposeHdrColorを乗っ取り、代わりにDecomposeHdrColor255を実行させるようにする
		this.HijackDecomposeHdrColor();

		// 最後に、次のフレームに備えて現在のColorCodeとintensityValueを保存しておく
		this.previousColorCode = this.ColorCode;
		this.previousIntensityValue = this.intensityValue;
	}

	// コンポーネント破壊時にColorMutator.DecomposeHdrColorを元の状態に戻す
	private void OnDestroy()
	{
		if (this.decomposeHdrColorPointer == IntPtr.Zero)
		{
			return;
		}
		Marshal.Copy(this.decomposeHdrColorBackup, 0, this.decomposeHdrColorPointer, this.decomposeHdrColorBackup.Length);
		this.decomposeHdrColorPointer = IntPtr.Zero;
	}

	// ColorMutator.DecomposeHdrColorを乗っ取り、DecomposeHdrColor255へ制御を移すよう改変を加える
	private void HijackDecomposeHdrColor()
	{
		#if UNITY_EDITOR
		if (this.decomposeHdrColorPointer != IntPtr.Zero)
		{
			return;
		}

		// ColorMutator.DecomposeHdrColorのメモリ上の位置を取得する
		const BindingFlags bindingFlags = BindingFlags.DeclaredOnly | BindingFlags.NonPublic | BindingFlags.Static;
		var decomposeHdrColorMethodHandle = typeof(EditorWindow).Assembly.GetType("UnityEditor.ColorMutator").GetMethod("DecomposeHdrColor", bindingFlags).MethodHandle;
		RuntimeHelpers.PrepareMethod(decomposeHdrColorMethodHandle);
		this.decomposeHdrColorPointer = decomposeHdrColorMethodHandle.GetFunctionPointer();

		// DecomposeHdrColor255のメモリ上の位置を取得する
		var decomposeHdrColor255MethodHandle = typeof(EmissionController2).GetMethod(nameof(DecomposeHdrColor255), bindingFlags).MethodHandle;
		RuntimeHelpers.PrepareMethod(decomposeHdrColor255MethodHandle);
		var decomposeHdrColor255Pointer = decomposeHdrColor255MethodHandle.GetFunctionPointer();

		// コンポーネント破壊時にColorMutator.DecomposeHdrColorを復元するため、先頭5バイトをバックアップしておく
		Marshal.Copy(this.decomposeHdrColorPointer, this.decomposeHdrColorBackup, 0, this.decomposeHdrColorBackup.Length);

		// ColorMutator.DecomposeHdrColorの先頭5バイトにDecomposeHdrColor255へジャンプするコードを埋め込む
		Marshal.WriteByte(this.decomposeHdrColorPointer, 0xE9);
		Marshal.WriteInt32(this.decomposeHdrColorPointer, 1, (int)decomposeHdrColor255Pointer - (int)this.decomposeHdrColorPointer - this.decomposeHdrColorBackup.Length);
		#endif
	}

	// オリジナルのColorMutator.DecomposeHdrColorはベースカラーの基準値が191だが、
	// こちらは255を基準にベースカラーを決める
	private static void DecomposeHdrColor255(Color linearColorHdr, out Color32 baseLinearColor, out float exposure)
	{
		baseLinearColor = linearColorHdr;
		var maxColorComponent = linearColorHdr.maxColorComponent;
		if (maxColorComponent is 0.0f or <= 1.0f and >= 1.0f / 255.0f)
		{
			exposure = 0.0f;
			baseLinearColor.r = (byte)Mathf.RoundToInt(linearColorHdr.r * 255.0f);
			baseLinearColor.g = (byte)Mathf.RoundToInt(linearColorHdr.g * 255.0f);
			baseLinearColor.b = (byte)Mathf.RoundToInt(linearColorHdr.b * 255.0f);
		}
		else
		{
			var scaleFactor = 255.0f / maxColorComponent;
			exposure = Mathf.Log(maxColorComponent, 2.0f);
			baseLinearColor.r = (byte)Math.Min(255, Mathf.CeilToInt(scaleFactor * linearColorHdr.r));
			baseLinearColor.g = (byte)Math.Min(255, Mathf.CeilToInt(scaleFactor * linearColorHdr.g));
			baseLinearColor.b = (byte)Math.Min(255, Mathf.CeilToInt(scaleFactor * linearColorHdr.b));
		}
	}
}

マテリアル上でもIntensityが2になりました。

一見うまくいったように見えるかもしれませんが、逆にスクリプト側のベースカラー輝度が191でも、マテリアル側のベースカラー輝度は255になってしまいます。

(255, 128, 64)、Intensity 2の色と(191, 96, 48)、Intensity 2.416924の色は計算誤差を無視すれば同等で区別できず、カラーピッカー側で本来のベースカラー・Intensityを復元するのは無理っぽいです...

Comments

[Y0241-N]

丁寧な回答ありがとうございます。
入力値をColorMutatorと同じ計算式で矯正する、ということでしたので、

baseLinearColor = ColorCode;
var maxColorComponent = intensityValue;

としてDecomposeHdrColorを通し、outされたexposureを exposure = Mathf.pow(2,exposure)した値を
SetColor("_EmissionColor", baseLinearColor * exposure )してみたのですが、値が合いませんでした。
こういうことではないのでしょうか？

[Bongo]

矯正と申し上げたのは、そのようなことを意図しておりました。うまくいかなかったとなると、なにか計算式に問題があるんでしょうかね...?
ご参考までに、私もちょっとEmissionを設定するスクリプトを作成してみました。追記しましたように、とりあえず私の試した限りではマテリアル側に合わせた値にスクリプト側が矯正されたようだったのですが、あれと比べてどこか原因と思われる部分は見当たりますでしょうか?

[Y0241-N]

返答が遅くなってしまいましたが、頂いた追記内容を試してみましたが思っていたようにはいきませんでした。
試していただいた内容で言うと、矯正後のHDRColorにセットされているIntensityの値を入力値と同じ値にしたかったのですが、そういう訳ではなかったです。
またColorCodeに渡すカラーが初めからHDRColorを渡すか、RGBColorを渡すかによっても矯正後のIntensityの値が変わってくるため、おとなしく[ColorUsage(false, true)]を使用したHDRColorをInspectorからIntensityを調整してSetColorしようと思います。

[Bongo]

すみませんでした、ご質問者さんの意図と私の認識に齟齬があったようで、ご希望の挙動ではなかったようですね...
何かコメントせねばと思いまして追記いたしましたが、結局意図通りの挙動は実現できずすみません。この問題はいわば「○×□=12です。○と□はそれぞれいくつでしょう?」と問われても○と□を一意に決定できないように、原理的に解決できない問題かもしれませんね。不本意かとお察ししますが、コメントいただいたようにそういったものとして諦めていただくことになりそうです...

[Y0241-N]

いえいえ、ご丁寧に回答していただいてありがとうございました。
また機会がありましたらその際もご助力いただけますと幸いです。

この質問は自己回答にて「現状スクリプトからIntensityを数値指定して変更することはできない」としてクローズ致します。お時間を割いていただいてありがとうございました。

Answer 2

結論として現状スクリプトからIntensityを数値指定して変更することはできないと思われます。