UdonTask

This package enables the execution of Udon from a separate thread.

Udonを別スレッドで実行可能にするやつ。

Installation

Iwashi Packagesを開いて「Add to VCC」を押してVCCからUdonTaskを追加します。

Usage

通常

using UnityEngine;
using UdonSharp;
using VRC.Udon.Common.Interfaces;
using Iwashi.UdonTask;

public class UdonTaskSample : UdonSharpBehaviour
{
  public void ExecuteTask()
  {
    UdonTask.New((IUdonEventReceiver)this, nameof(OnProcess), nameof(OnComplete));
  }

  public void OnProcess()
  {
    /* ここに重たい処理を書く。
     * メインスレッドでしか触れないものは当然触れません。要注意！ */
  }

  public void OnComplete()
  {
    Debug.Log("完了！");
  }
}

戻り値・引数付き

using UnityEngine;
using UdonSharp;
using VRC.Udon.Common.Interfaces;
using Iwashi.UdonTask;

public class UdonTaskSample : UdonSharpBehaviour
{
	public void ExecuteTask()
	{
		UdonTask.New((IUdonEventReceiver)this, nameof(OnProcess), nameof(OnComplete), "onProcessContainer", "onReturnContainer", "イワシ");
	}

	public UdonTaskContainer OnProcess(UdonTaskContainer onProcessContainer)
	{
		var container = UdonTaskContainer.New();
		var str = onProcessContainer.GetVariable<string>(0);
		container = container.AddVariable($"{str}ーモ");
		Debug.Log(container.GetVariable<string>(container.Count() - 1));
		return container;
	}

	public void OnComplete(UdonTaskContainer onReturnContainer)
	{
		Debug.Log(onReturnContainer.GetVariable<string>(0));
	}
}

第1引数にIUdonEventReceiverを指定します。(IUdonEventReceiver)thisを使うと自身のUdonSharpBehaviourを設定できます。
10秒以上かかる処理はUdonが死ぬので実行できません。9.9秒くらいを測って分割するようにしてください。
引数付きを利用する場合は関数の引数は必ずそのスクリプト内で一意の名前になるようにしてください。
- UdonTask.Newする際に引数の名前を指定する必要があります。

Samples

UnityのPackageManagerのUdonTask→Samplesからサンプルシーンをインポートできます。

サンプルシーンではBase64エンコードされた17枚の画像データを高速で読み込むテスト等ができます。

テストワールド

TIPS

別スレッドからSendCustomEventDelayedSeconds/SendCustomEventDelayedFramesを呼ぶとメインスレッドを呼び出せる。
別スレッドで触ってるフィールドをメインスレッドで触るとタイミング次第でUdonが死ぬ。
- そもそもタイミング次第で死ぬ。UdonVMのスタックがずれるっぽい？特定のフィールドが別の型に化けるとか起きる。
別スレッドからでもDebug.Logの出力は可能。

Note

Harmonyを用いてスレッドセーフなUdonログの出力を実装。
スレッドセーフな疑似ランダム生成器クラスを実装。

YukiNagatoVR/udon-task