nuklear_sdl_renderer.h 14 KB

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