Newer
Older
ForwardPlusRenderer / Docs / html / classfpr_1_1_render_pass.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: fpr::RenderPass Class Reference</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('classfpr_1_1_render_pass.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classfpr_1_1_render_pass-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">fpr::RenderPass Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a56eae73ef43e7505e5862c4f2ceb8174"><td class="memItemLeft" align="right" valign="top">vk::RenderPass &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_render_pass.html#a56eae73ef43e7505e5862c4f2ceb8174">GetvkRenderPass</a> () FPR_NOEXCEPT</td></tr>
<tr class="separator:a56eae73ef43e7505e5862c4f2ceb8174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af709461679fac8d39c2bc3563a00fc9d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_render_pass.html#af709461679fac8d39c2bc3563a00fc9d">RenderPass</a> (const <a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a> &amp;options, <a class="el" href="classfpr_1_1_device.html">fpr::Device</a> *device)</td></tr>
<tr class="separator:af709461679fac8d39c2bc3563a00fc9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3519f85bc20f6681185842edb462347d"><td class="memItemLeft" align="right" valign="top"><a id="a3519f85bc20f6681185842edb462347d" name="a3519f85bc20f6681185842edb462347d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RenderPass</b> (const <a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a> &amp;other)=delete</td></tr>
<tr class="separator:a3519f85bc20f6681185842edb462347d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f2a46c641f59d5f658557893531da80"><td class="memItemLeft" align="right" valign="top"><a id="a4f2a46c641f59d5f658557893531da80" name="a4f2a46c641f59d5f658557893531da80"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>RenderPass</b> (const <a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a> &amp;&amp;other)=delete</td></tr>
<tr class="separator:a4f2a46c641f59d5f658557893531da80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4ec9d31f13b4eb5b4abcdeb8bf3ff98"><td class="memItemLeft" align="right" valign="top"><a id="ac4ec9d31f13b4eb5b4abcdeb8bf3ff98" name="ac4ec9d31f13b4eb5b4abcdeb8bf3ff98"></a>
<a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a> &amp;other)=delete</td></tr>
<tr class="separator:ac4ec9d31f13b4eb5b4abcdeb8bf3ff98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2df20798a1a7c0c9eedc09afa38b24f8"><td class="memItemLeft" align="right" valign="top"><a id="a2df20798a1a7c0c9eedc09afa38b24f8" name="a2df20798a1a7c0c9eedc09afa38b24f8"></a>
<a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a> &amp;&amp;other)=delete</td></tr>
<tr class="separator:a2df20798a1a7c0c9eedc09afa38b24f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9feda396c5c3fada4e1ad6847d7df8b1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_render_pass.html#a9feda396c5c3fada4e1ad6847d7df8b1">MakeDefaultRenderPass</a> (vk::Format swapchain_format, vk::Format depth_format)</td></tr>
<tr class="separator:a9feda396c5c3fada4e1ad6847d7df8b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a270235809d1514315a312c0640a80864"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_render_pass.html#a270235809d1514315a312c0640a80864">MakeDefaultDepthPass</a> (vk::Format depth_format)</td></tr>
<tr class="separator:a270235809d1514315a312c0640a80864"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ab9d682d7f58648b5db92aa33e8c61a1f"><td class="memItemLeft" align="right" valign="top">vk::UniqueRenderPass&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_render_pass.html#ab9d682d7f58648b5db92aa33e8c61a1f">m_render_pass</a></td></tr>
<tr class="separator:ab9d682d7f58648b5db92aa33e8c61a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="_render_pass_8h_source.html#l00014">14</a> of file <a class="el" href="_render_pass_8h_source.html">RenderPass.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af709461679fac8d39c2bc3563a00fc9d" name="af709461679fac8d39c2bc3563a00fc9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af709461679fac8d39c2bc3563a00fc9d">&#9670;&#160;</a></span>RenderPass()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">fpr::RenderPass::RenderPass </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a> &amp;&#160;</td>
          <td class="paramname"><em>options</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classfpr_1_1_device.html">fpr::Device</a> *&#160;</td>
          <td class="paramname"><em>device</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_render_pass_8cpp_source.html#l00014">14</a> of file <a class="el" href="_render_pass_8cpp_source.html">RenderPass.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a56eae73ef43e7505e5862c4f2ceb8174" name="a56eae73ef43e7505e5862c4f2ceb8174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56eae73ef43e7505e5862c4f2ceb8174">&#9670;&#160;</a></span>GetvkRenderPass()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vk::RenderPass &amp; fpr::RenderPass::GetvkRenderPass </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_render_pass_8cpp_source.html#l00009">9</a> of file <a class="el" href="_render_pass_8cpp_source.html">RenderPass.cpp</a>.</p>

</div>
</div>
<a id="a270235809d1514315a312c0640a80864" name="a270235809d1514315a312c0640a80864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a270235809d1514315a312c0640a80864">&#9670;&#160;</a></span>MakeDefaultDepthPass()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a> fpr::RenderPass::MakeDefaultDepthPass </td>
          <td>(</td>
          <td class="paramtype">vk::Format&#160;</td>
          <td class="paramname"><em>depth_format</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_render_pass_8cpp_source.html#l00096">96</a> of file <a class="el" href="_render_pass_8cpp_source.html">RenderPass.cpp</a>.</p>

</div>
</div>
<a id="a9feda396c5c3fada4e1ad6847d7df8b1" name="a9feda396c5c3fada4e1ad6847d7df8b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9feda396c5c3fada4e1ad6847d7df8b1">&#9670;&#160;</a></span>MakeDefaultRenderPass()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structfpr_1_1_render_pass_options.html">RenderPassOptions</a> fpr::RenderPass::MakeDefaultRenderPass </td>
          <td>(</td>
          <td class="paramtype">vk::Format&#160;</td>
          <td class="paramname"><em>swapchain_format</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">vk::Format&#160;</td>
          <td class="paramname"><em>depth_format</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_render_pass_8cpp_source.html#l00036">36</a> of file <a class="el" href="_render_pass_8cpp_source.html">RenderPass.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab9d682d7f58648b5db92aa33e8c61a1f" name="ab9d682d7f58648b5db92aa33e8c61a1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9d682d7f58648b5db92aa33e8c61a1f">&#9670;&#160;</a></span>m_render_pass</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">vk::UniqueRenderPass fpr::RenderPass::m_render_pass</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_render_pass_8h_source.html#l00016">16</a> of file <a class="el" href="_render_pass_8h_source.html">RenderPass.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/include/<a class="el" href="_render_pass_8h_source.html">RenderPass.h</a></li>
<li>D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/src/<a class="el" href="_render_pass_8cpp_source.html">RenderPass.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
		<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
			<ul>
				<li class="navelem"><b>fpr</b></li><li class="navelem"><a class="el" href="classfpr_1_1_render_pass.html">RenderPass</a></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>