Deploying to gh-pages from @ e60e049 🚀

khonsulabs · Aug 18, 2024 · 2b7d294 · 2b7d294
1 parent ee310f6
commit 2b7d294
Show file tree

Hide file tree

Showing 41 changed files with 317 additions and 395 deletions.
diff --git a/main/easing_function/easings/enum.StandardEasing.html b/main/easing_function/easings/enum.StandardEasing.html
diff --git a/main/easing_function/easings/index.html b/main/easing_function/easings/index.html
diff --git a/main/easing_function/easings/struct.EaseInBack.html b/main/easing_function/easings/struct.EaseInBack.html
diff --git a/main/easing_function/easings/struct.EaseInBounce.html b/main/easing_function/easings/struct.EaseInBounce.html
diff --git a/main/easing_function/easings/struct.EaseInCircular.html b/main/easing_function/easings/struct.EaseInCircular.html
diff --git a/main/easing_function/easings/struct.EaseInCubic.html b/main/easing_function/easings/struct.EaseInCubic.html
diff --git a/main/easing_function/easings/struct.EaseInElastic.html b/main/easing_function/easings/struct.EaseInElastic.html
diff --git a/main/easing_function/easings/struct.EaseInExponential.html b/main/easing_function/easings/struct.EaseInExponential.html
diff --git a/main/easing_function/easings/struct.EaseInOutBack.html b/main/easing_function/easings/struct.EaseInOutBack.html
diff --git a/main/easing_function/easings/struct.EaseInOutBounce.html b/main/easing_function/easings/struct.EaseInOutBounce.html
diff --git a/main/easing_function/easings/struct.EaseInOutCircular.html b/main/easing_function/easings/struct.EaseInOutCircular.html
diff --git a/main/easing_function/easings/struct.EaseInOutCubic.html b/main/easing_function/easings/struct.EaseInOutCubic.html
diff --git a/main/easing_function/easings/struct.EaseInOutElastic.html b/main/easing_function/easings/struct.EaseInOutElastic.html
diff --git a/main/easing_function/easings/struct.EaseInOutExponential.html b/main/easing_function/easings/struct.EaseInOutExponential.html
diff --git a/main/easing_function/easings/struct.EaseInOutQuadradic.html b/main/easing_function/easings/struct.EaseInOutQuadradic.html
diff --git a/main/easing_function/easings/struct.EaseInOutQuartic.html b/main/easing_function/easings/struct.EaseInOutQuartic.html
diff --git a/main/easing_function/easings/struct.EaseInOutQuintic.html b/main/easing_function/easings/struct.EaseInOutQuintic.html
diff --git a/main/easing_function/easings/struct.EaseInOutSine.html b/main/easing_function/easings/struct.EaseInOutSine.html
diff --git a/main/easing_function/easings/struct.EaseInQuadradic.html b/main/easing_function/easings/struct.EaseInQuadradic.html
diff --git a/main/easing_function/easings/struct.EaseInQuartic.html b/main/easing_function/easings/struct.EaseInQuartic.html
diff --git a/main/easing_function/easings/struct.EaseInQuintic.html b/main/easing_function/easings/struct.EaseInQuintic.html
diff --git a/main/easing_function/easings/struct.EaseInSine.html b/main/easing_function/easings/struct.EaseInSine.html
diff --git a/main/easing_function/easings/struct.EaseOutBack.html b/main/easing_function/easings/struct.EaseOutBack.html
diff --git a/main/easing_function/easings/struct.EaseOutBounce.html b/main/easing_function/easings/struct.EaseOutBounce.html
diff --git a/main/easing_function/easings/struct.EaseOutCircular.html b/main/easing_function/easings/struct.EaseOutCircular.html
diff --git a/main/easing_function/easings/struct.EaseOutCubic.html b/main/easing_function/easings/struct.EaseOutCubic.html
diff --git a/main/easing_function/easings/struct.EaseOutElastic.html b/main/easing_function/easings/struct.EaseOutElastic.html
diff --git a/main/easing_function/easings/struct.EaseOutExponential.html b/main/easing_function/easings/struct.EaseOutExponential.html
diff --git a/main/easing_function/easings/struct.EaseOutQuadradic.html b/main/easing_function/easings/struct.EaseOutQuadradic.html
diff --git a/main/easing_function/easings/struct.EaseOutQuartic.html b/main/easing_function/easings/struct.EaseOutQuartic.html
diff --git a/main/easing_function/easings/struct.EaseOutQuintic.html b/main/easing_function/easings/struct.EaseOutQuintic.html
diff --git a/main/easing_function/easings/struct.EaseOutSine.html b/main/easing_function/easings/struct.EaseOutSine.html
diff --git a/main/easing_function/easings/struct.Linear.html b/main/easing_function/easings/struct.Linear.html
diff --git a/main/easing_function/easings/struct.NonStandardEasing.html b/main/easing_function/easings/struct.NonStandardEasing.html
diff --git a/main/easing_function/index.html b/main/easing_function/index.html
@@ -1 +1,37 @@
-<!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="API documentation for the Rust `easing_function` crate."><title>easing_function - 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-b25d77b18a16a9a4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="easing_function" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (feeba198f 2024-08-17)" data-channel="nightly" data-search-js="search-ef54e092fea9c776.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-cb0df477c2d67d00.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 crate"><!--[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="../easing_function/index.html">easing_<wbr>function</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">easing_function</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/easing_function/lib.rs.html#1-90">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="easings/index.html" title="mod easing_function::easings">easings</a></div><div class="desc docblock-short">Built-in <a href="trait.Easing.html" title="trait easing_function::Easing"><code>Easing</code></a> implementations.</div></li></ul><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.EasingFunction.html" title="struct easing_function::EasingFunction">Easing<wbr>Function</a></div><div class="desc docblock-short">An easing function for customizing animations.</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.Easing.html" title="trait easing_function::Easing">Easing</a></div><div class="desc docblock-short">Performs easing for value interpolation.</div></li></ul></section></div></main></body></html>
+<!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="easing-function is considered alpha crate version Documentation for `main`"><title>easing_function - 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-b25d77b18a16a9a4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="easing_function" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0-nightly (feeba198f 2024-08-17)" data-channel="nightly" data-search-js="search-ef54e092fea9c776.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-cb0df477c2d67d00.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.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 crate"><!--[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="../easing_function/index.html">easing_<wbr>function</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">easing_function</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/easing_function/lib.rs.html#1-72">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"><!-- This file is generated by `rustme`. Ensure you're editing the source in the .rustme/ directory --!>
+<!-- markdownlint-disable first-line-h1 -->
+<p><img src="https://img.shields.io/badge/status-alpha-orange" alt="easing-function is considered alpha" />
+<a href="https://crates.io/crates/easing-function"><img src="https://img.shields.io/crates/v/muse.svg" alt="crate version" /></a>
+<a href="https://khonsulabs.github.io/easing-function/main/easing_function/"><img src="https://img.shields.io/badge/docs-main-informational" alt="Documentation for main" /></a></p>
+<p>A Rusty implementation of easing functions.</p>
+<h3 id="what-is-an-easing-function"><a class="doc-anchor" href="#what-is-an-easing-function">§</a>What is an Easing Function?</h3>
+<p>An easing function is a function that describes how to apply a change of a value
+over time. This library’s easing functions expect input values between 0.0 and
+1.0 and will return values corresponding to that range but may be outside of the
+range depending on the function.</p>
+<p>Easing functions are typically used in animation systems to customize values
+produced between keyframes (tweening).</p>
+<h3 id="why-another-easing-functions-crate"><a class="doc-anchor" href="#why-another-easing-functions-crate">§</a>Why another easing functions crate?</h3>
+<p>When creating <a href="https://github.com/khonsulabs/cushy">Cushy</a>, no maintained
+library seemed to offer a trait-based solution to allow for custom easing
+functions in addition to the standard ones inspired by Robert Penner’s original
+collection.</p>
+<h3 id="using-this-crate"><a class="doc-anchor" href="#using-this-crate">§</a>Using this crate</h3>
+<p>The <a href="struct.EasingFunction.html" title="struct easing_function::EasingFunction"><code>EasingFunction</code></a> type is the central type of this crate. It allows
+defining an easing function in two ways:</p>
+<ul>
+<li><a href="struct.EasingFunction.html#method.from_fn" title="struct easing_function::EasingFunction"><code>EasingFunction::from_fn</code></a>: Creates an easing function from a <code>fn(f32) -&gt;     f32</code> function.</li>
+<li><a href="struct.EasingFunction.html#method.new" title="struct easing_function::EasingFunction"><code>EasingFunction::new</code></a>: Creates an easing function from an <a href="trait.Easing.html" title="trait easing_function::Easing"><code>Easing</code></a>
+implementor.</li>
+</ul>
+<p>This crate also provides the standard set of easing functions in the
+<a href="easings/index.html" title="mod easing_function::easings">easings</a> module (e.g., <a href="easings/struct.EaseInOutSine.html" title="struct easing_function::easings::EaseInOutSine"><code>EaseInOutSine</code></a>). Finally, the
+<a href="easings/enum.StandardEasing.html" title="enum easing_function::easings::StandardEasing"><code>StandardEasings</code></a> enum provides access to the standard easing
+functions through an enumeration. This enum also supports <code>serde</code> when enabling
+the <code>serde</code> feature of this crate.</p>
+<h3 id="open-source-licenses"><a class="doc-anchor" href="#open-source-licenses">§</a>Open-source Licenses</h3>
+<p>This project, like all projects from <a href="https://khonsulabs.com/">Khonsu Labs</a>, is open-source.
+This repository is available under the <a href="./LICENSE-MIT">MIT License</a> or the
+<a href="./LICENSE-APACHE">Apache License 2.0</a>.</p>
+<p>To learn more about contributing, please see <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
+</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="easings/index.html" title="mod easing_function::easings">easings</a></div><div class="desc docblock-short">Built-in <a href="trait.Easing.html" title="trait easing_function::Easing"><code>Easing</code></a> implementations.</div></li></ul><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.EasingFunction.html" title="struct easing_function::EasingFunction">Easing<wbr>Function</a></div><div class="desc docblock-short">An easing function for customizing animations.</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.Easing.html" title="trait easing_function::Easing">Easing</a></div><div class="desc docblock-short">Performs easing for value interpolation.</div></li></ul></section></div></main></body></html>