nuklear_sdl_renderer.h 14 KB

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