mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
20 lines
14 KiB
HTML
20 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="API documentation for the Rust `Context` struct in crate `glutin`."><meta name="keywords" content="rust, rustlang, rust-lang, Context"><title>glutin::Context - 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></head><body class="rustdoc struct"><!--[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><p class='location'>Struct Context</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-GlContextExt">GlContextExt</a><a href="#impl-GlContext">GlContext</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>glutin</a></p><script>window.sidebarCurrent = {name: 'Context', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></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 js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><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='in-band'>Struct <a href='index.html'>glutin</a>::<wbr><a class="struct" href=''>Context</a></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'>−</span>]</a></span><a class='srclink' href='../src/glutin/lib.rs.html#163-165' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Context { /* fields omitted */ }</pre></div><div class='docblock'><p>Represents an OpenGL context.</p>
|
||
<p>A <code>Context</code> is normally associated with a single Window, however <code>Context</code>s can be <em>shared</em>
|
||
between multiple windows.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">context</span> <span class="op">=</span> <span class="ident">glutin</span>::<span class="ident">ContextBuilder</span>::<span class="ident">new</span>()
|
||
.<span class="ident">with_vsync</span>(<span class="bool-val">true</span>)
|
||
.<span class="ident">with_multisampling</span>(<span class="number">8</span>)
|
||
.<span class="ident">with_shared_lists</span>(<span class="ident">some_gl_window</span>.<span class="ident">context</span>());</pre>
|
||
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-GlContextExt' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../glutin/os/trait.GlContextExt.html" title="trait glutin::os::GlContextExt">GlContextExt</a> for <a class="struct" href="../glutin/struct.Context.html" title="struct glutin::Context">Context</a></code><a href='#impl-GlContextExt' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/os/unix.rs.html#19-26' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Handle' class="type"><span id='Handle.t' class='invisible'><code>type <a href='../glutin/os/trait.GlContextExt.html#associatedtype.Handle' class="type">Handle</a> = <a class="enum" href="../glutin/os/unix/enum.RawHandle.html" title="enum glutin::os::unix::RawHandle">RawHandle</a></code></span></h4>
|
||
<div class='docblock'><p>Raw context handle.</p>
|
||
</div><h4 id='method.raw_handle' class="method"><span id='raw_handle.v' class='invisible'><table class='table-display'><tbody><tr><td><code>unsafe fn <a href='../glutin/os/trait.GlContextExt.html#tymethod.raw_handle' class='fnname'>raw_handle</a>(&self) -> Self::<a class="type" href="../glutin/os/trait.GlContextExt.html#associatedtype.Handle" title="type glutin::os::GlContextExt::Handle">Handle</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/os/unix.rs.html#23-25' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the raw context handle.</p>
|
||
</div></div><h3 id='impl-GlContext' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../glutin/trait.GlContext.html" title="trait glutin::GlContext">GlContext</a> for <a class="struct" href="../glutin/struct.Context.html" title="struct glutin::Context">Context</a></code><a href='#impl-GlContext' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#392-421' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.make_current' class="method"><span id='make_current.v' class='invisible'><table class='table-display'><tbody><tr><td><code>unsafe fn <a href='../glutin/trait.GlContext.html#tymethod.make_current' class='fnname'>make_current</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../glutin/enum.ContextError.html" title="enum glutin::ContextError">ContextError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#393-395' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the context as the current context.</p>
|
||
</div><h4 id='method.is_current' class="method"><span id='is_current.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.is_current' class='fnname'>is_current</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#397-399' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns true if this context is the current one in this thread.</p>
|
||
</div><h4 id='method.get_proc_address' class="method"><span id='get_proc_address.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.get_proc_address' class='fnname'>get_proc_address</a>(&self, addr: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#401-403' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the address of an OpenGL function.</p>
|
||
</div><h4 id='method.swap_buffers' class="method"><span id='swap_buffers.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.swap_buffers' class='fnname'>swap_buffers</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../glutin/enum.ContextError.html" title="enum glutin::ContextError">ContextError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#405-407' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Swaps the buffers in case of double or triple buffering. <a href="../glutin/trait.GlContext.html#tymethod.swap_buffers">Read more</a></p>
|
||
</div><h4 id='method.get_api' class="method"><span id='get_api.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.get_api' class='fnname'>get_api</a>(&self) -> <a class="enum" href="../glutin/enum.Api.html" title="enum glutin::Api">Api</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#409-411' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the OpenGL API being used.</p>
|
||
</div><h4 id='method.get_pixel_format' class="method"><span id='get_pixel_format.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.get_pixel_format' class='fnname'>get_pixel_format</a>(&self) -> <a class="struct" href="../glutin/struct.PixelFormat.html" title="struct glutin::PixelFormat">PixelFormat</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#413-415' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the pixel format of the main framebuffer of the context.</p>
|
||
</div><h4 id='method.resize' class="method"><span id='resize.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../glutin/trait.GlContext.html#tymethod.resize' class='fnname'>resize</a>(&self, size: <a class="struct" href="../glutin/dpi/struct.PhysicalSize.html" title="struct glutin::dpi::PhysicalSize">PhysicalSize</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/lib.rs.html#417-420' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Resize the GL context. <a href="../glutin/trait.GlContext.html#tymethod.resize">Read more</a></p>
|
||
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../glutin/struct.Context.html" title="struct glutin::Context">Context</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../glutin/struct.Context.html" title="struct glutin::Context">Context</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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 = "glutin";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |