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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
<!-- 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: mingfx::Platform 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="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="namespacemingfx.html">mingfx</a></li><li class="navelem"><a class="el" href="classmingfx_1_1_platform.html">Platform</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classmingfx_1_1_platform-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mingfx::Platform Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides access to the underlying file system and other platform-specific routines. </p>
<p class="definition">Definition at line <a class="el" href="platform_8h_source.html#l00026">26</a> of file <a class="el" href="platform_8h_source.html">platform.h</a>.</p>
</div>
<p><code>#include <<a class="el" href="platform_8h_source.html">platform.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a045007efda73123a7f4019837d83bc92"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_platform.html#a045007efda73123a7f4019837d83bc92">FileExists</a> (const std::string &filename)</td></tr>
<tr class="memdesc:a045007efda73123a7f4019837d83bc92"><td class="mdescLeft"> </td><td class="mdescRight">True if filename is found and can be opened for reading on the system. <a href="classmingfx_1_1_platform.html#a045007efda73123a7f4019837d83bc92">More...</a><br /></td></tr>
<tr class="separator:a045007efda73123a7f4019837d83bc92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32a392f4bac832c95fabc2d10bd03ad1"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_platform.html#a32a392f4bac832c95fabc2d10bd03ad1">FindFile</a> (const std::string &basename, const std::vector< std::string > &searchpath)</td></tr>
<tr class="separator:a32a392f4bac832c95fabc2d10bd03ad1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03ade910313dd9580c9e37a7b63f87b2"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_platform.html#a03ade910313dd9580c9e37a7b63f87b2">FindFile</a> (const std::string &basename, const std::string &searchpath)</td></tr>
<tr class="separator:a03ade910313dd9580c9e37a7b63f87b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c36ca57a246efa218a49a942c8c4a3b"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_platform.html#a2c36ca57a246efa218a49a942c8c4a3b">FindMinGfxDataFile</a> (const std::string &basename)</td></tr>
<tr class="memdesc:a2c36ca57a246efa218a49a942c8c4a3b"><td class="mdescLeft"> </td><td class="mdescRight">Searches for a data file that ships with MinGfx. <a href="classmingfx_1_1_platform.html#a2c36ca57a246efa218a49a942c8c4a3b">More...</a><br /></td></tr>
<tr class="separator:a2c36ca57a246efa218a49a942c8c4a3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af12cd63e1ede33529d8c282d7d916169"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classmingfx_1_1_platform.html#af12cd63e1ede33529d8c282d7d916169">FindMinGfxShaderFile</a> (const std::string &basename)</td></tr>
<tr class="memdesc:af12cd63e1ede33529d8c282d7d916169"><td class="mdescLeft"> </td><td class="mdescRight">Searches for a shader file that ships with MinGfx. <a href="classmingfx_1_1_platform.html#af12cd63e1ede33529d8c282d7d916169">More...</a><br /></td></tr>
<tr class="separator:af12cd63e1ede33529d8c282d7d916169"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a045007efda73123a7f4019837d83bc92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a045007efda73123a7f4019837d83bc92">◆ </a></span>FileExists()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool mingfx::Platform::FileExists </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>filename</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>True if filename is found and can be opened for reading on the system. </p>
</div>
</div>
<a id="a03ade910313dd9580c9e37a7b63f87b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03ade910313dd9580c9e37a7b63f87b2">◆ </a></span>FindFile() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string mingfx::Platform::FindFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>basename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>searchpath</em> </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">
</div>
</div>
<a id="a32a392f4bac832c95fabc2d10bd03ad1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32a392f4bac832c95fabc2d10bd03ad1">◆ </a></span>FindFile() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string mingfx::Platform::FindFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>basename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< std::string > & </td>
<td class="paramname"><em>searchpath</em> </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">
</div>
</div>
<a id="a2c36ca57a246efa218a49a942c8c4a3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c36ca57a246efa218a49a942c8c4a3b">◆ </a></span>FindMinGfxDataFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string mingfx::Platform::FindMinGfxDataFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>basename</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>Searches for a data file that ships with MinGfx. </p>
<p>This will look in the following locations in order:</p><ol type="1">
<li>the current working directory.</li>
<li>a subdirectory called data within the current working directory.</li>
<li>the installed data directory INSTALL_PREFIX/share/MinGfx-1.0/data.</li>
<li>the data directory in the MinGfx build tree. If the file is found, the full path is returned, else basename is returned. </li>
</ol>
</div>
</div>
<a id="af12cd63e1ede33529d8c282d7d916169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af12cd63e1ede33529d8c282d7d916169">◆ </a></span>FindMinGfxShaderFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::string mingfx::Platform::FindMinGfxShaderFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>basename</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>Searches for a shader file that ships with MinGfx. </p>
<p>This will look in the following locations in order:</p><ol type="1">
<li>the current working directory.</li>
<li>a subdirectory called shaders within the current working directory.</li>
<li>the installed shaders directory INSTALL_PREFIX/share/MinGfx-1.0/shaders.</li>
<li>the shaders directory in the MinGfx build tree. If the file is found, the full path is returned, else basename is returned. </li>
</ol>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/<a class="el" href="platform_8h_source.html">platform.h</a></li>
</ul>
</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>
|
