nuklear_sdl_renderer.h 14 KB

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