mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
67 lines
16 KiB
HTML
67 lines
16 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="API documentation for the Rust `sdl2` crate."><meta name="keywords" content="rust, rustlang, rust-lang, sdl2"><title>sdl2 - Rust</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 mod"><!--[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='../sdl2/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate sdl2</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all sdl2's items</p></a><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'sdl2', ty: 'mod', relpath: '../'};</script></div></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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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"><h1 class='fqn'><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'>−</span>]</a></span><a class='srclink' href='../src/sdl2/lib.rs.html#1-107' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>sdl2</a></span></h1><div class='docblock'><h1 id="getting-started" class="section-header"><a href="#getting-started">Getting started</a></h1>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">sdl2</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">sdl2</span>::<span class="ident">pixels</span>::<span class="ident">Color</span>;
|
||
<span class="kw">use</span> <span class="ident">sdl2</span>::<span class="ident">event</span>::<span class="ident">Event</span>;
|
||
<span class="kw">use</span> <span class="ident">sdl2</span>::<span class="ident">keyboard</span>::<span class="ident">Keycode</span>;
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">time</span>::<span class="ident">Duration</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="kw">let</span> <span class="ident">sdl_context</span> <span class="op">=</span> <span class="ident">sdl2</span>::<span class="ident">init</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="ident">video_subsystem</span> <span class="op">=</span> <span class="ident">sdl_context</span>.<span class="ident">video</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">window</span> <span class="op">=</span> <span class="ident">video_subsystem</span>.<span class="ident">window</span>(<span class="string">"rust-sdl2 demo"</span>, <span class="number">800</span>, <span class="number">600</span>)
|
||
.<span class="ident">position_centered</span>()
|
||
.<span class="ident">build</span>()
|
||
.<span class="ident">unwrap</span>();
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">canvas</span> <span class="op">=</span> <span class="ident">window</span>.<span class="ident">into_canvas</span>().<span class="ident">build</span>().<span class="ident">unwrap</span>();
|
||
|
||
<span class="ident">canvas</span>.<span class="ident">set_draw_color</span>(<span class="ident">Color</span>::<span class="ident">RGB</span>(<span class="number">0</span>, <span class="number">255</span>, <span class="number">255</span>));
|
||
<span class="ident">canvas</span>.<span class="ident">clear</span>();
|
||
<span class="ident">canvas</span>.<span class="ident">present</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">event_pump</span> <span class="op">=</span> <span class="ident">sdl_context</span>.<span class="ident">event_pump</span>().<span class="ident">unwrap</span>();
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">i</span> <span class="op">=</span> <span class="number">0</span>;
|
||
<span class="lifetime">'running</span>: <span class="kw">loop</span> {
|
||
<span class="ident">i</span> <span class="op">=</span> (<span class="ident">i</span> <span class="op">+</span> <span class="number">1</span>) <span class="op">%</span> <span class="number">255</span>;
|
||
<span class="ident">canvas</span>.<span class="ident">set_draw_color</span>(<span class="ident">Color</span>::<span class="ident">RGB</span>(<span class="ident">i</span>, <span class="number">64</span>, <span class="number">255</span> <span class="op">-</span> <span class="ident">i</span>));
|
||
<span class="ident">canvas</span>.<span class="ident">clear</span>();
|
||
<span class="kw">for</span> <span class="ident">event</span> <span class="kw">in</span> <span class="ident">event_pump</span>.<span class="ident">poll_iter</span>() {
|
||
<span class="kw">match</span> <span class="ident">event</span> {
|
||
<span class="ident">Event</span>::<span class="ident">Quit</span> {..} <span class="op">|</span>
|
||
<span class="ident">Event</span>::<span class="ident">KeyDown</span> { <span class="ident">keycode</span>: <span class="prelude-val">Some</span>(<span class="ident">Keycode</span>::<span class="ident">Escape</span>), .. } <span class="op">=</span><span class="op">></span> {
|
||
<span class="kw">break</span> <span class="lifetime">'running</span>
|
||
},
|
||
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> {}
|
||
}
|
||
}
|
||
<span class="comment">// The rest of the game loop goes here...</span>
|
||
|
||
<span class="ident">canvas</span>.<span class="ident">present</span>();
|
||
::<span class="ident">std</span>::<span class="ident">thread</span>::<span class="ident">sleep</span>(<span class="ident">Duration</span>::<span class="ident">new</span>(<span class="number">0</span>, <span class="number">1_000_000_000u32</span> <span class="op">/</span> <span class="number">60</span>));
|
||
}
|
||
}</pre></div>
|
||
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
|
||
<table><tr><td><code>pub extern crate <a class="mod" href="../libc/index.html" title="mod libc">libc</a>;</code></td></tr><tr><td><code>pub extern crate <a class="mod" href="../sdl2_sys/index.html" title="mod sdl2_sys">sdl2_sys</a> as sys;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
||
<table><tr class='module-item'><td><a class="mod" href="audio/index.html" title='sdl2::audio mod'>audio</a></td><td class='docblock-short'><p>Audio Functions</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="clipboard/index.html" title='sdl2::clipboard mod'>clipboard</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="controller/index.html" title='sdl2::controller mod'>controller</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="cpuinfo/index.html" title='sdl2::cpuinfo mod'>cpuinfo</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="event/index.html" title='sdl2::event mod'>event</a></td><td class='docblock-short'><p>Event Handling</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="filesystem/index.html" title='sdl2::filesystem mod'>filesystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="gfx/index.html" title='sdl2::gfx mod'>gfx</a></td><td class='docblock-short'><p>A binding for the library <code>SDL2_gfx</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="haptic/index.html" title='sdl2::haptic mod'>haptic</a></td><td class='docblock-short'><p>Haptic Functions</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="hint/index.html" title='sdl2::hint mod'>hint</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="image/index.html" title='sdl2::image mod'>image</a></td><td class='docblock-short'><p>A binding for the library <code>SDL2_image</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="joystick/index.html" title='sdl2::joystick mod'>joystick</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="keyboard/index.html" title='sdl2::keyboard mod'>keyboard</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="log/index.html" title='sdl2::log mod'>log</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="messagebox/index.html" title='sdl2::messagebox mod'>messagebox</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="mixer/index.html" title='sdl2::mixer mod'>mixer</a></td><td class='docblock-short'><p>A binding for the library <code>SDL2_mixer</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="mouse/index.html" title='sdl2::mouse mod'>mouse</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="pixels/index.html" title='sdl2::pixels mod'>pixels</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="rect/index.html" title='sdl2::rect mod'>rect</a></td><td class='docblock-short'><p>Rectangles and points.</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="render/index.html" title='sdl2::render mod'>render</a></td><td class='docblock-short'><p>2D accelerated rendering</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="rwops/index.html" title='sdl2::rwops mod'>rwops</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="surface/index.html" title='sdl2::surface mod'>surface</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="timer/index.html" title='sdl2::timer mod'>timer</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="touch/index.html" title='sdl2::touch mod'>touch</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="mod" href="ttf/index.html" title='sdl2::ttf mod'>ttf</a></td><td class='docblock-short'><p>A binding for the library <code>SDL2_ttf</code></p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="version/index.html" title='sdl2::version mod'>version</a></td><td class='docblock-short'><p>Querying SDL Version</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="video/index.html" title='sdl2::video mod'>video</a></td><td class='docblock-short'></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.AudioSubsystem.html" title='sdl2::AudioSubsystem struct'>AudioSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.EventPump.html" title='sdl2::EventPump struct'>EventPump</a></td><td class='docblock-short'><p>A thread-safe type that encapsulates SDL event-pumping functions.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.EventSubsystem.html" title='sdl2::EventSubsystem struct'>EventSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.GameControllerSubsystem.html" title='sdl2::GameControllerSubsystem struct'>GameControllerSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.HapticSubsystem.html" title='sdl2::HapticSubsystem struct'>HapticSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.JoystickSubsystem.html" title='sdl2::JoystickSubsystem struct'>JoystickSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Sdl.html" title='sdl2::Sdl struct'>Sdl</a></td><td class='docblock-short'><p>The SDL context type. Initialize with <code>sdl2::init()</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.TimerSubsystem.html" title='sdl2::TimerSubsystem struct'>TimerSubsystem</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.VideoSubsystem.html" title='sdl2::VideoSubsystem struct'>VideoSubsystem</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.Error.html" title='sdl2::Error enum'>Error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.IntegerOrSdlError.html" title='sdl2::IntegerOrSdlError enum'>IntegerOrSdlError</a></td><td class='docblock-short'><p>A given integer was so big that its representation as a C integer would be
|
||
negative.</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.clear_error.html" title='sdl2::clear_error fn'>clear_error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_error.html" title='sdl2::get_error fn'>get_error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.get_platform.html" title='sdl2::get_platform fn'>get_platform</a></td><td class='docblock-short'><p>Get platform name</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.init.html" title='sdl2::init fn'>init</a></td><td class='docblock-short'><p>Initializes the SDL library.
|
||
This must be called before using any other SDL function.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.set_error.html" title='sdl2::set_error fn'>set_error</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.set_error_from_code.html" title='sdl2::set_error_from_code fn'>set_error_from_code</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "sdl2";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |