2018-10-28 21:14:05 -05:00

152 lines
11 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 `opengl_graphics` crate."><meta name="keywords" content="rust, rustlang, rust-lang, opengl_graphics"><title>opengl_graphics - 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 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">&#9776;</div><p class='location'>Crate opengl_graphics</p><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="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'opengl_graphics', 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 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'>Crate <a class="mod" href=''>opengl_graphics</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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/opengl_graphics/lib.rs.html#1-28' title='goto source code'>[src]</a></span></h1><div class='docblock'><p>An OpenGL back-end for Rust-Graphics</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="error/index.html"
title='mod opengl_graphics::error'>error</a></td>
<td class='docblock-short'>
<p>Errors</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="ops/index.html"
title='mod opengl_graphics::ops'>ops</a></td>
<td class='docblock-short'>
<p>Image operations for textures.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="shader_uniforms/index.html"
title='mod opengl_graphics::shader_uniforms'>shader_uniforms</a></td>
<td class='docblock-short'>
<p>Types and methods for setting shader uniforms</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="shader_utils/index.html"
title='mod opengl_graphics::shader_utils'>shader_utils</a></td>
<td class='docblock-short'>
<p>Helper functions for dealing with shaders.</p>
</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.Colored.html"
title='struct opengl_graphics::Colored'>Colored</a></td>
<td class='docblock-short'>
<p>Describes how to render colored objects.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.GlGraphics.html"
title='struct opengl_graphics::GlGraphics'>GlGraphics</a></td>
<td class='docblock-short'>
<p>Contains OpenGL data.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Shaders.html"
title='struct opengl_graphics::Shaders'>Shaders</a></td>
<td class='docblock-short'>
<p>Shader picker.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Texture.html"
title='struct opengl_graphics::Texture'>Texture</a></td>
<td class='docblock-short'>
<p>Wraps OpenGL texture data.
The texture gets deleted when running out of scope.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.TextureSettings.html"
title='struct opengl_graphics::TextureSettings'>TextureSettings</a></td>
<td class='docblock-short'>
<p>Texture creation parameters.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Textured.html"
title='struct opengl_graphics::Textured'>Textured</a></td>
<td class='docblock-short'>
<p>Describes how to render textured objects.</p>
</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.Filter.html"
title='enum opengl_graphics::Filter'>Filter</a></td>
<td class='docblock-short'>
<p>Sampling filter</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.Format.html"
title='enum opengl_graphics::Format'>Format</a></td>
<td class='docblock-short'>
<p>Texture format.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.GLSL.html"
title='enum opengl_graphics::GLSL'>GLSL</a></td>
<td class='docblock-short'>
<p>For OpenGL version 3.3 and above,
the GLSL version is the same as the OpenGL version.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.OpenGL.html"
title='enum opengl_graphics::OpenGL'>OpenGL</a></td>
<td class='docblock-short'>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.CreateTexture.html"
title='trait opengl_graphics::CreateTexture'>CreateTexture</a></td>
<td class='docblock-short'>
<p>Implemented by textures for creation.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.ImageSize.html"
title='trait opengl_graphics::ImageSize'>ImageSize</a></td>
<td class='docblock-short'>
<p>Implemented by all images to be used with generic algorithms.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.UpdateTexture.html"
title='trait opengl_graphics::UpdateTexture'>UpdateTexture</a></td>
<td class='docblock-short'>
<p>Implemented by textures for updating.</p>
</td>
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="type" href="type.GlyphCache.html"
title='type opengl_graphics::GlyphCache'>GlyphCache</a></td>
<td class='docblock-short'>
<p>Glyph cache implementation for OpenGL backend.</p>
</td>
</tr></table></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>&#9166;</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 = "opengl_graphics";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>