nuklear_sdl_renderer.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. /*
  2. * Nuklear - 4.9.4 - public domain
  3. */
  4. /*
  5. * ==============================================================
  6. *
  7. * API
  8. *
  9. * ===============================================================
  10. */
  11. #ifndef NK_SDL_RENDERER_H_
  12. #define NK_SDL_RENDERER_H_
  13. #ifndef NK_SDL_RENDERER_SDL_H
  14. #define NK_SDL_RENDERER_SDL_H <SDL.h>
  15. #endif
  16. #include NK_SDL_RENDERER_SDL_H
  17. NK_API struct nk_context* nk_sdl_init(SDL_Window *win, SDL_Renderer *renderer);
  18. NK_API void nk_sdl_font_stash_begin(struct nk_font_atlas **atlas);
  19. NK_API void nk_sdl_font_stash_end(void);
  20. NK_API int nk_sdl_handle_event(SDL_Event *evt);
  21. NK_API void nk_sdl_render(enum nk_anti_aliasing);
  22. NK_API void nk_sdl_shutdown(void);
  23. NK_API void nk_sdl_handle_grab(void);
  24. #if SDL_COMPILEDVERSION < SDL_VERSIONNUM(2, 0, 22)
  25. /* Metal API does not support cliprects with negative coordinates or large
  26. * dimensions. The issue is fixed in SDL2 with version 2.0.22 but until
  27. * that version is released, the NK_SDL_CLAMP_CLIP_RECT flag can be used to
  28. * ensure the cliprect is itself clipped to the viewport.
  29. * See discussion at https://discourse.libsdl.org/t/rendergeometryraw-producing-different-results-in-metal-vs-opengl/34953
  30. */
  31. #define NK_SDL_CLAMP_CLIP_RECT
  32. #endif
  33. #endif /* NK_SDL_RENDERER_H_ */
  34. /*
  35. * ==============================================================
  36. *
  37. * IMPLEMENTATION
  38. *
  39. * ===============================================================
  40. */
  41. #ifdef NK_SDL_RENDERER_IMPLEMENTATION
  42. #include <string.h>
  43. #include <stdlib.h>
  44. struct nk_sdl_device {
  45. struct nk_buffer cmds;
  46. struct nk_draw_null_texture tex_null;
  47. SDL_Texture *font_tex;
  48. };
  49. struct nk_sdl_vertex {
  50. float position[2];
  51. float uv[2];
  52. nk_byte col[4];
  53. };
  54. static struct nk_sdl {
  55. SDL_Window *win;
  56. SDL_Renderer *renderer;
  57. struct nk_sdl_device ogl;
  58. struct nk_context ctx;
  59. struct nk_font_atlas atlas;
  60. Uint64 time_of_last_frame;
  61. } sdl;
  62. NK_INTERN void
  63. nk_sdl_device_upload_atlas(const void *image, int width, int height)
  64. {
  65. struct nk_sdl_device *dev = &sdl.ogl;
  66. SDL_Texture *g_SDLFontTexture = SDL_CreateTexture(sdl.renderer, SDL_PIXELFORMAT_ARGB8888, SDL_TEXTUREACCESS_STATIC, width, height);
  67. if (g_SDLFontTexture == NULL) {
  68. SDL_Log("error creating texture");
  69. return;
  70. }
  71. SDL_UpdateTexture(g_SDLFontTexture, NULL, image, 4 * width);
  72. SDL_SetTextureBlendMode(g_SDLFontTexture, SDL_BLENDMODE_BLEND);
  73. dev->font_tex = g_SDLFontTexture;
  74. }
  75. NK_API void
  76. nk_sdl_render(enum nk_anti_aliasing AA)
  77. {
  78. /* setup global state */
  79. struct nk_sdl_device *dev = &sdl.ogl;
  80. {
  81. SDL_Rect saved_clip;
  82. #ifdef NK_SDL_CLAMP_CLIP_RECT
  83. SDL_Rect viewport;
  84. #endif
  85. SDL_bool clipping_enabled;
  86. int vs = sizeof(struct nk_sdl_vertex);
  87. size_t vp = offsetof(struct nk_sdl_vertex, position);
  88. size_t vt = offsetof(struct nk_sdl_vertex, uv);
  89. size_t vc = offsetof(struct nk_sdl_vertex, col);
  90. /* convert from command queue into draw list and draw to screen */
  91. const struct nk_draw_command *cmd;
  92. const nk_draw_index *offset = NULL;
  93. struct nk_buffer vbuf, ebuf;
  94. /* fill converting configuration */
  95. struct nk_convert_config config;
  96. static const struct nk_draw_vertex_layout_element vertex_layout[] = {
  97. {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_sdl_vertex, position)},
  98. {NK_VERTEX_TEXCOORD, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_sdl_vertex, uv)},
  99. {NK_VERTEX_COLOR, NK_FORMAT_R8G8B8A8, NK_OFFSETOF(struct nk_sdl_vertex, col)},
  100. {NK_VERTEX_LAYOUT_END}
  101. };
  102. Uint64 now = SDL_GetTicks64();
  103. sdl.ctx.delta_time_seconds = (float)(now - sdl.time_of_last_frame) / 1000;
  104. sdl.time_of_last_frame = now;
  105. NK_MEMSET(&config, 0, sizeof(config));
  106. config.vertex_layout = vertex_layout;
  107. config.vertex_size = sizeof(struct nk_sdl_vertex);
  108. config.vertex_alignment = NK_ALIGNOF(struct nk_sdl_vertex);
  109. config.tex_null = dev->tex_null;
  110. config.circle_segment_count = 22;
  111. config.curve_segment_count = 22;
  112. config.arc_segment_count = 22;
  113. config.global_alpha = 1.0f;
  114. config.shape_AA = AA;
  115. config.line_AA = AA;
  116. /* convert shapes into vertexes */
  117. nk_buffer_init_default(&vbuf);
  118. nk_buffer_init_default(&ebuf);
  119. nk_convert(&sdl.ctx, &dev->cmds, &vbuf, &ebuf, &config);
  120. /* iterate over and execute each draw command */
  121. offset = (const nk_draw_index*)nk_buffer_memory_const(&ebuf);
  122. clipping_enabled = SDL_RenderIsClipEnabled(sdl.renderer);
  123. SDL_RenderGetClipRect(sdl.renderer, &saved_clip);
  124. #ifdef NK_SDL_CLAMP_CLIP_RECT
  125. SDL_RenderGetViewport(sdl.renderer, &viewport);
  126. #endif
  127. nk_draw_foreach(cmd, &sdl.ctx, &dev->cmds)
  128. {
  129. if (!cmd->elem_count) continue;
  130. {
  131. SDL_Rect r;
  132. r.x = cmd->clip_rect.x;
  133. r.y = cmd->clip_rect.y;
  134. r.w = cmd->clip_rect.w;
  135. r.h = cmd->clip_rect.h;
  136. #ifdef NK_SDL_CLAMP_CLIP_RECT
  137. if (r.x < 0) {
  138. r.w += r.x;
  139. r.x = 0;
  140. }
  141. if (r.y < 0) {
  142. r.h += r.y;
  143. r.y = 0;
  144. }
  145. if (r.h > viewport.h) {
  146. r.h = viewport.h;
  147. }
  148. if (r.w > viewport.w) {
  149. r.w = viewport.w;
  150. }
  151. #endif
  152. SDL_RenderSetClipRect(sdl.renderer, &r);
  153. }
  154. {
  155. const void *vertices = nk_buffer_memory_const(&vbuf);
  156. SDL_RenderGeometryRaw(sdl.renderer,
  157. (SDL_Texture *)cmd->texture.ptr,
  158. (const float*)((const nk_byte*)vertices + vp), vs,
  159. (const SDL_Color*)((const nk_byte*)vertices + vc), vs,
  160. (const float*)((const nk_byte*)vertices + vt), vs,
  161. (vbuf.needed / vs),
  162. (void *) offset, cmd->elem_count, 2);
  163. offset += cmd->elem_count;
  164. }
  165. }
  166. SDL_RenderSetClipRect(sdl.renderer, &saved_clip);
  167. if (!clipping_enabled) {
  168. SDL_RenderSetClipRect(sdl.renderer, NULL);
  169. }
  170. nk_clear(&sdl.ctx);
  171. nk_buffer_clear(&dev->cmds);
  172. nk_buffer_free(&vbuf);
  173. nk_buffer_free(&ebuf);
  174. }
  175. }
  176. static void
  177. nk_sdl_clipboard_paste(nk_handle usr, struct nk_text_edit *edit)
  178. {
  179. const char *text = SDL_GetClipboardText();
  180. if (text) nk_textedit_paste(edit, text, nk_strlen(text));
  181. (void)usr;
  182. }
  183. static void
  184. nk_sdl_clipboard_copy(nk_handle usr, const char *text, int len)
  185. {
  186. char *str = 0;
  187. (void)usr;
  188. if (!len) return;
  189. str = (char*)malloc((size_t)len+1);
  190. if (!str) return;
  191. memcpy(str, text, (size_t)len);
  192. str[len] = '\0';
  193. SDL_SetClipboardText(str);
  194. free(str);
  195. }
  196. NK_API struct nk_context*
  197. nk_sdl_init(SDL_Window *win, SDL_Renderer *renderer)
  198. {
  199. #ifndef NK_SDL_CLAMP_CLIP_RECT
  200. SDL_RendererInfo info;
  201. SDL_version runtimeVer;
  202. /* warn for cases where NK_SDL_CLAMP_CLIP_RECT should have been set but isn't */
  203. SDL_GetRendererInfo(renderer, &info);
  204. SDL_GetVersion(&runtimeVer);
  205. if (strncmp("metal", info.name, 5) == 0 &&
  206. SDL_VERSIONNUM(runtimeVer.major, runtimeVer.minor, runtimeVer.patch) < SDL_VERSIONNUM(2, 0, 22))
  207. {
  208. SDL_LogWarn(
  209. SDL_LOG_CATEGORY_APPLICATION,
  210. "renderer is using Metal API but runtime SDL version %d.%d.%d is older than compiled version %d.%d.%d, "
  211. "which may cause issues with rendering",
  212. runtimeVer.major, runtimeVer.minor, runtimeVer.patch,
  213. SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL
  214. );
  215. }
  216. #endif
  217. sdl.win = win;
  218. sdl.renderer = renderer;
  219. sdl.time_of_last_frame = SDL_GetTicks64();
  220. nk_init_default(&sdl.ctx, 0);
  221. sdl.ctx.clip.copy = nk_sdl_clipboard_copy;
  222. sdl.ctx.clip.paste = nk_sdl_clipboard_paste;
  223. sdl.ctx.clip.userdata = nk_handle_ptr(0);
  224. nk_buffer_init_default(&sdl.ogl.cmds);
  225. return &sdl.ctx;
  226. }
  227. NK_API void
  228. nk_sdl_font_stash_begin(struct nk_font_atlas **atlas)
  229. {
  230. nk_font_atlas_init_default(&sdl.atlas);
  231. nk_font_atlas_begin(&sdl.atlas);
  232. *atlas = &sdl.atlas;
  233. }
  234. NK_API void
  235. nk_sdl_font_stash_end(void)
  236. {
  237. const void *image; int w, h;
  238. image = nk_font_atlas_bake(&sdl.atlas, &w, &h, NK_FONT_ATLAS_RGBA32);
  239. nk_sdl_device_upload_atlas(image, w, h);
  240. nk_font_atlas_end(&sdl.atlas, nk_handle_ptr(sdl.ogl.font_tex), &sdl.ogl.tex_null);
  241. if (sdl.atlas.default_font)
  242. nk_style_set_font(&sdl.ctx, &sdl.atlas.default_font->handle);
  243. }
  244. NK_API void
  245. nk_sdl_handle_grab(void)
  246. {
  247. struct nk_context *ctx = &sdl.ctx;
  248. if (ctx->input.mouse.grab) {
  249. SDL_SetRelativeMouseMode(SDL_TRUE);
  250. } else if (ctx->input.mouse.ungrab) {
  251. /* better support for older SDL by setting mode first; causes an extra mouse motion event */
  252. SDL_SetRelativeMouseMode(SDL_FALSE);
  253. SDL_WarpMouseInWindow(sdl.win, (int)ctx->input.mouse.prev.x, (int)ctx->input.mouse.prev.y);
  254. } else if (ctx->input.mouse.grabbed) {
  255. ctx->input.mouse.pos.x = ctx->input.mouse.prev.x;
  256. ctx->input.mouse.pos.y = ctx->input.mouse.prev.y;
  257. }
  258. }
  259. NK_API int
  260. nk_sdl_handle_event(SDL_Event *evt)
  261. {
  262. struct nk_context *ctx = &sdl.ctx;
  263. switch(evt->type)
  264. {
  265. case SDL_KEYUP: /* KEYUP & KEYDOWN share same routine */
  266. case SDL_KEYDOWN:
  267. {
  268. int down = evt->type == SDL_KEYDOWN;
  269. const Uint8* state = SDL_GetKeyboardState(0);
  270. switch(evt->key.keysym.sym)
  271. {
  272. case SDLK_RSHIFT: /* RSHIFT & LSHIFT share same routine */
  273. case SDLK_LSHIFT: nk_input_key(ctx, NK_KEY_SHIFT, down); break;
  274. case SDLK_DELETE: nk_input_key(ctx, NK_KEY_DEL, down); break;
  275. case SDLK_KP_ENTER:
  276. case SDLK_RETURN: nk_input_key(ctx, NK_KEY_ENTER, down); break;
  277. case SDLK_TAB: nk_input_key(ctx, NK_KEY_TAB, down); break;
  278. case SDLK_BACKSPACE: nk_input_key(ctx, NK_KEY_BACKSPACE, down); break;
  279. case SDLK_HOME: nk_input_key(ctx, NK_KEY_TEXT_START, down);
  280. nk_input_key(ctx, NK_KEY_SCROLL_START, down); break;
  281. case SDLK_END: nk_input_key(ctx, NK_KEY_TEXT_END, down);
  282. nk_input_key(ctx, NK_KEY_SCROLL_END, down); break;
  283. case SDLK_PAGEDOWN: nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); break;
  284. case SDLK_PAGEUP: nk_input_key(ctx, NK_KEY_SCROLL_UP, down); break;
  285. case SDLK_z: nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); break;
  286. case SDLK_r: nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); break;
  287. case SDLK_c: nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); break;
  288. case SDLK_v: nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); break;
  289. case SDLK_x: nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); break;
  290. case SDLK_b: nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); break;
  291. case SDLK_e: nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); break;
  292. case SDLK_UP: nk_input_key(ctx, NK_KEY_UP, down); break;
  293. case SDLK_DOWN: nk_input_key(ctx, NK_KEY_DOWN, down); break;
  294. case SDLK_a:
  295. if(state[SDL_SCANCODE_LCTRL])
  296. nk_input_key(ctx,NK_KEY_TEXT_SELECT_ALL, down);
  297. break;
  298. case SDLK_LEFT:
  299. if (state[SDL_SCANCODE_LCTRL])
  300. nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down);
  301. else nk_input_key(ctx, NK_KEY_LEFT, down);
  302. break;
  303. case SDLK_RIGHT:
  304. if (state[SDL_SCANCODE_LCTRL])
  305. nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down);
  306. else nk_input_key(ctx, NK_KEY_RIGHT, down);
  307. break;
  308. }
  309. }
  310. return 1;
  311. case SDL_MOUSEBUTTONUP: /* MOUSEBUTTONUP & MOUSEBUTTONDOWN share same routine */
  312. case SDL_MOUSEBUTTONDOWN:
  313. {
  314. int down = evt->type == SDL_MOUSEBUTTONDOWN;
  315. const int x = evt->button.x, y = evt->button.y;
  316. switch(evt->button.button)
  317. {
  318. case SDL_BUTTON_LEFT:
  319. if (evt->button.clicks > 1)
  320. nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down);
  321. nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); break;
  322. case SDL_BUTTON_MIDDLE: nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); break;
  323. case SDL_BUTTON_RIGHT: nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); break;
  324. }
  325. }
  326. return 1;
  327. case SDL_MOUSEMOTION:
  328. if (ctx->input.mouse.grabbed) {
  329. int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y;
  330. nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel);
  331. }
  332. else nk_input_motion(ctx, evt->motion.x, evt->motion.y);
  333. return 1;
  334. case SDL_TEXTINPUT:
  335. {
  336. nk_glyph glyph;
  337. memcpy(glyph, evt->text.text, NK_UTF_SIZE);
  338. nk_input_glyph(ctx, glyph);
  339. }
  340. return 1;
  341. case SDL_MOUSEWHEEL:
  342. nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y));
  343. return 1;
  344. }
  345. return 0;
  346. }
  347. NK_API
  348. void nk_sdl_shutdown(void)
  349. {
  350. struct nk_sdl_device *dev = &sdl.ogl;
  351. nk_font_atlas_clear(&sdl.atlas);
  352. nk_free(&sdl.ctx);
  353. SDL_DestroyTexture(dev->font_tex);
  354. /* glDeleteTextures(1, &dev->font_tex); */
  355. nk_buffer_free(&dev->cmds);
  356. memset(&sdl, 0, sizeof(sdl));
  357. }
  358. #endif /* NK_SDL_RENDERER_IMPLEMENTATION */