RmlUi_Renderer_GL3.cpp 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019-2023 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "RmlUi_Renderer_GL3.h"
  29. #include <RmlUi/Core/Core.h>
  30. #include <RmlUi/Core/DecorationTypes.h>
  31. #include <RmlUi/Core/FileInterface.h>
  32. #include <RmlUi/Core/Geometry.h>
  33. #include <RmlUi/Core/Log.h>
  34. #include <RmlUi/Core/MeshUtilities.h>
  35. #include <RmlUi/Core/Platform.h>
  36. #include <RmlUi/Core/SystemInterface.h>
  37. #include <algorithm>
  38. #include <string.h>
  39. #if defined(RMLUI_PLATFORM_WIN32) && !defined(__MINGW32__)
  40. // function call missing argument list
  41. #pragma warning(disable : 4551)
  42. // unreferenced local function has been removed
  43. #pragma warning(disable : 4505)
  44. #endif
  45. #if defined RMLUI_PLATFORM_EMSCRIPTEN
  46. #define RMLUI_SHADER_HEADER_VERSION "#version 300 es\nprecision highp float;\n"
  47. #include <GLES3/gl3.h>
  48. #elif defined RMLUI_GL3_CUSTOM_LOADER
  49. #define RMLUI_SHADER_HEADER_VERSION "#version 330\n"
  50. #include RMLUI_GL3_CUSTOM_LOADER
  51. #else
  52. #define RMLUI_SHADER_HEADER_VERSION "#version 330\n"
  53. #define GLAD_GL_IMPLEMENTATION
  54. #include "RmlUi_Include_GL3.h"
  55. #endif
  56. // Determines the anti-aliasing quality when creating layers. Enables better-looking visuals, especially when transforms are applied.
  57. #ifndef RMLUI_NUM_MSAA_SAMPLES
  58. #define RMLUI_NUM_MSAA_SAMPLES 2
  59. #endif
  60. #define MAX_NUM_STOPS 16
  61. #define BLUR_SIZE 7
  62. #define BLUR_NUM_WEIGHTS ((BLUR_SIZE + 1) / 2)
  63. #define RMLUI_STRINGIFY_IMPL(x) #x
  64. #define RMLUI_STRINGIFY(x) RMLUI_STRINGIFY_IMPL(x)
  65. #define RMLUI_SHADER_HEADER \
  66. RMLUI_SHADER_HEADER_VERSION "#define MAX_NUM_STOPS " RMLUI_STRINGIFY(MAX_NUM_STOPS) "\n#line " RMLUI_STRINGIFY(__LINE__) "\n"
  67. static const char* shader_vert_main = RMLUI_SHADER_HEADER R"(
  68. uniform vec2 _translate;
  69. uniform mat4 _transform;
  70. in vec2 inPosition;
  71. in vec4 inColor0;
  72. in vec2 inTexCoord0;
  73. out vec2 fragTexCoord;
  74. out vec4 fragColor;
  75. void main() {
  76. fragTexCoord = inTexCoord0;
  77. fragColor = inColor0;
  78. vec2 translatedPos = inPosition + _translate;
  79. vec4 outPos = _transform * vec4(translatedPos, 0.0, 1.0);
  80. gl_Position = outPos;
  81. }
  82. )";
  83. static const char* shader_frag_texture = RMLUI_SHADER_HEADER R"(
  84. uniform sampler2D _tex;
  85. in vec2 fragTexCoord;
  86. in vec4 fragColor;
  87. out vec4 finalColor;
  88. void main() {
  89. vec4 texColor = texture(_tex, fragTexCoord);
  90. finalColor = fragColor * texColor;
  91. }
  92. )";
  93. static const char* shader_frag_color = RMLUI_SHADER_HEADER R"(
  94. in vec2 fragTexCoord;
  95. in vec4 fragColor;
  96. out vec4 finalColor;
  97. void main() {
  98. finalColor = fragColor;
  99. }
  100. )";
  101. enum class ShaderGradientFunction { Linear, Radial, Conic, RepeatingLinear, RepeatingRadial, RepeatingConic }; // Must match shader definitions below.
  102. static const char* shader_frag_gradient = RMLUI_SHADER_HEADER R"(
  103. #define LINEAR 0
  104. #define RADIAL 1
  105. #define CONIC 2
  106. #define REPEATING_LINEAR 3
  107. #define REPEATING_RADIAL 4
  108. #define REPEATING_CONIC 5
  109. #define PI 3.14159265
  110. uniform int _func; // one of the above definitions
  111. uniform vec2 _p; // linear: starting point, radial: center, conic: center
  112. uniform vec2 _v; // linear: vector to ending point, radial: 2d curvature (inverse radius), conic: angled unit vector
  113. uniform vec4 _stop_colors[MAX_NUM_STOPS];
  114. uniform float _stop_positions[MAX_NUM_STOPS]; // normalized, 0 -> starting point, 1 -> ending point
  115. uniform int _num_stops;
  116. in vec2 fragTexCoord;
  117. in vec4 fragColor;
  118. out vec4 finalColor;
  119. vec4 mix_stop_colors(float t) {
  120. vec4 color = _stop_colors[0];
  121. for (int i = 1; i < _num_stops; i++)
  122. color = mix(color, _stop_colors[i], smoothstep(_stop_positions[i-1], _stop_positions[i], t));
  123. return color;
  124. }
  125. void main() {
  126. float t = 0.0;
  127. if (_func == LINEAR || _func == REPEATING_LINEAR)
  128. {
  129. float dist_square = dot(_v, _v);
  130. vec2 V = fragTexCoord - _p;
  131. t = dot(_v, V) / dist_square;
  132. }
  133. else if (_func == RADIAL || _func == REPEATING_RADIAL)
  134. {
  135. vec2 V = fragTexCoord - _p;
  136. t = length(_v * V);
  137. }
  138. else if (_func == CONIC || _func == REPEATING_CONIC)
  139. {
  140. mat2 R = mat2(_v.x, -_v.y, _v.y, _v.x);
  141. vec2 V = R * (fragTexCoord - _p);
  142. t = 0.5 + atan(-V.x, V.y) / (2.0 * PI);
  143. }
  144. if (_func == REPEATING_LINEAR || _func == REPEATING_RADIAL || _func == REPEATING_CONIC)
  145. {
  146. float t0 = _stop_positions[0];
  147. float t1 = _stop_positions[_num_stops - 1];
  148. t = t0 + mod(t - t0, t1 - t0);
  149. }
  150. finalColor = fragColor * mix_stop_colors(t);
  151. }
  152. )";
  153. // "Creation" by Danilo Guanabara, based on: https://www.shadertoy.com/view/XsXXDn
  154. static const char* shader_frag_creation = RMLUI_SHADER_HEADER R"(
  155. uniform float _value;
  156. uniform vec2 _dimensions;
  157. in vec2 fragTexCoord;
  158. in vec4 fragColor;
  159. out vec4 finalColor;
  160. void main() {
  161. float t = _value;
  162. vec3 c;
  163. float l;
  164. for (int i = 0; i < 3; i++) {
  165. vec2 p = fragTexCoord;
  166. vec2 uv = p;
  167. p -= .5;
  168. p.x *= _dimensions.x / _dimensions.y;
  169. float z = t + float(i) * .07;
  170. l = length(p);
  171. uv += p / l * (sin(z) + 1.) * abs(sin(l * 9. - z - z));
  172. c[i] = .01 / length(mod(uv, 1.) - .5);
  173. }
  174. finalColor = vec4(c / l, fragColor.a);
  175. }
  176. )";
  177. static const char* shader_vert_passthrough = RMLUI_SHADER_HEADER R"(
  178. in vec2 inPosition;
  179. in vec2 inTexCoord0;
  180. out vec2 fragTexCoord;
  181. void main() {
  182. fragTexCoord = inTexCoord0;
  183. gl_Position = vec4(inPosition, 0.0, 1.0);
  184. }
  185. )";
  186. static const char* shader_frag_passthrough = RMLUI_SHADER_HEADER R"(
  187. uniform sampler2D _tex;
  188. in vec2 fragTexCoord;
  189. out vec4 finalColor;
  190. void main() {
  191. finalColor = texture(_tex, fragTexCoord);
  192. }
  193. )";
  194. static const char* shader_frag_color_matrix = RMLUI_SHADER_HEADER R"(
  195. uniform sampler2D _tex;
  196. uniform mat4 _color_matrix;
  197. in vec2 fragTexCoord;
  198. out vec4 finalColor;
  199. void main() {
  200. // The general case uses a 4x5 color matrix for full rgba transformation, plus a constant term with the last column.
  201. // However, we only consider the case of rgb transformations. Thus, we could in principle use a 3x4 matrix, but we
  202. // keep the alpha row for simplicity.
  203. // In the general case we should do the matrix transformation in non-premultiplied space. However, without alpha
  204. // transformations, we can do it directly in premultiplied space to avoid the extra division and multiplication
  205. // steps. In this space, the constant term needs to be multiplied by the alpha value, instead of unity.
  206. vec4 texColor = texture(_tex, fragTexCoord);
  207. vec3 transformedColor = vec3(_color_matrix * texColor);
  208. finalColor = vec4(transformedColor, texColor.a);
  209. }
  210. )";
  211. static const char* shader_frag_blend_mask = RMLUI_SHADER_HEADER R"(
  212. uniform sampler2D _tex;
  213. uniform sampler2D _texMask;
  214. in vec2 fragTexCoord;
  215. out vec4 finalColor;
  216. void main() {
  217. vec4 texColor = texture(_tex, fragTexCoord);
  218. float maskAlpha = texture(_texMask, fragTexCoord).a;
  219. finalColor = texColor * maskAlpha;
  220. }
  221. )";
  222. #define RMLUI_SHADER_BLUR_HEADER \
  223. RMLUI_SHADER_HEADER "\n#define BLUR_SIZE " RMLUI_STRINGIFY(BLUR_SIZE) "\n#define BLUR_NUM_WEIGHTS " RMLUI_STRINGIFY(BLUR_NUM_WEIGHTS)
  224. static const char* shader_vert_blur = RMLUI_SHADER_BLUR_HEADER R"(
  225. uniform vec2 _texelOffset;
  226. in vec3 inPosition;
  227. in vec2 inTexCoord0;
  228. out vec2 fragTexCoord[BLUR_SIZE];
  229. void main() {
  230. for(int i = 0; i < BLUR_SIZE; i++)
  231. fragTexCoord[i] = inTexCoord0 - float(i - BLUR_NUM_WEIGHTS + 1) * _texelOffset;
  232. gl_Position = vec4(inPosition, 1.0);
  233. }
  234. )";
  235. static const char* shader_frag_blur = RMLUI_SHADER_BLUR_HEADER R"(
  236. uniform sampler2D _tex;
  237. uniform float _weights[BLUR_NUM_WEIGHTS];
  238. uniform vec2 _texCoordMin;
  239. uniform vec2 _texCoordMax;
  240. in vec2 fragTexCoord[BLUR_SIZE];
  241. out vec4 finalColor;
  242. void main() {
  243. vec4 color = vec4(0.0, 0.0, 0.0, 0.0);
  244. for(int i = 0; i < BLUR_SIZE; i++)
  245. {
  246. vec2 in_region = step(_texCoordMin, fragTexCoord[i]) * step(fragTexCoord[i], _texCoordMax);
  247. color += texture(_tex, fragTexCoord[i]) * in_region.x * in_region.y * _weights[abs(i - BLUR_NUM_WEIGHTS + 1)];
  248. }
  249. finalColor = color;
  250. }
  251. )";
  252. static const char* shader_frag_drop_shadow = RMLUI_SHADER_HEADER R"(
  253. uniform sampler2D _tex;
  254. uniform vec2 _texCoordMin;
  255. uniform vec2 _texCoordMax;
  256. uniform vec4 _color;
  257. in vec2 fragTexCoord;
  258. out vec4 finalColor;
  259. void main() {
  260. vec2 in_region = step(_texCoordMin, fragTexCoord) * step(fragTexCoord, _texCoordMax);
  261. finalColor = texture(_tex, fragTexCoord).a * in_region.x * in_region.y * _color;
  262. }
  263. )";
  264. enum class ProgramId {
  265. None,
  266. Color,
  267. Texture,
  268. Gradient,
  269. Creation,
  270. Passthrough,
  271. ColorMatrix,
  272. BlendMask,
  273. Blur,
  274. DropShadow,
  275. Count,
  276. };
  277. enum class VertShaderId {
  278. Main,
  279. Passthrough,
  280. Blur,
  281. Count,
  282. };
  283. enum class FragShaderId {
  284. Color,
  285. Texture,
  286. Gradient,
  287. Creation,
  288. Passthrough,
  289. ColorMatrix,
  290. BlendMask,
  291. Blur,
  292. DropShadow,
  293. Count,
  294. };
  295. enum class UniformId {
  296. Translate,
  297. Transform,
  298. Tex,
  299. Color,
  300. ColorMatrix,
  301. TexelOffset,
  302. TexCoordMin,
  303. TexCoordMax,
  304. TexMask,
  305. Weights,
  306. Func,
  307. P,
  308. V,
  309. StopColors,
  310. StopPositions,
  311. NumStops,
  312. Value,
  313. Dimensions,
  314. Count,
  315. };
  316. namespace Gfx {
  317. static const char* const program_uniform_names[(size_t)UniformId::Count] = {"_translate", "_transform", "_tex", "_color", "_color_matrix",
  318. "_texelOffset", "_texCoordMin", "_texCoordMax", "_texMask", "_weights[0]", "_func", "_p", "_v", "_stop_colors[0]", "_stop_positions[0]",
  319. "_num_stops", "_value", "_dimensions"};
  320. enum class VertexAttribute { Position, Color0, TexCoord0, Count };
  321. static const char* const vertex_attribute_names[(size_t)VertexAttribute::Count] = {"inPosition", "inColor0", "inTexCoord0"};
  322. struct VertShaderDefinition {
  323. VertShaderId id;
  324. const char* name_str;
  325. const char* code_str;
  326. };
  327. struct FragShaderDefinition {
  328. FragShaderId id;
  329. const char* name_str;
  330. const char* code_str;
  331. };
  332. struct ProgramDefinition {
  333. ProgramId id;
  334. const char* name_str;
  335. VertShaderId vert_shader;
  336. FragShaderId frag_shader;
  337. };
  338. // clang-format off
  339. static const VertShaderDefinition vert_shader_definitions[] = {
  340. {VertShaderId::Main, "main", shader_vert_main},
  341. {VertShaderId::Passthrough, "passthrough", shader_vert_passthrough},
  342. {VertShaderId::Blur, "blur", shader_vert_blur},
  343. };
  344. static const FragShaderDefinition frag_shader_definitions[] = {
  345. {FragShaderId::Color, "color", shader_frag_color},
  346. {FragShaderId::Texture, "texture", shader_frag_texture},
  347. {FragShaderId::Gradient, "gradient", shader_frag_gradient},
  348. {FragShaderId::Creation, "creation", shader_frag_creation},
  349. {FragShaderId::Passthrough, "passthrough", shader_frag_passthrough},
  350. {FragShaderId::ColorMatrix, "color_matrix", shader_frag_color_matrix},
  351. {FragShaderId::BlendMask, "blend_mask", shader_frag_blend_mask},
  352. {FragShaderId::Blur, "blur", shader_frag_blur},
  353. {FragShaderId::DropShadow, "drop_shadow", shader_frag_drop_shadow},
  354. };
  355. static const ProgramDefinition program_definitions[] = {
  356. {ProgramId::Color, "color", VertShaderId::Main, FragShaderId::Color},
  357. {ProgramId::Texture, "texture", VertShaderId::Main, FragShaderId::Texture},
  358. {ProgramId::Gradient, "gradient", VertShaderId::Main, FragShaderId::Gradient},
  359. {ProgramId::Creation, "creation", VertShaderId::Main, FragShaderId::Creation},
  360. {ProgramId::Passthrough, "passthrough", VertShaderId::Passthrough, FragShaderId::Passthrough},
  361. {ProgramId::ColorMatrix, "color_matrix", VertShaderId::Passthrough, FragShaderId::ColorMatrix},
  362. {ProgramId::BlendMask, "blend_mask", VertShaderId::Passthrough, FragShaderId::BlendMask},
  363. {ProgramId::Blur, "blur", VertShaderId::Blur, FragShaderId::Blur},
  364. {ProgramId::DropShadow, "drop_shadow", VertShaderId::Passthrough, FragShaderId::DropShadow},
  365. };
  366. // clang-format on
  367. template <typename T, typename Enum>
  368. class EnumArray {
  369. public:
  370. const T& operator[](Enum id) const
  371. {
  372. RMLUI_ASSERT((size_t)id < (size_t)Enum::Count);
  373. return ids[size_t(id)];
  374. }
  375. T& operator[](Enum id)
  376. {
  377. RMLUI_ASSERT((size_t)id < (size_t)Enum::Count);
  378. return ids[size_t(id)];
  379. }
  380. auto begin() const { return ids.begin(); }
  381. auto end() const { return ids.end(); }
  382. private:
  383. Rml::Array<T, (size_t)Enum::Count> ids = {};
  384. };
  385. using Programs = EnumArray<GLuint, ProgramId>;
  386. using VertShaders = EnumArray<GLuint, VertShaderId>;
  387. using FragShaders = EnumArray<GLuint, FragShaderId>;
  388. class Uniforms {
  389. public:
  390. GLint Get(ProgramId id, UniformId uniform) const
  391. {
  392. auto it = map.find(ToKey(id, uniform));
  393. if (it != map.end())
  394. return it->second;
  395. return -1;
  396. }
  397. void Insert(ProgramId id, UniformId uniform, GLint location) { map[ToKey(id, uniform)] = location; }
  398. private:
  399. using Key = uint64_t;
  400. Key ToKey(ProgramId id, UniformId uniform) const { return (static_cast<Key>(id) << 32) | static_cast<Key>(uniform); }
  401. Rml::UnorderedMap<Key, GLint> map;
  402. };
  403. struct ProgramData {
  404. Programs programs;
  405. VertShaders vert_shaders;
  406. FragShaders frag_shaders;
  407. Uniforms uniforms;
  408. };
  409. struct CompiledGeometryData {
  410. GLuint vao;
  411. GLuint vbo;
  412. GLuint ibo;
  413. GLsizei draw_count;
  414. };
  415. struct FramebufferData {
  416. int width, height;
  417. GLuint framebuffer;
  418. GLuint color_tex_buffer;
  419. GLuint color_render_buffer;
  420. GLuint depth_stencil_buffer;
  421. bool owns_depth_stencil_buffer;
  422. };
  423. enum class FramebufferAttachment { None, DepthStencil };
  424. static void CheckGLError(const char* operation_name)
  425. {
  426. #ifdef RMLUI_DEBUG
  427. GLenum error_code = glGetError();
  428. if (error_code != GL_NO_ERROR)
  429. {
  430. static const Rml::Pair<GLenum, const char*> error_names[] = {{GL_INVALID_ENUM, "GL_INVALID_ENUM"}, {GL_INVALID_VALUE, "GL_INVALID_VALUE"},
  431. {GL_INVALID_OPERATION, "GL_INVALID_OPERATION"}, {GL_OUT_OF_MEMORY, "GL_OUT_OF_MEMORY"}};
  432. const char* error_str = "''";
  433. for (auto& err : error_names)
  434. {
  435. if (err.first == error_code)
  436. {
  437. error_str = err.second;
  438. break;
  439. }
  440. }
  441. Rml::Log::Message(Rml::Log::LT_ERROR, "OpenGL error during %s. Error code 0x%x (%s).", operation_name, error_code, error_str);
  442. }
  443. #endif
  444. (void)operation_name;
  445. }
  446. // Create the shader, 'shader_type' is either GL_VERTEX_SHADER or GL_FRAGMENT_SHADER.
  447. static bool CreateShader(GLuint& out_shader_id, GLenum shader_type, const char* code_string)
  448. {
  449. RMLUI_ASSERT(shader_type == GL_VERTEX_SHADER || shader_type == GL_FRAGMENT_SHADER);
  450. GLuint id = glCreateShader(shader_type);
  451. glShaderSource(id, 1, (const GLchar**)&code_string, NULL);
  452. glCompileShader(id);
  453. GLint status = 0;
  454. glGetShaderiv(id, GL_COMPILE_STATUS, &status);
  455. if (status == GL_FALSE)
  456. {
  457. GLint info_log_length = 0;
  458. glGetShaderiv(id, GL_INFO_LOG_LENGTH, &info_log_length);
  459. char* info_log_string = new char[info_log_length + 1];
  460. glGetShaderInfoLog(id, info_log_length, NULL, info_log_string);
  461. Rml::Log::Message(Rml::Log::LT_ERROR, "Compile failure in OpenGL shader: %s", info_log_string);
  462. delete[] info_log_string;
  463. glDeleteShader(id);
  464. return false;
  465. }
  466. CheckGLError("CreateShader");
  467. out_shader_id = id;
  468. return true;
  469. }
  470. static bool CreateProgram(GLuint& out_program, Uniforms& inout_uniform_map, ProgramId program_id, GLuint vertex_shader, GLuint fragment_shader)
  471. {
  472. GLuint id = glCreateProgram();
  473. RMLUI_ASSERT(id);
  474. for (GLuint i = 0; i < (GLuint)VertexAttribute::Count; i++)
  475. glBindAttribLocation(id, i, vertex_attribute_names[i]);
  476. CheckGLError("BindAttribLocations");
  477. glAttachShader(id, vertex_shader);
  478. glAttachShader(id, fragment_shader);
  479. glLinkProgram(id);
  480. glDetachShader(id, vertex_shader);
  481. glDetachShader(id, fragment_shader);
  482. GLint status = 0;
  483. glGetProgramiv(id, GL_LINK_STATUS, &status);
  484. if (status == GL_FALSE)
  485. {
  486. GLint info_log_length = 0;
  487. glGetProgramiv(id, GL_INFO_LOG_LENGTH, &info_log_length);
  488. char* info_log_string = new char[info_log_length + 1];
  489. glGetProgramInfoLog(id, info_log_length, NULL, info_log_string);
  490. Rml::Log::Message(Rml::Log::LT_ERROR, "OpenGL program linking failure: %s", info_log_string);
  491. delete[] info_log_string;
  492. glDeleteProgram(id);
  493. return false;
  494. }
  495. out_program = id;
  496. // Make a lookup table for the uniform locations.
  497. GLint num_active_uniforms = 0;
  498. glGetProgramiv(id, GL_ACTIVE_UNIFORMS, &num_active_uniforms);
  499. constexpr size_t name_size = 64;
  500. GLchar name_buf[name_size] = "";
  501. for (int unif = 0; unif < num_active_uniforms; ++unif)
  502. {
  503. GLint array_size = 0;
  504. GLenum type = 0;
  505. GLsizei actual_length = 0;
  506. glGetActiveUniform(id, unif, name_size, &actual_length, &array_size, &type, name_buf);
  507. GLint location = glGetUniformLocation(id, name_buf);
  508. // See if we have the name in our pre-defined name list.
  509. UniformId program_uniform = UniformId::Count;
  510. for (int i = 0; i < (int)UniformId::Count; i++)
  511. {
  512. const char* uniform_name = program_uniform_names[i];
  513. if (strcmp(name_buf, uniform_name) == 0)
  514. {
  515. program_uniform = (UniformId)i;
  516. break;
  517. }
  518. }
  519. if ((size_t)program_uniform < (size_t)UniformId::Count)
  520. {
  521. inout_uniform_map.Insert(program_id, program_uniform, location);
  522. }
  523. else
  524. {
  525. Rml::Log::Message(Rml::Log::LT_ERROR, "OpenGL program uses unknown uniform '%s'.", name_buf);
  526. return false;
  527. }
  528. }
  529. CheckGLError("CreateProgram");
  530. return true;
  531. }
  532. static bool CreateFramebuffer(FramebufferData& out_fb, int width, int height, int samples, FramebufferAttachment attachment,
  533. GLuint shared_depth_stencil_buffer)
  534. {
  535. #ifdef RMLUI_PLATFORM_EMSCRIPTEN
  536. constexpr GLint wrap_mode = GL_CLAMP_TO_EDGE;
  537. #else
  538. constexpr GLint wrap_mode = GL_CLAMP_TO_BORDER; // GL_REPEAT GL_MIRRORED_REPEAT GL_CLAMP_TO_EDGE
  539. #endif
  540. constexpr GLenum color_format = GL_RGBA8; // GL_RGBA8 GL_SRGB8_ALPHA8 GL_RGBA16F
  541. constexpr GLint min_mag_filter = GL_LINEAR; // GL_NEAREST
  542. const Rml::Colourf border_color(0.f, 0.f);
  543. GLuint framebuffer = 0;
  544. glGenFramebuffers(1, &framebuffer);
  545. glBindFramebuffer(GL_FRAMEBUFFER, framebuffer);
  546. GLuint color_tex_buffer = 0;
  547. GLuint color_render_buffer = 0;
  548. if (samples > 0)
  549. {
  550. glGenRenderbuffers(1, &color_render_buffer);
  551. glBindRenderbuffer(GL_RENDERBUFFER, color_render_buffer);
  552. glRenderbufferStorageMultisample(GL_RENDERBUFFER, samples, color_format, width, height);
  553. glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_RENDERBUFFER, color_render_buffer);
  554. }
  555. else
  556. {
  557. glGenTextures(1, &color_tex_buffer);
  558. glBindTexture(GL_TEXTURE_2D, color_tex_buffer);
  559. glTexImage2D(GL_TEXTURE_2D, 0, color_format, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, NULL);
  560. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, min_mag_filter);
  561. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, min_mag_filter);
  562. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, wrap_mode);
  563. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, wrap_mode);
  564. #ifndef RMLUI_PLATFORM_EMSCRIPTEN
  565. glTexParameterfv(GL_TEXTURE_2D, GL_TEXTURE_BORDER_COLOR, &border_color[0]);
  566. #endif
  567. glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, color_tex_buffer, 0);
  568. }
  569. // Create depth/stencil buffer storage attachment.
  570. GLuint depth_stencil_buffer = 0;
  571. if (attachment != FramebufferAttachment::None)
  572. {
  573. if (shared_depth_stencil_buffer)
  574. {
  575. // Share depth/stencil buffer
  576. depth_stencil_buffer = shared_depth_stencil_buffer;
  577. }
  578. else
  579. {
  580. // Create new depth/stencil buffer
  581. glGenRenderbuffers(1, &depth_stencil_buffer);
  582. glBindRenderbuffer(GL_RENDERBUFFER, depth_stencil_buffer);
  583. glRenderbufferStorageMultisample(GL_RENDERBUFFER, samples, GL_DEPTH24_STENCIL8, width, height);
  584. }
  585. glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_STENCIL_ATTACHMENT, GL_RENDERBUFFER, depth_stencil_buffer);
  586. }
  587. const GLuint framebuffer_status = glCheckFramebufferStatus(GL_FRAMEBUFFER);
  588. if (framebuffer_status != GL_FRAMEBUFFER_COMPLETE)
  589. {
  590. Rml::Log::Message(Rml::Log::LT_ERROR, "OpenGL framebuffer could not be generated. Error code %x.", framebuffer_status);
  591. return false;
  592. }
  593. glBindFramebuffer(GL_FRAMEBUFFER, 0);
  594. glBindTexture(GL_TEXTURE_2D, 0);
  595. glBindRenderbuffer(GL_RENDERBUFFER, 0);
  596. CheckGLError("CreateFramebuffer");
  597. out_fb = {};
  598. out_fb.width = width;
  599. out_fb.height = height;
  600. out_fb.framebuffer = framebuffer;
  601. out_fb.color_tex_buffer = color_tex_buffer;
  602. out_fb.color_render_buffer = color_render_buffer;
  603. out_fb.depth_stencil_buffer = depth_stencil_buffer;
  604. out_fb.owns_depth_stencil_buffer = !shared_depth_stencil_buffer;
  605. return true;
  606. }
  607. static void DestroyFramebuffer(FramebufferData& fb)
  608. {
  609. if (fb.framebuffer)
  610. glDeleteFramebuffers(1, &fb.framebuffer);
  611. if (fb.color_tex_buffer)
  612. glDeleteTextures(1, &fb.color_tex_buffer);
  613. if (fb.color_render_buffer)
  614. glDeleteRenderbuffers(1, &fb.color_render_buffer);
  615. if (fb.owns_depth_stencil_buffer && fb.depth_stencil_buffer)
  616. glDeleteRenderbuffers(1, &fb.depth_stencil_buffer);
  617. fb = {};
  618. }
  619. static void BindTexture(const FramebufferData& fb)
  620. {
  621. if (!fb.color_tex_buffer)
  622. {
  623. RMLUI_ERRORMSG("Only framebuffers with color textures can be bound as textures. This framebuffer probably uses multisampling which needs a "
  624. "blit step first.");
  625. }
  626. glBindTexture(GL_TEXTURE_2D, fb.color_tex_buffer);
  627. }
  628. static bool CreateShaders(ProgramData& data)
  629. {
  630. RMLUI_ASSERT(std::all_of(data.vert_shaders.begin(), data.vert_shaders.end(), [](auto&& value) { return value == 0; }));
  631. RMLUI_ASSERT(std::all_of(data.frag_shaders.begin(), data.frag_shaders.end(), [](auto&& value) { return value == 0; }));
  632. RMLUI_ASSERT(std::all_of(data.programs.begin(), data.programs.end(), [](auto&& value) { return value == 0; }));
  633. auto ReportError = [](const char* type, const char* name) {
  634. Rml::Log::Message(Rml::Log::LT_ERROR, "Could not create OpenGL %s: '%s'.", type, name);
  635. return false;
  636. };
  637. for (const VertShaderDefinition& def : vert_shader_definitions)
  638. {
  639. if (!CreateShader(data.vert_shaders[def.id], GL_VERTEX_SHADER, def.code_str))
  640. return ReportError("vertex shader", def.name_str);
  641. }
  642. for (const FragShaderDefinition& def : frag_shader_definitions)
  643. {
  644. if (!CreateShader(data.frag_shaders[def.id], GL_FRAGMENT_SHADER, def.code_str))
  645. return ReportError("fragment shader", def.name_str);
  646. }
  647. for (const ProgramDefinition& def : program_definitions)
  648. {
  649. if (!CreateProgram(data.programs[def.id], data.uniforms, def.id, data.vert_shaders[def.vert_shader], data.frag_shaders[def.frag_shader]))
  650. return ReportError("program", def.name_str);
  651. }
  652. glUseProgram(data.programs[ProgramId::BlendMask]);
  653. glUniform1i(data.uniforms.Get(ProgramId::BlendMask, UniformId::TexMask), 1);
  654. glUseProgram(0);
  655. return true;
  656. }
  657. static void DestroyShaders(const ProgramData& data)
  658. {
  659. for (GLuint id : data.programs)
  660. glDeleteProgram(id);
  661. for (GLuint id : data.vert_shaders)
  662. glDeleteShader(id);
  663. for (GLuint id : data.frag_shaders)
  664. glDeleteShader(id);
  665. }
  666. } // namespace Gfx
  667. RenderInterface_GL3::RenderInterface_GL3()
  668. {
  669. auto mut_program_data = Rml::MakeUnique<Gfx::ProgramData>();
  670. if (Gfx::CreateShaders(*mut_program_data))
  671. {
  672. program_data = std::move(mut_program_data);
  673. Rml::Mesh mesh;
  674. Rml::MeshUtilities::GenerateQuad(mesh, Rml::Vector2f(-1), Rml::Vector2f(2), {});
  675. fullscreen_quad_geometry = RenderInterface_GL3::CompileGeometry(mesh.vertices, mesh.indices);
  676. }
  677. }
  678. RenderInterface_GL3::~RenderInterface_GL3()
  679. {
  680. if (fullscreen_quad_geometry)
  681. {
  682. RenderInterface_GL3::ReleaseGeometry(fullscreen_quad_geometry);
  683. fullscreen_quad_geometry = {};
  684. }
  685. if (program_data)
  686. {
  687. Gfx::DestroyShaders(*program_data);
  688. program_data.reset();
  689. }
  690. }
  691. void RenderInterface_GL3::SetViewport(int width, int height, int offset_x, int offset_y)
  692. {
  693. viewport_width = Rml::Math::Max(width, 1);
  694. viewport_height = Rml::Math::Max(height, 1);
  695. viewport_offset_x = offset_x;
  696. viewport_offset_y = offset_y;
  697. projection = Rml::Matrix4f::ProjectOrtho(0, (float)viewport_width, (float)viewport_height, 0, -10000, 10000);
  698. }
  699. void RenderInterface_GL3::BeginFrame()
  700. {
  701. RMLUI_ASSERT(viewport_width >= 1 && viewport_height >= 1);
  702. // Backup GL state.
  703. glstate_backup.enable_cull_face = glIsEnabled(GL_CULL_FACE);
  704. glstate_backup.enable_blend = glIsEnabled(GL_BLEND);
  705. glstate_backup.enable_stencil_test = glIsEnabled(GL_STENCIL_TEST);
  706. glstate_backup.enable_scissor_test = glIsEnabled(GL_SCISSOR_TEST);
  707. glstate_backup.enable_depth_test = glIsEnabled(GL_DEPTH_TEST);
  708. glGetIntegerv(GL_VIEWPORT, glstate_backup.viewport);
  709. glGetIntegerv(GL_SCISSOR_BOX, glstate_backup.scissor);
  710. glGetIntegerv(GL_ACTIVE_TEXTURE, &glstate_backup.active_texture);
  711. glGetIntegerv(GL_STENCIL_CLEAR_VALUE, &glstate_backup.stencil_clear_value);
  712. glGetFloatv(GL_COLOR_CLEAR_VALUE, glstate_backup.color_clear_value);
  713. glGetBooleanv(GL_COLOR_WRITEMASK, glstate_backup.color_writemask);
  714. glGetIntegerv(GL_BLEND_EQUATION_RGB, &glstate_backup.blend_equation_rgb);
  715. glGetIntegerv(GL_BLEND_EQUATION_ALPHA, &glstate_backup.blend_equation_alpha);
  716. glGetIntegerv(GL_BLEND_SRC_RGB, &glstate_backup.blend_src_rgb);
  717. glGetIntegerv(GL_BLEND_DST_RGB, &glstate_backup.blend_dst_rgb);
  718. glGetIntegerv(GL_BLEND_SRC_ALPHA, &glstate_backup.blend_src_alpha);
  719. glGetIntegerv(GL_BLEND_DST_ALPHA, &glstate_backup.blend_dst_alpha);
  720. glGetIntegerv(GL_STENCIL_FUNC, &glstate_backup.stencil_front.func);
  721. glGetIntegerv(GL_STENCIL_REF, &glstate_backup.stencil_front.ref);
  722. glGetIntegerv(GL_STENCIL_VALUE_MASK, &glstate_backup.stencil_front.value_mask);
  723. glGetIntegerv(GL_STENCIL_WRITEMASK, &glstate_backup.stencil_front.writemask);
  724. glGetIntegerv(GL_STENCIL_FAIL, &glstate_backup.stencil_front.fail);
  725. glGetIntegerv(GL_STENCIL_PASS_DEPTH_FAIL, &glstate_backup.stencil_front.pass_depth_fail);
  726. glGetIntegerv(GL_STENCIL_PASS_DEPTH_PASS, &glstate_backup.stencil_front.pass_depth_pass);
  727. glGetIntegerv(GL_STENCIL_BACK_FUNC, &glstate_backup.stencil_back.func);
  728. glGetIntegerv(GL_STENCIL_BACK_REF, &glstate_backup.stencil_back.ref);
  729. glGetIntegerv(GL_STENCIL_BACK_VALUE_MASK, &glstate_backup.stencil_back.value_mask);
  730. glGetIntegerv(GL_STENCIL_BACK_WRITEMASK, &glstate_backup.stencil_back.writemask);
  731. glGetIntegerv(GL_STENCIL_BACK_FAIL, &glstate_backup.stencil_back.fail);
  732. glGetIntegerv(GL_STENCIL_BACK_PASS_DEPTH_FAIL, &glstate_backup.stencil_back.pass_depth_fail);
  733. glGetIntegerv(GL_STENCIL_BACK_PASS_DEPTH_PASS, &glstate_backup.stencil_back.pass_depth_pass);
  734. // Setup expected GL state.
  735. glViewport(0, 0, viewport_width, viewport_height);
  736. glClearStencil(0);
  737. glClearColor(0, 0, 0, 0);
  738. glActiveTexture(GL_TEXTURE0);
  739. glDisable(GL_SCISSOR_TEST);
  740. glDisable(GL_CULL_FACE);
  741. // Set blending function for premultiplied alpha.
  742. glEnable(GL_BLEND);
  743. glBlendEquation(GL_FUNC_ADD);
  744. glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
  745. #ifndef RMLUI_PLATFORM_EMSCRIPTEN
  746. // We do blending in nonlinear sRGB space because that is the common practice and gives results that we are used to.
  747. glDisable(GL_FRAMEBUFFER_SRGB);
  748. #endif
  749. glEnable(GL_STENCIL_TEST);
  750. glStencilFunc(GL_ALWAYS, 1, GLuint(-1));
  751. glStencilMask(GLuint(-1));
  752. glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
  753. glDisable(GL_DEPTH_TEST);
  754. SetTransform(nullptr);
  755. render_layers.BeginFrame(viewport_width, viewport_height);
  756. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetTopLayer().framebuffer);
  757. glClear(GL_COLOR_BUFFER_BIT);
  758. UseProgram(ProgramId::None);
  759. program_transform_dirty.set();
  760. scissor_state = Rml::Rectanglei::MakeInvalid();
  761. Gfx::CheckGLError("BeginFrame");
  762. }
  763. void RenderInterface_GL3::EndFrame()
  764. {
  765. const Gfx::FramebufferData& fb_active = render_layers.GetTopLayer();
  766. const Gfx::FramebufferData& fb_postprocess = render_layers.GetPostprocessPrimary();
  767. // Resolve MSAA to postprocess framebuffer.
  768. glBindFramebuffer(GL_READ_FRAMEBUFFER, fb_active.framebuffer);
  769. glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fb_postprocess.framebuffer);
  770. glBlitFramebuffer(0, 0, fb_active.width, fb_active.height, 0, 0, fb_postprocess.width, fb_postprocess.height, GL_COLOR_BUFFER_BIT, GL_NEAREST);
  771. // Draw to backbuffer
  772. glBindFramebuffer(GL_FRAMEBUFFER, 0);
  773. glViewport(viewport_offset_x, viewport_offset_y, viewport_width, viewport_height);
  774. // Assuming we have an opaque background, we can just write to it with the premultiplied alpha blend mode and we'll get the correct result.
  775. // Instead, if we had a transparent destination that didn't use premultiplied alpha, we would need to perform a manual un-premultiplication step.
  776. glActiveTexture(GL_TEXTURE0);
  777. Gfx::BindTexture(fb_postprocess);
  778. UseProgram(ProgramId::Passthrough);
  779. DrawFullscreenQuad();
  780. render_layers.EndFrame();
  781. // Restore GL state.
  782. if (glstate_backup.enable_cull_face)
  783. glEnable(GL_CULL_FACE);
  784. else
  785. glDisable(GL_CULL_FACE);
  786. if (glstate_backup.enable_blend)
  787. glEnable(GL_BLEND);
  788. else
  789. glDisable(GL_BLEND);
  790. if (glstate_backup.enable_stencil_test)
  791. glEnable(GL_STENCIL_TEST);
  792. else
  793. glDisable(GL_STENCIL_TEST);
  794. if (glstate_backup.enable_scissor_test)
  795. glEnable(GL_SCISSOR_TEST);
  796. else
  797. glDisable(GL_SCISSOR_TEST);
  798. if (glstate_backup.enable_depth_test)
  799. glEnable(GL_DEPTH_TEST);
  800. else
  801. glDisable(GL_DEPTH_TEST);
  802. glViewport(glstate_backup.viewport[0], glstate_backup.viewport[1], glstate_backup.viewport[2], glstate_backup.viewport[3]);
  803. glScissor(glstate_backup.scissor[0], glstate_backup.scissor[1], glstate_backup.scissor[2], glstate_backup.scissor[3]);
  804. glActiveTexture(glstate_backup.active_texture);
  805. glClearStencil(glstate_backup.stencil_clear_value);
  806. glClearColor(glstate_backup.color_clear_value[0], glstate_backup.color_clear_value[1], glstate_backup.color_clear_value[2],
  807. glstate_backup.color_clear_value[3]);
  808. glColorMask(glstate_backup.color_writemask[0], glstate_backup.color_writemask[1], glstate_backup.color_writemask[2],
  809. glstate_backup.color_writemask[3]);
  810. glBlendEquationSeparate(glstate_backup.blend_equation_rgb, glstate_backup.blend_equation_alpha);
  811. glBlendFuncSeparate(glstate_backup.blend_src_rgb, glstate_backup.blend_dst_rgb, glstate_backup.blend_src_alpha, glstate_backup.blend_dst_alpha);
  812. glStencilFuncSeparate(GL_FRONT, glstate_backup.stencil_front.func, glstate_backup.stencil_front.ref, glstate_backup.stencil_front.value_mask);
  813. glStencilMaskSeparate(GL_FRONT, glstate_backup.stencil_front.writemask);
  814. glStencilOpSeparate(GL_FRONT, glstate_backup.stencil_front.fail, glstate_backup.stencil_front.pass_depth_fail,
  815. glstate_backup.stencil_front.pass_depth_pass);
  816. glStencilFuncSeparate(GL_BACK, glstate_backup.stencil_back.func, glstate_backup.stencil_back.ref, glstate_backup.stencil_back.value_mask);
  817. glStencilMaskSeparate(GL_BACK, glstate_backup.stencil_back.writemask);
  818. glStencilOpSeparate(GL_BACK, glstate_backup.stencil_back.fail, glstate_backup.stencil_back.pass_depth_fail,
  819. glstate_backup.stencil_back.pass_depth_pass);
  820. Gfx::CheckGLError("EndFrame");
  821. }
  822. void RenderInterface_GL3::Clear()
  823. {
  824. glClearColor(0, 0, 0, 1);
  825. glClear(GL_COLOR_BUFFER_BIT);
  826. }
  827. Rml::CompiledGeometryHandle RenderInterface_GL3::CompileGeometry(Rml::Span<const Rml::Vertex> vertices, Rml::Span<const int> indices)
  828. {
  829. constexpr GLenum draw_usage = GL_STATIC_DRAW;
  830. GLuint vao = 0;
  831. GLuint vbo = 0;
  832. GLuint ibo = 0;
  833. glGenVertexArrays(1, &vao);
  834. glGenBuffers(1, &vbo);
  835. glGenBuffers(1, &ibo);
  836. glBindVertexArray(vao);
  837. glBindBuffer(GL_ARRAY_BUFFER, vbo);
  838. glBufferData(GL_ARRAY_BUFFER, sizeof(Rml::Vertex) * vertices.size(), (const void*)vertices.data(), draw_usage);
  839. glEnableVertexAttribArray((GLuint)Gfx::VertexAttribute::Position);
  840. glVertexAttribPointer((GLuint)Gfx::VertexAttribute::Position, 2, GL_FLOAT, GL_FALSE, sizeof(Rml::Vertex),
  841. (const GLvoid*)(offsetof(Rml::Vertex, position)));
  842. glEnableVertexAttribArray((GLuint)Gfx::VertexAttribute::Color0);
  843. glVertexAttribPointer((GLuint)Gfx::VertexAttribute::Color0, 4, GL_UNSIGNED_BYTE, GL_TRUE, sizeof(Rml::Vertex),
  844. (const GLvoid*)(offsetof(Rml::Vertex, colour)));
  845. glEnableVertexAttribArray((GLuint)Gfx::VertexAttribute::TexCoord0);
  846. glVertexAttribPointer((GLuint)Gfx::VertexAttribute::TexCoord0, 2, GL_FLOAT, GL_FALSE, sizeof(Rml::Vertex),
  847. (const GLvoid*)(offsetof(Rml::Vertex, tex_coord)));
  848. glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ibo);
  849. glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(int) * indices.size(), (const void*)indices.data(), draw_usage);
  850. glBindVertexArray(0);
  851. glBindBuffer(GL_ARRAY_BUFFER, 0);
  852. Gfx::CheckGLError("CompileGeometry");
  853. Gfx::CompiledGeometryData* geometry = new Gfx::CompiledGeometryData;
  854. geometry->vao = vao;
  855. geometry->vbo = vbo;
  856. geometry->ibo = ibo;
  857. geometry->draw_count = (GLsizei)indices.size();
  858. return (Rml::CompiledGeometryHandle)geometry;
  859. }
  860. void RenderInterface_GL3::RenderGeometry(Rml::CompiledGeometryHandle handle, Rml::Vector2f translation, Rml::TextureHandle texture)
  861. {
  862. Gfx::CompiledGeometryData* geometry = (Gfx::CompiledGeometryData*)handle;
  863. if (texture == TexturePostprocess)
  864. {
  865. // Do nothing.
  866. }
  867. else if (texture)
  868. {
  869. UseProgram(ProgramId::Texture);
  870. SubmitTransformUniform(translation);
  871. if (texture != TextureEnableWithoutBinding)
  872. glBindTexture(GL_TEXTURE_2D, (GLuint)texture);
  873. }
  874. else
  875. {
  876. UseProgram(ProgramId::Color);
  877. glBindTexture(GL_TEXTURE_2D, 0);
  878. SubmitTransformUniform(translation);
  879. }
  880. glBindVertexArray(geometry->vao);
  881. glDrawElements(GL_TRIANGLES, geometry->draw_count, GL_UNSIGNED_INT, (const GLvoid*)0);
  882. glBindVertexArray(0);
  883. glBindTexture(GL_TEXTURE_2D, 0);
  884. Gfx::CheckGLError("RenderCompiledGeometry");
  885. }
  886. void RenderInterface_GL3::ReleaseGeometry(Rml::CompiledGeometryHandle handle)
  887. {
  888. Gfx::CompiledGeometryData* geometry = (Gfx::CompiledGeometryData*)handle;
  889. glDeleteVertexArrays(1, &geometry->vao);
  890. glDeleteBuffers(1, &geometry->vbo);
  891. glDeleteBuffers(1, &geometry->ibo);
  892. delete geometry;
  893. }
  894. /// Flip vertical axis of the rectangle, and move its origin to the vertically opposite side of the viewport.
  895. /// @note Changes coordinate system from RmlUi to OpenGL, or equivalently in reverse.
  896. /// @note The Rectangle::Top and Rectangle::Bottom members will have reverse meaning in the returned rectangle.
  897. static Rml::Rectanglei VerticallyFlipped(Rml::Rectanglei rect, int viewport_height)
  898. {
  899. RMLUI_ASSERT(rect.Valid());
  900. Rml::Rectanglei flipped_rect = rect;
  901. flipped_rect.p0.y = viewport_height - rect.p1.y;
  902. flipped_rect.p1.y = viewport_height - rect.p0.y;
  903. return flipped_rect;
  904. }
  905. void RenderInterface_GL3::SetScissor(Rml::Rectanglei region, bool vertically_flip)
  906. {
  907. if (region.Valid() != scissor_state.Valid())
  908. {
  909. if (region.Valid())
  910. glEnable(GL_SCISSOR_TEST);
  911. else
  912. glDisable(GL_SCISSOR_TEST);
  913. }
  914. if (region.Valid() && vertically_flip)
  915. region = VerticallyFlipped(region, viewport_height);
  916. if (region.Valid() && region != scissor_state)
  917. {
  918. // Some render APIs don't like offscreen positions (WebGL in particular), so clamp them to the viewport.
  919. const int x = Rml::Math::Clamp(region.Left(), 0, viewport_width);
  920. const int y = Rml::Math::Clamp(viewport_height - region.Bottom(), 0, viewport_height);
  921. glScissor(x, y, region.Width(), region.Height());
  922. }
  923. Gfx::CheckGLError("SetScissorRegion");
  924. scissor_state = region;
  925. }
  926. void RenderInterface_GL3::EnableScissorRegion(bool enable)
  927. {
  928. // Assume enable is immediately followed by a SetScissorRegion() call, and ignore it here.
  929. if (!enable)
  930. SetScissor(Rml::Rectanglei::MakeInvalid(), false);
  931. }
  932. void RenderInterface_GL3::SetScissorRegion(Rml::Rectanglei region)
  933. {
  934. SetScissor(region);
  935. }
  936. void RenderInterface_GL3::EnableClipMask(bool enable)
  937. {
  938. if (enable)
  939. glEnable(GL_STENCIL_TEST);
  940. else
  941. glDisable(GL_STENCIL_TEST);
  942. }
  943. void RenderInterface_GL3::RenderToClipMask(Rml::ClipMaskOperation operation, Rml::CompiledGeometryHandle geometry, Rml::Vector2f translation)
  944. {
  945. RMLUI_ASSERT(glIsEnabled(GL_STENCIL_TEST));
  946. using Rml::ClipMaskOperation;
  947. const bool clear_stencil = (operation == ClipMaskOperation::Set || operation == ClipMaskOperation::SetInverse);
  948. if (clear_stencil)
  949. {
  950. // @performance Increment the reference value instead of clearing each time.
  951. glClear(GL_STENCIL_BUFFER_BIT);
  952. }
  953. GLint stencil_test_value = 0;
  954. glGetIntegerv(GL_STENCIL_REF, &stencil_test_value);
  955. glColorMask(GL_FALSE, GL_FALSE, GL_FALSE, GL_FALSE);
  956. glStencilFunc(GL_ALWAYS, GLint(1), GLuint(-1));
  957. switch (operation)
  958. {
  959. case ClipMaskOperation::Set:
  960. {
  961. glStencilOp(GL_KEEP, GL_KEEP, GL_REPLACE);
  962. stencil_test_value = 1;
  963. }
  964. break;
  965. case ClipMaskOperation::SetInverse:
  966. {
  967. glStencilOp(GL_KEEP, GL_KEEP, GL_REPLACE);
  968. stencil_test_value = 0;
  969. }
  970. break;
  971. case ClipMaskOperation::Intersect:
  972. {
  973. glStencilOp(GL_KEEP, GL_KEEP, GL_INCR);
  974. stencil_test_value += 1;
  975. }
  976. break;
  977. }
  978. RenderGeometry(geometry, translation, {});
  979. // Restore state
  980. // @performance Cache state so we don't toggle it unnecessarily.
  981. glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
  982. glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
  983. glStencilFunc(GL_EQUAL, stencil_test_value, GLuint(-1));
  984. }
  985. // Set to byte packing, or the compiler will expand our struct, which means it won't read correctly from file
  986. #pragma pack(1)
  987. struct TGAHeader {
  988. char idLength;
  989. char colourMapType;
  990. char dataType;
  991. short int colourMapOrigin;
  992. short int colourMapLength;
  993. char colourMapDepth;
  994. short int xOrigin;
  995. short int yOrigin;
  996. short int width;
  997. short int height;
  998. char bitsPerPixel;
  999. char imageDescriptor;
  1000. };
  1001. // Restore packing
  1002. #pragma pack()
  1003. Rml::TextureHandle RenderInterface_GL3::LoadTexture(Rml::Vector2i& texture_dimensions, const Rml::String& source)
  1004. {
  1005. Rml::FileInterface* file_interface = Rml::GetFileInterface();
  1006. Rml::FileHandle file_handle = file_interface->Open(source);
  1007. if (!file_handle)
  1008. {
  1009. return false;
  1010. }
  1011. file_interface->Seek(file_handle, 0, SEEK_END);
  1012. size_t buffer_size = file_interface->Tell(file_handle);
  1013. file_interface->Seek(file_handle, 0, SEEK_SET);
  1014. if (buffer_size <= sizeof(TGAHeader))
  1015. {
  1016. Rml::Log::Message(Rml::Log::LT_ERROR, "Texture file size is smaller than TGAHeader, file is not a valid TGA image.");
  1017. file_interface->Close(file_handle);
  1018. return false;
  1019. }
  1020. using Rml::byte;
  1021. Rml::UniquePtr<byte[]> buffer(new byte[buffer_size]);
  1022. file_interface->Read(buffer.get(), buffer_size, file_handle);
  1023. file_interface->Close(file_handle);
  1024. TGAHeader header;
  1025. memcpy(&header, buffer.get(), sizeof(TGAHeader));
  1026. int color_mode = header.bitsPerPixel / 8;
  1027. const size_t image_size = header.width * header.height * 4; // We always make 32bit textures
  1028. if (header.dataType != 2)
  1029. {
  1030. Rml::Log::Message(Rml::Log::LT_ERROR, "Only 24/32bit uncompressed TGAs are supported.");
  1031. return false;
  1032. }
  1033. // Ensure we have at least 3 colors
  1034. if (color_mode < 3)
  1035. {
  1036. Rml::Log::Message(Rml::Log::LT_ERROR, "Only 24 and 32bit textures are supported.");
  1037. return false;
  1038. }
  1039. const byte* image_src = buffer.get() + sizeof(TGAHeader);
  1040. Rml::UniquePtr<byte[]> image_dest_buffer(new byte[image_size]);
  1041. byte* image_dest = image_dest_buffer.get();
  1042. // Targa is BGR, swap to RGB, flip Y axis, and convert to premultiplied alpha.
  1043. for (long y = 0; y < header.height; y++)
  1044. {
  1045. long read_index = y * header.width * color_mode;
  1046. long write_index = ((header.imageDescriptor & 32) != 0) ? read_index : (header.height - y - 1) * header.width * 4;
  1047. for (long x = 0; x < header.width; x++)
  1048. {
  1049. image_dest[write_index] = image_src[read_index + 2];
  1050. image_dest[write_index + 1] = image_src[read_index + 1];
  1051. image_dest[write_index + 2] = image_src[read_index];
  1052. if (color_mode == 4)
  1053. {
  1054. const byte alpha = image_src[read_index + 3];
  1055. for (size_t j = 0; j < 3; j++)
  1056. image_dest[write_index + j] = byte((image_dest[write_index + j] * alpha) / 255);
  1057. image_dest[write_index + 3] = alpha;
  1058. }
  1059. else
  1060. image_dest[write_index + 3] = 255;
  1061. write_index += 4;
  1062. read_index += color_mode;
  1063. }
  1064. }
  1065. texture_dimensions.x = header.width;
  1066. texture_dimensions.y = header.height;
  1067. return GenerateTexture({image_dest, image_size}, texture_dimensions);
  1068. }
  1069. Rml::TextureHandle RenderInterface_GL3::GenerateTexture(Rml::Span<const Rml::byte> source_data, Rml::Vector2i source_dimensions)
  1070. {
  1071. RMLUI_ASSERT(source_data.data() && source_data.size() == size_t(source_dimensions.x * source_dimensions.y * 4));
  1072. GLuint texture_id = 0;
  1073. glGenTextures(1, &texture_id);
  1074. if (texture_id == 0)
  1075. {
  1076. Rml::Log::Message(Rml::Log::LT_ERROR, "Failed to generate texture.");
  1077. return false;
  1078. }
  1079. glBindTexture(GL_TEXTURE_2D, texture_id);
  1080. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, source_dimensions.x, source_dimensions.y, 0, GL_RGBA, GL_UNSIGNED_BYTE, source_data.data());
  1081. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  1082. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  1083. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT);
  1084. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT);
  1085. glBindTexture(GL_TEXTURE_2D, 0);
  1086. return (Rml::TextureHandle)texture_id;
  1087. }
  1088. void RenderInterface_GL3::DrawFullscreenQuad()
  1089. {
  1090. RenderGeometry(fullscreen_quad_geometry, {}, RenderInterface_GL3::TexturePostprocess);
  1091. }
  1092. void RenderInterface_GL3::DrawFullscreenQuad(Rml::Vector2f uv_offset, Rml::Vector2f uv_scaling)
  1093. {
  1094. Rml::Mesh mesh;
  1095. Rml::MeshUtilities::GenerateQuad(mesh, Rml::Vector2f(-1), Rml::Vector2f(2), {});
  1096. if (uv_offset != Rml::Vector2f() || uv_scaling != Rml::Vector2f(1.f))
  1097. {
  1098. for (Rml::Vertex& vertex : mesh.vertices)
  1099. vertex.tex_coord = (vertex.tex_coord * uv_scaling) + uv_offset;
  1100. }
  1101. const Rml::CompiledGeometryHandle geometry = CompileGeometry(mesh.vertices, mesh.indices);
  1102. RenderGeometry(geometry, {}, RenderInterface_GL3::TexturePostprocess);
  1103. ReleaseGeometry(geometry);
  1104. }
  1105. static Rml::Colourf ConvertToColorf(Rml::ColourbPremultiplied c0)
  1106. {
  1107. Rml::Colourf result;
  1108. for (int i = 0; i < 4; i++)
  1109. result[i] = (1.f / 255.f) * float(c0[i]);
  1110. return result;
  1111. }
  1112. static void SigmaToParameters(const float desired_sigma, int& out_pass_level, float& out_sigma)
  1113. {
  1114. constexpr int max_num_passes = 10;
  1115. static_assert(max_num_passes < 31, "");
  1116. constexpr float max_single_pass_sigma = 3.0f;
  1117. out_pass_level = Rml::Math::Clamp(Rml::Math::Log2(int(desired_sigma * (2.f / max_single_pass_sigma))), 0, max_num_passes);
  1118. out_sigma = Rml::Math::Clamp(desired_sigma / float(1 << out_pass_level), 0.0f, max_single_pass_sigma);
  1119. }
  1120. static void SetTexCoordLimits(GLint tex_coord_min_location, GLint tex_coord_max_location, Rml::Rectanglei rectangle_flipped,
  1121. Rml::Vector2i framebuffer_size)
  1122. {
  1123. // Offset by half-texel values so that texture lookups are clamped to fragment centers, thereby avoiding color
  1124. // bleeding from neighboring texels due to bilinear interpolation.
  1125. const Rml::Vector2f min = (Rml::Vector2f(rectangle_flipped.p0) + Rml::Vector2f(0.5f)) / Rml::Vector2f(framebuffer_size);
  1126. const Rml::Vector2f max = (Rml::Vector2f(rectangle_flipped.p1) - Rml::Vector2f(0.5f)) / Rml::Vector2f(framebuffer_size);
  1127. glUniform2f(tex_coord_min_location, min.x, min.y);
  1128. glUniform2f(tex_coord_max_location, max.x, max.y);
  1129. }
  1130. static void SetBlurWeights(GLint weights_location, float sigma)
  1131. {
  1132. constexpr int num_weights = BLUR_NUM_WEIGHTS;
  1133. float weights[num_weights];
  1134. float normalization = 0.0f;
  1135. for (int i = 0; i < num_weights; i++)
  1136. {
  1137. if (Rml::Math::Absolute(sigma) < 0.1f)
  1138. weights[i] = float(i == 0);
  1139. else
  1140. weights[i] = Rml::Math::Exp(-float(i * i) / (2.0f * sigma * sigma)) / (Rml::Math::SquareRoot(2.f * Rml::Math::RMLUI_PI) * sigma);
  1141. normalization += (i == 0 ? 1.f : 2.0f) * weights[i];
  1142. }
  1143. for (int i = 0; i < num_weights; i++)
  1144. weights[i] /= normalization;
  1145. glUniform1fv(weights_location, (GLsizei)num_weights, &weights[0]);
  1146. }
  1147. void RenderInterface_GL3::RenderBlur(float sigma, const Gfx::FramebufferData& source_destination, const Gfx::FramebufferData& temp,
  1148. const Rml::Rectanglei window_flipped)
  1149. {
  1150. RMLUI_ASSERT(&source_destination != &temp && source_destination.width == temp.width && source_destination.height == temp.height);
  1151. RMLUI_ASSERT(window_flipped.Valid());
  1152. int pass_level = 0;
  1153. SigmaToParameters(sigma, pass_level, sigma);
  1154. const Rml::Rectanglei original_scissor = scissor_state;
  1155. // Begin by downscaling so that the blur pass can be done at a reduced resolution for large sigma.
  1156. Rml::Rectanglei scissor = window_flipped;
  1157. UseProgram(ProgramId::Passthrough);
  1158. SetScissor(scissor, true);
  1159. // Downscale by iterative half-scaling with bilinear filtering, to reduce aliasing.
  1160. glViewport(0, 0, source_destination.width / 2, source_destination.height / 2);
  1161. // Scale UVs if we have even dimensions, such that texture fetches align perfectly between texels, thereby producing a 50% blend of
  1162. // neighboring texels.
  1163. const Rml::Vector2f uv_scaling = {(source_destination.width % 2 == 1) ? (1.f - 1.f / float(source_destination.width)) : 1.f,
  1164. (source_destination.height % 2 == 1) ? (1.f - 1.f / float(source_destination.height)) : 1.f};
  1165. for (int i = 0; i < pass_level; i++)
  1166. {
  1167. scissor.p0 = (scissor.p0 + Rml::Vector2i(1)) / 2;
  1168. scissor.p1 = Rml::Math::Max(scissor.p1 / 2, scissor.p0);
  1169. const bool from_source = (i % 2 == 0);
  1170. Gfx::BindTexture(from_source ? source_destination : temp);
  1171. glBindFramebuffer(GL_FRAMEBUFFER, (from_source ? temp : source_destination).framebuffer);
  1172. SetScissor(scissor, true);
  1173. DrawFullscreenQuad({}, uv_scaling);
  1174. }
  1175. glViewport(0, 0, source_destination.width, source_destination.height);
  1176. // Ensure texture data end up in the temp buffer. Depending on the last downscaling, we might need to move it from the source_destination buffer.
  1177. const bool transfer_to_temp_buffer = (pass_level % 2 == 0);
  1178. if (transfer_to_temp_buffer)
  1179. {
  1180. Gfx::BindTexture(source_destination);
  1181. glBindFramebuffer(GL_FRAMEBUFFER, temp.framebuffer);
  1182. DrawFullscreenQuad();
  1183. }
  1184. // Set up uniforms.
  1185. UseProgram(ProgramId::Blur);
  1186. SetBlurWeights(GetUniformLocation(UniformId::Weights), sigma);
  1187. SetTexCoordLimits(GetUniformLocation(UniformId::TexCoordMin), GetUniformLocation(UniformId::TexCoordMax), scissor,
  1188. {source_destination.width, source_destination.height});
  1189. const GLint texel_offset_location = GetUniformLocation(UniformId::TexelOffset);
  1190. auto SetTexelOffset = [texel_offset_location](Rml::Vector2f blur_direction, int texture_dimension) {
  1191. const Rml::Vector2f texel_offset = blur_direction * (1.0f / float(texture_dimension));
  1192. glUniform2f(texel_offset_location, texel_offset.x, texel_offset.y);
  1193. };
  1194. // Blur render pass - vertical.
  1195. Gfx::BindTexture(temp);
  1196. glBindFramebuffer(GL_FRAMEBUFFER, source_destination.framebuffer);
  1197. SetTexelOffset({0.f, 1.f}, temp.height);
  1198. DrawFullscreenQuad();
  1199. // Blur render pass - horizontal.
  1200. Gfx::BindTexture(source_destination);
  1201. glBindFramebuffer(GL_FRAMEBUFFER, temp.framebuffer);
  1202. // Add a 1px transparent border around the blur region by first clearing with a padded scissor. This helps prevent
  1203. // artifacts when upscaling the blur result in the later step. On Intel and AMD, we have observed that during
  1204. // blitting with linear filtering, pixels outside the 'src' region can be blended into the output. On the other
  1205. // hand, it looks like Nvidia clamps the pixels to the source edge, which is what we really want. Regardless, we
  1206. // work around the issue with this extra step.
  1207. SetScissor(scissor.Extend(1), true);
  1208. glClear(GL_COLOR_BUFFER_BIT);
  1209. SetScissor(scissor, true);
  1210. SetTexelOffset({1.f, 0.f}, source_destination.width);
  1211. DrawFullscreenQuad();
  1212. // Blit the blurred image to the scissor region with upscaling.
  1213. SetScissor(window_flipped, true);
  1214. glBindFramebuffer(GL_READ_FRAMEBUFFER, temp.framebuffer);
  1215. glBindFramebuffer(GL_DRAW_FRAMEBUFFER, source_destination.framebuffer);
  1216. const Rml::Vector2i src_min = scissor.p0;
  1217. const Rml::Vector2i src_max = scissor.p1;
  1218. const Rml::Vector2i dst_min = window_flipped.p0;
  1219. const Rml::Vector2i dst_max = window_flipped.p1;
  1220. glBlitFramebuffer(src_min.x, src_min.y, src_max.x, src_max.y, dst_min.x, dst_min.y, dst_max.x, dst_max.y, GL_COLOR_BUFFER_BIT, GL_LINEAR);
  1221. // The above upscale blit might be jittery at low resolutions (large pass levels). This is especially noticeable when moving an element with
  1222. // backdrop blur around or when trying to click/hover an element within a blurred region since it may be rendered at an offset. For more stable
  1223. // and accurate rendering we next upscale the blur image by an exact power-of-two. However, this may not fill the edges completely so we need to
  1224. // do the above first. Note that this strategy may sometimes result in visible seams. Alternatively, we could try to enlarge the window to the
  1225. // next power-of-two size and then downsample and blur that.
  1226. const Rml::Vector2i target_min = src_min * (1 << pass_level);
  1227. const Rml::Vector2i target_max = src_max * (1 << pass_level);
  1228. if (target_min != dst_min || target_max != dst_max)
  1229. {
  1230. glBlitFramebuffer(src_min.x, src_min.y, src_max.x, src_max.y, target_min.x, target_min.y, target_max.x, target_max.y, GL_COLOR_BUFFER_BIT,
  1231. GL_LINEAR);
  1232. }
  1233. // Restore render state.
  1234. SetScissor(original_scissor);
  1235. Gfx::CheckGLError("Blur");
  1236. }
  1237. void RenderInterface_GL3::ReleaseTexture(Rml::TextureHandle texture_handle)
  1238. {
  1239. glDeleteTextures(1, (GLuint*)&texture_handle);
  1240. }
  1241. void RenderInterface_GL3::SetTransform(const Rml::Matrix4f* new_transform)
  1242. {
  1243. transform = (new_transform ? (projection * (*new_transform)) : projection);
  1244. program_transform_dirty.set();
  1245. }
  1246. enum class FilterType { Invalid = 0, Passthrough, Blur, DropShadow, ColorMatrix, MaskImage };
  1247. struct CompiledFilter {
  1248. FilterType type;
  1249. // Passthrough
  1250. float blend_factor;
  1251. // Blur
  1252. float sigma;
  1253. // Drop shadow
  1254. Rml::Vector2f offset;
  1255. Rml::ColourbPremultiplied color;
  1256. // ColorMatrix
  1257. Rml::Matrix4f color_matrix;
  1258. };
  1259. Rml::CompiledFilterHandle RenderInterface_GL3::CompileFilter(const Rml::String& name, const Rml::Dictionary& parameters)
  1260. {
  1261. CompiledFilter filter = {};
  1262. if (name == "opacity")
  1263. {
  1264. filter.type = FilterType::Passthrough;
  1265. filter.blend_factor = Rml::Get(parameters, "value", 1.0f);
  1266. }
  1267. else if (name == "blur")
  1268. {
  1269. filter.type = FilterType::Blur;
  1270. filter.sigma = Rml::Get(parameters, "sigma", 1.0f);
  1271. }
  1272. else if (name == "drop-shadow")
  1273. {
  1274. filter.type = FilterType::DropShadow;
  1275. filter.sigma = Rml::Get(parameters, "sigma", 0.f);
  1276. filter.color = Rml::Get(parameters, "color", Rml::Colourb()).ToPremultiplied();
  1277. filter.offset = Rml::Get(parameters, "offset", Rml::Vector2f(0.f));
  1278. }
  1279. else if (name == "brightness")
  1280. {
  1281. filter.type = FilterType::ColorMatrix;
  1282. const float value = Rml::Get(parameters, "value", 1.0f);
  1283. filter.color_matrix = Rml::Matrix4f::Diag(value, value, value, 1.f);
  1284. }
  1285. else if (name == "contrast")
  1286. {
  1287. filter.type = FilterType::ColorMatrix;
  1288. const float value = Rml::Get(parameters, "value", 1.0f);
  1289. const float grayness = 0.5f - 0.5f * value;
  1290. filter.color_matrix = Rml::Matrix4f::Diag(value, value, value, 1.f);
  1291. filter.color_matrix.SetColumn(3, Rml::Vector4f(grayness, grayness, grayness, 1.f));
  1292. }
  1293. else if (name == "invert")
  1294. {
  1295. filter.type = FilterType::ColorMatrix;
  1296. const float value = Rml::Math::Clamp(Rml::Get(parameters, "value", 1.0f), 0.f, 1.f);
  1297. const float inverted = 1.f - 2.f * value;
  1298. filter.color_matrix = Rml::Matrix4f::Diag(inverted, inverted, inverted, 1.f);
  1299. filter.color_matrix.SetColumn(3, Rml::Vector4f(value, value, value, 1.f));
  1300. }
  1301. else if (name == "grayscale")
  1302. {
  1303. filter.type = FilterType::ColorMatrix;
  1304. const float value = Rml::Get(parameters, "value", 1.0f);
  1305. const float rev_value = 1.f - value;
  1306. const Rml::Vector3f gray = value * Rml::Vector3f(0.2126f, 0.7152f, 0.0722f);
  1307. // clang-format off
  1308. filter.color_matrix = Rml::Matrix4f::FromRows(
  1309. {gray.x + rev_value, gray.y, gray.z, 0.f},
  1310. {gray.x, gray.y + rev_value, gray.z, 0.f},
  1311. {gray.x, gray.y, gray.z + rev_value, 0.f},
  1312. {0.f, 0.f, 0.f, 1.f}
  1313. );
  1314. // clang-format on
  1315. }
  1316. else if (name == "sepia")
  1317. {
  1318. filter.type = FilterType::ColorMatrix;
  1319. const float value = Rml::Get(parameters, "value", 1.0f);
  1320. const float rev_value = 1.f - value;
  1321. const Rml::Vector3f r_mix = value * Rml::Vector3f(0.393f, 0.769f, 0.189f);
  1322. const Rml::Vector3f g_mix = value * Rml::Vector3f(0.349f, 0.686f, 0.168f);
  1323. const Rml::Vector3f b_mix = value * Rml::Vector3f(0.272f, 0.534f, 0.131f);
  1324. // clang-format off
  1325. filter.color_matrix = Rml::Matrix4f::FromRows(
  1326. {r_mix.x + rev_value, r_mix.y, r_mix.z, 0.f},
  1327. {g_mix.x, g_mix.y + rev_value, g_mix.z, 0.f},
  1328. {b_mix.x, b_mix.y, b_mix.z + rev_value, 0.f},
  1329. {0.f, 0.f, 0.f, 1.f}
  1330. );
  1331. // clang-format on
  1332. }
  1333. else if (name == "hue-rotate")
  1334. {
  1335. // Hue-rotation and saturation values based on: https://www.w3.org/TR/filter-effects-1/#attr-valuedef-type-huerotate
  1336. filter.type = FilterType::ColorMatrix;
  1337. const float value = Rml::Get(parameters, "value", 1.0f);
  1338. const float s = Rml::Math::Sin(value);
  1339. const float c = Rml::Math::Cos(value);
  1340. // clang-format off
  1341. filter.color_matrix = Rml::Matrix4f::FromRows(
  1342. {0.213f + 0.787f * c - 0.213f * s, 0.715f - 0.715f * c - 0.715f * s, 0.072f - 0.072f * c + 0.928f * s, 0.f},
  1343. {0.213f - 0.213f * c + 0.143f * s, 0.715f + 0.285f * c + 0.140f * s, 0.072f - 0.072f * c - 0.283f * s, 0.f},
  1344. {0.213f - 0.213f * c - 0.787f * s, 0.715f - 0.715f * c + 0.715f * s, 0.072f + 0.928f * c + 0.072f * s, 0.f},
  1345. {0.f, 0.f, 0.f, 1.f}
  1346. );
  1347. // clang-format on
  1348. }
  1349. else if (name == "saturate")
  1350. {
  1351. filter.type = FilterType::ColorMatrix;
  1352. const float value = Rml::Get(parameters, "value", 1.0f);
  1353. // clang-format off
  1354. filter.color_matrix = Rml::Matrix4f::FromRows(
  1355. {0.213f + 0.787f * value, 0.715f - 0.715f * value, 0.072f - 0.072f * value, 0.f},
  1356. {0.213f - 0.213f * value, 0.715f + 0.285f * value, 0.072f - 0.072f * value, 0.f},
  1357. {0.213f - 0.213f * value, 0.715f - 0.715f * value, 0.072f + 0.928f * value, 0.f},
  1358. {0.f, 0.f, 0.f, 1.f}
  1359. );
  1360. // clang-format on
  1361. }
  1362. if (filter.type != FilterType::Invalid)
  1363. return reinterpret_cast<Rml::CompiledFilterHandle>(new CompiledFilter(std::move(filter)));
  1364. Rml::Log::Message(Rml::Log::LT_WARNING, "Unsupported filter type '%s'.", name.c_str());
  1365. return {};
  1366. }
  1367. void RenderInterface_GL3::ReleaseFilter(Rml::CompiledFilterHandle filter)
  1368. {
  1369. delete reinterpret_cast<CompiledFilter*>(filter);
  1370. }
  1371. enum class CompiledShaderType { Invalid = 0, Gradient, Creation };
  1372. struct CompiledShader {
  1373. CompiledShaderType type;
  1374. // Gradient
  1375. ShaderGradientFunction gradient_function;
  1376. Rml::Vector2f p;
  1377. Rml::Vector2f v;
  1378. Rml::Vector<float> stop_positions;
  1379. Rml::Vector<Rml::Colourf> stop_colors;
  1380. // Shader
  1381. Rml::Vector2f dimensions;
  1382. };
  1383. Rml::CompiledShaderHandle RenderInterface_GL3::CompileShader(const Rml::String& name, const Rml::Dictionary& parameters)
  1384. {
  1385. auto ApplyColorStopList = [](CompiledShader& shader, const Rml::Dictionary& shader_parameters) {
  1386. auto it = shader_parameters.find("color_stop_list");
  1387. RMLUI_ASSERT(it != shader_parameters.end() && it->second.GetType() == Rml::Variant::COLORSTOPLIST);
  1388. const Rml::ColorStopList& color_stop_list = it->second.GetReference<Rml::ColorStopList>();
  1389. const int num_stops = Rml::Math::Min((int)color_stop_list.size(), MAX_NUM_STOPS);
  1390. shader.stop_positions.resize(num_stops);
  1391. shader.stop_colors.resize(num_stops);
  1392. for (int i = 0; i < num_stops; i++)
  1393. {
  1394. const Rml::ColorStop& stop = color_stop_list[i];
  1395. RMLUI_ASSERT(stop.position.unit == Rml::Unit::NUMBER);
  1396. shader.stop_positions[i] = stop.position.number;
  1397. shader.stop_colors[i] = ConvertToColorf(stop.color);
  1398. }
  1399. };
  1400. CompiledShader shader = {};
  1401. if (name == "linear-gradient")
  1402. {
  1403. shader.type = CompiledShaderType::Gradient;
  1404. const bool repeating = Rml::Get(parameters, "repeating", false);
  1405. shader.gradient_function = (repeating ? ShaderGradientFunction::RepeatingLinear : ShaderGradientFunction::Linear);
  1406. shader.p = Rml::Get(parameters, "p0", Rml::Vector2f(0.f));
  1407. shader.v = Rml::Get(parameters, "p1", Rml::Vector2f(0.f)) - shader.p;
  1408. ApplyColorStopList(shader, parameters);
  1409. }
  1410. else if (name == "radial-gradient")
  1411. {
  1412. shader.type = CompiledShaderType::Gradient;
  1413. const bool repeating = Rml::Get(parameters, "repeating", false);
  1414. shader.gradient_function = (repeating ? ShaderGradientFunction::RepeatingRadial : ShaderGradientFunction::Radial);
  1415. shader.p = Rml::Get(parameters, "center", Rml::Vector2f(0.f));
  1416. shader.v = Rml::Vector2f(1.f) / Rml::Get(parameters, "radius", Rml::Vector2f(1.f));
  1417. ApplyColorStopList(shader, parameters);
  1418. }
  1419. else if (name == "conic-gradient")
  1420. {
  1421. shader.type = CompiledShaderType::Gradient;
  1422. const bool repeating = Rml::Get(parameters, "repeating", false);
  1423. shader.gradient_function = (repeating ? ShaderGradientFunction::RepeatingConic : ShaderGradientFunction::Conic);
  1424. shader.p = Rml::Get(parameters, "center", Rml::Vector2f(0.f));
  1425. const float angle = Rml::Get(parameters, "angle", 0.f);
  1426. shader.v = {Rml::Math::Cos(angle), Rml::Math::Sin(angle)};
  1427. ApplyColorStopList(shader, parameters);
  1428. }
  1429. else if (name == "shader")
  1430. {
  1431. const Rml::String value = Rml::Get(parameters, "value", Rml::String());
  1432. if (value == "creation")
  1433. {
  1434. shader.type = CompiledShaderType::Creation;
  1435. shader.dimensions = Rml::Get(parameters, "dimensions", Rml::Vector2f(0.f));
  1436. }
  1437. }
  1438. if (shader.type != CompiledShaderType::Invalid)
  1439. return reinterpret_cast<Rml::CompiledShaderHandle>(new CompiledShader(std::move(shader)));
  1440. Rml::Log::Message(Rml::Log::LT_WARNING, "Unsupported shader type '%s'.", name.c_str());
  1441. return {};
  1442. }
  1443. void RenderInterface_GL3::RenderShader(Rml::CompiledShaderHandle shader_handle, Rml::CompiledGeometryHandle geometry_handle,
  1444. Rml::Vector2f translation, Rml::TextureHandle /*texture*/)
  1445. {
  1446. RMLUI_ASSERT(shader_handle && geometry_handle);
  1447. const CompiledShader& shader = *reinterpret_cast<CompiledShader*>(shader_handle);
  1448. const CompiledShaderType type = shader.type;
  1449. const Gfx::CompiledGeometryData& geometry = *reinterpret_cast<Gfx::CompiledGeometryData*>(geometry_handle);
  1450. switch (type)
  1451. {
  1452. case CompiledShaderType::Gradient:
  1453. {
  1454. RMLUI_ASSERT(shader.stop_positions.size() == shader.stop_colors.size());
  1455. const int num_stops = (int)shader.stop_positions.size();
  1456. UseProgram(ProgramId::Gradient);
  1457. glUniform1i(GetUniformLocation(UniformId::Func), static_cast<int>(shader.gradient_function));
  1458. glUniform2f(GetUniformLocation(UniformId::P), shader.p.x, shader.p.y);
  1459. glUniform2f(GetUniformLocation(UniformId::V), shader.v.x, shader.v.y);
  1460. glUniform1i(GetUniformLocation(UniformId::NumStops), num_stops);
  1461. glUniform1fv(GetUniformLocation(UniformId::StopPositions), num_stops, shader.stop_positions.data());
  1462. glUniform4fv(GetUniformLocation(UniformId::StopColors), num_stops, shader.stop_colors[0]);
  1463. SubmitTransformUniform(translation);
  1464. glBindVertexArray(geometry.vao);
  1465. glDrawElements(GL_TRIANGLES, geometry.draw_count, GL_UNSIGNED_INT, (const GLvoid*)0);
  1466. glBindVertexArray(0);
  1467. }
  1468. break;
  1469. case CompiledShaderType::Creation:
  1470. {
  1471. const double time = Rml::GetSystemInterface()->GetElapsedTime();
  1472. UseProgram(ProgramId::Creation);
  1473. glUniform1f(GetUniformLocation(UniformId::Value), (float)time);
  1474. glUniform2f(GetUniformLocation(UniformId::Dimensions), shader.dimensions.x, shader.dimensions.y);
  1475. SubmitTransformUniform(translation);
  1476. glBindVertexArray(geometry.vao);
  1477. glDrawElements(GL_TRIANGLES, geometry.draw_count, GL_UNSIGNED_INT, (const GLvoid*)0);
  1478. glBindVertexArray(0);
  1479. }
  1480. break;
  1481. case CompiledShaderType::Invalid:
  1482. {
  1483. Rml::Log::Message(Rml::Log::LT_WARNING, "Unhandled render shader %d.", (int)type);
  1484. }
  1485. break;
  1486. }
  1487. Gfx::CheckGLError("RenderShader");
  1488. }
  1489. void RenderInterface_GL3::ReleaseShader(Rml::CompiledShaderHandle shader_handle)
  1490. {
  1491. delete reinterpret_cast<CompiledShader*>(shader_handle);
  1492. }
  1493. void RenderInterface_GL3::BlitLayerToPostprocessPrimary(Rml::LayerHandle layer_handle)
  1494. {
  1495. const Gfx::FramebufferData& source = render_layers.GetLayer(layer_handle);
  1496. const Gfx::FramebufferData& destination = render_layers.GetPostprocessPrimary();
  1497. glBindFramebuffer(GL_READ_FRAMEBUFFER, source.framebuffer);
  1498. glBindFramebuffer(GL_DRAW_FRAMEBUFFER, destination.framebuffer);
  1499. // Blit and resolve MSAA. Any active scissor state will restrict the size of the blit region.
  1500. glBlitFramebuffer(0, 0, source.width, source.height, 0, 0, destination.width, destination.height, GL_COLOR_BUFFER_BIT, GL_NEAREST);
  1501. }
  1502. void RenderInterface_GL3::RenderFilters(Rml::Span<const Rml::CompiledFilterHandle> filter_handles)
  1503. {
  1504. for (const Rml::CompiledFilterHandle filter_handle : filter_handles)
  1505. {
  1506. const CompiledFilter& filter = *reinterpret_cast<const CompiledFilter*>(filter_handle);
  1507. const FilterType type = filter.type;
  1508. switch (type)
  1509. {
  1510. case FilterType::Passthrough:
  1511. {
  1512. UseProgram(ProgramId::Passthrough);
  1513. glBlendFunc(GL_CONSTANT_COLOR, GL_ZERO);
  1514. glBlendColor(filter.blend_factor, filter.blend_factor, filter.blend_factor, filter.blend_factor);
  1515. const Gfx::FramebufferData& source = render_layers.GetPostprocessPrimary();
  1516. const Gfx::FramebufferData& destination = render_layers.GetPostprocessSecondary();
  1517. Gfx::BindTexture(source);
  1518. glBindFramebuffer(GL_FRAMEBUFFER, destination.framebuffer);
  1519. DrawFullscreenQuad();
  1520. render_layers.SwapPostprocessPrimarySecondary();
  1521. glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
  1522. }
  1523. break;
  1524. case FilterType::Blur:
  1525. {
  1526. glDisable(GL_BLEND);
  1527. const Gfx::FramebufferData& source_destination = render_layers.GetPostprocessPrimary();
  1528. const Gfx::FramebufferData& temp = render_layers.GetPostprocessSecondary();
  1529. const Rml::Rectanglei window_flipped = VerticallyFlipped(scissor_state, viewport_height);
  1530. RenderBlur(filter.sigma, source_destination, temp, window_flipped);
  1531. glEnable(GL_BLEND);
  1532. }
  1533. break;
  1534. case FilterType::DropShadow:
  1535. {
  1536. UseProgram(ProgramId::DropShadow);
  1537. glDisable(GL_BLEND);
  1538. Rml::Colourf color = ConvertToColorf(filter.color);
  1539. glUniform4fv(GetUniformLocation(UniformId::Color), 1, &color[0]);
  1540. const Gfx::FramebufferData& primary = render_layers.GetPostprocessPrimary();
  1541. const Gfx::FramebufferData& secondary = render_layers.GetPostprocessSecondary();
  1542. Gfx::BindTexture(primary);
  1543. glBindFramebuffer(GL_FRAMEBUFFER, secondary.framebuffer);
  1544. const Rml::Rectanglei window_flipped = VerticallyFlipped(scissor_state, viewport_height);
  1545. SetTexCoordLimits(GetUniformLocation(UniformId::TexCoordMin), GetUniformLocation(UniformId::TexCoordMax), window_flipped,
  1546. {primary.width, primary.height});
  1547. const Rml::Vector2f uv_offset = filter.offset / Rml::Vector2f(-(float)viewport_width, (float)viewport_height);
  1548. DrawFullscreenQuad(uv_offset);
  1549. if (filter.sigma >= 0.5f)
  1550. {
  1551. const Gfx::FramebufferData& tertiary = render_layers.GetPostprocessTertiary();
  1552. RenderBlur(filter.sigma, secondary, tertiary, window_flipped);
  1553. }
  1554. UseProgram(ProgramId::Passthrough);
  1555. BindTexture(primary);
  1556. glEnable(GL_BLEND);
  1557. DrawFullscreenQuad();
  1558. render_layers.SwapPostprocessPrimarySecondary();
  1559. }
  1560. break;
  1561. case FilterType::ColorMatrix:
  1562. {
  1563. UseProgram(ProgramId::ColorMatrix);
  1564. glDisable(GL_BLEND);
  1565. const GLint uniform_location = program_data->uniforms.Get(ProgramId::ColorMatrix, UniformId::ColorMatrix);
  1566. constexpr bool transpose = std::is_same<decltype(filter.color_matrix), Rml::RowMajorMatrix4f>::value;
  1567. glUniformMatrix4fv(uniform_location, 1, transpose, filter.color_matrix.data());
  1568. const Gfx::FramebufferData& source = render_layers.GetPostprocessPrimary();
  1569. const Gfx::FramebufferData& destination = render_layers.GetPostprocessSecondary();
  1570. Gfx::BindTexture(source);
  1571. glBindFramebuffer(GL_FRAMEBUFFER, destination.framebuffer);
  1572. DrawFullscreenQuad();
  1573. render_layers.SwapPostprocessPrimarySecondary();
  1574. glEnable(GL_BLEND);
  1575. }
  1576. break;
  1577. case FilterType::MaskImage:
  1578. {
  1579. UseProgram(ProgramId::BlendMask);
  1580. glDisable(GL_BLEND);
  1581. const Gfx::FramebufferData& source = render_layers.GetPostprocessPrimary();
  1582. const Gfx::FramebufferData& blend_mask = render_layers.GetBlendMask();
  1583. const Gfx::FramebufferData& destination = render_layers.GetPostprocessSecondary();
  1584. Gfx::BindTexture(source);
  1585. glActiveTexture(GL_TEXTURE1);
  1586. Gfx::BindTexture(blend_mask);
  1587. glActiveTexture(GL_TEXTURE0);
  1588. glBindFramebuffer(GL_FRAMEBUFFER, destination.framebuffer);
  1589. DrawFullscreenQuad();
  1590. render_layers.SwapPostprocessPrimarySecondary();
  1591. glEnable(GL_BLEND);
  1592. }
  1593. break;
  1594. case FilterType::Invalid:
  1595. {
  1596. Rml::Log::Message(Rml::Log::LT_WARNING, "Unhandled render filter %d.", (int)type);
  1597. }
  1598. break;
  1599. }
  1600. }
  1601. Gfx::CheckGLError("RenderFilter");
  1602. }
  1603. Rml::LayerHandle RenderInterface_GL3::PushLayer()
  1604. {
  1605. const Rml::LayerHandle layer_handle = render_layers.PushLayer();
  1606. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetLayer(layer_handle).framebuffer);
  1607. glClear(GL_COLOR_BUFFER_BIT);
  1608. return layer_handle;
  1609. }
  1610. void RenderInterface_GL3::CompositeLayers(Rml::LayerHandle source_handle, Rml::LayerHandle destination_handle, Rml::BlendMode blend_mode,
  1611. Rml::Span<const Rml::CompiledFilterHandle> filters)
  1612. {
  1613. using Rml::BlendMode;
  1614. // Blit source layer to postprocessing buffer. Do this regardless of whether we actually have any filters to be
  1615. // applied, because we need to resolve the multi-sampled framebuffer in any case.
  1616. // @performance If we have BlendMode::Replace and no filters or mask then we can just blit directly to the destination.
  1617. BlitLayerToPostprocessPrimary(source_handle);
  1618. // Render the filters, the PostprocessPrimary framebuffer is used for both input and output.
  1619. RenderFilters(filters);
  1620. // Render to the destination layer.
  1621. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetLayer(destination_handle).framebuffer);
  1622. Gfx::BindTexture(render_layers.GetPostprocessPrimary());
  1623. UseProgram(ProgramId::Passthrough);
  1624. if (blend_mode == BlendMode::Replace)
  1625. glDisable(GL_BLEND);
  1626. DrawFullscreenQuad();
  1627. if (blend_mode == BlendMode::Replace)
  1628. glEnable(GL_BLEND);
  1629. if (destination_handle != render_layers.GetTopLayerHandle())
  1630. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetTopLayer().framebuffer);
  1631. Gfx::CheckGLError("CompositeLayers");
  1632. }
  1633. void RenderInterface_GL3::PopLayer()
  1634. {
  1635. render_layers.PopLayer();
  1636. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetTopLayer().framebuffer);
  1637. }
  1638. Rml::TextureHandle RenderInterface_GL3::SaveLayerAsTexture()
  1639. {
  1640. RMLUI_ASSERT(scissor_state.Valid());
  1641. const Rml::Rectanglei bounds = scissor_state;
  1642. Rml::TextureHandle render_texture = GenerateTexture({}, bounds.Size());
  1643. if (!render_texture)
  1644. return {};
  1645. BlitLayerToPostprocessPrimary(render_layers.GetTopLayerHandle());
  1646. EnableScissorRegion(false);
  1647. const Gfx::FramebufferData& source = render_layers.GetPostprocessPrimary();
  1648. const Gfx::FramebufferData& destination = render_layers.GetPostprocessSecondary();
  1649. glBindFramebuffer(GL_READ_FRAMEBUFFER, source.framebuffer);
  1650. glBindFramebuffer(GL_DRAW_FRAMEBUFFER, destination.framebuffer);
  1651. // Flip the image vertically, as that convention is used for textures, and move to origin.
  1652. glBlitFramebuffer( //
  1653. bounds.Left(), source.height - bounds.Bottom(), // src0
  1654. bounds.Right(), source.height - bounds.Top(), // src1
  1655. 0, bounds.Height(), // dst0
  1656. bounds.Width(), 0, // dst1
  1657. GL_COLOR_BUFFER_BIT, GL_NEAREST //
  1658. );
  1659. glBindTexture(GL_TEXTURE_2D, (GLuint)render_texture);
  1660. const Gfx::FramebufferData& texture_source = destination;
  1661. glBindFramebuffer(GL_READ_FRAMEBUFFER, texture_source.framebuffer);
  1662. glCopyTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, 0, 0, bounds.Width(), bounds.Height());
  1663. SetScissor(bounds);
  1664. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetTopLayer().framebuffer);
  1665. Gfx::CheckGLError("SaveLayerAsTexture");
  1666. return render_texture;
  1667. }
  1668. Rml::CompiledFilterHandle RenderInterface_GL3::SaveLayerAsMaskImage()
  1669. {
  1670. BlitLayerToPostprocessPrimary(render_layers.GetTopLayerHandle());
  1671. const Gfx::FramebufferData& source = render_layers.GetPostprocessPrimary();
  1672. const Gfx::FramebufferData& destination = render_layers.GetBlendMask();
  1673. glBindFramebuffer(GL_FRAMEBUFFER, destination.framebuffer);
  1674. BindTexture(source);
  1675. UseProgram(ProgramId::Passthrough);
  1676. glDisable(GL_BLEND);
  1677. DrawFullscreenQuad();
  1678. glEnable(GL_BLEND);
  1679. glBindFramebuffer(GL_FRAMEBUFFER, render_layers.GetTopLayer().framebuffer);
  1680. Gfx::CheckGLError("SaveLayerAsMaskImage");
  1681. CompiledFilter filter = {};
  1682. filter.type = FilterType::MaskImage;
  1683. return reinterpret_cast<Rml::CompiledFilterHandle>(new CompiledFilter(std::move(filter)));
  1684. }
  1685. void RenderInterface_GL3::UseProgram(ProgramId program_id)
  1686. {
  1687. RMLUI_ASSERT(program_data);
  1688. if (active_program != program_id)
  1689. {
  1690. if (program_id != ProgramId::None)
  1691. glUseProgram(program_data->programs[program_id]);
  1692. active_program = program_id;
  1693. }
  1694. }
  1695. int RenderInterface_GL3::GetUniformLocation(UniformId uniform_id) const
  1696. {
  1697. return program_data->uniforms.Get(active_program, uniform_id);
  1698. }
  1699. void RenderInterface_GL3::SubmitTransformUniform(Rml::Vector2f translation)
  1700. {
  1701. static_assert((size_t)ProgramId::Count < MaxNumPrograms, "Maximum number of programs exceeded.");
  1702. const size_t program_index = (size_t)active_program;
  1703. if (program_transform_dirty.test(program_index))
  1704. {
  1705. glUniformMatrix4fv(GetUniformLocation(UniformId::Transform), 1, false, transform.data());
  1706. program_transform_dirty.set(program_index, false);
  1707. }
  1708. glUniform2fv(GetUniformLocation(UniformId::Translate), 1, &translation.x);
  1709. Gfx::CheckGLError("SubmitTransformUniform");
  1710. }
  1711. RenderInterface_GL3::RenderLayerStack::RenderLayerStack()
  1712. {
  1713. fb_postprocess.resize(4);
  1714. }
  1715. RenderInterface_GL3::RenderLayerStack::~RenderLayerStack()
  1716. {
  1717. DestroyFramebuffers();
  1718. }
  1719. Rml::LayerHandle RenderInterface_GL3::RenderLayerStack::PushLayer()
  1720. {
  1721. RMLUI_ASSERT(layers_size <= (int)fb_layers.size());
  1722. if (layers_size == (int)fb_layers.size())
  1723. {
  1724. // All framebuffers should share a single stencil buffer.
  1725. GLuint shared_depth_stencil = (fb_layers.empty() ? 0 : fb_layers.front().depth_stencil_buffer);
  1726. fb_layers.push_back(Gfx::FramebufferData{});
  1727. Gfx::CreateFramebuffer(fb_layers.back(), width, height, RMLUI_NUM_MSAA_SAMPLES, Gfx::FramebufferAttachment::DepthStencil,
  1728. shared_depth_stencil);
  1729. }
  1730. layers_size += 1;
  1731. return GetTopLayerHandle();
  1732. }
  1733. void RenderInterface_GL3::RenderLayerStack::PopLayer()
  1734. {
  1735. RMLUI_ASSERT(layers_size > 0);
  1736. layers_size -= 1;
  1737. }
  1738. const Gfx::FramebufferData& RenderInterface_GL3::RenderLayerStack::GetLayer(Rml::LayerHandle layer) const
  1739. {
  1740. RMLUI_ASSERT((size_t)layer < (size_t)layers_size);
  1741. return fb_layers[layer];
  1742. }
  1743. const Gfx::FramebufferData& RenderInterface_GL3::RenderLayerStack::GetTopLayer() const
  1744. {
  1745. return GetLayer(GetTopLayerHandle());
  1746. }
  1747. Rml::LayerHandle RenderInterface_GL3::RenderLayerStack::GetTopLayerHandle() const
  1748. {
  1749. RMLUI_ASSERT(layers_size > 0);
  1750. return static_cast<Rml::LayerHandle>(layers_size - 1);
  1751. }
  1752. void RenderInterface_GL3::RenderLayerStack::SwapPostprocessPrimarySecondary()
  1753. {
  1754. std::swap(fb_postprocess[0], fb_postprocess[1]);
  1755. }
  1756. void RenderInterface_GL3::RenderLayerStack::BeginFrame(int new_width, int new_height)
  1757. {
  1758. RMLUI_ASSERT(layers_size == 0);
  1759. if (new_width != width || new_height != height)
  1760. {
  1761. width = new_width;
  1762. height = new_height;
  1763. DestroyFramebuffers();
  1764. }
  1765. PushLayer();
  1766. }
  1767. void RenderInterface_GL3::RenderLayerStack::EndFrame()
  1768. {
  1769. RMLUI_ASSERT(layers_size == 1);
  1770. PopLayer();
  1771. }
  1772. void RenderInterface_GL3::RenderLayerStack::DestroyFramebuffers()
  1773. {
  1774. RMLUI_ASSERTMSG(layers_size == 0, "Do not call this during frame rendering, that is, between BeginFrame() and EndFrame().");
  1775. for (Gfx::FramebufferData& fb : fb_layers)
  1776. Gfx::DestroyFramebuffer(fb);
  1777. fb_layers.clear();
  1778. for (Gfx::FramebufferData& fb : fb_postprocess)
  1779. Gfx::DestroyFramebuffer(fb);
  1780. }
  1781. const Gfx::FramebufferData& RenderInterface_GL3::RenderLayerStack::EnsureFramebufferPostprocess(int index)
  1782. {
  1783. RMLUI_ASSERT(index < (int)fb_postprocess.size())
  1784. Gfx::FramebufferData& fb = fb_postprocess[index];
  1785. if (!fb.framebuffer)
  1786. Gfx::CreateFramebuffer(fb, width, height, 0, Gfx::FramebufferAttachment::None, 0);
  1787. return fb;
  1788. }
  1789. const Rml::Matrix4f& RenderInterface_GL3::GetTransform() const
  1790. {
  1791. return transform;
  1792. }
  1793. void RenderInterface_GL3::ResetProgram()
  1794. {
  1795. UseProgram(ProgramId::None);
  1796. }
  1797. bool RmlGL3::Initialize(Rml::String* out_message)
  1798. {
  1799. #if defined RMLUI_PLATFORM_EMSCRIPTEN
  1800. if (out_message)
  1801. *out_message = "Started Emscripten WebGL renderer.";
  1802. #elif !defined RMLUI_GL3_CUSTOM_LOADER
  1803. const int gl_version = gladLoaderLoadGL();
  1804. if (gl_version == 0)
  1805. {
  1806. if (out_message)
  1807. *out_message = "Failed to initialize OpenGL context.";
  1808. return false;
  1809. }
  1810. if (out_message)
  1811. *out_message = Rml::CreateString("Loaded OpenGL %d.%d.", GLAD_VERSION_MAJOR(gl_version), GLAD_VERSION_MINOR(gl_version));
  1812. #endif
  1813. return true;
  1814. }
  1815. void RmlGL3::Shutdown()
  1816. {
  1817. #if !defined RMLUI_PLATFORM_EMSCRIPTEN && !defined RMLUI_GL3_CUSTOM_LOADER
  1818. gladLoaderUnloadGL();
  1819. #endif
  1820. }