221 lines
14 KiB
HTML
221 lines
14 KiB
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="Source to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/cgmath-0.17.0/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../cgmath/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10"> 10</span>
|
||
<span id="11"> 11</span>
|
||
<span id="12"> 12</span>
|
||
<span id="13"> 13</span>
|
||
<span id="14"> 14</span>
|
||
<span id="15"> 15</span>
|
||
<span id="16"> 16</span>
|
||
<span id="17"> 17</span>
|
||
<span id="18"> 18</span>
|
||
<span id="19"> 19</span>
|
||
<span id="20"> 20</span>
|
||
<span id="21"> 21</span>
|
||
<span id="22"> 22</span>
|
||
<span id="23"> 23</span>
|
||
<span id="24"> 24</span>
|
||
<span id="25"> 25</span>
|
||
<span id="26"> 26</span>
|
||
<span id="27"> 27</span>
|
||
<span id="28"> 28</span>
|
||
<span id="29"> 29</span>
|
||
<span id="30"> 30</span>
|
||
<span id="31"> 31</span>
|
||
<span id="32"> 32</span>
|
||
<span id="33"> 33</span>
|
||
<span id="34"> 34</span>
|
||
<span id="35"> 35</span>
|
||
<span id="36"> 36</span>
|
||
<span id="37"> 37</span>
|
||
<span id="38"> 38</span>
|
||
<span id="39"> 39</span>
|
||
<span id="40"> 40</span>
|
||
<span id="41"> 41</span>
|
||
<span id="42"> 42</span>
|
||
<span id="43"> 43</span>
|
||
<span id="44"> 44</span>
|
||
<span id="45"> 45</span>
|
||
<span id="46"> 46</span>
|
||
<span id="47"> 47</span>
|
||
<span id="48"> 48</span>
|
||
<span id="49"> 49</span>
|
||
<span id="50"> 50</span>
|
||
<span id="51"> 51</span>
|
||
<span id="52"> 52</span>
|
||
<span id="53"> 53</span>
|
||
<span id="54"> 54</span>
|
||
<span id="55"> 55</span>
|
||
<span id="56"> 56</span>
|
||
<span id="57"> 57</span>
|
||
<span id="58"> 58</span>
|
||
<span id="59"> 59</span>
|
||
<span id="60"> 60</span>
|
||
<span id="61"> 61</span>
|
||
<span id="62"> 62</span>
|
||
<span id="63"> 63</span>
|
||
<span id="64"> 64</span>
|
||
<span id="65"> 65</span>
|
||
<span id="66"> 66</span>
|
||
<span id="67"> 67</span>
|
||
<span id="68"> 68</span>
|
||
<span id="69"> 69</span>
|
||
<span id="70"> 70</span>
|
||
<span id="71"> 71</span>
|
||
<span id="72"> 72</span>
|
||
<span id="73"> 73</span>
|
||
<span id="74"> 74</span>
|
||
<span id="75"> 75</span>
|
||
<span id="76"> 76</span>
|
||
<span id="77"> 77</span>
|
||
<span id="78"> 78</span>
|
||
<span id="79"> 79</span>
|
||
<span id="80"> 80</span>
|
||
<span id="81"> 81</span>
|
||
<span id="82"> 82</span>
|
||
<span id="83"> 83</span>
|
||
<span id="84"> 84</span>
|
||
<span id="85"> 85</span>
|
||
<span id="86"> 86</span>
|
||
<span id="87"> 87</span>
|
||
<span id="88"> 88</span>
|
||
<span id="89"> 89</span>
|
||
<span id="90"> 90</span>
|
||
<span id="91"> 91</span>
|
||
<span id="92"> 92</span>
|
||
<span id="93"> 93</span>
|
||
<span id="94"> 94</span>
|
||
<span id="95"> 95</span>
|
||
<span id="96"> 96</span>
|
||
<span id="97"> 97</span>
|
||
<span id="98"> 98</span>
|
||
<span id="99"> 99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
<span id="104">104</span>
|
||
<span id="105">105</span>
|
||
<span id="106">106</span>
|
||
<span id="107">107</span>
|
||
<span id="108">108</span>
|
||
<span id="109">109</span>
|
||
</pre><div class="example-wrap"><pre class="rust ">
|
||
<span class="comment">// Copyright 2013-2014 The CGMath Developers. For a full listing of the authors,</span>
|
||
<span class="comment">// refer to the Cargo.toml file at the top-level directory of this distribution.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||
<span class="comment">// you may not use this file except in compliance with the License.</span>
|
||
<span class="comment">// You may obtain a copy of the License at</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// Unless required by applicable law or agreed to in writing, software</span>
|
||
<span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span>
|
||
<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
||
<span class="comment">// See the License for the specific language governing permissions and</span>
|
||
<span class="comment">// limitations under the License.</span>
|
||
|
||
<span class="doccomment">//! A low-dimensional linear algebra library, targeted at computer graphics.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! # Trait overview</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! In order to make a clean, composable API, we divide operations into traits</span>
|
||
<span class="doccomment">//! that are roughly based on mathematical properties. The main ones that we</span>
|
||
<span class="doccomment">//! concern ourselves with are listed below:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! - `VectorSpace`: Specifies the main operators for vectors, quaternions, and</span>
|
||
<span class="doccomment">//! matrices.</span>
|
||
<span class="doccomment">//! - `MetricSpace`: For types that have a distance function implemented.</span>
|
||
<span class="doccomment">//! - `InnerSpace`: For types that have a dot (or inner) product - ie. vectors or</span>
|
||
<span class="doccomment">//! quaternions. This also allows for the definition of operations that are</span>
|
||
<span class="doccomment">//! based on the dot product, like finding the magnitude or normalizing.</span>
|
||
<span class="doccomment">//! - `EuclideanSpace`: Points in euclidean space, with an associated space of</span>
|
||
<span class="doccomment">//! displacement vectors.</span>
|
||
<span class="doccomment">//! - `Matrix`: Common operations for matrices of arbitrary dimensions.</span>
|
||
<span class="doccomment">//! - `SquareMatrix`: A special trait for matrices where the number of columns</span>
|
||
<span class="doccomment">//! equal the number of rows.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! Other traits are included for practical convenience, for example:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! - `Array`: For contiguous, indexable arrays of elements, specifically</span>
|
||
<span class="doccomment">//! vectors.</span>
|
||
<span class="doccomment">//! - `ElementWise`: For element-wise addition, subtraction, multiplication,</span>
|
||
<span class="doccomment">//! division, and remainder operations.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! # The prelude</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! Importing each trait individually can become a chore, so we provide a</span>
|
||
<span class="doccomment">//! `prelude` module to allow you to import the main trait all at once. For</span>
|
||
<span class="doccomment">//! example:</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ```rust</span>
|
||
<span class="doccomment">//! use cgmath::prelude::*;</span>
|
||
<span class="doccomment">//! ```</span>
|
||
|
||
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"simd"</span>, <span class="ident">feature</span>(<span class="ident">specialization</span>))]</span>
|
||
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">approx</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"mint"</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">mint</span>;
|
||
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rand</span>;
|
||
<span class="kw">pub</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">num_traits</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"serde"</span>)]</span>
|
||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">serde</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"simd"</span>)]</span>
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">simd</span>;
|
||
|
||
<span class="comment">// Re-exports</span>
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">approx</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">num</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">structure</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">matrix</span>::{<span class="ident">Matrix2</span>, <span class="ident">Matrix3</span>, <span class="ident">Matrix4</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">quaternion</span>::<span class="ident">Quaternion</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">vector</span>::{<span class="ident">dot</span>, <span class="ident">Vector1</span>, <span class="ident">Vector2</span>, <span class="ident">Vector3</span>, <span class="ident">Vector4</span>, <span class="ident">vec1</span>, <span class="ident">vec2</span>, <span class="ident">vec3</span>, <span class="ident">vec4</span>};
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">angle</span>::{<span class="ident">Deg</span>, <span class="ident">Rad</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">euler</span>::<span class="ident">Euler</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">point</span>::{<span class="ident">Point1</span>, <span class="ident">Point2</span>, <span class="ident">Point3</span>};
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">rotation</span>::<span class="kw-2">*</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">transform</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">projection</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="comment">// Modules</span>
|
||
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">conv</span>;
|
||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">prelude</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">macros</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">num</span>;
|
||
<span class="kw">mod</span> <span class="ident">structure</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">matrix</span>;
|
||
<span class="kw">mod</span> <span class="ident">quaternion</span>;
|
||
<span class="kw">mod</span> <span class="ident">vector</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">angle</span>;
|
||
<span class="kw">mod</span> <span class="ident">euler</span>;
|
||
<span class="kw">mod</span> <span class="ident">point</span>;
|
||
<span class="kw">mod</span> <span class="ident">rotation</span>;
|
||
<span class="kw">mod</span> <span class="ident">transform</span>;
|
||
|
||
<span class="kw">mod</span> <span class="ident">projection</span>;
|
||
</pre></div>
|
||
</section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "cgmath";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html> |