<!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/Buffer/Buffer.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&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&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&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_buffer_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">Buffer.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 <stdafx.h></span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">namespace </span>fpr</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span>{</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a52305babb43406486a66eb5a541df908"> 18</a></span> vk::DeviceSize <a class="code hl_variable" href="classfpr_1_1_buffer.html#a52305babb43406486a66eb5a541df908">m_buffer_size</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a15cc0c1d535e6b8517b98119dbee81e8"> 23</a></span> vk::UniqueBuffer <a class="code hl_variable" href="classfpr_1_1_buffer.html#a15cc0c1d535e6b8517b98119dbee81e8">m_buffer</a>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#aa6b4c531a7c12ec99c8211eb27ae36c0"> 28</a></span> vk::UniqueDeviceMemory <a class="code hl_variable" href="classfpr_1_1_buffer.html#aa6b4c531a7c12ec99c8211eb27ae36c0">m_memory</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#ad77ef431dbb9d3ba1ab3dea71e93535b"> 33</a></span> vk::DescriptorBufferInfo <a class="code hl_variable" href="classfpr_1_1_buffer.html#ad77ef431dbb9d3ba1ab3dea71e93535b">m_buffer_info</a>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a0948d795cd3a84c7290bbbe1db071bce"> 37</a></span> vk::DeviceSize <a class="code hl_variable" href="classfpr_1_1_buffer.html#a0948d795cd3a84c7290bbbe1db071bce">m_alignment</a> = 0;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a597dc9657c76e2ac517895f7e1a79bcf"> 41</a></span> vk::BufferUsageFlags <a class="code hl_variable" href="classfpr_1_1_buffer.html#a597dc9657c76e2ac517895f7e1a79bcf">m_usage</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a049dd5d7e633bcfdbb7bebc795c0e6c3"> 46</a></span> vk::MemoryPropertyFlags <a class="code hl_variable" href="classfpr_1_1_buffer.html#a049dd5d7e633bcfdbb7bebc795c0e6c3">m_memory_flags</a>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a6665690308d2cb41ff90c68ca2232a9c"> 50</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="classfpr_1_1_buffer.html#a6665690308d2cb41ff90c68ca2232a9c">mapped_data</a> = <span class="keyword">nullptr</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a1c647d7d61e69cafad4257f580d2c41f"> 56</a></span> <a class="code hl_function" href="classfpr_1_1_buffer.html#a1c647d7d61e69cafad4257f580d2c41f">Buffer</a>(<a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a>& other) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a>(vk::DeviceSize buffer_size, vk::BufferUsageFlags usage_flags, vk::MemoryPropertyFlags mem_flags);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classfpr_1_1_buffer.html">~Buffer</a>();</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> [[nodiscard]] vk::DeviceSize <a class="code hl_function" href="classfpr_1_1_buffer.html#abff1e9a70a69394da6823463870bab77">GetSize</a>();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> [[nodiscard]] vk::Buffer& <a class="code hl_function" href="classfpr_1_1_buffer.html#af0d421e1b5a9db2c825e081ebbc18b2c">GetBuffer</a>();</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classfpr_1_1_buffer.html#a829fed31e6ac9706893bd0043537af0e"> 89</a></span> <a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a> <a class="code hl_function" href="classfpr_1_1_buffer.html#a829fed31e6ac9706893bd0043537af0e">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a>& other) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfpr_1_1_buffer.html#a607111a387447a1990aab2a4aa8ca21e">Transfer</a>(<a class="code hl_class" href="classfpr_1_1_buffer.html">Buffer</a>* other);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfpr_1_1_buffer.html#a776a0f23c5eb01c4247273656fae73cb">Update</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* new_data);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classfpr_1_1_buffer.html#a107b4e093c5456eb07cd1d86a9746da2">Flush</a>();</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> [[nodiscard]] <span class="keywordtype">void</span>* <a class="code hl_function" href="classfpr_1_1_buffer.html#ab0b808db2e96d58c31da5b86138f00ce">GetMapped</a>();</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>};</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span>} <span class="comment">// namespace fpr</span></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html"><div class="ttname"><a href="classfpr_1_1_buffer.html">fpr::Buffer</a></div><div class="ttdoc">Holds some essential information for data transfer between the CPU and GPU. Data transfer between GPU...</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00013">Buffer.h:14</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a049dd5d7e633bcfdbb7bebc795c0e6c3"><div class="ttname"><a href="classfpr_1_1_buffer.html#a049dd5d7e633bcfdbb7bebc795c0e6c3">fpr::Buffer::m_memory_flags</a></div><div class="ttdeci">vk::MemoryPropertyFlags m_memory_flags</div><div class="ttdoc">A buffer's held data may not be always available to the CPU intentionally to increase GPU access spee...</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00046">Buffer.h:46</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a0948d795cd3a84c7290bbbe1db071bce"><div class="ttname"><a href="classfpr_1_1_buffer.html#a0948d795cd3a84c7290bbbe1db071bce">fpr::Buffer::m_alignment</a></div><div class="ttdeci">vk::DeviceSize m_alignment</div><div class="ttdoc">Alignment of buffer data. Mostly irrelevant, though important when _aligned_malloc() is used.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00037">Buffer.h:37</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a107b4e093c5456eb07cd1d86a9746da2"><div class="ttname"><a href="classfpr_1_1_buffer.html#a107b4e093c5456eb07cd1d86a9746da2">fpr::Buffer::Flush</a></div><div class="ttdeci">void Flush()</div><div class="ttdoc">Flushes the mapped memory. Used when the buffer is updated and released to ensure the buffer is in a ...</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00079">Buffer.cpp:79</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a15cc0c1d535e6b8517b98119dbee81e8"><div class="ttname"><a href="classfpr_1_1_buffer.html#a15cc0c1d535e6b8517b98119dbee81e8">fpr::Buffer::m_buffer</a></div><div class="ttdeci">vk::UniqueBuffer m_buffer</div><div class="ttdoc">RAII handle for a VkBuffer.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00023">Buffer.h:23</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a1c647d7d61e69cafad4257f580d2c41f"><div class="ttname"><a href="classfpr_1_1_buffer.html#a1c647d7d61e69cafad4257f580d2c41f">fpr::Buffer::Buffer</a></div><div class="ttdeci">Buffer(Buffer &other)=delete</div><div class="ttdoc">Copy constructor for a buffer is deleted. A buffer must never be copied directly like this,...</div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a52305babb43406486a66eb5a541df908"><div class="ttname"><a href="classfpr_1_1_buffer.html#a52305babb43406486a66eb5a541df908">fpr::Buffer::m_buffer_size</a></div><div class="ttdeci">vk::DeviceSize m_buffer_size</div><div class="ttdoc">The size of the buffer in bytes.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00018">Buffer.h:18</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a597dc9657c76e2ac517895f7e1a79bcf"><div class="ttname"><a href="classfpr_1_1_buffer.html#a597dc9657c76e2ac517895f7e1a79bcf">fpr::Buffer::m_usage</a></div><div class="ttdeci">vk::BufferUsageFlags m_usage</div><div class="ttdoc">Denotes what the buffer will be used for, i.e index buffer or vertex buffer and so on.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00041">Buffer.h:41</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a607111a387447a1990aab2a4aa8ca21e"><div class="ttname"><a href="classfpr_1_1_buffer.html#a607111a387447a1990aab2a4aa8ca21e">fpr::Buffer::Transfer</a></div><div class="ttdeci">void Transfer(Buffer *other)</div><div class="ttdoc">Transfer this buffer into another through the use of an intermediary staging buffer....</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00061">Buffer.cpp:61</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a6665690308d2cb41ff90c68ca2232a9c"><div class="ttname"><a href="classfpr_1_1_buffer.html#a6665690308d2cb41ff90c68ca2232a9c">fpr::Buffer::mapped_data</a></div><div class="ttdeci">void * mapped_data</div><div class="ttdoc">Raw pointer to the data held on the GPU. In this engine, most data is persistently mapped.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00050">Buffer.h:50</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a776a0f23c5eb01c4247273656fae73cb"><div class="ttname"><a href="classfpr_1_1_buffer.html#a776a0f23c5eb01c4247273656fae73cb">fpr::Buffer::Update</a></div><div class="ttdeci">void Update(const void *new_data)</div><div class="ttdoc">Does not validate the given data for size. Simply copies the new data and overwrites the currently ma...</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00071">Buffer.cpp:71</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_a829fed31e6ac9706893bd0043537af0e"><div class="ttname"><a href="classfpr_1_1_buffer.html#a829fed31e6ac9706893bd0043537af0e">fpr::Buffer::operator=</a></div><div class="ttdeci">Buffer operator=(const Buffer &other)=delete</div><div class="ttdoc">Like the copy constructor, the copy assigment operator is also deleted due to identical reasoning.</div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_aa6b4c531a7c12ec99c8211eb27ae36c0"><div class="ttname"><a href="classfpr_1_1_buffer.html#aa6b4c531a7c12ec99c8211eb27ae36c0">fpr::Buffer::m_memory</a></div><div class="ttdeci">vk::UniqueDeviceMemory m_memory</div><div class="ttdoc">RAII handle for VkDeviceMemory.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00028">Buffer.h:28</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_ab0b808db2e96d58c31da5b86138f00ce"><div class="ttname"><a href="classfpr_1_1_buffer.html#ab0b808db2e96d58c31da5b86138f00ce">fpr::Buffer::GetMapped</a></div><div class="ttdeci">void * GetMapped()</div><div class="ttdoc">Getter for private member holding the raw data of the buffer.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00090">Buffer.cpp:90</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_abff1e9a70a69394da6823463870bab77"><div class="ttname"><a href="classfpr_1_1_buffer.html#abff1e9a70a69394da6823463870bab77">fpr::Buffer::GetSize</a></div><div class="ttdeci">vk::DeviceSize GetSize()</div><div class="ttdoc">Getter for the buffer size private member.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00051">Buffer.cpp:51</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_ad77ef431dbb9d3ba1ab3dea71e93535b"><div class="ttname"><a href="classfpr_1_1_buffer.html#ad77ef431dbb9d3ba1ab3dea71e93535b">fpr::Buffer::m_buffer_info</a></div><div class="ttdeci">vk::DescriptorBufferInfo m_buffer_info</div><div class="ttdoc">Buffer information used for descriptor sets. Primarily concerns shaders.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8h_source.html#l00033">Buffer.h:33</a></div></div>
<div class="ttc" id="aclassfpr_1_1_buffer_html_af0d421e1b5a9db2c825e081ebbc18b2c"><div class="ttname"><a href="classfpr_1_1_buffer.html#af0d421e1b5a9db2c825e081ebbc18b2c">fpr::Buffer::GetBuffer</a></div><div class="ttdeci">vk::Buffer & GetBuffer()</div><div class="ttdoc">Getter for the VkBuffer private member.</div><div class="ttdef"><b>Definition:</b> <a href="_buffer_8cpp_source.html#l00056">Buffer.cpp:56</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"><a class="el" href="dir_5b8ecbc3efc5e49a9fcfef2c0721cde7.html">Buffer</a></li><li class="navelem"><b>Buffer.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>
Mantas Buzelis