Skip to content

Commit

Permalink
update macos docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Liam Taylor committed Jun 14, 2024
1 parent 0043924 commit 6a8b140
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/macos_docs/crabgrab/feature/bitmap/index.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Frame to Bitmap conversion (requires `bitmap` feature)"><title>crabgrab::feature::bitmap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="crabgrab" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-e32f0c247825364d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../crabgrab/index.html">crabgrab</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">Module bitmap</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crabgrab::feature</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../crabgrab/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">crabgrab</a>::<wbr><a href="../index.html">feature</a>::<wbr><a class="mod" href="#">bitmap</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/crabgrab/feature/bitmap/mod.rs.html#1-731">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Frame to Bitmap conversion
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Frame to Bitmap conversion (requires `bitmap` feature)"><title>crabgrab::feature::bitmap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="crabgrab" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-e32f0c247825364d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../crabgrab/index.html">crabgrab</a><span class="version">0.4.0</span></h2></div><h2 class="location"><a href="#">Module bitmap</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crabgrab::feature</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../crabgrab/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">crabgrab</a>::<wbr><a href="../index.html">feature</a>::<wbr><a class="mod" href="#">bitmap</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/crabgrab/feature/bitmap/mod.rs.html#1-733">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Frame to Bitmap conversion
(requires <code>bitmap</code> feature)</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.FrameBitmapArgbUnormPacked2101010.html" title="struct crabgrab::feature::bitmap::FrameBitmapArgbUnormPacked2101010">FrameBitmapArgbUnormPacked2101010</a></div><div class="desc docblock-short">A Rgba1010102 format bitmap</div></li><li><div class="item-name"><a class="struct" href="struct.FrameBitmapBgraUnorm8x4.html" title="struct crabgrab::feature::bitmap::FrameBitmapBgraUnorm8x4">FrameBitmapBgraUnorm8x4</a></div><div class="desc docblock-short">A Bgra8888 format bitmap</div></li><li><div class="item-name"><a class="struct" href="struct.FrameBitmapPool.html" title="struct crabgrab::feature::bitmap::FrameBitmapPool">FrameBitmapPool</a></div><div class="desc docblock-short">A pool of frame bitmaps</div></li><li><div class="item-name"><a class="struct" href="struct.FrameBitmapRgbaF16x4.html" title="struct crabgrab::feature::bitmap::FrameBitmapRgbaF16x4">FrameBitmapRgbaF16x4</a></div><div class="desc docblock-short">A RgbaF16x4 format bitmap</div></li><li><div class="item-name"><a class="struct" href="struct.FrameBitmapYCbCr.html" title="struct crabgrab::feature::bitmap::FrameBitmapYCbCr">FrameBitmapYCbCr</a></div><div class="desc docblock-short">A YCbCr image, corresponding to either V420 or F420 pixel formats.</div></li><li><div class="item-name"><a class="struct" href="struct.PooledBitmap.html" title="struct crabgrab::feature::bitmap::PooledBitmap">PooledBitmap</a></div><div class="desc docblock-short">A pooled bitmap, belinging to it’s creator BitmapPool. When this bitmap is dropped, it will be returned to it’s pool.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.FrameBitmap.html" title="enum crabgrab::feature::bitmap::FrameBitmap">FrameBitmap</a></div><div class="desc docblock-short">A bitmap image of the selected format</div></li><li><div class="item-name"><a class="enum" href="enum.VideoFrameBitmapError.html" title="enum crabgrab::feature::bitmap::VideoFrameBitmapError">VideoFrameBitmapError</a></div><div class="desc docblock-short">Represents an error while generating a frame bitmap</div></li><li><div class="item-name"><a class="enum" href="enum.VideoRange.html" title="enum crabgrab::feature::bitmap::VideoRange">VideoRange</a></div><div class="desc docblock-short">The video range for a YCbCr format bitmap</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.BitmapDataArgbUnormPacked2101010.html" title="trait crabgrab::feature::bitmap::BitmapDataArgbUnormPacked2101010">BitmapDataArgbUnormPacked2101010</a></div><div class="desc docblock-short">Bitmap data in the Argb2101010 format</div></li><li><div class="item-name"><a class="trait" href="trait.BitmapDataBgra8x4.html" title="trait crabgrab::feature::bitmap::BitmapDataBgra8x4">BitmapDataBgra8x4</a></div><div class="desc docblock-short">Bitmap data in the Bgra8888 format</div></li><li><div class="item-name"><a class="trait" href="trait.BitmapDataChroma.html" title="trait crabgrab::feature::bitmap::BitmapDataChroma">BitmapDataChroma</a></div><div class="desc docblock-short">Bitmap data in the CbCr Chroma/u8x2 format</div></li><li><div class="item-name"><a class="trait" href="trait.BitmapDataLuma.html" title="trait crabgrab::feature::bitmap::BitmapDataLuma">BitmapDataLuma</a></div><div class="desc docblock-short">Bitmap data in the Luma/u8 format</div></li><li><div class="item-name"><a class="trait" href="trait.BitmapDataRgbaF16x4.html" title="trait crabgrab::feature::bitmap::BitmapDataRgbaF16x4">BitmapDataRgbaF16x4</a></div><div class="desc docblock-short">Bitmap data in the RgbaF16x4 format</div></li><li><div class="item-name"><a class="trait" href="trait.VideoFrameBitmap.html" title="trait crabgrab::feature::bitmap::VideoFrameBitmap">VideoFrameBitmap</a></div><div class="desc docblock-short">A video frame which can produce a bitmap</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxedSliceFrameBitmap.html" title="type crabgrab::feature::bitmap::BoxedSliceFrameBitmap">BoxedSliceFrameBitmap</a></div><div class="desc docblock-short">A Bitmap with boxed-slice image data</div></li><li><div class="item-name"><a class="type" href="type.PooledFrameBitmap.html" title="type crabgrab::feature::bitmap::PooledFrameBitmap">PooledFrameBitmap</a></div><div class="desc docblock-short">A bitmap with booled images as bitmap data</div></li></ul></section></div></main></body></html>
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@
&amp;self,
bitmap_pool: &amp;<a class="struct" href="struct.FrameBitmapPool.html" title="struct crabgrab::feature::bitmap::FrameBitmapPool">FrameBitmapPool</a>
) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.79.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="type" href="type.PooledFrameBitmap.html" title="type crabgrab::feature::bitmap::PooledFrameBitmap">PooledFrameBitmap</a>, <a class="enum" href="enum.VideoFrameBitmapError.html" title="enum crabgrab::feature::bitmap::VideoFrameBitmapError">VideoFrameBitmapError</a>&gt;</h4></section></summary><div class="docblock"><p>Get a pooled bitmap, waiting for one to become available if <code>max</code> pooled bitmaps are checked out</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-VideoFrameBitmap-for-VideoFrame" class="impl"><a class="src rightside" href="../../../src/crabgrab/feature/bitmap/mod.rs.html#560-731">source</a><a href="#impl-VideoFrameBitmap-for-VideoFrame" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.VideoFrameBitmap.html" title="trait crabgrab::feature::bitmap::VideoFrameBitmap">VideoFrameBitmap</a> for <a class="struct" href="../../frame/struct.VideoFrame.html" title="struct crabgrab::frame::VideoFrame">VideoFrame</a></h3></section></div><script src="../../../trait.impl/crabgrab/feature/bitmap/trait.VideoFrameBitmap.js" async></script></section></div></main></body></html>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-VideoFrameBitmap-for-VideoFrame" class="impl"><a class="src rightside" href="../../../src/crabgrab/feature/bitmap/mod.rs.html#562-733">source</a><a href="#impl-VideoFrameBitmap-for-VideoFrame" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.VideoFrameBitmap.html" title="trait crabgrab::feature::bitmap::VideoFrameBitmap">VideoFrameBitmap</a> for <a class="struct" href="../../frame/struct.VideoFrame.html" title="struct crabgrab::frame::VideoFrame">VideoFrame</a></h3></section></div><script src="../../../trait.impl/crabgrab/feature/bitmap/trait.VideoFrameBitmap.js" async></script></section></div></main></body></html>
Loading

0 comments on commit 6a8b140

Please sign in to comment.