-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_monitor_8h_source.html
75 lines (75 loc) · 16.9 KB
/
_monitor_8h_source.html
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
<!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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Monitor.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.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="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.15.0</span>
</div>
<div id="projectbrief">A C++14 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Monitor.h</div> </div>
</div><!--header-->
<div class="contents">
<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"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2019 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</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> <span class="comment"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef GF_MONITOR_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_MONITOR_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Library.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Vector.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structgf_1_1_video_mode.html"> 41</a></span>  <span class="keyword">struct </span>GF_API <a class="code" href="structgf_1_1_video_mode.html">VideoMode</a> {</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structgf_1_1_video_mode.html#a790e1a2f52f62992138fdbe0d2309b2a"> 42</a></span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> <a class="code" href="structgf_1_1_video_mode.html#a790e1a2f52f62992138fdbe0d2309b2a">size</a>; </div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structgf_1_1_video_mode.html#a3182ee31180cea3f2814700ca5dc3dcc"> 43</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="structgf_1_1_video_mode.html#a3182ee31180cea3f2814700ca5dc3dcc">bitsPerPixel</a>; </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structgf_1_1_video_mode.html#a8f8105444de460ef7bc8013956cc9cc4"> 44</a></span>  <span class="keywordtype">int</span> <a class="code" href="structgf_1_1_video_mode.html#a8f8105444de460ef7bc8013956cc9cc4">refreshRate</a>; </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classgf_1_1_monitor.html"> 51</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_monitor.html">Monitor</a> {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">static</span> <a class="code" href="classgf_1_1_monitor.html">Monitor</a> getPrimaryMonitor();</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> std::vector<Monitor> getAvailableMonitors();</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classgf_1_1_monitor.html">Monitor</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_monitor.html">Monitor</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classgf_1_1_monitor.html">Monitor</a>& operator=(<span class="keyword">const</span> <a class="code" href="classgf_1_1_monitor.html">Monitor</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <a class="code" href="classgf_1_1_monitor.html">Monitor</a>(<a class="code" href="classgf_1_1_monitor.html">Monitor</a>&& other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classgf_1_1_monitor.html">Monitor</a>& operator=(<a class="code" href="classgf_1_1_monitor.html">Monitor</a>&& other) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::string getName() <span class="keyword">const</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> getPosition() <span class="keyword">const</span>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> getPhysicalSize() <span class="keyword">const</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  std::vector<VideoMode> getAvailableVideoModes() <span class="keyword">const</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="structgf_1_1_video_mode.html">VideoMode</a> getCurrentVideoMode() <span class="keyword">const</span>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classgf_1_1_monitor.html#a553f958a25683445088050a69d3de8e9"> 121</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classgf_1_1_window.html">Window</a>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">explicit</span> <a class="code" href="classgf_1_1_monitor.html">Monitor</a>(<span class="keywordtype">int</span> index);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classgf_1_1_library.html">Library</a> m_lib; <span class="comment">// to automatically initialize SDL</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">int</span> m_index;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  };</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> }</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif // GL_MONITOR_H</span></div><div class="ttc" id="structgf_1_1_video_mode_html_a8f8105444de460ef7bc8013956cc9cc4"><div class="ttname"><a href="structgf_1_1_video_mode.html#a8f8105444de460ef7bc8013956cc9cc4">gf::VideoMode::refreshRate</a></div><div class="ttdeci">int refreshRate</div><div class="ttdoc">Video mode refresh rate, in Hz. </div><div class="ttdef"><b>Definition:</b> Monitor.h:44</div></div>
<div class="ttc" id="structgf_1_1_video_mode_html"><div class="ttname"><a href="structgf_1_1_video_mode.html">gf::VideoMode</a></div><div class="ttdoc">A video mode. </div><div class="ttdef"><b>Definition:</b> Monitor.h:41</div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:35</div></div>
<div class="ttc" id="classgf_1_1_library_html"><div class="ttname"><a href="classgf_1_1_library.html">gf::Library</a></div><div class="ttdoc">A class to represent the library. </div><div class="ttdef"><b>Definition:</b> Library.h:44</div></div>
<div class="ttc" id="classgf_1_1_window_html"><div class="ttname"><a href="classgf_1_1_window.html">gf::Window</a></div><div class="ttdoc">An OS window. </div><div class="ttdef"><b>Definition:</b> Window.h:88</div></div>
<div class="ttc" id="classgf_1_1_monitor_html"><div class="ttname"><a href="classgf_1_1_monitor.html">gf::Monitor</a></div><div class="ttdoc">A monitor. </div><div class="ttdef"><b>Definition:</b> Monitor.h:51</div></div>
<div class="ttc" id="structgf_1_1_video_mode_html_a790e1a2f52f62992138fdbe0d2309b2a"><div class="ttname"><a href="structgf_1_1_video_mode.html#a790e1a2f52f62992138fdbe0d2309b2a">gf::VideoMode::size</a></div><div class="ttdeci">Vector2i size</div><div class="ttdoc">Video mode size, in pixels. </div><div class="ttdef"><b>Definition:</b> Monitor.h:42</div></div>
<div class="ttc" id="structgf_1_1_video_mode_html_a3182ee31180cea3f2814700ca5dc3dcc"><div class="ttname"><a href="structgf_1_1_video_mode.html#a3182ee31180cea3f2814700ca5dc3dcc">gf::VideoMode::bitsPerPixel</a></div><div class="ttdeci">unsigned bitsPerPixel</div><div class="ttdoc">Video mode pixel depth, in bits per pixel. </div><div class="ttdef"><b>Definition:</b> Monitor.h:43</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< int, 2 ></a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.8.13
</small></address>
</body>
</html>