nuklear_sdl_renderer.h 14 KB

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