mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
32 lines
17 KiB
HTML
32 lines
17 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 `HeadlessRendererBuilder` struct in crate `glutin`."><meta name="keywords" content="rust, rustlang, rust-lang, HeadlessRendererBuilder"><title>glutin::HeadlessRendererBuilder - 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 HeadlessRendererBuilder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.dimensions">dimensions</a><a href="#structfield.opengl">opengl</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_gl">with_gl</a><a href="#method.with_gl_profile">with_gl_profile</a><a href="#method.with_gl_debug_flag">with_gl_debug_flag</a><a href="#method.with_gl_robustness">with_gl_robustness</a><a href="#method.build">build</a><a href="#method.build_strict">build_strict</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</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: 'HeadlessRendererBuilder', 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=''>HeadlessRendererBuilder</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/headless.rs.html#16-28' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct HeadlessRendererBuilder<'a> {
|
||
pub dimensions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>,
|
||
pub opengl: <a class="struct" href="../glutin/struct.GlAttributes.html" title="struct glutin::GlAttributes">GlAttributes</a><&'a HeadlessContext>,
|
||
// some fields omitted
|
||
}</pre></div><div class='docblock'><p>Object that allows you to build headless contexts.</p>
|
||
</div><h2 id='fields' class='fields small-section-header'>
|
||
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.dimensions" class="structfield small-section-header">
|
||
<a href="#structfield.dimensions" class="anchor field"></a>
|
||
<span id="dimensions.v" class='invisible'>
|
||
<code>dimensions: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code>
|
||
</span></span><div class='docblock'><p>The dimensions to use.</p>
|
||
</div><span id="structfield.opengl" class="structfield small-section-header">
|
||
<a href="#structfield.opengl" class="anchor field"></a>
|
||
<span id="opengl.v" class='invisible'>
|
||
<code>opengl: <a class="struct" href="../glutin/struct.GlAttributes.html" title="struct glutin::GlAttributes">GlAttributes</a><&'a HeadlessContext></code>
|
||
</span></span><div class='docblock'><p>The OpenGL attributes to build the context with.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#30-95' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>(width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#33-43' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Initializes a new <code>HeadlessRendererBuilder</code> with default values.</p>
|
||
</div><h4 id='method.with_gl' class="method"><span id='with_gl.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_gl' class='fnname'>with_gl</a>(self, request: <a class="enum" href="../glutin/enum.GlRequest.html" title="enum glutin::GlRequest">GlRequest</a>) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#47-50' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets how the backend should choose the OpenGL API and version.</p>
|
||
</div><h4 id='method.with_gl_profile' class="method"><span id='with_gl_profile.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_gl_profile' class='fnname'>with_gl_profile</a>(self, profile: <a class="enum" href="../glutin/enum.GlProfile.html" title="enum glutin::GlProfile">GlProfile</a>) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#54-57' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the desired OpenGL context profile.</p>
|
||
</div><h4 id='method.with_gl_debug_flag' class="method"><span id='with_gl_debug_flag.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_gl_debug_flag' class='fnname'>with_gl_debug_flag</a>(self, flag: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#64-67' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the <em>debug</em> flag for the OpenGL context.</p>
|
||
<p>The default value for this flag is <code>cfg!(ndebug)</code>, which means that it's enabled
|
||
when you run <code>cargo build</code> and disabled when you run <code>cargo build --release</code>.</p>
|
||
</div><h4 id='method.with_gl_robustness' class="method"><span id='with_gl_robustness.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.with_gl_robustness' class='fnname'>with_gl_robustness</a>(<br> self, <br> robustness: <a class="enum" href="../glutin/enum.Robustness.html" title="enum glutin::Robustness">Robustness</a><br>) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#71-74' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets the robustness of the OpenGL context. See the docs of <code>Robustness</code>.</p>
|
||
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</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="struct" href="../glutin/struct.HeadlessContext.html" title="struct glutin::HeadlessContext">HeadlessContext</a>, <a class="enum" href="../glutin/enum.CreationError.html" title="enum glutin::CreationError">CreationError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#81-85' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Builds the headless context.</p>
|
||
<p>Error should be very rare and only occur in case of permission denied, incompatible system,
|
||
out of memory, etc.</p>
|
||
</div><h4 id='method.build_strict' class="method"><span id='build_strict.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build_strict' class='fnname'>build_strict</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="struct" href="../glutin/struct.HeadlessContext.html" title="struct glutin::HeadlessContext">HeadlessContext</a>, <a class="enum" href="../glutin/enum.CreationError.html" title="enum glutin::CreationError">CreationError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#92-94' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Builds the headless context.</p>
|
||
<p>The context is build in a <em>strict</em> way. That means that if the backend couldn't give
|
||
you what you requested, an <code>Err</code> will be returned.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#15' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../glutin/struct.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/glutin/headless.rs.html#15' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">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> <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.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'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> <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.HeadlessRendererBuilder.html" title="struct glutin::HeadlessRendererBuilder">HeadlessRendererBuilder</a><'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> |