This commit is contained in:
neuecc
2020-09-07 08:57:49 +00:00
parent 3e38e17a12
commit ca6a29f99a
3 changed files with 505 additions and 1 deletions

View File

@@ -377,6 +377,62 @@ For example: FooAction = UniTask.Action(async () =&gt; { /* */ })</p>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_Run__1_System_Func_System_Object_Cysharp_Threading_Tasks_UniTask___0___System_Object_System_Boolean_CancellationToken_">Run&lt;T&gt;(Func&lt;Object, UniTask&lt;T&gt;&gt;, Object, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Action_System_Boolean_CancellationToken_">RunOnThreadPool(Action, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Action_System_Object__System_Object_System_Boolean_CancellationToken_">RunOnThreadPool(Action&lt;Object&gt;, Object, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Func_Cysharp_Threading_Tasks_UniTask__System_Boolean_CancellationToken_">RunOnThreadPool(Func&lt;UniTask&gt;, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Func_System_Object_Cysharp_Threading_Tasks_UniTask__System_Object_System_Boolean_CancellationToken_">RunOnThreadPool(Func&lt;Object, UniTask&gt;, Object, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func___0__System_Boolean_CancellationToken_">RunOnThreadPool&lt;T&gt;(Func&lt;T&gt;, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_Cysharp_Threading_Tasks_UniTask___0___System_Boolean_CancellationToken_">RunOnThreadPool&lt;T&gt;(Func&lt;UniTask&lt;T&gt;&gt;, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_System_Object___0__System_Object_System_Boolean_CancellationToken_">RunOnThreadPool&lt;T&gt;(Func&lt;Object, T&gt;, Object, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html#Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_System_Object_Cysharp_Threading_Tasks_UniTask___0___System_Object_System_Boolean_CancellationToken_">RunOnThreadPool&lt;T&gt;(Func&lt;Object, UniTask&lt;T&gt;&gt;, Object, Boolean, CancellationToken)</a>
</td>
<td class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</td>
</tr>
<tr>
@@ -2252,6 +2308,378 @@ For example: FooAction = UniTask.Action(async () =&gt; { /* */ })</p>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Action_System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool(System.Action,System.Boolean,CancellationToken)">RunOnThreadPool(Action, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask RunOnThreadPool(Action action, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>action</code></span> <span class="xref">System.Action</span></dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Action_System_Object__System_Object_System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool(System.Action{System.Object},System.Object,System.Boolean,CancellationToken)">RunOnThreadPool(Action&lt;Object&gt;, Object, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask RunOnThreadPool(Action&lt;object&gt; action, object state, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>action</code></span> <span class="xref">System.Action</span>&lt;<span class="xref">System.Object</span>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Func_Cysharp_Threading_Tasks_UniTask__System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool(System.Func{Cysharp.Threading.Tasks.UniTask},System.Boolean,CancellationToken)">RunOnThreadPool(Func&lt;UniTask&gt;, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask RunOnThreadPool(Func&lt;UniTask&gt; action, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>action</code></span> <span class="xref">System.Func</span>&lt;<a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_System_Func_System_Object_Cysharp_Threading_Tasks_UniTask__System_Object_System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool(System.Func{System.Object,Cysharp.Threading.Tasks.UniTask},System.Object,System.Boolean,CancellationToken)">RunOnThreadPool(Func&lt;Object, UniTask&gt;, Object, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask RunOnThreadPool(Func&lt;object, UniTask&gt; action, object state, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>action</code></span> <span class="xref">System.Func</span>&lt;<span class="xref">System.Object</span>, <a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a>&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask.html">UniTask</a></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func___0__System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool``1(System.Func{``0},System.Boolean,CancellationToken)">RunOnThreadPool&lt;T&gt;(Func&lt;T&gt;, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask&lt;T&gt; RunOnThreadPool&lt;T&gt;(Func&lt;T&gt; func, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>func</code></span> <span class="xref">System.Func</span>&lt;T&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_Cysharp_Threading_Tasks_UniTask___0___System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool``1(System.Func{Cysharp.Threading.Tasks.UniTask{``0}},System.Boolean,CancellationToken)">RunOnThreadPool&lt;T&gt;(Func&lt;UniTask&lt;T&gt;&gt;, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask&lt;T&gt; RunOnThreadPool&lt;T&gt;(Func&lt;UniTask&lt;T&gt;&gt; func, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>func</code></span> <span class="xref">System.Func</span>&lt;<a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_System_Object___0__System_Object_System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool``1(System.Func{System.Object,``0},System.Object,System.Boolean,CancellationToken)">RunOnThreadPool&lt;T&gt;(Func&lt;Object, T&gt;, Object, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask&lt;T&gt; RunOnThreadPool&lt;T&gt;(Func&lt;object, T&gt; func, object state, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>func</code></span> <span class="xref">System.Func</span>&lt;<span class="xref">System.Object</span>, T&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool*"></a>
<h4 id="Cysharp_Threading_Tasks_UniTask_RunOnThreadPool__1_System_Func_System_Object_Cysharp_Threading_Tasks_UniTask___0___System_Object_System_Boolean_CancellationToken_" data-uid="Cysharp.Threading.Tasks.UniTask.RunOnThreadPool``1(System.Func{System.Object,Cysharp.Threading.Tasks.UniTask{``0}},System.Object,System.Boolean,CancellationToken)">RunOnThreadPool&lt;T&gt;(Func&lt;Object, UniTask&lt;T&gt;&gt;, Object, Boolean, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Run action on the threadPool and return to main thread if configureAwait = true.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static UniTask&lt;T&gt; RunOnThreadPool&lt;T&gt;(Func&lt;object, UniTask&lt;T&gt;&gt; func, object state, bool configureAwait = true, CancellationToken cancellationToken = null)</code></pre>
</div>
<section>
<h5 class="parameters">Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>func</code></span> <span class="xref">System.Func</span>&lt;<span class="xref">System.Object</span>, <a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;&gt;</dt>
<dd></dd>
<dt><span class="parametername"><code>state</code></span> <span class="xref">System.Object</span></dt>
<dd></dd>
<dt><span class="parametername"><code>configureAwait</code></span> <span class="xref">System.Boolean</span></dt>
<dd></dd>
<dt><span class="parametername"><code>cancellationToken</code></span> <span class="xref">CancellationToken</span></dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="returns">Returns</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><a class="xref" href="Cysharp.Threading.Tasks.UniTask-1.html">UniTask</a>&lt;T&gt;</dt>
<dd></dd>
</dl>
</section>
<section>
<h5 class="typeParameters">Type Parameters</h5>
<dl class="cysharpdocfx-valuedefinition">
<dt><span class="parametername"><code>T</code></span></dt>
<dd></dd>
</dl>
</section>
</section>
<section>
<a id="Cysharp_Threading_Tasks_UniTask_SuppressCancellationThrow_" data-uid="Cysharp.Threading.Tasks.UniTask.SuppressCancellationThrow*"></a>