1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<!-- HTML header for doxygen 1.8.9.1-->
<!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.1"/>
<title>MinGfx Toolkit: src/platform.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="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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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 style="padding-left: 0.5em;">
<div id="projectname">MinGfx Toolkit
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.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: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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">platform.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="platform_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> This file is part of the MinGfx Project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> </span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2017,2018 Regents of the University of Minnesota.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> All Rights Reserved.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Original Author(s) of this File:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> Dan Keefe, 2018, University of Minnesota</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Author(s) of Significant Updates/Modifications to the File:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ...</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef SRC_PLATFORM_H_</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define SRC_PLATFORM_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span><a class="code" href="namespacemingfx.html">mingfx</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classmingfx_1_1_platform.html">Platform</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html#a045007efda73123a7f4019837d83bc92"> 30</a></span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="classmingfx_1_1_platform.html#a045007efda73123a7f4019837d83bc92">FileExists</a>(<span class="keyword">const</span> std::string &filename);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">/* Looks for a file named basename in each of the paths specified. If found,</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> the full path to the file is returned. If not found, then basename is returned.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> Example:</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> ~~~</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> std::vector<std::string> search_path;</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> search_path.push_back(".");</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> search_path.push_back("./data");</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> search_path.push_back("./shaders");</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> search_path.push_back("/usr/local/share/blah/blah/data");</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> </span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> std::string file = Platform::findFile("mydata.csv", search_path);</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> ~~~</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html#a32a392f4bac832c95fabc2d10bd03ad1"> 45</a></span>  <span class="keyword">static</span> std::string <a class="code" href="classmingfx_1_1_platform.html#a32a392f4bac832c95fabc2d10bd03ad1">FindFile</a>(<span class="keyword">const</span> std::string &basename, <span class="keyword">const</span> std::vector<std::string> &searchpath);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">/* Looks for a file named basename in each of the paths specified in a semi-colon</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> separated list. If found, the full path to the file is returned. If not found, </span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> then basename is returned. Example:</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> ~~~</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> std::string search_path = ".;./data;./shaders;/usr/local/share/blah/blah/data";</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> std::string file = Platform::findFile("mydata.csv", search_path);</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> ~~~</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html#a03ade910313dd9580c9e37a7b63f87b2"> 55</a></span>  <span class="keyword">static</span> std::string <a class="code" href="classmingfx_1_1_platform.html#a03ade910313dd9580c9e37a7b63f87b2">FindFile</a>(<span class="keyword">const</span> std::string &basename, <span class="keyword">const</span> std::string &searchpath);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html#a2c36ca57a246efa218a49a942c8c4a3b"> 65</a></span>  <span class="keyword">static</span> std::string <a class="code" href="classmingfx_1_1_platform.html#a2c36ca57a246efa218a49a942c8c4a3b">FindMinGfxDataFile</a>(<span class="keyword">const</span> std::string &basename);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classmingfx_1_1_platform.html#af12cd63e1ede33529d8c282d7d916169"> 75</a></span>  <span class="keyword">static</span> std::string <a class="code" href="classmingfx_1_1_platform.html#af12cd63e1ede33529d8c282d7d916169">FindMinGfxShaderFile</a>(<span class="keyword">const</span> std::string &basename);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">// end namespace</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html"><div class="ttname"><a href="classmingfx_1_1_platform.html">mingfx::Platform</a></div><div class="ttdoc">Provides access to the underlying file system and other platform-specific routines.</div><div class="ttdef"><b>Definition:</b> <a href="platform_8h_source.html#l00026">platform.h:26</a></div></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html_a03ade910313dd9580c9e37a7b63f87b2"><div class="ttname"><a href="classmingfx_1_1_platform.html#a03ade910313dd9580c9e37a7b63f87b2">mingfx::Platform::FindFile</a></div><div class="ttdeci">static std::string FindFile(const std::string &basename, const std::string &searchpath)</div></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html_a045007efda73123a7f4019837d83bc92"><div class="ttname"><a href="classmingfx_1_1_platform.html#a045007efda73123a7f4019837d83bc92">mingfx::Platform::FileExists</a></div><div class="ttdeci">static bool FileExists(const std::string &filename)</div><div class="ttdoc">True if filename is found and can be opened for reading on the system.</div></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html_a2c36ca57a246efa218a49a942c8c4a3b"><div class="ttname"><a href="classmingfx_1_1_platform.html#a2c36ca57a246efa218a49a942c8c4a3b">mingfx::Platform::FindMinGfxDataFile</a></div><div class="ttdeci">static std::string FindMinGfxDataFile(const std::string &basename)</div><div class="ttdoc">Searches for a data file that ships with MinGfx.</div></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html_a32a392f4bac832c95fabc2d10bd03ad1"><div class="ttname"><a href="classmingfx_1_1_platform.html#a32a392f4bac832c95fabc2d10bd03ad1">mingfx::Platform::FindFile</a></div><div class="ttdeci">static std::string FindFile(const std::string &basename, const std::vector< std::string > &searchpath)</div></div>
<div class="ttc" id="aclassmingfx_1_1_platform_html_af12cd63e1ede33529d8c282d7d916169"><div class="ttname"><a href="classmingfx_1_1_platform.html#af12cd63e1ede33529d8c282d7d916169">mingfx::Platform::FindMinGfxShaderFile</a></div><div class="ttdeci">static std::string FindMinGfxShaderFile(const std::string &basename)</div><div class="ttdoc">Searches for a shader file that ships with MinGfx.</div></div>
<div class="ttc" id="anamespacemingfx_html"><div class="ttname"><a href="namespacemingfx.html">mingfx</a></div><div class="ttdoc">Namespace for the MinGfx Toolkit.</div><div class="ttdef"><b>Definition:</b> <a href="aabb_8h_source.html#l00021">aabb.h:21</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- 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.png" alt="doxygen"/>
</a> 1.9.1
</small></address>
</body>
</html>
|
