Newer
Older
ForwardPlusRenderer / Docs / html / _pipeline_8h_source.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
		<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
		<meta http-equiv="X-UA-Compatible" content="IE=9"/>
		<meta name="generator" content="Doxygen 1.9.5"/>
		<meta name="viewport" content="width=device-width, initial-scale=1"/>
		<title>Final Year Project: D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/include/Pipeline.h Source File</title>
		<link href="tabs.css" rel="stylesheet" type="text/css"/>
		<script type="text/javascript" src="jquery.js"></script>
		<script type="text/javascript" src="dynsections.js"></script>
		<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
		<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
		<link href="doxygen.css" rel="stylesheet" type="text/css" />
		<link href="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
<link href="custom.css" rel="stylesheet" type="text/css"/>
	</head>
	<body>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div id="titlearea">
			<table cellspacing="0" cellpadding="0">
				<tbody>
					<tr style="height: 56px;">
						<td id="projectalign" style="padding-left: 0.5em;">
							<div id="projectname">Final Year Project
							</div>
						</td>
					</tr>
				</tbody>
			</table>
		</div>
		<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_pipeline_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="headertitle"><div class="title">Pipeline.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="preprocessor">#include &lt;stdafx.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="preprocessor">#include &quot;Device.h&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#include &quot;Vertex.h&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="keyword">namespace </span>fpr</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span>{</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span>  <span class="comment">//Pipelines have many different possible options.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span>  <span class="comment">//All of these are contained in this struct. This struct can be passed into a Pipeline constructor instead of all of the members individually.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="structfpr_1_1_pipeline_options.html">   10</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span>  std::vector&lt;std::pair&lt;vk::ShaderModule, vk::ShaderStageFlagBits&gt;&gt; modules;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span>  vk::PipelineInputAssemblyStateCreateInfo           input_assembly;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>  vk::PipelineViewportStateCreateInfo                viewport;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>  vk::PipelineRasterizationStateCreateInfo           rasterizer;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>  std::vector&lt;vk::DynamicState&gt;                      dynamic_states;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>  vk::PipelineMultisampleStateCreateInfo             multisample;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>  std::vector&lt;vk::PipelineColorBlendAttachmentState&gt; blend_attach_states;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>  vk::PipelineDepthStencilStateCreateInfo            depth_stencil;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>  std::vector&lt;vk::DescriptorSetLayout&gt;               layouts;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>  vk::PipelineCreateFlags                            flags;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>  vk::RenderPass                                     render_pass;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>  uint32_t                                           subpass              = 0;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>  vk::Pipeline                                       base_pipeline_handle = <span class="keyword">nullptr</span>; <span class="comment">//most pipelines don&#39;t have a parent</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>  int32_t                                            base_pipeline_index  = -1;      <span class="comment">// thus they don&#39;t have a pipeline index.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>  std::vector&lt;vk::PushConstantRange&gt;                 push_constant_ranges;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>};</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="keyword">enum class</span> EPipelineType : uint8_t</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>{</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    EPT_Graphics,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    EPT_Compute</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>};</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="classfpr_1_1_pipeline.html">   35</a></span><span class="keyword">class </span><a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>  vk::UniquePipeline       m_pipeline;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>  vk::UniquePipelineCache  m_cache;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>  vk::UniquePipelineLayout m_layout;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>  <a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a>          m_options;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>*        m_parent = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>  <span class="keyword">static</span> <a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a> GetDefaultGraphicsPipeline();</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>  <span class="keyword">static</span> <a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a> GetDepthPassPipeline();</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>  <span class="keyword">static</span> <a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a> GetLightCullingPipeline();</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>  vk::Pipeline&amp;          GetPipeline();</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>  vk::PipelineLayout&amp;    GetLayout();</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structfpr_1_1_pipeline_options.html">PipelineOptions</a>&amp; options, <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>* parent = <span class="keyword">nullptr</span>, EPipelineType type = EPipelineType::EPT_Graphics);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>&amp; other)  = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>&amp;&amp; other) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a> operator=(<span class="keyword">const</span> <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>&amp; other) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>  <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a> operator=(<span class="keyword">const</span> <a class="code hl_class" href="classfpr_1_1_pipeline.html">Pipeline</a>&amp;&amp; other) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>};</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span>vk::ShaderModule CreateShaderModule(<span class="keyword">const</span> std::vector&lt;char&gt;&amp; shader);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>} <span class="comment">// namespace fpr</span></div>
<div class="ttc" id="aclassfpr_1_1_pipeline_html"><div class="ttname"><a href="classfpr_1_1_pipeline.html">fpr::Pipeline</a></div><div class="ttdef"><b>Definition:</b> <a href="_pipeline_8h_source.html#l00035">Pipeline.h:36</a></div></div>
<div class="ttc" id="astructfpr_1_1_pipeline_options_html"><div class="ttname"><a href="structfpr_1_1_pipeline_options.html">fpr::PipelineOptions</a></div><div class="ttdef"><b>Definition:</b> <a href="_pipeline_8h_source.html#l00010">Pipeline.h:11</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
		<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
			<ul>
				<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><b>Pipeline.h</b></li>
				<li class="footer">
					Generated on Mon Oct 3 2022 13:44:05 for Final Year Project by <a href="http://www.doxygen.org/index.html">
					<img class="footer" src="doxygen.png" alt="doxygen"
                     onerror="this.onerror=null;this.src='doxygen.svg';"/></a> 1.9.5.
					Dark theme by <a href="http://majerle.eu" target="_new">Tilen Majerle</a>. All rights reserved.
				</li>
			</ul>
		</div>
		<script src="custom.js"></script>
	</body>
</html>