GLContext.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905
  1. /*
  2. * Copyright (c) 2021, Jesse Buhagiar <jooster669@gmail.com>
  3. * Copyright (c) 2021, Stephan Unverwerth <s.unverwerth@serenityos.org>
  4. * Copyright (c) 2022-2024, Jelle Raaijmakers <jelle@gmta.nl>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #include <AK/Debug.h>
  9. #include <AK/StringBuilder.h>
  10. #include <AK/Vector.h>
  11. #include <LibGL/GLContext.h>
  12. #include <LibGL/Image.h>
  13. #include <LibGPU/Device.h>
  14. #include <LibGPU/Enums.h>
  15. #include <LibGPU/ImageDataLayout.h>
  16. #include <LibGPU/ImageFormat.h>
  17. #include <LibGfx/Bitmap.h>
  18. __attribute__((visibility("hidden"))) GL::GLContext* g_gl_context;
  19. namespace GL {
  20. GLContext::GLContext(RefPtr<GPU::Driver> driver, NonnullOwnPtr<GPU::Device> device, Gfx::Bitmap& frontbuffer)
  21. : m_driver { driver }
  22. , m_rasterizer { move(device) }
  23. , m_device_info { m_rasterizer->info() }
  24. , m_viewport { frontbuffer.rect() }
  25. , m_frontbuffer { frontbuffer }
  26. {
  27. m_texture_units.resize(m_device_info.num_texture_units);
  28. m_active_texture_unit = &m_texture_units[0];
  29. // All texture units are initialized with default textures for all targets; these
  30. // can be referenced later on with texture name 0 in operations like glBindTexture().
  31. auto default_texture_2d = adopt_ref(*new Texture2D());
  32. m_default_textures.set(GL_TEXTURE_2D, default_texture_2d);
  33. for (auto& texture_unit : m_texture_units)
  34. texture_unit.set_texture_2d_target_texture(default_texture_2d);
  35. // Query the number lights from the device and set set up their state
  36. // locally in the GL
  37. m_light_states.resize(m_device_info.num_lights);
  38. // Set-up light0's state, as it has a different default state
  39. // to the other lights, as per the OpenGL 1.5 spec
  40. auto& light0 = m_light_states.at(0);
  41. light0.diffuse_intensity = { 1.0f, 1.0f, 1.0f, 1.0f };
  42. light0.specular_intensity = { 1.0f, 1.0f, 1.0f, 1.0f };
  43. m_light_state_is_dirty = true;
  44. m_client_side_texture_coord_array_enabled.resize(m_device_info.num_texture_units);
  45. m_client_tex_coord_pointer.resize(m_device_info.num_texture_units);
  46. m_current_vertex_tex_coord.resize(m_device_info.num_texture_units);
  47. for (auto& tex_coord : m_current_vertex_tex_coord)
  48. tex_coord = { 0.0f, 0.0f, 0.0f, 1.0f };
  49. // Initialize the texture coordinate generation coefficients
  50. // Indices 0,1,2,3 refer to the S,T,R and Q coordinate of the respective texture
  51. // coordinate generation config.
  52. m_texture_coordinate_generation.resize(m_device_info.num_texture_units);
  53. for (auto& texture_coordinate_generation : m_texture_coordinate_generation) {
  54. texture_coordinate_generation[0].object_plane_coefficients = { 1.f, 0.f, 0.f, 0.f };
  55. texture_coordinate_generation[0].eye_plane_coefficients = { 1.f, 0.f, 0.f, 0.f };
  56. texture_coordinate_generation[1].object_plane_coefficients = { 0.f, 1.f, 0.f, 0.f };
  57. texture_coordinate_generation[1].eye_plane_coefficients = { 0.f, 1.f, 0.f, 0.f };
  58. texture_coordinate_generation[2].object_plane_coefficients = { 0.f, 0.f, 0.f, 0.f };
  59. texture_coordinate_generation[2].eye_plane_coefficients = { 0.f, 0.f, 0.f, 0.f };
  60. texture_coordinate_generation[3].object_plane_coefficients = { 0.f, 0.f, 0.f, 0.f };
  61. texture_coordinate_generation[3].eye_plane_coefficients = { 0.f, 0.f, 0.f, 0.f };
  62. }
  63. m_extensions = build_extension_string().release_value_but_fixme_should_propagate_errors();
  64. }
  65. GLContext::~GLContext()
  66. {
  67. dbgln_if(GL_DEBUG, "GLContext::~GLContext() {:p}", this);
  68. if (g_gl_context == this)
  69. make_context_current(nullptr);
  70. }
  71. void GLContext::gl_begin(GLenum mode)
  72. {
  73. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_begin, mode);
  74. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  75. RETURN_WITH_ERROR_IF(mode > GL_POLYGON, GL_INVALID_ENUM);
  76. m_current_draw_mode = mode;
  77. m_in_draw_state = true; // Certain commands will now generate an error
  78. }
  79. void GLContext::gl_clear(GLbitfield mask)
  80. {
  81. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_clear, mask);
  82. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  83. RETURN_WITH_ERROR_IF(mask & ~(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT), GL_INVALID_ENUM);
  84. if (mask & GL_COLOR_BUFFER_BIT)
  85. m_rasterizer->clear_color(m_clear_color);
  86. if (mask & GL_DEPTH_BUFFER_BIT)
  87. m_rasterizer->clear_depth(m_clear_depth);
  88. if (mask & GL_STENCIL_BUFFER_BIT)
  89. m_rasterizer->clear_stencil(m_clear_stencil);
  90. }
  91. void GLContext::gl_clear_color(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha)
  92. {
  93. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_clear_color, red, green, blue, alpha);
  94. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  95. m_clear_color = { red, green, blue, alpha };
  96. m_clear_color.clamp(0.f, 1.f);
  97. }
  98. void GLContext::gl_clear_depth(GLfloat depth)
  99. {
  100. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_clear_depth, depth);
  101. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  102. m_clear_depth = clamp(depth, 0.f, 1.f);
  103. }
  104. void GLContext::gl_end()
  105. {
  106. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_end);
  107. // Make sure we had a `glBegin` before this call...
  108. RETURN_WITH_ERROR_IF(!m_in_draw_state, GL_INVALID_OPERATION);
  109. m_in_draw_state = false;
  110. sync_device_config();
  111. GPU::PrimitiveType primitive_type;
  112. switch (m_current_draw_mode) {
  113. case GL_LINE_LOOP:
  114. primitive_type = GPU::PrimitiveType::LineLoop;
  115. break;
  116. case GL_LINE_STRIP:
  117. primitive_type = GPU::PrimitiveType::LineStrip;
  118. break;
  119. case GL_LINES:
  120. primitive_type = GPU::PrimitiveType::Lines;
  121. break;
  122. case GL_POINTS:
  123. primitive_type = GPU::PrimitiveType::Points;
  124. break;
  125. case GL_TRIANGLES:
  126. primitive_type = GPU::PrimitiveType::Triangles;
  127. break;
  128. case GL_TRIANGLE_STRIP:
  129. case GL_QUAD_STRIP:
  130. primitive_type = GPU::PrimitiveType::TriangleStrip;
  131. break;
  132. case GL_TRIANGLE_FAN:
  133. case GL_POLYGON:
  134. primitive_type = GPU::PrimitiveType::TriangleFan;
  135. break;
  136. case GL_QUADS:
  137. primitive_type = GPU::PrimitiveType::Quads;
  138. break;
  139. default:
  140. VERIFY_NOT_REACHED();
  141. }
  142. m_rasterizer->draw_primitives(primitive_type, m_vertex_list);
  143. m_vertex_list.clear_with_capacity();
  144. }
  145. GLenum GLContext::gl_get_error()
  146. {
  147. if (m_in_draw_state)
  148. return GL_INVALID_OPERATION;
  149. auto last_error = m_error;
  150. m_error = GL_NO_ERROR;
  151. return last_error;
  152. }
  153. GLubyte const* GLContext::gl_get_string(GLenum name)
  154. {
  155. RETURN_VALUE_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION, nullptr);
  156. switch (name) {
  157. case GL_VENDOR:
  158. return reinterpret_cast<GLubyte const*>(m_device_info.vendor_name.characters());
  159. case GL_RENDERER:
  160. return reinterpret_cast<GLubyte const*>(m_device_info.device_name.characters());
  161. case GL_VERSION:
  162. return reinterpret_cast<GLubyte const*>("1.5");
  163. case GL_EXTENSIONS:
  164. return reinterpret_cast<GLubyte const*>(m_extensions.data());
  165. case GL_SHADING_LANGUAGE_VERSION:
  166. return reinterpret_cast<GLubyte const*>("0.0");
  167. default:
  168. dbgln_if(GL_DEBUG, "gl_get_string({:#x}): unknown name", name);
  169. break;
  170. }
  171. RETURN_VALUE_WITH_ERROR_IF(true, GL_INVALID_ENUM, nullptr);
  172. }
  173. void GLContext::gl_viewport(GLint x, GLint y, GLsizei width, GLsizei height)
  174. {
  175. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_viewport, x, y, width, height);
  176. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  177. RETURN_WITH_ERROR_IF(width < 0 || height < 0, GL_INVALID_VALUE);
  178. m_viewport = { x, y, width, height };
  179. auto rasterizer_options = m_rasterizer->options();
  180. rasterizer_options.viewport = m_viewport;
  181. m_rasterizer->set_options(rasterizer_options);
  182. }
  183. void GLContext::gl_front_face(GLenum face)
  184. {
  185. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_front_face, face);
  186. RETURN_WITH_ERROR_IF(face < GL_CW || face > GL_CCW, GL_INVALID_ENUM);
  187. m_front_face = face;
  188. auto rasterizer_options = m_rasterizer->options();
  189. rasterizer_options.front_face = (face == GL_CW) ? GPU::WindingOrder::Clockwise : GPU::WindingOrder::CounterClockwise;
  190. m_rasterizer->set_options(rasterizer_options);
  191. }
  192. void GLContext::gl_cull_face(GLenum cull_mode)
  193. {
  194. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_cull_face, cull_mode);
  195. RETURN_WITH_ERROR_IF(cull_mode != GL_FRONT && cull_mode != GL_BACK && cull_mode != GL_FRONT_AND_BACK, GL_INVALID_ENUM);
  196. m_culled_sides = cull_mode;
  197. auto rasterizer_options = m_rasterizer->options();
  198. rasterizer_options.cull_back = cull_mode == GL_BACK || cull_mode == GL_FRONT_AND_BACK;
  199. rasterizer_options.cull_front = cull_mode == GL_FRONT || cull_mode == GL_FRONT_AND_BACK;
  200. m_rasterizer->set_options(rasterizer_options);
  201. }
  202. void GLContext::gl_flush()
  203. {
  204. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  205. // No-op since GLContext is completely synchronous at the moment
  206. }
  207. void GLContext::gl_finish()
  208. {
  209. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  210. // No-op since GLContext is completely synchronous at the moment
  211. }
  212. void GLContext::gl_alpha_func(GLenum func, GLclampf ref)
  213. {
  214. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_alpha_func, func, ref);
  215. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  216. RETURN_WITH_ERROR_IF(func < GL_NEVER || func > GL_ALWAYS, GL_INVALID_ENUM);
  217. m_alpha_test_func = func;
  218. m_alpha_test_ref_value = ref;
  219. auto options = m_rasterizer->options();
  220. switch (func) {
  221. case GL_NEVER:
  222. options.alpha_test_func = GPU::AlphaTestFunction::Never;
  223. break;
  224. case GL_ALWAYS:
  225. options.alpha_test_func = GPU::AlphaTestFunction::Always;
  226. break;
  227. case GL_LESS:
  228. options.alpha_test_func = GPU::AlphaTestFunction::Less;
  229. break;
  230. case GL_LEQUAL:
  231. options.alpha_test_func = GPU::AlphaTestFunction::LessOrEqual;
  232. break;
  233. case GL_EQUAL:
  234. options.alpha_test_func = GPU::AlphaTestFunction::Equal;
  235. break;
  236. case GL_NOTEQUAL:
  237. options.alpha_test_func = GPU::AlphaTestFunction::NotEqual;
  238. break;
  239. case GL_GEQUAL:
  240. options.alpha_test_func = GPU::AlphaTestFunction::GreaterOrEqual;
  241. break;
  242. case GL_GREATER:
  243. options.alpha_test_func = GPU::AlphaTestFunction::Greater;
  244. break;
  245. default:
  246. VERIFY_NOT_REACHED();
  247. }
  248. options.alpha_test_ref_value = m_alpha_test_ref_value;
  249. m_rasterizer->set_options(options);
  250. }
  251. void GLContext::gl_hint(GLenum target, GLenum mode)
  252. {
  253. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_hint, target, mode);
  254. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  255. RETURN_WITH_ERROR_IF(target != GL_PERSPECTIVE_CORRECTION_HINT
  256. && target != GL_POINT_SMOOTH_HINT
  257. && target != GL_LINE_SMOOTH_HINT
  258. && target != GL_POLYGON_SMOOTH_HINT
  259. && target != GL_FOG_HINT
  260. && target != GL_GENERATE_MIPMAP_HINT
  261. && target != GL_TEXTURE_COMPRESSION_HINT,
  262. GL_INVALID_ENUM);
  263. RETURN_WITH_ERROR_IF(mode != GL_DONT_CARE
  264. && mode != GL_FASTEST
  265. && mode != GL_NICEST,
  266. GL_INVALID_ENUM);
  267. // According to the spec implementors are free to ignore glHint. So we do.
  268. }
  269. void GLContext::gl_read_buffer(GLenum mode)
  270. {
  271. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_read_buffer, mode);
  272. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  273. // FIXME: Also allow aux buffers GL_AUX0 through GL_AUX3 here
  274. // plus any aux buffer between 0 and GL_AUX_BUFFERS
  275. RETURN_WITH_ERROR_IF(mode != GL_FRONT_LEFT
  276. && mode != GL_FRONT_RIGHT
  277. && mode != GL_BACK_LEFT
  278. && mode != GL_BACK_RIGHT
  279. && mode != GL_FRONT
  280. && mode != GL_BACK
  281. && mode != GL_LEFT
  282. && mode != GL_RIGHT,
  283. GL_INVALID_ENUM);
  284. // FIXME: We do not currently have aux buffers, so make it an invalid
  285. // operation to select anything but front or back buffers. Also we do
  286. // not allow selecting the stereoscopic RIGHT buffers since we do not
  287. // have them configured.
  288. RETURN_WITH_ERROR_IF(mode != GL_FRONT_LEFT
  289. && mode != GL_FRONT
  290. && mode != GL_BACK_LEFT
  291. && mode != GL_BACK
  292. && mode != GL_FRONT
  293. && mode != GL_BACK
  294. && mode != GL_LEFT,
  295. GL_INVALID_OPERATION);
  296. m_current_read_buffer = mode;
  297. }
  298. void GLContext::gl_draw_buffer(GLenum buffer)
  299. {
  300. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_draw_buffer, buffer);
  301. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  302. // FIXME: Also allow aux buffers GL_AUX0 through GL_AUX3 here
  303. // plus any aux buffer between 0 and GL_AUX_BUFFERS
  304. RETURN_WITH_ERROR_IF(buffer != GL_NONE
  305. && buffer != GL_FRONT_LEFT
  306. && buffer != GL_FRONT_RIGHT
  307. && buffer != GL_BACK_LEFT
  308. && buffer != GL_BACK_RIGHT
  309. && buffer != GL_FRONT
  310. && buffer != GL_BACK
  311. && buffer != GL_LEFT
  312. && buffer != GL_RIGHT,
  313. GL_INVALID_ENUM);
  314. // FIXME: We do not currently have aux buffers, so make it an invalid
  315. // operation to select anything but front or back buffers. Also we do
  316. // not allow selecting the stereoscopic RIGHT buffers since we do not
  317. // have them configured.
  318. RETURN_WITH_ERROR_IF(buffer != GL_NONE
  319. && buffer != GL_FRONT_LEFT
  320. && buffer != GL_FRONT
  321. && buffer != GL_BACK_LEFT
  322. && buffer != GL_BACK
  323. && buffer != GL_FRONT
  324. && buffer != GL_BACK
  325. && buffer != GL_LEFT,
  326. GL_INVALID_OPERATION);
  327. m_current_draw_buffer = buffer;
  328. auto rasterizer_options = m_rasterizer->options();
  329. // FIXME: We only have a single draw buffer in SoftGPU at the moment,
  330. // so we simply disable color writes if GL_NONE is selected
  331. rasterizer_options.enable_color_write = m_current_draw_buffer != GL_NONE;
  332. m_rasterizer->set_options(rasterizer_options);
  333. }
  334. void GLContext::gl_read_pixels(GLint x, GLint y, GLsizei width, GLsizei height, GLenum format, GLenum type, GLvoid* pixels)
  335. {
  336. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  337. RETURN_WITH_ERROR_IF(width < 0 || height < 0, GL_INVALID_VALUE);
  338. RETURN_WITH_ERROR_IF(format == GL_NONE || type == GL_NONE, GL_INVALID_ENUM);
  339. auto pixel_type_or_error = get_validated_pixel_type(GL_NONE, GL_NONE, format, type);
  340. RETURN_WITH_ERROR_IF(pixel_type_or_error.is_error(), pixel_type_or_error.release_error().code());
  341. auto pixel_type = pixel_type_or_error.release_value();
  342. GPU::ImageDataLayout output_layout = {
  343. .pixel_type = pixel_type,
  344. .packing = get_packing_specification(PackingType::Pack),
  345. .dimensions = {
  346. .width = static_cast<u32>(width),
  347. .height = static_cast<u32>(height),
  348. .depth = 1,
  349. },
  350. .selection = {
  351. .width = static_cast<u32>(width),
  352. .height = static_cast<u32>(height),
  353. .depth = 1,
  354. },
  355. };
  356. if (pixel_type.format == GPU::PixelFormat::DepthComponent) {
  357. // FIXME: This check needs to be a bit more sophisticated. Currently the buffers are
  358. // hardcoded. Once we add proper structures for them we need to correct this check
  359. // Error because only back buffer has a depth buffer
  360. RETURN_WITH_ERROR_IF(m_current_read_buffer == GL_FRONT
  361. || m_current_read_buffer == GL_FRONT_LEFT
  362. || m_current_read_buffer == GL_FRONT_RIGHT,
  363. GL_INVALID_OPERATION);
  364. m_rasterizer->blit_from_depth_buffer(pixels, { x, y }, output_layout);
  365. } else if (pixel_type.format == GPU::PixelFormat::StencilIndex) {
  366. dbgln("gl_read_pixels(): GL_STENCIL_INDEX is not yet supported");
  367. } else {
  368. m_rasterizer->blit_from_color_buffer(pixels, { x, y }, output_layout);
  369. }
  370. }
  371. void GLContext::gl_depth_mask(GLboolean flag)
  372. {
  373. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_depth_mask, flag);
  374. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  375. auto options = m_rasterizer->options();
  376. options.enable_depth_write = (flag != GL_FALSE);
  377. m_rasterizer->set_options(options);
  378. }
  379. void GLContext::gl_draw_pixels(GLsizei width, GLsizei height, GLenum format, GLenum type, void const* data)
  380. {
  381. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_draw_pixels, width, height, format, type, data);
  382. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  383. RETURN_WITH_ERROR_IF(width < 0 || height < 0, GL_INVALID_VALUE);
  384. // FIXME: GL_INVALID_OPERATION is generated if format is GL_STENCIL_INDEX and there is no stencil buffer
  385. // FIXME: GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to the GL_PIXEL_UNPACK_BUFFER
  386. // target and the buffer object's data store is currently mapped.
  387. // FIXME: GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to the GL_PIXEL_UNPACK_BUFFER
  388. // target and the data would be unpacked from the buffer object such that the memory reads required would
  389. // exceed the data store size.
  390. // FIXME: GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to the GL_PIXEL_UNPACK_BUFFER
  391. // target and data is not evenly divisible into the number of bytes needed to store in memory a datum
  392. // indicated by type.
  393. RETURN_WITH_ERROR_IF(format == GL_NONE || type == GL_NONE, GL_INVALID_ENUM);
  394. auto pixel_type_or_error = get_validated_pixel_type(GL_NONE, GL_NONE, format, type);
  395. RETURN_WITH_ERROR_IF(pixel_type_or_error.is_error(), pixel_type_or_error.release_error().code());
  396. auto pixel_type = pixel_type_or_error.release_value();
  397. GPU::ImageDataLayout input_layout = {
  398. .pixel_type = pixel_type,
  399. .packing = get_packing_specification(PackingType::Unpack),
  400. .dimensions = {
  401. .width = static_cast<u32>(width),
  402. .height = static_cast<u32>(height),
  403. .depth = 1,
  404. },
  405. .selection = {
  406. .width = static_cast<u32>(width),
  407. .height = static_cast<u32>(height),
  408. .depth = 1,
  409. },
  410. };
  411. if (pixel_type.format == GPU::PixelFormat::DepthComponent) {
  412. m_rasterizer->blit_to_depth_buffer_at_raster_position(data, input_layout);
  413. } else if (pixel_type.format == GPU::PixelFormat::StencilIndex) {
  414. dbgln("gl_draw_pixels(): GL_STENCIL_INDEX is not yet supported");
  415. } else {
  416. m_rasterizer->blit_to_color_buffer_at_raster_position(data, input_layout);
  417. }
  418. }
  419. void GLContext::gl_depth_range(GLdouble min, GLdouble max)
  420. {
  421. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_depth_range, min, max);
  422. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  423. auto options = m_rasterizer->options();
  424. options.depth_min = clamp<float>(min, 0.f, 1.f);
  425. options.depth_max = clamp<float>(max, 0.f, 1.f);
  426. m_rasterizer->set_options(options);
  427. }
  428. void GLContext::gl_depth_func(GLenum func)
  429. {
  430. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_depth_func, func);
  431. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  432. RETURN_WITH_ERROR_IF(!(func == GL_NEVER
  433. || func == GL_LESS
  434. || func == GL_EQUAL
  435. || func == GL_LEQUAL
  436. || func == GL_GREATER
  437. || func == GL_NOTEQUAL
  438. || func == GL_GEQUAL
  439. || func == GL_ALWAYS),
  440. GL_INVALID_ENUM);
  441. auto options = m_rasterizer->options();
  442. switch (func) {
  443. case GL_NEVER:
  444. options.depth_func = GPU::DepthTestFunction::Never;
  445. break;
  446. case GL_ALWAYS:
  447. options.depth_func = GPU::DepthTestFunction::Always;
  448. break;
  449. case GL_LESS:
  450. options.depth_func = GPU::DepthTestFunction::Less;
  451. break;
  452. case GL_LEQUAL:
  453. options.depth_func = GPU::DepthTestFunction::LessOrEqual;
  454. break;
  455. case GL_EQUAL:
  456. options.depth_func = GPU::DepthTestFunction::Equal;
  457. break;
  458. case GL_NOTEQUAL:
  459. options.depth_func = GPU::DepthTestFunction::NotEqual;
  460. break;
  461. case GL_GEQUAL:
  462. options.depth_func = GPU::DepthTestFunction::GreaterOrEqual;
  463. break;
  464. case GL_GREATER:
  465. options.depth_func = GPU::DepthTestFunction::Greater;
  466. break;
  467. default:
  468. VERIFY_NOT_REACHED();
  469. }
  470. m_rasterizer->set_options(options);
  471. }
  472. void GLContext::gl_color_mask(GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha)
  473. {
  474. auto options = m_rasterizer->options();
  475. options.color_mask = (red == GL_TRUE ? 0xff : 0)
  476. | (green == GL_TRUE ? 0xff00 : 0)
  477. | (blue == GL_TRUE ? 0xff0000 : 0)
  478. | (alpha == GL_TRUE ? 0xff000000 : 0);
  479. m_rasterizer->set_options(options);
  480. }
  481. void GLContext::gl_polygon_mode(GLenum face, GLenum mode)
  482. {
  483. RETURN_WITH_ERROR_IF(!(face == GL_BACK || face == GL_FRONT || face == GL_FRONT_AND_BACK), GL_INVALID_ENUM);
  484. RETURN_WITH_ERROR_IF(!(mode == GL_POINT || mode == GL_LINE || mode == GL_FILL), GL_INVALID_ENUM);
  485. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  486. auto options = m_rasterizer->options();
  487. // FIXME: This must support different polygon modes for front- and backside
  488. if (face == GL_BACK) {
  489. dbgln_if(GL_DEBUG, "gl_polygon_mode(GL_BACK, {:#x}): unimplemented", mode);
  490. return;
  491. }
  492. auto map_mode = [](GLenum mode) -> GPU::PolygonMode {
  493. switch (mode) {
  494. case GL_FILL:
  495. return GPU::PolygonMode::Fill;
  496. case GL_LINE:
  497. return GPU::PolygonMode::Line;
  498. case GL_POINT:
  499. return GPU::PolygonMode::Point;
  500. default:
  501. VERIFY_NOT_REACHED();
  502. }
  503. };
  504. options.polygon_mode = map_mode(mode);
  505. m_rasterizer->set_options(options);
  506. }
  507. void GLContext::gl_polygon_offset(GLfloat factor, GLfloat units)
  508. {
  509. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_polygon_offset, factor, units);
  510. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  511. auto rasterizer_options = m_rasterizer->options();
  512. rasterizer_options.depth_offset_factor = factor;
  513. rasterizer_options.depth_offset_constant = units;
  514. m_rasterizer->set_options(rasterizer_options);
  515. }
  516. void GLContext::gl_fogfv(GLenum pname, GLfloat const* params)
  517. {
  518. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_fogfv, pname, params);
  519. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  520. auto options = m_rasterizer->options();
  521. switch (pname) {
  522. case GL_FOG_COLOR:
  523. options.fog_color = { params[0], params[1], params[2], params[3] };
  524. break;
  525. default:
  526. RETURN_WITH_ERROR_IF(true, GL_INVALID_ENUM);
  527. }
  528. m_rasterizer->set_options(options);
  529. }
  530. void GLContext::gl_fogf(GLenum pname, GLfloat param)
  531. {
  532. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_fogf, pname, param);
  533. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  534. RETURN_WITH_ERROR_IF(param < 0.0f, GL_INVALID_VALUE);
  535. auto options = m_rasterizer->options();
  536. switch (pname) {
  537. case GL_FOG_DENSITY:
  538. options.fog_density = param;
  539. break;
  540. case GL_FOG_END:
  541. options.fog_end = param;
  542. break;
  543. case GL_FOG_START:
  544. options.fog_start = param;
  545. break;
  546. default:
  547. RETURN_WITH_ERROR_IF(true, GL_INVALID_ENUM);
  548. }
  549. m_rasterizer->set_options(options);
  550. }
  551. void GLContext::gl_fogi(GLenum pname, GLint param)
  552. {
  553. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_fogi, pname, param);
  554. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  555. RETURN_WITH_ERROR_IF(param != GL_LINEAR && param != GL_EXP && param != GL_EXP2, GL_INVALID_ENUM);
  556. auto options = m_rasterizer->options();
  557. switch (pname) {
  558. case GL_FOG_MODE:
  559. switch (param) {
  560. case GL_LINEAR:
  561. options.fog_mode = GPU::FogMode::Linear;
  562. break;
  563. case GL_EXP:
  564. options.fog_mode = GPU::FogMode::Exp;
  565. break;
  566. case GL_EXP2:
  567. options.fog_mode = GPU::FogMode::Exp2;
  568. break;
  569. }
  570. break;
  571. default:
  572. RETURN_WITH_ERROR_IF(true, GL_INVALID_ENUM);
  573. }
  574. m_rasterizer->set_options(options);
  575. }
  576. void GLContext::gl_pixel_storei(GLenum pname, GLint param)
  577. {
  578. auto const is_packing_parameter = (pname >= GL_PACK_SWAP_BYTES && pname <= GL_PACK_ALIGNMENT)
  579. || pname == GL_PACK_SKIP_IMAGES
  580. || pname == GL_PACK_IMAGE_HEIGHT;
  581. auto& pixel_parameters = is_packing_parameter ? m_packing_parameters : m_unpacking_parameters;
  582. switch (pname) {
  583. case GL_PACK_ALIGNMENT:
  584. case GL_UNPACK_ALIGNMENT:
  585. RETURN_WITH_ERROR_IF(param != 1 && param != 2 && param != 4 && param != 8, GL_INVALID_VALUE);
  586. pixel_parameters.pack_alignment = param;
  587. break;
  588. case GL_PACK_IMAGE_HEIGHT:
  589. case GL_UNPACK_IMAGE_HEIGHT:
  590. RETURN_WITH_ERROR_IF(param < 0, GL_INVALID_VALUE);
  591. pixel_parameters.image_height = param;
  592. break;
  593. case GL_PACK_LSB_FIRST:
  594. case GL_UNPACK_LSB_FIRST:
  595. pixel_parameters.least_significant_bit_first = (param != 0);
  596. break;
  597. case GL_PACK_ROW_LENGTH:
  598. case GL_UNPACK_ROW_LENGTH:
  599. RETURN_WITH_ERROR_IF(param < 0, GL_INVALID_VALUE);
  600. pixel_parameters.row_length = param;
  601. break;
  602. case GL_PACK_SKIP_IMAGES:
  603. case GL_UNPACK_SKIP_IMAGES:
  604. RETURN_WITH_ERROR_IF(param < 0, GL_INVALID_VALUE);
  605. pixel_parameters.skip_images = param;
  606. break;
  607. case GL_PACK_SKIP_PIXELS:
  608. case GL_UNPACK_SKIP_PIXELS:
  609. RETURN_WITH_ERROR_IF(param < 0, GL_INVALID_VALUE);
  610. pixel_parameters.skip_pixels = param;
  611. break;
  612. case GL_PACK_SKIP_ROWS:
  613. case GL_UNPACK_SKIP_ROWS:
  614. RETURN_WITH_ERROR_IF(param < 0, GL_INVALID_VALUE);
  615. pixel_parameters.skip_rows = param;
  616. break;
  617. case GL_PACK_SWAP_BYTES:
  618. case GL_UNPACK_SWAP_BYTES:
  619. pixel_parameters.swap_bytes = (param != 0);
  620. break;
  621. default:
  622. RETURN_WITH_ERROR_IF(true, GL_INVALID_ENUM);
  623. }
  624. }
  625. void GLContext::gl_scissor(GLint x, GLint y, GLsizei width, GLsizei height)
  626. {
  627. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_scissor, x, y, width, height);
  628. RETURN_WITH_ERROR_IF(width < 0 || height < 0, GL_INVALID_VALUE);
  629. auto options = m_rasterizer->options();
  630. options.scissor_box = { x, y, width, height };
  631. m_rasterizer->set_options(options);
  632. }
  633. void GLContext::gl_raster_pos(GLfloat x, GLfloat y, GLfloat z, GLfloat w)
  634. {
  635. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_raster_pos, x, y, z, w);
  636. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  637. sync_matrices();
  638. m_rasterizer->set_raster_position({ x, y, z, w });
  639. }
  640. void GLContext::gl_line_width(GLfloat width)
  641. {
  642. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_line_width, width);
  643. RETURN_WITH_ERROR_IF(width <= 0, GL_INVALID_VALUE);
  644. m_line_width = width;
  645. auto options = m_rasterizer->options();
  646. options.line_width = width;
  647. m_rasterizer->set_options(options);
  648. }
  649. void GLContext::gl_push_attrib(GLbitfield mask)
  650. {
  651. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_push_attrib, mask);
  652. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  653. // FIXME: implement
  654. dbgln_if(GL_DEBUG, "GLContext FIXME: implement gl_push_attrib({})", mask);
  655. }
  656. void GLContext::gl_pop_attrib()
  657. {
  658. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_pop_attrib);
  659. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  660. // FIXME: implement
  661. dbgln_if(GL_DEBUG, "GLContext FIXME: implement gl_pop_attrib()");
  662. }
  663. void GLContext::gl_bitmap(GLsizei width, GLsizei height, GLfloat xorig, GLfloat yorig, GLfloat xmove, GLfloat ymove, GLubyte const* bitmap)
  664. {
  665. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_bitmap, width, height, xorig, yorig, xmove, ymove, bitmap);
  666. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  667. if (bitmap != nullptr) {
  668. // FIXME: implement
  669. dbgln_if(GL_DEBUG, "gl_bitmap({}, {}, {}, {}, {}, {}, {}): unimplemented", width, height, xorig, yorig, xmove, ymove, bitmap);
  670. }
  671. auto raster_position = m_rasterizer->raster_position();
  672. raster_position.window_coordinates += { xmove, ymove, 0.f, 0.f };
  673. m_rasterizer->set_raster_position(raster_position);
  674. }
  675. void GLContext::gl_rect(GLdouble x1, GLdouble y1, GLdouble x2, GLdouble y2)
  676. {
  677. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_rect, x1, y1, x2, y2);
  678. RETURN_WITH_ERROR_IF(m_in_draw_state, GL_INVALID_OPERATION);
  679. gl_begin(GL_POLYGON);
  680. gl_vertex(x1, y1, 0.0, 1.0);
  681. gl_vertex(x2, y1, 0.0, 1.0);
  682. gl_vertex(x2, y2, 0.0, 1.0);
  683. gl_vertex(x1, y2, 0.0, 1.0);
  684. gl_end();
  685. }
  686. void GLContext::gl_point_size(GLfloat size)
  687. {
  688. APPEND_TO_CALL_LIST_AND_RETURN_IF_NEEDED(gl_point_size, size);
  689. RETURN_WITH_ERROR_IF(size <= 0.f, GL_INVALID_VALUE);
  690. m_point_size = size;
  691. auto rasterizer_options = m_rasterizer->options();
  692. rasterizer_options.point_size = size;
  693. m_rasterizer->set_options(rasterizer_options);
  694. }
  695. void GLContext::present()
  696. {
  697. m_rasterizer->blit_from_color_buffer(*m_frontbuffer);
  698. }
  699. void GLContext::sync_device_config()
  700. {
  701. sync_clip_planes();
  702. sync_device_sampler_config();
  703. sync_device_texture_units();
  704. sync_light_state();
  705. sync_matrices();
  706. sync_stencil_configuration();
  707. }
  708. ErrorOr<ByteBuffer> GLContext::build_extension_string()
  709. {
  710. Vector<StringView, 6> extensions;
  711. // FIXME: npot texture support became a required core feature starting with OpenGL 2.0 (https://www.khronos.org/opengl/wiki/NPOT_Texture)
  712. // Ideally we would verify if the selected device adheres to the requested OpenGL context version before context creation
  713. // and refuse to create a context if it doesn't.
  714. if (m_device_info.supports_npot_textures)
  715. TRY(extensions.try_append("GL_ARB_texture_non_power_of_two"sv));
  716. if (m_device_info.num_texture_units > 1)
  717. TRY(extensions.try_append("GL_ARB_multitexture"sv));
  718. if (m_device_info.supports_texture_clamp_to_edge)
  719. TRY(extensions.try_append("GL_EXT_texture_edge_clamp"sv));
  720. if (m_device_info.supports_texture_env_add) {
  721. TRY(extensions.try_append("GL_ARB_texture_env_add"sv));
  722. TRY(extensions.try_append("GL_EXT_texture_env_add"sv));
  723. }
  724. if (m_device_info.max_texture_lod_bias > 0.f)
  725. TRY(extensions.try_append("GL_EXT_texture_lod_bias"sv));
  726. StringBuilder string_builder {};
  727. TRY(string_builder.try_join(' ', extensions));
  728. // Create null-terminated string
  729. auto extensions_bytes = TRY(string_builder.to_byte_buffer());
  730. TRY(extensions_bytes.try_append(0));
  731. return extensions_bytes;
  732. }
  733. ErrorOr<NonnullOwnPtr<GLContext>> create_context(Gfx::Bitmap& bitmap)
  734. {
  735. // FIXME: Make driver selectable. This is currently hardcoded to LibSoftGPU
  736. auto driver = TRY(GPU::Driver::try_create("softgpu"sv));
  737. auto device = TRY(driver->try_create_device(bitmap.size()));
  738. auto context = make<GLContext>(driver, move(device), bitmap);
  739. dbgln_if(GL_DEBUG, "GL::create_context({}) -> {:p}", bitmap.size(), context.ptr());
  740. if (!g_gl_context)
  741. make_context_current(context);
  742. return context;
  743. }
  744. void make_context_current(GLContext* context)
  745. {
  746. if (g_gl_context == context)
  747. return;
  748. dbgln_if(GL_DEBUG, "GL::make_context_current({:p})", context);
  749. g_gl_context = context;
  750. }
  751. }