nuklear_sdl_renderer.h 14 KB

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