This repository has been archived on 2022-04-04. You can view files and clone it, but cannot push or open issues or pull requests.

29 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `core` mod in crate `raylib`."><meta name="keywords" content="rust, rustlang, rust-lang, core"><title>raylib::core - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><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="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../../raylib/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
</a><h2 class="location">Module core</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="core" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../raylib/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><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><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">raylib</a>::<wbr><a class="mod" href="#">core</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/raylib/core/mod.rs.html#1-213" title="goto source code">[src]</a></span></h1><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="audio/index.html" title="raylib::core::audio mod">audio</a></div><div class="item-right docblock-short"><p>Contains code related to audio. <a href="audio/struct.RaylibAudio.html" title="RaylibAudio"><code>RaylibAudio</code></a> plays sounds and music.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="camera/index.html" title="raylib::core::camera mod">camera</a></div><div class="item-right docblock-short"><p>Utility code for using Raylib <a href="camera/struct.Camera3D.html" title="Camera3D"><code>Camera3D</code></a> and <a href="camera/struct.Camera2D.html" title="Camera2D"><code>Camera2D</code></a></p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="collision/index.html" title="raylib::core::collision mod">collision</a></div><div class="item-right docblock-short"><p>Common collision handling code</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="color/index.html" title="raylib::core::color mod">color</a></div><div class="item-right docblock-short"><p><a href="color/struct.Color.html" title="Color"><code>Color</code></a> manipulation helpers</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="data/index.html" title="raylib::core::data mod">data</a></div><div class="item-right docblock-short"><p>Data manipulation functions. Compress and Decompress with DEFLATE</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="drawing/index.html" title="raylib::core::drawing mod">drawing</a></div><div class="item-right docblock-short"><p>Contains code related to drawing. Types that can be set as a surface to draw will implement the <a href="drawing/trait.RaylibDraw.html" title="RaylibDraw"><code>RaylibDraw</code></a> trait</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="file/index.html" title="raylib::core::file mod">file</a></div><div class="item-right docblock-short"><p>File manipulation functions. Should be parity with std::fs except on emscripten</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="input/index.html" title="raylib::core::input mod">input</a></div><div class="item-right docblock-short"><p>Keyboard, Controller, and Mouse related functions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="logging/index.html" title="raylib::core::logging mod">logging</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="math/index.html" title="raylib::core::math mod">math</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="misc/index.html" title="raylib::core::misc mod">misc</a></div><div class="item-right docblock-short"><p>Useful functions that dont fit anywhere else</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="models/index.html" title="raylib::core::models mod">models</a></div><div class="item-right docblock-short"><p>3D Model, Mesh, and Animation</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="shaders/index.html" title="raylib::core::shaders mod">shaders</a></div><div class="item-right docblock-short"><p>Code for the safe manipulation of shaders</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="text/index.html" title="raylib::core::text mod">text</a></div><div class="item-right docblock-short"><p>Text and Font related functions
Text manipulation functions are super unsafe so use rust String functions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="texture/index.html" title="raylib::core::texture mod">texture</a></div><div class="item-right docblock-short"><p>Image and texture related functions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="vr/index.html" title="raylib::core::vr mod">vr</a></div><div class="item-right docblock-short"><p>Vr related functions</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="window/index.html" title="raylib::core::window mod">window</a></div><div class="item-right docblock-short"><p>Window manipulation functions</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RaylibBuilder.html" title="raylib::core::RaylibBuilder struct">RaylibBuilder</a></div><div class="item-right docblock-short"><p>A builder that allows more customization of the game window shown to the user before the <code>RaylibHandle</code> is created.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RaylibHandle.html" title="raylib::core::RaylibHandle struct">RaylibHandle</a></div><div class="item-right docblock-short"><p>The main interface into the Raylib API.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RaylibThread.html" title="raylib::core::RaylibThread struct">RaylibThread</a></div><div class="item-right docblock-short"><p>This token is used to ensure certain functions are only running on the same
thread raylib was initialized from. This is useful for architectures like macos
where cocoa can only be called from one thread.</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.init.html" title="raylib::core::init fn">init</a></div><div class="item-right docblock-short"><p>Creates a <code>RaylibBuilder</code> for choosing window options before initialization.</p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="raylib" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
</body></html>