Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

Commit

Permalink
update macos docs
Browse files Browse the repository at this point in the history
  • Loading branch information
liam committed Apr 18, 2024
1 parent 9207fbd commit 0712a97
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 34 deletions.
2 changes: 1 addition & 1 deletion docs/macos_docs/crabgrab/capture_stream/struct.CaptureConfig.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/macos_docs/crabgrab/capture_stream/struct.CaptureStream.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
callback: impl <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="enum" href="https://doc.rust-lang.org/1.75.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="enum" href="enum.StreamEvent.html" title="enum crabgrab::capture_stream::StreamEvent">StreamEvent</a>, <a class="enum" href="enum.StreamError.html" title="enum crabgrab::capture_stream::StreamError">StreamError</a>&gt;) + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.75.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="enum" href="enum.StreamCreateError.html" title="enum crabgrab::capture_stream::StreamCreateError">StreamCreateError</a>&gt;</h4></section></summary><div class="docblock"><p>Start a new capture stream with the given stream callback</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.stop" class="method"><a class="src rightside" href="../../src/crabgrab/capture_stream.rs.html#333-335">source</a><h4 class="code-header">pub fn <a href="#method.stop" class="fn">stop</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.75.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.75.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.StreamStopError.html" title="enum crabgrab::capture_stream::StreamStopError">StreamStopError</a>&gt;</h4></section></summary><div class="docblock"><p>Stop the capture</p>
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-MetalCaptureStreamExt-for-CaptureStream" class="impl"><a class="src rightside" href="../../src/crabgrab/feature/metal/mod.rs.html#158-162">source</a><a href="#impl-MetalCaptureStreamExt-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../feature/metal/trait.MetalCaptureStreamExt.html" title="trait crabgrab::feature::metal::MetalCaptureStreamExt">MetalCaptureStreamExt</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get_metal_device" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/metal/mod.rs.html#159-161">source</a><a href="#method.get_metal_device" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/metal/trait.MetalCaptureStreamExt.html#tymethod.get_metal_device" class="fn">get_metal_device</a>(&amp;self) -&gt; Device</h4></section></summary><div class='docblock'>Get the metal device used for frame capture</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-WgpuCaptureStreamExt-for-CaptureStream" class="impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#303-313">source</a><a href="#impl-WgpuCaptureStreamExt-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../feature/wgpu/trait.WgpuCaptureStreamExt.html" title="trait crabgrab::feature::wgpu::WgpuCaptureStreamExt">WgpuCaptureStreamExt</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get_wgpu_device" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#304-307">source</a><a href="#method.get_wgpu_device" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/wgpu/trait.WgpuCaptureStreamExt.html#tymethod.get_wgpu_device" class="fn">get_wgpu_device</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.75.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Device&gt;</h4></section></summary><div class='docblock'>Gets the Wgpu device referenced by device wrapper supplied to <code>CaptureConfig::with_wgpu_device(..)</code></div></details><details class="toggle method-toggle" open><summary><section id="method.get_wgpu_device_wrapper" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#309-312">source</a><a href="#method.get_wgpu_device_wrapper" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/wgpu/trait.WgpuCaptureStreamExt.html#tymethod.get_wgpu_device_wrapper" class="fn">get_wgpu_device_wrapper</a>(
</div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-MetalCaptureStreamExt-for-CaptureStream" class="impl"><a class="src rightside" href="../../src/crabgrab/feature/metal/mod.rs.html#158-162">source</a><a href="#impl-MetalCaptureStreamExt-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../feature/metal/trait.MetalCaptureStreamExt.html" title="trait crabgrab::feature::metal::MetalCaptureStreamExt">MetalCaptureStreamExt</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get_metal_device" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/metal/mod.rs.html#159-161">source</a><a href="#method.get_metal_device" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/metal/trait.MetalCaptureStreamExt.html#tymethod.get_metal_device" class="fn">get_metal_device</a>(&amp;self) -&gt; Device</h4></section></summary><div class='docblock'>Get the metal device used for frame capture</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-WgpuCaptureStreamExt-for-CaptureStream" class="impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#304-318">source</a><a href="#impl-WgpuCaptureStreamExt-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="../feature/wgpu/trait.WgpuCaptureStreamExt.html" title="trait crabgrab::feature::wgpu::WgpuCaptureStreamExt">WgpuCaptureStreamExt</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.get_wgpu_device" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#305-310">source</a><a href="#method.get_wgpu_device" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/wgpu/trait.WgpuCaptureStreamExt.html#tymethod.get_wgpu_device" class="fn">get_wgpu_device</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.75.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;Device&gt;</h4></section></summary><div class='docblock'>Gets the Wgpu device referenced by device wrapper supplied to <code>CaptureConfig::with_wgpu_device(..)</code></div></details><details class="toggle method-toggle" open><summary><section id="method.get_wgpu_device_wrapper" class="method trait-impl"><a class="src rightside" href="../../src/crabgrab/feature/wgpu/mod.rs.html#312-317">source</a><a href="#method.get_wgpu_device_wrapper" class="anchor">§</a><h4 class="code-header">fn <a href="../feature/wgpu/trait.WgpuCaptureStreamExt.html#tymethod.get_wgpu_device_wrapper" class="fn">get_wgpu_device_wrapper</a>(
&amp;self
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.75.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="https://doc.rust-lang.org/1.75.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;dyn <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a>&lt;Device&gt; + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static&gt;&gt;</h4></section></summary><div class='docblock'>Gets the Wgpu device wrapper supplied to <code>CaptureConfig::with_wgpu_device(..)</code></div></details></div></details><section id="impl-Send-for-CaptureStream" class="impl"><a class="src rightside" href="../../src/crabgrab/capture_stream.rs.html#284">source</a><a href="#impl-Send-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-CaptureStream" class="impl"><a href="#impl-RefUnwindSafe-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.75.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section><section id="impl-Sync-for-CaptureStream" class="impl"><a href="#impl-Sync-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section><section id="impl-Unpin-for-CaptureStream" class="impl"><a href="#impl-Unpin-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section><section id="impl-UnwindSafe-for-CaptureStream" class="impl"><a href="#impl-UnwindSafe-for-CaptureStream" class="anchor">§</a><h3 class="code-header">impl !<a class="trait" href="https://doc.rust-lang.org/1.75.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.CaptureStream.html" title="struct crabgrab::capture_stream::CaptureStream">CaptureStream</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.75.0/src/core/any.rs.html#135">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.75.0/src/core/any.rs.html#136">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.75.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.75.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.75.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.75.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<span class="where fmt-newline">where
Expand Down
Loading

0 comments on commit 0712a97

Please sign in to comment.