127 lines
7.1 KiB
HTML
127 lines
7.1 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.8.20"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>EnTT: entt::resource_loader< Loader, Resource > Class Template 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="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" />
|
|
</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">EnTT
|
|
 <span id="projectnumber">3.6.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.20 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceentt.html">entt</a></li><li class="navelem"><a class="el" href="classentt_1_1resource__loader.html">resource_loader</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classentt_1_1resource__loader-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">entt::resource_loader< Loader, Resource > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for resource loaders.
|
|
<a href="classentt_1_1resource__loader.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="loader_8hpp_source.html">loader.hpp</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:a1cc23ee577fee7c2e019e4d2949d3cbe"><td class="memItemLeft" align="right" valign="top"><a id="a1cc23ee577fee7c2e019e4d2949d3cbe"></a>
|
|
struct </td><td class="memItemRight" valign="bottom"><a class="el" href="classentt_1_1resource__loader.html#a1cc23ee577fee7c2e019e4d2949d3cbe">resource_cache< Resource ></a></td></tr>
|
|
<tr class="memdesc:a1cc23ee577fee7c2e019e4d2949d3cbe"><td class="mdescLeft"> </td><td class="mdescRight">Resource loaders are friends of their caches. <br /></td></tr>
|
|
<tr class="separator:a1cc23ee577fee7c2e019e4d2949d3cbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename Loader, typename Resource><br />
|
|
class entt::resource_loader< Loader, Resource ></h3>
|
|
|
|
<p>Base class for resource loaders. </p>
|
|
<p>Resource loaders must inherit from this class and stay true to the CRTP idiom. Moreover, a resource loader must expose a public, const member function named <code>load</code> that accepts a variable number of arguments and returns a shared pointer to the resource just created.<br />
|
|
As an example:</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span>my_resource {};</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keyword">struct </span>my_loader: <a class="code" href="classentt_1_1resource__loader.html">entt::resource_loader</a><my_loader, my_resource> {</div>
|
|
<div class="line"> std::shared_ptr<my_resource> load(<span class="keywordtype">int</span>)<span class="keyword"> const </span>{</div>
|
|
<div class="line"> <span class="comment">// use the integer value somehow</span></div>
|
|
<div class="line"> <span class="keywordflow">return</span> std::make_shared<my_resource>();</div>
|
|
<div class="line"> }</div>
|
|
<div class="line">};</div>
|
|
</div><!-- fragment --><p>In general, resource loaders should not have a state or retain data of any type. They should let the cache manage their resources instead.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Base class and CRTP idiom aren't strictly required with the current implementation. One could argue that a cache can easily work with loaders of any type. However, future changes won't be breaking ones by forcing the use of a base class today and that's why the model is already in its place.</dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">Loader</td><td>Type of the derived class. </td></tr>
|
|
<tr><td class="paramname">Resource</td><td>Type of resource for which to use the loader. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="loader_8hpp_source.html#l00045">45</a> of file <a class="el" href="loader_8hpp_source.html">loader.hpp</a>.</p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/entt/resource/<a class="el" href="resource_2fwd_8hpp_source.html">fwd.hpp</a></li>
|
|
<li>src/entt/resource/<a class="el" href="loader_8hpp_source.html">loader.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<div class="ttc" id="aclassentt_1_1resource__loader_html"><div class="ttname"><a href="classentt_1_1resource__loader.html">entt::resource_loader</a></div><div class="ttdoc">Base class for resource loaders.</div><div class="ttdef"><b>Definition:</b> <a href="loader_8hpp_source.html#l00045">loader.hpp:45</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20
|
|
</small></address>
|
|
</body>
|
|
</html>
|