mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
36 lines
12 KiB
HTML
36 lines
12 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 `GlContext` trait in crate `glutin`."><meta name="keywords" content="rust, rustlang, rust-lang, GlContext"><title>glutin::GlContext - 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 trait"><!--[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'>Trait GlContext</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.make_current">make_current</a><a href="#tymethod.is_current">is_current</a><a href="#tymethod.get_proc_address">get_proc_address</a><a href="#tymethod.swap_buffers">swap_buffers</a><a href="#tymethod.get_api">get_api</a><a href="#tymethod.get_pixel_format">get_pixel_format</a><a href="#tymethod.resize">resize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>glutin</a></p><script>window.sidebarCurrent = {name: 'GlContext', ty: 'trait', 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'>Trait <a href='index.html'>glutin</a>::<wbr><a class="trait" href=''>GlContext</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#106-140' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait GlContext {
|
||
unsafe fn <a href='#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>>;
|
||
<div class='item-spacer'></div> fn <a href='#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>;
|
||
<div class='item-spacer'></div> fn <a href='#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>;
|
||
<div class='item-spacer'></div> fn <a href='#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>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.get_api' class='fnname'>get_api</a>(&self) -> <a class="enum" href="../glutin/enum.Api.html" title="enum glutin::Api">Api</a>;
|
||
<div class='item-spacer'></div> fn <a href='#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>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.resize' class='fnname'>resize</a>(&self, size: <a class="struct" href="../glutin/dpi/struct.PhysicalSize.html" title="struct glutin::dpi::PhysicalSize">PhysicalSize</a>);
|
||
}</pre></div><div class='docblock'><p>A trait for types associated with a GL context.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.make_current' class='method'><span id='make_current.v' class='invisible'><code>unsafe fn <a href='#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></h3><div class='docblock'><p>Sets the context as the current context.</p>
|
||
</div><h3 id='tymethod.is_current' class='method'><span id='is_current.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Returns true if this context is the current one in this thread.</p>
|
||
</div><h3 id='tymethod.get_proc_address' class='method'><span id='get_proc_address.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Returns the address of an OpenGL function.</p>
|
||
</div><h3 id='tymethod.swap_buffers' class='method'><span id='swap_buffers.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Swaps the buffers in case of double or triple buffering.</p>
|
||
<p>You should call this function every time you have finished rendering, or the image may not
|
||
be displayed on the screen.</p>
|
||
<p><strong>Warning</strong>: if you enabled vsync, this function will block until the next time the screen
|
||
is refreshed. However drivers can choose to override your vsync settings, which means that
|
||
you can't know in advance whether <code>swap_buffers</code> will block or not.</p>
|
||
</div><h3 id='tymethod.get_api' class='method'><span id='get_api.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Returns the OpenGL API being used.</p>
|
||
</div><h3 id='tymethod.get_pixel_format' class='method'><span id='get_pixel_format.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Returns the pixel format of the main framebuffer of the context.</p>
|
||
</div><h3 id='tymethod.resize' class='method'><span id='resize.v' class='invisible'><code>fn <a href='#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></h3><div class='docblock'><p>Resize the GL context.</p>
|
||
<p>Some platforms (macos, wayland) require being manually updated when their window or
|
||
surface is resized.</p>
|
||
<p>The easiest way of doing this is to call this method for each <code>Resized</code> window event that
|
||
is received with the width and height given by the event.</p>
|
||
</div></div><h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><ul class='item-list' id='implementors-list'><li><table class='table-display'><tbody><tr><td><code>impl GlContext for <a class="struct" href="../glutin/struct.HeadlessContext.html" title="struct glutin::HeadlessContext">HeadlessContext</a></code><td><div class='out-of-band'><a class='srclink' href='../src/glutin/headless.rs.html#102-147' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl GlContext for <a class="struct" href="../glutin/struct.Context.html" title="struct glutin::Context">Context</a></code><td><div class='out-of-band'><a class='srclink' href='../src/glutin/lib.rs.html#392-421' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
<li><table class='table-display'><tbody><tr><td><code>impl GlContext for <a class="struct" href="../glutin/struct.GlWindow.html" title="struct glutin::GlWindow">GlWindow</a></code><td><div class='out-of-band'><a class='srclink' href='../src/glutin/lib.rs.html#423-451' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
|
||
</ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../implementors/glutin/trait.GlContext.js">
|
||
</script></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> |