-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_render_states_8h_source.html
137 lines (137 loc) · 17.9 KB
/
_render_states_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
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
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): RenderStates.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" async="async" 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign">
<div id="projectname">Gamedev Framework (gf)<span id="projectnumber"> 0.21.0</span>
</div>
<div id="projectbrief">A C++17 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */
</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">RenderStates.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="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Gamedev Framework (gf)</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2016-2021 Julien Bernard</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" 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 id="l00006" 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 id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" 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 id="l00010" 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 id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * freely, subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * appreciated but is not required.</span></div>
<div class="line"><a id="l00017" 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 id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * misrepresented as being the original software.</span></div>
<div class="line"><a id="l00019" 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 id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> *</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * Part of this file comes from SFML, with the same license:</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * Copyright (C) 2007-2015 Laurent Gomila ([email protected])</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> */</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#ifndef GF_RENDER_STATES_H</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#define GF_RENDER_STATES_H</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include "Blend.h"</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include "GraphicsApi.h"</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include "Matrix.h"</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include "Transform.h"</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegf.html">gf</a> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span>BareTexture;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">class </span>Shader;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html"> 82</a></span> <span class="keyword">struct </span>GF_GRAPHICS_API <a class="code hl_struct" href="structgf_1_1_render_states.html">RenderStates</a> {</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#a0d21932a5e5fbf03c65963afc2e28c39"> 83</a></span> <a class="code hl_struct" href="structgf_1_1_blend_mode.html">BlendMode</a> mode = <a class="code hl_variable" href="namespacegf.html#a1fa131411a6a7f3bf3827e46fecc316f">BlendAlpha</a>; </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#a8ebe53edcc7e0d84865a47a41a1f30d0"> 84</a></span> <a class="code hl_class" href="structgf_1_1_matrix.html">Matrix3f</a> <a class="code hl_function" href="group__core__geometry.html#gac4e4c75521a6691a917073fa54a99dcf">transform</a> = <a class="code hl_function" href="group__core__geometry.html#ga6dda386c75e98622d0c0759c5284afc4">identityTransform</a>(); </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#a1f9c9c1fbf24bdeec6a3c735fe9cc5b2"> 85</a></span> <span class="keyword">const</span> <a class="code hl_class" href="classgf_1_1_bare_texture.html">BareTexture</a> *texture [2] = { <span class="keyword">nullptr</span>, <span class="keyword">nullptr</span> }; </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#a38b5fe28cff8f7760bbb9904e3a13f11"> 86</a></span> <a class="code hl_class" href="classgf_1_1_shader.html">Shader</a> *shader = <span class="keyword">nullptr</span>; </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#a991bdf53fea2fc3cb6cd4b20995856b6"> 87</a></span> <span class="keywordtype">float</span> lineWidth = 0.0f; </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> };</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">inline</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="structgf_1_1_render_states.html#afcaee43a461682ade9b7fa4c6db75e51"> 98</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="structgf_1_1_render_states.html#afcaee43a461682ade9b7fa4c6db75e51">operator==</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgf_1_1_render_states.html">RenderStates</a>& lhs, <span class="keyword">const</span> <a class="code hl_struct" href="structgf_1_1_render_states.html">RenderStates</a>& rhs) {</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> lhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a0d21932a5e5fbf03c65963afc2e28c39">mode</a> == rhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a0d21932a5e5fbf03c65963afc2e28c39">mode</a> && lhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a8ebe53edcc7e0d84865a47a41a1f30d0">transform</a> == rhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a8ebe53edcc7e0d84865a47a41a1f30d0">transform</a> && lhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a1f9c9c1fbf24bdeec6a3c735fe9cc5b2">texture</a> == rhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a1f9c9c1fbf24bdeec6a3c735fe9cc5b2">texture</a> && lhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a38b5fe28cff8f7760bbb9904e3a13f11">shader</a> == rhs.<a class="code hl_variable" href="structgf_1_1_render_states.html#a38b5fe28cff8f7760bbb9904e3a13f11">shader</a>;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> }</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>}</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="preprocessor">#endif </span><span class="comment">// GF_RENDER_STATES_H</span></div>
<div class="ttc" id="aclassgf_1_1_bare_texture_html"><div class="ttname"><a href="classgf_1_1_bare_texture.html">gf::BareTexture</a></div><div class="ttdoc">An image that lives in the graphic memory that can be used for drawing.</div><div class="ttdef"><b>Definition:</b> Texture.h:79</div></div>
<div class="ttc" id="aclassgf_1_1_shader_html"><div class="ttname"><a href="classgf_1_1_shader.html">gf::Shader</a></div><div class="ttdoc">An OpenGL vertex and/or fragment shader.</div><div class="ttdef"><b>Definition:</b> Shader.h:119</div></div>
<div class="ttc" id="agroup__core__geometry_html_ga6dda386c75e98622d0c0759c5284afc4"><div class="ttname"><a href="group__core__geometry.html#ga6dda386c75e98622d0c0759c5284afc4">gf::identityTransform</a></div><div class="ttdeci">constexpr Matrix3f identityTransform()</div><div class="ttdoc">Identity transform.</div><div class="ttdef"><b>Definition:</b> Transform.h:349</div></div>
<div class="ttc" id="agroup__core__geometry_html_gac4e4c75521a6691a917073fa54a99dcf"><div class="ttname"><a href="group__core__geometry.html#gac4e4c75521a6691a917073fa54a99dcf">gf::transform</a></div><div class="ttdeci">constexpr Vector2f transform(const Matrix3f &mat, Vector2f point)</div><div class="ttdoc">Apply an affine transformation to a 2D point.</div><div class="ttdef"><b>Definition:</b> Transform.h:326</div></div>
<div class="ttc" id="anamespacegf_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="anamespacegf_html_a1fa131411a6a7f3bf3827e46fecc316f"><div class="ttname"><a href="namespacegf.html#a1fa131411a6a7f3bf3827e46fecc316f">gf::BlendAlpha</a></div><div class="ttdeci">constexpr BlendMode BlendAlpha</div><div class="ttdoc">Alpha blend mode.</div><div class="ttdef"><b>Definition:</b> Blend.h:211</div></div>
<div class="ttc" id="astructgf_1_1_blend_mode_html"><div class="ttname"><a href="structgf_1_1_blend_mode.html">gf::BlendMode</a></div><div class="ttdoc">Blending modes for drawing.</div><div class="ttdef"><b>Definition:</b> Blend.h:126</div></div>
<div class="ttc" id="astructgf_1_1_matrix_html"><div class="ttname"><a href="structgf_1_1_matrix.html">gf::Matrix< float, 3, 3 ></a></div></div>
<div class="ttc" id="astructgf_1_1_render_states_html"><div class="ttname"><a href="structgf_1_1_render_states.html">gf::RenderStates</a></div><div class="ttdoc">Define the states used for drawing to a RenderTarget.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:82</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html_a0d21932a5e5fbf03c65963afc2e28c39"><div class="ttname"><a href="structgf_1_1_render_states.html#a0d21932a5e5fbf03c65963afc2e28c39">gf::RenderStates::mode</a></div><div class="ttdeci">BlendMode mode</div><div class="ttdoc">The blending mode.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:83</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html_a1f9c9c1fbf24bdeec6a3c735fe9cc5b2"><div class="ttname"><a href="structgf_1_1_render_states.html#a1f9c9c1fbf24bdeec6a3c735fe9cc5b2">gf::RenderStates::texture</a></div><div class="ttdeci">const BareTexture * texture[2]</div><div class="ttdoc">The texture.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:85</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html_a38b5fe28cff8f7760bbb9904e3a13f11"><div class="ttname"><a href="structgf_1_1_render_states.html#a38b5fe28cff8f7760bbb9904e3a13f11">gf::RenderStates::shader</a></div><div class="ttdeci">Shader * shader</div><div class="ttdoc">The shader.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:86</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html_a8ebe53edcc7e0d84865a47a41a1f30d0"><div class="ttname"><a href="structgf_1_1_render_states.html#a8ebe53edcc7e0d84865a47a41a1f30d0">gf::RenderStates::transform</a></div><div class="ttdeci">Matrix3f transform</div><div class="ttdoc">The transform matrix.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:84</div></div>
<div class="ttc" id="astructgf_1_1_render_states_html_afcaee43a461682ade9b7fa4c6db75e51"><div class="ttname"><a href="structgf_1_1_render_states.html#afcaee43a461682ade9b7fa4c6db75e51">gf::RenderStates::operator==</a></div><div class="ttdeci">bool operator==(const RenderStates &lhs, const RenderStates &rhs)</div><div class="ttdoc">Check render states equality.</div><div class="ttdef"><b>Definition:</b> RenderStates.h:98</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>