|
|
|
|
|
<!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 `viewport` mod in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, viewport"><title>vulkano::pipeline::viewport - 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='../../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Module viewport</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>pipeline</a></p><script>window.sidebarCurrent = {name: 'viewport', ty: 'mod', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" 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/vulkano/pipeline/viewport.rs.html#10-201' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>pipeline</a>::<wbr><a class="mod" href=''>viewport</a></span></h1><div class='docblock'><p>Viewports and scissor boxes.</p>
|
|
|
|
|
|
<p>There are two different concepts to determine where things will be drawn:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>The viewport is the region of the image which corresponds to the
|
|
|
|
|
|
vertex coordinates <code>-1.0</code> to <code>1.0</code>.</li>
|
|
|
|
|
|
<li>Any pixel outside of the scissor box will be discarded.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>In other words modifying the viewport will stretch the image, while modifying the scissor
|
|
|
|
|
|
box acts like a filter.</p>
|
|
|
|
|
|
<p>It is legal and sensible to use a viewport that is larger than the target image or that
|
|
|
|
|
|
only partially overlaps the target image.</p>
|
|
|
|
|
|
<h1 id="multiple-viewports" class="section-header"><a href="#multiple-viewports">Multiple viewports</a></h1>
|
|
|
|
|
|
<p>In most situations, you only need a single viewport and a single scissor box.</p>
|
|
|
|
|
|
<p>If, however, you use a geometry shader, you can specify multiple viewports and scissor boxes.
|
|
|
|
|
|
Then in your geometry shader you can specify in which viewport and scissor box the primitive
|
|
|
|
|
|
should be written to. In GLSL this is done by writing to the special variable
|
|
|
|
|
|
<code>gl_ViewportIndex</code>.</p>
|
|
|
|
|
|
<p>If you don't use a geometry shader or use a geometry shader where don't set which viewport to
|
|
|
|
|
|
use, then the first viewport and scissor box will be used.</p>
|
|
|
|
|
|
<h1 id="dynamic-and-fixed" class="section-header"><a href="#dynamic-and-fixed">Dynamic and fixed</a></h1>
|
|
|
|
|
|
<p>Vulkan allows four different setups:</p>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>The state of both the viewports and scissor boxes is known at pipeline creation.</li>
|
|
|
|
|
|
<li>The state of viewports is known at pipeline creation, but the state of scissor boxes is
|
|
|
|
|
|
only known when submitting the draw command.</li>
|
|
|
|
|
|
<li>The state of scissor boxes is known at pipeline creation, but the state of viewports is
|
|
|
|
|
|
only known when submitting the draw command.</li>
|
|
|
|
|
|
<li>The state of both the viewports and scissor boxes is only known when submitting the
|
|
|
|
|
|
draw command.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<p>In all cases the number of viewports and scissor boxes must be the same.</p>
|
|
|
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Scissor.html" title='vulkano::pipeline::viewport::Scissor struct'>Scissor</a></td><td class='docblock-short'><p>State of a single scissor box.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Viewport.html" title='vulkano::pipeline::viewport::Viewport struct'>Viewport</a></td><td class='docblock-short'><p>State of a single viewport.</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.ViewportsState.html" title='vulkano::pipeline::viewport::ViewportsState enum'>ViewportsState</a></td><td class='docblock-short'><p>List of viewports and scissors that are used when creating a graphics pipeline object.</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>⏎</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 = "vulkano";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
