diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4ce28c3 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# EditorConfig: https://EditorConfig.org + +root = true + +[*] +indent_style = space +charset = utf-8 +end_of_line = lf +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +[clib.json] +indent_size = 2 diff --git a/.github/workflows/create-tag.yml b/.github/workflows/create-tag.yml new file mode 100644 index 0000000..f5f30b0 --- /dev/null +++ b/.github/workflows/create-tag.yml @@ -0,0 +1,16 @@ +name: Create Tag + +on: + push: + branches: + - master + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: butlerlogic/action-autotag@stable + with: + GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" + root: clib.json diff --git a/Readme.md b/Readme.md index 3d42f2d..401ea3e 100644 --- a/Readme.md +++ b/Readme.md @@ -92,7 +92,7 @@ nk_end(&ctx); ![example](https://cloud.githubusercontent.com/assets/8057201/10187981/584ecd68-675c-11e5-897c-822ef534a876.png) ## Bindings -There are a number of nuklear bindings for different languges created by other authors. +There are a number of nuklear bindings for different languages created by other authors. I cannot attest for their quality since I am not necessarily proficient in any of these languages. Furthermore there are no guarantee that all bindings will always be kept up to date: @@ -185,8 +185,8 @@ Reviewing changes to `src/*` and `nuklear.h`: * Variable/function name casing. * Indentation. * Curly bracket (`{}`) placement. -* Ensure that the contributer have bumped the appropriate version in - [package.json](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/package.json) +* Ensure that the contributor has bumped the appropriate version in + [clib.json](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/clib.json) and added their changes to the [CHANGELOG](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/src/CHANGELOG). * Have at least one other person review the changes before merging. diff --git a/package.json b/clib.json similarity index 76% rename from package.json rename to clib.json index 65aa3eb..3fe7d63 100644 --- a/package.json +++ b/clib.json @@ -1,8 +1,9 @@ { "name": "nuklear", - "version": "4.09.0", + "version": "4.10.1", "repo": "Immediate-Mode-UI/Nuklear", "description": "A small ANSI C gui toolkit", "keywords": ["gl", "ui", "toolkit"], + "license": "MIT, Unlicense", "src": ["nuklear.h"] } diff --git a/demo/allegro5/Makefile b/demo/allegro5/Makefile index 090a126..d792fa2 100644 --- a/demo/allegro5/Makefile +++ b/demo/allegro5/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -Wno-unused-function -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/allegro5/main.c b/demo/allegro5/main.c index 2f3cb54..ee01de7 100644 --- a/demo/allegro5/main.c +++ b/demo/allegro5/main.c @@ -29,32 +29,57 @@ #define MAX(a,b) ((a) < (b) ? (b) : (a)) #define LEN(a) (sizeof(a)/sizeof(a)[0]) + /* =============================================================== * * EXAMPLE * * ===============================================================*/ /* This are some code examples to provide a small overview of what can be - * done with this library. To try out an example uncomment the include - * and the corresponding function. */ -/*#include "../style.c"*/ -/*#include "../calculator.c"*/ -#include "../overview.c" -/*#include "../node_editor.c"*/ + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ +#define INCLUDE_OVERVIEW +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif /* =============================================================== * * DEMO * * ===============================================================*/ -static void error_callback(int e, const char *d) -{printf("Error %d: %s\n", e, d);} - int main(void) { /* Platform */ ALLEGRO_DISPLAY *display = NULL; ALLEGRO_EVENT_QUEUE *event_queue = NULL; + NkAllegro5Font *font; + struct nk_context *ctx; if (!al_init()) { fprintf(stdout, "failed to initialize allegro5!\n"); @@ -85,25 +110,32 @@ int main(void) al_register_event_source(event_queue, al_get_mouse_event_source()); al_register_event_source(event_queue, al_get_keyboard_event_source()); - NkAllegro5Font *font; font = nk_allegro5_font_create_from_file("../../../extra_font/Roboto-Regular.ttf", 12, 0); - struct nk_context *ctx; ctx = nk_allegro5_init(font, display, WINDOW_WIDTH, WINDOW_HEIGHT); /* style.c */ - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + #ifdef INCLUDE_STYLE + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif + #endif while(1) { + bool get_event; ALLEGRO_EVENT ev; ALLEGRO_TIMEOUT timeout; al_init_timeout(&timeout, 0.06); - bool get_event = al_wait_for_event_until(event_queue, &ev, &timeout); + get_event = al_wait_for_event_until(event_queue, &ev, &timeout); if (get_event && ev.type == ALLEGRO_EVENT_DISPLAY_CLOSE) { break; @@ -141,9 +173,18 @@ int main(void) nk_end(ctx); /* -------------- EXAMPLES ---------------- */ - /*calculator(ctx);*/ - overview(ctx); - /*node_editor(ctx);*/ + #ifdef INCLUDE_CALCULATOR + calculator(ctx); + #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif + #ifdef INCLUDE_OVERVIEW + overview(ctx); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(ctx); + #endif /* ----------------------------------------- */ /* Draw */ diff --git a/demo/allegro5/nuklear_allegro5.h b/demo/allegro5/nuklear_allegro5.h index f697317..8e10c9b 100644 --- a/demo/allegro5/nuklear_allegro5.h +++ b/demo/allegro5/nuklear_allegro5.h @@ -70,18 +70,20 @@ static struct nk_allegro5 { NK_API struct nk_image* nk_allegro5_create_image(const char* file_name) { + ALLEGRO_BITMAP *bitmap; + struct nk_image *image; if (!al_init_image_addon()) { fprintf(stdout, "Unable to initialize required allegro5 image addon\n"); exit(1); } - ALLEGRO_BITMAP* bitmap = al_load_bitmap(file_name); + bitmap = al_load_bitmap(file_name); if (bitmap == NULL) { fprintf(stdout, "Unable to load image file: %s\n", file_name); return NULL; } - struct nk_image *image = (struct nk_image*)calloc(1, sizeof(struct nk_image)); + image = (struct nk_image*)calloc(1, sizeof(struct nk_image)); image->handle.ptr = bitmap; image->w = al_get_bitmap_width(bitmap); image->h = al_get_bitmap_height(bitmap); @@ -98,7 +100,10 @@ NK_API void nk_allegro5_del_image(struct nk_image* image) static float nk_allegro5_font_get_text_width(nk_handle handle, float height, const char *text, int len) { + float width; + char *strcpy; NkAllegro5Font *font = (NkAllegro5Font*)handle.ptr; + NK_UNUSED(height); if (!font || !text) { return 0; } @@ -106,16 +111,19 @@ nk_allegro5_font_get_text_width(nk_handle handle, float height, const char *text as nuklear uses variable size buffers and al_get_text_width doesn't accept a length, it infers length from null-termination (which is unsafe API design by allegro devs!) */ - char strcpy[len+1]; - strncpy((char*)&strcpy, text, len); + strcpy = malloc(len + 1); + strncpy(strcpy, text, len); strcpy[len] = '\0'; - return al_get_text_width(font->font, strcpy); + width = al_get_text_width(font->font, strcpy); + free(strcpy); + return width; } /* Flags are identical to al_load_font() flags argument */ NK_API NkAllegro5Font* nk_allegro5_font_create_from_file(const char *file_name, int font_size, int flags) { + NkAllegro5Font *font; if (!al_init_image_addon()) { fprintf(stdout, "Unable to initialize required allegro5 image addon\n"); exit(1); @@ -128,7 +136,7 @@ nk_allegro5_font_create_from_file(const char *file_name, int font_size, int flag fprintf(stdout, "Unable to initialize required allegro5 TTF font addon\n"); exit(1); } - NkAllegro5Font *font = (NkAllegro5Font*)calloc(1, sizeof(NkAllegro5Font)); + font = (NkAllegro5Font*)calloc(1, sizeof(NkAllegro5Font)); font->font = al_load_font(file_name, font_size, flags); if (font->font == NULL) { @@ -200,18 +208,18 @@ nk_allegro5_render() (float)r->rounding, color); } break; case NK_COMMAND_CIRCLE: { + float xr, yr; const struct nk_command_circle *c = (const struct nk_command_circle *)cmd; color = nk_color_to_allegro_color(c->color); - float xr, yr; xr = (float)c->w/2; yr = (float)c->h/2; al_draw_ellipse(((float)(c->x)) + xr, ((float)c->y) + yr, xr, yr, color, (float)c->line_thickness); } break; case NK_COMMAND_CIRCLE_FILLED: { + float xr, yr; const struct nk_command_circle_filled *c = (const struct nk_command_circle_filled *)cmd; color = nk_color_to_allegro_color(c->color); - float xr, yr; xr = (float)c->w/2; yr = (float)c->h/2; al_draw_filled_ellipse(((float)(c->x)) + xr, ((float)c->y) + yr, @@ -230,54 +238,61 @@ nk_allegro5_render() (float)t->b.y, (float)t->c.x, (float)t->c.y, color); } break; case NK_COMMAND_POLYGON: { - const struct nk_command_polygon *p = (const struct nk_command_polygon*)cmd; - color = nk_color_to_allegro_color(p->color); int i; - float vertices[p->point_count * 2]; + float *vertices; + const struct nk_command_polygon *p = (const struct nk_command_polygon*)cmd; + vertices = calloc(p->point_count * 2, sizeof(float)); + color = nk_color_to_allegro_color(p->color); for (i = 0; i < p->point_count; i++) { vertices[i*2] = p->points[i].x; vertices[(i*2) + 1] = p->points[i].y; } - al_draw_polyline((const float*)&vertices, (2 * sizeof(float)), + al_draw_polyline(vertices, (2 * sizeof(float)), (int)p->point_count, ALLEGRO_LINE_JOIN_ROUND, ALLEGRO_LINE_CAP_CLOSED, color, (float)p->line_thickness, 0.0); + free(vertices); } break; case NK_COMMAND_POLYGON_FILLED: { + int i, j = 0; + float *vertices; const struct nk_command_polygon_filled *p = (const struct nk_command_polygon_filled *)cmd; + vertices = calloc(p->point_count * 2, sizeof(float)); color = nk_color_to_allegro_color(p->color); - int i; - float vertices[p->point_count * 2]; - for (i = 0; i < p->point_count; i++) { - vertices[i*2] = p->points[i].x; - vertices[(i*2) + 1] = p->points[i].y; + for (i = p->point_count - 1; i >= 0; i--) { + vertices[j++] = p->points[i].x; + vertices[j++] = p->points[i].y; } - al_draw_filled_polygon((const float*)&vertices, (int)p->point_count, color); + al_draw_filled_polygon(vertices, (int)p->point_count, color); + free(vertices); } break; case NK_COMMAND_POLYLINE: { - const struct nk_command_polyline *p = (const struct nk_command_polyline *)cmd; - color = nk_color_to_allegro_color(p->color); int i; - float vertices[p->point_count * 2]; + float *vertices; + const struct nk_command_polyline *p = (const struct nk_command_polyline *)cmd; + vertices = calloc(p->point_count * 2, sizeof(float)); + color = nk_color_to_allegro_color(p->color); for (i = 0; i < p->point_count; i++) { vertices[i*2] = p->points[i].x; vertices[(i*2) + 1] = p->points[i].y; } - al_draw_polyline((const float*)&vertices, (2 * sizeof(float)), + al_draw_polyline(vertices, (2 * sizeof(float)), (int)p->point_count, ALLEGRO_LINE_JOIN_ROUND, ALLEGRO_LINE_CAP_ROUND, color, (float)p->line_thickness, 0.0); + free(vertices); } break; case NK_COMMAND_TEXT: { + NkAllegro5Font *font; const struct nk_command_text *t = (const struct nk_command_text*)cmd; color = nk_color_to_allegro_color(t->foreground); - NkAllegro5Font *font = (NkAllegro5Font*)t->font->userdata.ptr; + font = (NkAllegro5Font*)t->font->userdata.ptr; al_draw_text(font->font, color, (float)t->x, (float)t->y, 0, (const char*)t->string); } break; case NK_COMMAND_CURVE: { + float points[8]; const struct nk_command_curve *q = (const struct nk_command_curve *)cmd; color = nk_color_to_allegro_color(q->color); - float points[8]; points[0] = (float)q->begin.x; points[1] = (float)q->begin.y; points[2] = (float)q->ctrl[0].x; @@ -291,15 +306,20 @@ nk_allegro5_render() case NK_COMMAND_ARC: { const struct nk_command_arc *a = (const struct nk_command_arc *)cmd; color = nk_color_to_allegro_color(a->color); - al_draw_arc((float)a->cx, (float)a->cy, (float)a->r, a->a[0], + al_draw_pieslice((float)a->cx, (float)a->cy, (float)a->r, a->a[0], a->a[1], color, (float)a->line_thickness); } break; + case NK_COMMAND_ARC_FILLED: { + const struct nk_command_arc_filled *a = (const struct nk_command_arc_filled *)cmd; + color = nk_color_to_allegro_color(a->color); + al_draw_filled_pieslice((float)a->cx, (float)a->cy, (float)a->r, a->a[0], + a->a[1], color); + } break; case NK_COMMAND_IMAGE: { const struct nk_command_image *i = (const struct nk_command_image *)cmd; al_draw_bitmap_region(i->img.handle.ptr, 0, 0, i->w, i->h, i->x, i->y, 0); } break; case NK_COMMAND_RECT_MULTI_COLOR: - case NK_COMMAND_ARC_FILLED: default: break; } } @@ -465,12 +485,13 @@ NK_API struct nk_context* nk_allegro5_init(NkAllegro5Font *allegro5font, ALLEGRO_DISPLAY *dsp, unsigned int width, unsigned int height) { + struct nk_user_font *font; if (!al_init_primitives_addon()) { fprintf(stdout, "Unable to initialize required allegro5 primitives addon\n"); exit(1); } - struct nk_user_font *font = &allegro5font->nk; + font = &allegro5font->nk; allegro5.dsp = dsp; allegro5.width = width; diff --git a/demo/calculator.c b/demo/common/calculator.c similarity index 100% rename from demo/calculator.c rename to demo/common/calculator.c diff --git a/demo/common/canvas.c b/demo/common/canvas.c new file mode 100644 index 0000000..6c50bcb --- /dev/null +++ b/demo/common/canvas.c @@ -0,0 +1,105 @@ +/* nuklear - v1.05 - public domain */ +struct nk_canvas { + struct nk_command_buffer *painter; + struct nk_vec2 item_spacing; + struct nk_vec2 panel_padding; + struct nk_style_item window_background; +}; + +static nk_bool +canvas_begin(struct nk_context *ctx, struct nk_canvas *canvas, nk_flags flags, + int x, int y, int width, int height, struct nk_color background_color) +{ + /* save style properties which will be overwritten */ + canvas->panel_padding = ctx->style.window.padding; + canvas->item_spacing = ctx->style.window.spacing; + canvas->window_background = ctx->style.window.fixed_background; + + /* use the complete window space and set background */ + ctx->style.window.spacing = nk_vec2(0,0); + ctx->style.window.padding = nk_vec2(0,0); + ctx->style.window.fixed_background = nk_style_item_color(background_color); + + /* create/update window and set position + size */ + if (!nk_begin(ctx, "Canvas", nk_rect(x, y, width, height), NK_WINDOW_NO_SCROLLBAR|flags)) + return nk_false; + + /* allocate the complete window space for drawing */ + { + struct nk_rect total_space; + total_space = nk_window_get_content_region(ctx); + nk_layout_row_dynamic(ctx, total_space.h, 1); + nk_widget(&total_space, ctx); + canvas->painter = nk_window_get_canvas(ctx); + } + + return nk_true; +} + +static void +canvas_end(struct nk_context *ctx, struct nk_canvas *canvas) +{ + nk_end(ctx); + ctx->style.window.spacing = canvas->panel_padding; + ctx->style.window.padding = canvas->item_spacing; + ctx->style.window.fixed_background = canvas->window_background; +} + +static void +canvas(struct nk_context *ctx) +{ + struct nk_canvas canvas; + if (canvas_begin(ctx, &canvas, NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_SCALABLE| + NK_WINDOW_CLOSABLE|NK_WINDOW_MINIMIZABLE|NK_WINDOW_TITLE, 10, 10, 500, 550, nk_rgb(250,250,250))) + { + float x = canvas.painter->clip.x, y = canvas.painter->clip.y; + + nk_fill_rect(canvas.painter, nk_rect(x + 15, y + 15, 210, 210), 5, nk_rgb(247, 230, 154)); + nk_fill_rect(canvas.painter, nk_rect(x + 20, y + 20, 200, 200), 5, nk_rgb(188, 174, 118)); + /* nk_draw_text(canvas.painter, nk_rect(x + 30, y + 30, 150, 20), "Text to draw", 12, &font->handle, nk_rgb(188,174,118), nk_rgb(0,0,0)); */ + nk_fill_rect(canvas.painter, nk_rect(x + 250, y + 20, 100, 100), 0, nk_rgb(0,0,255)); + nk_fill_circle(canvas.painter, nk_rect(x + 20, y + 250, 100, 100), nk_rgb(255,0,0)); + nk_fill_triangle(canvas.painter, x + 250, y + 250, x + 350, y + 250, x + 300, y + 350, nk_rgb(0,255,0)); + nk_fill_arc(canvas.painter, x + 300, y + 420, 50, 0, 3.141592654f * 3.0f / 4.0f, nk_rgb(255,255,0)); + + { + float points[12]; + points[0] = x + 200; points[1] = y + 250; + points[2] = x + 250; points[3] = y + 350; + points[4] = x + 225; points[5] = y + 350; + points[6] = x + 200; points[7] = y + 300; + points[8] = x + 175; points[9] = y + 350; + points[10] = x + 150; points[11] = y + 350; + nk_fill_polygon(canvas.painter, points, 6, nk_rgb(0,0,0)); + } + + { + float points[12]; + points[0] = x + 200; points[1] = y + 370; + points[2] = x + 250; points[3] = y + 470; + points[4] = x + 225; points[5] = y + 470; + points[6] = x + 200; points[7] = y + 420; + points[8] = x + 175; points[9] = y + 470; + points[10] = x + 150; points[11] = y + 470; + nk_stroke_polygon(canvas.painter, points, 6, 4, nk_rgb(0,0,0)); + } + + { + float points[8]; + points[0] = x + 250; points[1] = y + 200; + points[2] = x + 275; points[3] = y + 220; + points[4] = x + 325; points[5] = y + 170; + points[6] = x + 350; points[7] = y + 200; + nk_stroke_polyline(canvas.painter, points, 4, 2, nk_rgb(255,128,0)); + } + + nk_stroke_line(canvas.painter, x + 15, y + 10, x + 200, y + 10, 2.0f, nk_rgb(189,45,75)); + nk_stroke_rect(canvas.painter, nk_rect(x + 370, y + 20, 100, 100), 10, 3, nk_rgb(0,0,255)); + nk_stroke_curve(canvas.painter, x + 380, y + 200, x + 405, y + 270, x + 455, y + 120, x + 480, y + 200, 2, nk_rgb(0,150,220)); + nk_stroke_circle(canvas.painter, nk_rect(x + 20, y + 370, 100, 100), 5, nk_rgb(0,255,120)); + nk_stroke_triangle(canvas.painter, x + 370, y + 250, x + 470, y + 250, x + 420, y + 350, 6, nk_rgb(255,0,143)); + nk_stroke_arc(canvas.painter, x + 420, y + 420, 50, 0, 3.141592654f * 3.0f / 4.0f, 5, nk_rgb(0,255,255)); + } + canvas_end(ctx, &canvas); +} + diff --git a/demo/common/file_browser.c b/demo/common/file_browser.c new file mode 100644 index 0000000..9095aa3 --- /dev/null +++ b/demo/common/file_browser.c @@ -0,0 +1,511 @@ +#include // strcpy, strlen + +#ifdef __unix__ +#include +#include +#endif + +#ifndef _WIN32 +# include +#endif + +struct icons { + struct nk_image desktop; + struct nk_image home; + struct nk_image computer; + struct nk_image directory; + + struct nk_image default_file; + struct nk_image text_file; + struct nk_image music_file; + struct nk_image font_file; + struct nk_image img_file; + struct nk_image movie_file; +}; + +enum file_groups { + FILE_GROUP_DEFAULT, + FILE_GROUP_TEXT, + FILE_GROUP_MUSIC, + FILE_GROUP_FONT, + FILE_GROUP_IMAGE, + FILE_GROUP_MOVIE, + FILE_GROUP_MAX +}; + +enum file_types { + FILE_DEFAULT, + FILE_TEXT, + FILE_C_SOURCE, + FILE_CPP_SOURCE, + FILE_HEADER, + FILE_CPP_HEADER, + FILE_MP3, + FILE_WAV, + FILE_OGG, + FILE_TTF, + FILE_BMP, + FILE_PNG, + FILE_JPEG, + FILE_PCX, + FILE_TGA, + FILE_GIF, + FILE_MAX +}; + +struct file_group { + enum file_groups group; + const char *name; + struct nk_image *icon; +}; + +struct file { + enum file_types type; + const char *suffix; + enum file_groups group; +}; + +struct media { + int font; + int icon_sheet; + struct icons icons; + struct file_group group[FILE_GROUP_MAX]; + struct file files[FILE_MAX]; +}; + +#define MAX_PATH_LEN 512 +struct file_browser { + /* path */ + char file[MAX_PATH_LEN]; + char home[MAX_PATH_LEN]; + char desktop[MAX_PATH_LEN]; + char directory[MAX_PATH_LEN]; + + /* directory content */ + char **files; + char **directories; + size_t file_count; + size_t dir_count; + struct media *media; +}; + +static void +die(const char *fmt, ...) +{ + va_list ap; + va_start(ap, fmt); + vfprintf(stderr, fmt, ap); + va_end(ap); + fputs("\n", stderr); + exit(EXIT_FAILURE); +} + +static struct nk_image +icon_load(const char *filename) +{ + int x,y,n; + GLuint tex; + unsigned char *data = stbi_load(filename, &x, &y, &n, 0); + if (!data) die("[SDL]: failed to load image: %s", filename); + + glGenTextures(1, &tex); + glBindTexture(GL_TEXTURE_2D, tex); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_NEAREST); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR_MIPMAP_NEAREST); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); + glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, x, y, 0, GL_RGBA, GL_UNSIGNED_BYTE, data); + glGenerateMipmap(GL_TEXTURE_2D); + stbi_image_free(data); + return nk_image_id((int)tex); +} + +#if 0 +static char* +file_load(const char* path, size_t* siz) +{ + char *buf; + FILE *fd = fopen(path, "rb"); + if (!fd) die("Failed to open file: %s\n", path); + fseek(fd, 0, SEEK_END); + *siz = (size_t)ftell(fd); + fseek(fd, 0, SEEK_SET); + buf = (char*)calloc(*siz, 1); + fread(buf, *siz, 1, fd); + fclose(fd); + return buf; +} +#endif + +static char* +str_duplicate(const char *src) +{ + char *ret; + size_t len = strlen(src); + if (!len) return 0; + ret = (char*)malloc(len+1); + if (!ret) return 0; + memcpy(ret, src, len); + ret[len] = '\0'; + return ret; +} + +static void +dir_free_list(char **list, size_t size) +{ + size_t i; + for (i = 0; i < size; ++i) + free(list[i]); + free(list); +} + +static char** +dir_list(const char *dir, int return_subdirs, size_t *count) +{ + size_t n = 0; + char buffer[MAX_PATH_LEN]; + char **results = NULL; + const DIR *none = NULL; + size_t capacity = 32; + size_t size; + DIR *z; + + assert(dir); + assert(count); + strncpy(buffer, dir, MAX_PATH_LEN); + buffer[MAX_PATH_LEN - 1] = 0; + n = strlen(buffer); + + if (n > 0 && (buffer[n-1] != '/')) + buffer[n++] = '/'; + + size = 0; + + z = opendir(dir); + if (z != none) { + int nonempty = 1; + struct dirent *data = readdir(z); + nonempty = (data != NULL); + if (!nonempty) return NULL; + + do { + DIR *y; + char *p; + int is_subdir; + if (data->d_name[0] == '.') + continue; + + strncpy(buffer + n, data->d_name, MAX_PATH_LEN-n); + y = opendir(buffer); + is_subdir = (y != NULL); + if (y != NULL) closedir(y); + + if ((return_subdirs && is_subdir) || (!is_subdir && !return_subdirs)){ + if (!size) { + results = (char**)calloc(sizeof(char*), capacity); + } else if (size >= capacity) { + void *old = results; + capacity = capacity * 2; + results = (char**)realloc(results, capacity * sizeof(char*)); + assert(results); + if (!results) free(old); + } + p = str_duplicate(data->d_name); + results[size++] = p; + } + } while ((data = readdir(z)) != NULL); + } + + if (z) closedir(z); + *count = size; + return results; +} + +static struct file_group +FILE_GROUP(enum file_groups group, const char *name, struct nk_image *icon) +{ + struct file_group fg; + fg.group = group; + fg.name = name; + fg.icon = icon; + return fg; +} + +static struct file +FILE_DEF(enum file_types type, const char *suffix, enum file_groups group) +{ + struct file fd; + fd.type = type; + fd.suffix = suffix; + fd.group = group; + return fd; +} + +static struct nk_image* +media_icon_for_file(struct media *media, const char *file) +{ + int i = 0; + const char *s = file; + char suffix[4]; + int found = 0; + memset(suffix, 0, sizeof(suffix)); + + /* extract suffix .xxx from file */ + while (*s++ != '\0') { + if (found && i < 3) + suffix[i++] = *s; + + if (*s == '.') { + if (found){ + found = 0; + break; + } + found = 1; + } + } + + /* check for all file definition of all groups for fitting suffix*/ + for (i = 0; i < FILE_MAX && found; ++i) { + struct file *d = &media->files[i]; + { + const char *f = d->suffix; + s = suffix; + while (f && *f && *s && *s == *f) { + s++; f++; + } + + /* found correct file definition so */ + if (f && *s == '\0' && *f == '\0') + return media->group[d->group].icon; + } + } + return &media->icons.default_file; +} + +static void +media_init(struct media *media) +{ + /* file groups */ + struct icons *icons = &media->icons; + media->group[FILE_GROUP_DEFAULT] = FILE_GROUP(FILE_GROUP_DEFAULT,"default",&icons->default_file); + media->group[FILE_GROUP_TEXT] = FILE_GROUP(FILE_GROUP_TEXT, "textual", &icons->text_file); + media->group[FILE_GROUP_MUSIC] = FILE_GROUP(FILE_GROUP_MUSIC, "music", &icons->music_file); + media->group[FILE_GROUP_FONT] = FILE_GROUP(FILE_GROUP_FONT, "font", &icons->font_file); + media->group[FILE_GROUP_IMAGE] = FILE_GROUP(FILE_GROUP_IMAGE, "image", &icons->img_file); + media->group[FILE_GROUP_MOVIE] = FILE_GROUP(FILE_GROUP_MOVIE, "movie", &icons->movie_file); + + /* files */ + media->files[FILE_DEFAULT] = FILE_DEF(FILE_DEFAULT, NULL, FILE_GROUP_DEFAULT); + media->files[FILE_TEXT] = FILE_DEF(FILE_TEXT, "txt", FILE_GROUP_TEXT); + media->files[FILE_C_SOURCE] = FILE_DEF(FILE_C_SOURCE, "c", FILE_GROUP_TEXT); + media->files[FILE_CPP_SOURCE] = FILE_DEF(FILE_CPP_SOURCE, "cpp", FILE_GROUP_TEXT); + media->files[FILE_HEADER] = FILE_DEF(FILE_HEADER, "h", FILE_GROUP_TEXT); + media->files[FILE_CPP_HEADER] = FILE_DEF(FILE_HEADER, "hpp", FILE_GROUP_TEXT); + media->files[FILE_MP3] = FILE_DEF(FILE_MP3, "mp3", FILE_GROUP_MUSIC); + media->files[FILE_WAV] = FILE_DEF(FILE_WAV, "wav", FILE_GROUP_MUSIC); + media->files[FILE_OGG] = FILE_DEF(FILE_OGG, "ogg", FILE_GROUP_MUSIC); + media->files[FILE_TTF] = FILE_DEF(FILE_TTF, "ttf", FILE_GROUP_FONT); + media->files[FILE_BMP] = FILE_DEF(FILE_BMP, "bmp", FILE_GROUP_IMAGE); + media->files[FILE_PNG] = FILE_DEF(FILE_PNG, "png", FILE_GROUP_IMAGE); + media->files[FILE_JPEG] = FILE_DEF(FILE_JPEG, "jpg", FILE_GROUP_IMAGE); + media->files[FILE_PCX] = FILE_DEF(FILE_PCX, "pcx", FILE_GROUP_IMAGE); + media->files[FILE_TGA] = FILE_DEF(FILE_TGA, "tga", FILE_GROUP_IMAGE); + media->files[FILE_GIF] = FILE_DEF(FILE_GIF, "gif", FILE_GROUP_IMAGE); +} + +static void +file_browser_reload_directory_content(struct file_browser *browser, const char *path) +{ + strncpy(browser->directory, path, MAX_PATH_LEN); + browser->directory[MAX_PATH_LEN - 1] = 0; + dir_free_list(browser->files, browser->file_count); + dir_free_list(browser->directories, browser->dir_count); + browser->files = dir_list(path, 0, &browser->file_count); + browser->directories = dir_list(path, 1, &browser->dir_count); +} + +static void +file_browser_init(struct file_browser *browser, struct media *media) +{ + memset(browser, 0, sizeof(*browser)); + browser->media = media; + { + /* load files and sub-directory list */ + const char *home = getenv("HOME"); +#ifdef _WIN32 + if (!home) home = getenv("USERPROFILE"); +#else + if (!home) home = getpwuid(getuid())->pw_dir; + { + size_t l; + strncpy(browser->home, home, MAX_PATH_LEN); + browser->home[MAX_PATH_LEN - 1] = 0; + l = strlen(browser->home); + strcpy(browser->home + l, "/"); + strcpy(browser->directory, browser->home); + } +#endif + { + size_t l; + strcpy(browser->desktop, browser->home); + l = strlen(browser->desktop); + strcpy(browser->desktop + l, "desktop/"); + } + browser->files = dir_list(browser->directory, 0, &browser->file_count); + browser->directories = dir_list(browser->directory, 1, &browser->dir_count); + } +} + +static void +file_browser_free(struct file_browser *browser) +{ + if (browser->files) + dir_free_list(browser->files, browser->file_count); + if (browser->directories) + dir_free_list(browser->directories, browser->dir_count); + browser->files = NULL; + browser->directories = NULL; + memset(browser, 0, sizeof(*browser)); +} + +int cmp_fn(const void *str1, const void *str2) +{ + const char *str1_ret = *(const char **)str1; + const char *str2_ret = *(const char **)str2; + return nk_stricmp(str1_ret, str2_ret); +} + +static int +file_browser_run(struct file_browser *browser, struct nk_context *ctx) +{ + int ret = 0; + struct media *media = browser->media; + struct nk_rect total_space; + static nk_bool file_browser_is_open = nk_true; + + if (file_browser_is_open) + { + if (nk_begin(ctx, "File Browser", nk_rect(50, 50, 600, 400), + NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_SCALABLE|NK_WINDOW_NO_SCROLLBAR| + NK_WINDOW_CLOSABLE|NK_WINDOW_MINIMIZABLE|NK_WINDOW_TITLE)) + { + static float ratio[] = {0.25f, NK_UNDEFINED}; + float spacing_x = ctx->style.window.spacing.x; + + /* output path directory selector in the menubar */ + ctx->style.window.spacing.x = 0; + nk_menubar_begin(ctx); + { + char *d = browser->directory; + char *begin = d + 1; + nk_layout_row_dynamic(ctx, 25, 6); + while (*d++) { + if (*d == '/') { + *d = '\0'; + if (nk_button_label(ctx, begin)) { + *d++ = '/'; *d = '\0'; + file_browser_reload_directory_content(browser, browser->directory); + break; + } + *d = '/'; + begin = d + 1; + } + } + } + nk_menubar_end(ctx); + ctx->style.window.spacing.x = spacing_x; + + /* window layout */ + total_space = nk_window_get_content_region(ctx); + nk_layout_row(ctx, NK_DYNAMIC, total_space.h - 40, 2, ratio); + + nk_group_begin(ctx, "Special", NK_WINDOW_NO_SCROLLBAR); + { + struct nk_image home = media->icons.home; + struct nk_image desktop = media->icons.desktop; + struct nk_image computer = media->icons.computer; + + nk_layout_row_dynamic(ctx, 40, 1); + if (nk_button_image_label(ctx, home, "home", NK_TEXT_CENTERED)) + file_browser_reload_directory_content(browser, browser->home); + if (nk_button_image_label(ctx,desktop,"desktop",NK_TEXT_CENTERED)) + file_browser_reload_directory_content(browser, browser->desktop); + if (nk_button_image_label(ctx,computer,"computer",NK_TEXT_CENTERED)) + file_browser_reload_directory_content(browser, "/"); + nk_group_end(ctx); + } + + /* output directory content window */ + nk_group_begin(ctx, "Content", NK_WINDOW_BORDER); + { + int index = -1; + size_t i = 0, j = 0; + size_t rows = 0, cols = 0; + size_t count = browser->dir_count + browser->file_count; + + /* File icons layout */ + cols = 2; + rows = count / cols; + static float ratio2[] = {0.08f, NK_UNDEFINED}; + nk_layout_row(ctx, NK_DYNAMIC, 30, 2, ratio2); + for (i = 0; i <= rows; i += 1) { + size_t n = j + cols; + for (; j < count && j < n; ++j) { + /* draw one column of icons */ + if (j < browser->dir_count) { + /* draw and execute directory buttons */ + if (nk_button_image(ctx,media->icons.directory)) + index = (int)j; + + qsort(browser->directories, browser->dir_count, sizeof(char *), cmp_fn); + nk_label(ctx, browser->directories[j], NK_TEXT_LEFT); + } else { + /* draw and execute files buttons */ + struct nk_image *icon; + size_t fileIndex = ((size_t)j - browser->dir_count); + icon = media_icon_for_file(media,browser->files[fileIndex]); + if (nk_button_image(ctx, *icon)) { + strncpy(browser->file, browser->directory, MAX_PATH_LEN); + n = strlen(browser->file); + strncpy(browser->file + n, browser->files[fileIndex], MAX_PATH_LEN - n); + ret = 1; + } + } + /* draw one column of labels */ + if (j >= browser->dir_count) { + size_t t = j - browser->dir_count; + qsort(browser->files, browser->file_count, sizeof(char *), cmp_fn); + nk_label(ctx,browser->files[t],NK_TEXT_LEFT); + } + } + } + + if (index != -1) { + size_t n = strlen(browser->directory); + strncpy(browser->directory + n, browser->directories[index], MAX_PATH_LEN - n); + n = strlen(browser->directory); + if (n < MAX_PATH_LEN - 1) { + browser->directory[n] = '/'; + browser->directory[n+1] = '\0'; + } + file_browser_reload_directory_content(browser, browser->directory); + } + nk_group_end(ctx); + } + + nk_layout_row_dynamic(ctx, 30, 5); + nk_label(ctx,"",NK_TEXT_LEFT); + nk_label(ctx,"",NK_TEXT_LEFT); + nk_label(ctx,"",NK_TEXT_LEFT); + if(nk_button_label(ctx, "Cancel")) + { + fprintf(stdout, "File dialog has been closed!\n"); + file_browser_is_open = nk_false; + } + if(nk_button_label(ctx, "Open")) + fprintf(stdout, "Insert routine to open/save the file!\n"); + } + nk_end(ctx); + } + return ret; +} diff --git a/demo/common/filebrowser/icon/checked.png b/demo/common/filebrowser/icon/checked.png new file mode 100644 index 0000000..e4e05b2 Binary files /dev/null and b/demo/common/filebrowser/icon/checked.png differ diff --git a/demo/common/filebrowser/icon/cloud.png b/demo/common/filebrowser/icon/cloud.png new file mode 100644 index 0000000..ecc5791 Binary files /dev/null and b/demo/common/filebrowser/icon/cloud.png differ diff --git a/demo/common/filebrowser/icon/computer.png b/demo/common/filebrowser/icon/computer.png new file mode 100644 index 0000000..29db8fc Binary files /dev/null and b/demo/common/filebrowser/icon/computer.png differ diff --git a/demo/common/filebrowser/icon/copy.png b/demo/common/filebrowser/icon/copy.png new file mode 100644 index 0000000..0a6e979 Binary files /dev/null and b/demo/common/filebrowser/icon/copy.png differ diff --git a/demo/common/filebrowser/icon/default.png b/demo/common/filebrowser/icon/default.png new file mode 100644 index 0000000..c11145a Binary files /dev/null and b/demo/common/filebrowser/icon/default.png differ diff --git a/demo/common/filebrowser/icon/delete.png b/demo/common/filebrowser/icon/delete.png new file mode 100644 index 0000000..7bc6dde Binary files /dev/null and b/demo/common/filebrowser/icon/delete.png differ diff --git a/demo/common/filebrowser/icon/desktop.png b/demo/common/filebrowser/icon/desktop.png new file mode 100644 index 0000000..b4abcfd Binary files /dev/null and b/demo/common/filebrowser/icon/desktop.png differ diff --git a/demo/common/filebrowser/icon/directory.png b/demo/common/filebrowser/icon/directory.png new file mode 100644 index 0000000..4c73d37 Binary files /dev/null and b/demo/common/filebrowser/icon/directory.png differ diff --git a/demo/common/filebrowser/icon/edit.png b/demo/common/filebrowser/icon/edit.png new file mode 100644 index 0000000..62ce0b4 Binary files /dev/null and b/demo/common/filebrowser/icon/edit.png differ diff --git a/demo/common/filebrowser/icon/export.png b/demo/common/filebrowser/icon/export.png new file mode 100644 index 0000000..ff6b5aa Binary files /dev/null and b/demo/common/filebrowser/icon/export.png differ diff --git a/demo/common/filebrowser/icon/font.png b/demo/common/filebrowser/icon/font.png new file mode 100644 index 0000000..918e9bf Binary files /dev/null and b/demo/common/filebrowser/icon/font.png differ diff --git a/demo/common/filebrowser/icon/home.png b/demo/common/filebrowser/icon/home.png new file mode 100644 index 0000000..8560626 Binary files /dev/null and b/demo/common/filebrowser/icon/home.png differ diff --git a/demo/common/filebrowser/icon/img.png b/demo/common/filebrowser/icon/img.png new file mode 100644 index 0000000..1985957 Binary files /dev/null and b/demo/common/filebrowser/icon/img.png differ diff --git a/demo/common/filebrowser/icon/movie.png b/demo/common/filebrowser/icon/movie.png new file mode 100644 index 0000000..5227883 Binary files /dev/null and b/demo/common/filebrowser/icon/movie.png differ diff --git a/demo/common/filebrowser/icon/music.png b/demo/common/filebrowser/icon/music.png new file mode 100644 index 0000000..0f1415c Binary files /dev/null and b/demo/common/filebrowser/icon/music.png differ diff --git a/demo/common/filebrowser/icon/next.png b/demo/common/filebrowser/icon/next.png new file mode 100644 index 0000000..af0b98d Binary files /dev/null and b/demo/common/filebrowser/icon/next.png differ diff --git a/demo/common/filebrowser/icon/pause.png b/demo/common/filebrowser/icon/pause.png new file mode 100644 index 0000000..7d6367e Binary files /dev/null and b/demo/common/filebrowser/icon/pause.png differ diff --git a/demo/common/filebrowser/icon/pen.png b/demo/common/filebrowser/icon/pen.png new file mode 100644 index 0000000..10c851c Binary files /dev/null and b/demo/common/filebrowser/icon/pen.png differ diff --git a/demo/common/filebrowser/icon/phone.png b/demo/common/filebrowser/icon/phone.png new file mode 100644 index 0000000..5e6f613 Binary files /dev/null and b/demo/common/filebrowser/icon/phone.png differ diff --git a/demo/common/filebrowser/icon/plane.png b/demo/common/filebrowser/icon/plane.png new file mode 100644 index 0000000..3a98489 Binary files /dev/null and b/demo/common/filebrowser/icon/plane.png differ diff --git a/demo/common/filebrowser/icon/play.png b/demo/common/filebrowser/icon/play.png new file mode 100644 index 0000000..9c9e8f0 Binary files /dev/null and b/demo/common/filebrowser/icon/play.png differ diff --git a/demo/common/filebrowser/icon/prev.png b/demo/common/filebrowser/icon/prev.png new file mode 100644 index 0000000..0eecc2e Binary files /dev/null and b/demo/common/filebrowser/icon/prev.png differ diff --git a/demo/common/filebrowser/icon/rocket.png b/demo/common/filebrowser/icon/rocket.png new file mode 100644 index 0000000..ea8e187 Binary files /dev/null and b/demo/common/filebrowser/icon/rocket.png differ diff --git a/demo/common/filebrowser/icon/settings.png b/demo/common/filebrowser/icon/settings.png new file mode 100644 index 0000000..e6e13f8 Binary files /dev/null and b/demo/common/filebrowser/icon/settings.png differ diff --git a/demo/common/filebrowser/icon/stop.png b/demo/common/filebrowser/icon/stop.png new file mode 100644 index 0000000..6742baf Binary files /dev/null and b/demo/common/filebrowser/icon/stop.png differ diff --git a/demo/common/filebrowser/icon/text.png b/demo/common/filebrowser/icon/text.png new file mode 100644 index 0000000..136e534 Binary files /dev/null and b/demo/common/filebrowser/icon/text.png differ diff --git a/demo/common/filebrowser/icon/tools.png b/demo/common/filebrowser/icon/tools.png new file mode 100644 index 0000000..412ff85 Binary files /dev/null and b/demo/common/filebrowser/icon/tools.png differ diff --git a/demo/common/filebrowser/icon/unchecked.png b/demo/common/filebrowser/icon/unchecked.png new file mode 100644 index 0000000..fca94d2 Binary files /dev/null and b/demo/common/filebrowser/icon/unchecked.png differ diff --git a/demo/common/filebrowser/icon/volume.png b/demo/common/filebrowser/icon/volume.png new file mode 100644 index 0000000..8e86fa9 Binary files /dev/null and b/demo/common/filebrowser/icon/volume.png differ diff --git a/demo/common/filebrowser/icon/wifi.png b/demo/common/filebrowser/icon/wifi.png new file mode 100644 index 0000000..270d55d Binary files /dev/null and b/demo/common/filebrowser/icon/wifi.png differ diff --git a/demo/common/filebrowser/stb_image.h b/demo/common/filebrowser/stb_image.h new file mode 100644 index 0000000..1f4d468 --- /dev/null +++ b/demo/common/filebrowser/stb_image.h @@ -0,0 +1,6509 @@ +/* stb_image - v2.08 - public domain image loader - http://nothings.org/stb_image.h + no warranty implied; use at your own risk + + Do this: + #define STB_IMAGE_IMPLEMENTATION + before you include this file in *one* C or C++ file to create the implementation. + + // i.e. it should look like this: + #include ... + #include ... + #include ... + #define STB_IMAGE_IMPLEMENTATION + #include "stb_image.h" + + You can #define STBI_ASSERT(x) before the #include to avoid using assert.h. + And #define STBI_MALLOC, STBI_REALLOC, and STBI_FREE to avoid using malloc,realloc,free + + + QUICK NOTES: + Primarily of interest to game developers and other people who can + avoid problematic images and only need the trivial interface + + JPEG baseline & progressive (12 bpc/arithmetic not supported, same as stock IJG lib) + PNG 1/2/4/8-bit-per-channel (16 bpc not supported) + + TGA (not sure what subset, if a subset) + BMP non-1bpp, non-RLE + PSD (composited view only, no extra channels, 8/16 bit-per-channel) + + GIF (*comp always reports as 4-channel) + HDR (radiance rgbE format) + PIC (Softimage PIC) + PNM (PPM and PGM binary only) + + Animated GIF still needs a proper API, but here's one way to do it: + http://gist.github.com/urraka/685d9a6340b26b830d49 + + - decode from memory or through FILE (define STBI_NO_STDIO to remove code) + - decode from arbitrary I/O callbacks + - SIMD acceleration on x86/x64 (SSE2) and ARM (NEON) + + Full documentation under "DOCUMENTATION" below. + + + Revision 2.00 release notes: + + - Progressive JPEG is now supported. + + - PPM and PGM binary formats are now supported, thanks to Ken Miller. + + - x86 platforms now make use of SSE2 SIMD instructions for + JPEG decoding, and ARM platforms can use NEON SIMD if requested. + This work was done by Fabian "ryg" Giesen. SSE2 is used by + default, but NEON must be enabled explicitly; see docs. + + With other JPEG optimizations included in this version, we see + 2x speedup on a JPEG on an x86 machine, and a 1.5x speedup + on a JPEG on an ARM machine, relative to previous versions of this + library. The same results will not obtain for all JPGs and for all + x86/ARM machines. (Note that progressive JPEGs are significantly + slower to decode than regular JPEGs.) This doesn't mean that this + is the fastest JPEG decoder in the land; rather, it brings it + closer to parity with standard libraries. If you want the fastest + decode, look elsewhere. (See "Philosophy" section of docs below.) + + See final bullet items below for more info on SIMD. + + - Added STBI_MALLOC, STBI_REALLOC, and STBI_FREE macros for replacing + the memory allocator. Unlike other STBI libraries, these macros don't + support a context parameter, so if you need to pass a context in to + the allocator, you'll have to store it in a global or a thread-local + variable. + + - Split existing STBI_NO_HDR flag into two flags, STBI_NO_HDR and + STBI_NO_LINEAR. + STBI_NO_HDR: suppress implementation of .hdr reader format + STBI_NO_LINEAR: suppress high-dynamic-range light-linear float API + + - You can suppress implementation of any of the decoders to reduce + your code footprint by #defining one or more of the following + symbols before creating the implementation. + + STBI_NO_JPEG + STBI_NO_PNG + STBI_NO_BMP + STBI_NO_PSD + STBI_NO_TGA + STBI_NO_GIF + STBI_NO_HDR + STBI_NO_PIC + STBI_NO_PNM (.ppm and .pgm) + + - You can request *only* certain decoders and suppress all other ones + (this will be more forward-compatible, as addition of new decoders + doesn't require you to disable them explicitly): + + STBI_ONLY_JPEG + STBI_ONLY_PNG + STBI_ONLY_BMP + STBI_ONLY_PSD + STBI_ONLY_TGA + STBI_ONLY_GIF + STBI_ONLY_HDR + STBI_ONLY_PIC + STBI_ONLY_PNM (.ppm and .pgm) + + Note that you can define multiples of these, and you will get all + of them ("only x" and "only y" is interpreted to mean "only x&y"). + + - If you use STBI_NO_PNG (or _ONLY_ without PNG), and you still + want the zlib decoder to be available, #define STBI_SUPPORT_ZLIB + + - Compilation of all SIMD code can be suppressed with + #define STBI_NO_SIMD + It should not be necessary to disable SIMD unless you have issues + compiling (e.g. using an x86 compiler which doesn't support SSE + intrinsics or that doesn't support the method used to detect + SSE2 support at run-time), and even those can be reported as + bugs so I can refine the built-in compile-time checking to be + smarter. + + - The old STBI_SIMD system which allowed installing a user-defined + IDCT etc. has been removed. If you need this, don't upgrade. My + assumption is that almost nobody was doing this, and those who + were will find the built-in SIMD more satisfactory anyway. + + - RGB values computed for JPEG images are slightly different from + previous versions of stb_image. (This is due to using less + integer precision in SIMD.) The C code has been adjusted so + that the same RGB values will be computed regardless of whether + SIMD support is available, so your app should always produce + consistent results. But these results are slightly different from + previous versions. (Specifically, about 3% of available YCbCr values + will compute different RGB results from pre-1.49 versions by +-1; + most of the deviating values are one smaller in the G channel.) + + - If you must produce consistent results with previous versions of + stb_image, #define STBI_JPEG_OLD and you will get the same results + you used to; however, you will not get the SIMD speedups for + the YCbCr-to-RGB conversion step (although you should still see + significant JPEG speedup from the other changes). + + Please note that STBI_JPEG_OLD is a temporary feature; it will be + removed in future versions of the library. It is only intended for + near-term back-compatibility use. + + + Latest revision history: + 2.08 (2015-09-13) fix to 2.07 cleanup, reading RGB PSD as RGBA + 2.07 (2015-09-13) partial animated GIF support + limited 16-bit PSD support + minor bugs, code cleanup, and compiler warnings + 2.06 (2015-04-19) fix bug where PSD returns wrong '*comp' value + 2.05 (2015-04-19) fix bug in progressive JPEG handling, fix warning + 2.04 (2015-04-15) try to re-enable SIMD on MinGW 64-bit + 2.03 (2015-04-12) additional corruption checking + stbi_set_flip_vertically_on_load + fix NEON support; fix mingw support + 2.02 (2015-01-19) fix incorrect assert, fix warning + 2.01 (2015-01-17) fix various warnings + 2.00b (2014-12-25) fix STBI_MALLOC in progressive JPEG + 2.00 (2014-12-25) optimize JPEG, including x86 SSE2 & ARM NEON SIMD + progressive JPEG + PGM/PPM support + STBI_MALLOC,STBI_REALLOC,STBI_FREE + STBI_NO_*, STBI_ONLY_* + GIF bugfix + 1.48 (2014-12-14) fix incorrectly-named assert() + 1.47 (2014-12-14) 1/2/4-bit PNG support (both grayscale and paletted) + optimize PNG + fix bug in interlaced PNG with user-specified channel count + + See end of file for full revision history. + + + ============================ Contributors ========================= + + Image formats Bug fixes & warning fixes + Sean Barrett (jpeg, png, bmp) Marc LeBlanc + Nicolas Schulz (hdr, psd) Christpher Lloyd + Jonathan Dummer (tga) Dave Moore + Jean-Marc Lienher (gif) Won Chun + Tom Seddon (pic) the Horde3D community + Thatcher Ulrich (psd) Janez Zemva + Ken Miller (pgm, ppm) Jonathan Blow + urraka@github (animated gif) Laurent Gomila + Aruelien Pocheville + Ryamond Barbiero + David Woo + Extensions, features Martin Golini + Jetro Lauha (stbi_info) Roy Eltham + Martin "SpartanJ" Golini (stbi_info) Luke Graham + James "moose2000" Brown (iPhone PNG) Thomas Ruf + Ben "Disch" Wenger (io callbacks) John Bartholomew + Omar Cornut (1/2/4-bit PNG) Ken Hamada + Nicolas Guillemot (vertical flip) Cort Stratton + Richard Mitton (16-bit PSD) Blazej Dariusz Roszkowski + Thibault Reuille + Paul Du Bois + Guillaume George + Jerry Jansson + Hayaki Saito + Johan Duparc + Ronny Chevalier + Optimizations & bugfixes Michal Cichon + Fabian "ryg" Giesen Tero Hanninen + Arseny Kapoulkine Sergio Gonzalez + Cass Everitt + Engin Manap + If your name should be here but Martins Mozeiko + isn't, let Sean know. Joseph Thomson + Phil Jordan + Nathan Reed + Michaelangel007@github + Nick Verigakis + +LICENSE + +This software is in the public domain. Where that dedication is not +recognized, you are granted a perpetual, irrevocable license to copy, +distribute, and modify this file as you see fit. + +*/ + +#ifndef STBI_INCLUDE_STB_IMAGE_H +#define STBI_INCLUDE_STB_IMAGE_H + +// DOCUMENTATION +// +// Limitations: +// - no 16-bit-per-channel PNG +// - no 12-bit-per-channel JPEG +// - no JPEGs with arithmetic coding +// - no 1-bit BMP +// - GIF always returns *comp=4 +// +// Basic usage (see HDR discussion below for HDR usage): +// int x,y,n; +// unsigned char *data = stbi_load(filename, &x, &y, &n, 0); +// // ... process data if not NULL ... +// // ... x = width, y = height, n = # 8-bit components per pixel ... +// // ... replace '0' with '1'..'4' to force that many components per pixel +// // ... but 'n' will always be the number that it would have been if you said 0 +// stbi_image_free(data) +// +// Standard parameters: +// int *x -- outputs image width in pixels +// int *y -- outputs image height in pixels +// int *comp -- outputs # of image components in image file +// int req_comp -- if non-zero, # of image components requested in result +// +// The return value from an image loader is an 'unsigned char *' which points +// to the pixel data, or NULL on an allocation failure or if the image is +// corrupt or invalid. The pixel data consists of *y scanlines of *x pixels, +// with each pixel consisting of N interleaved 8-bit components; the first +// pixel pointed to is top-left-most in the image. There is no padding between +// image scanlines or between pixels, regardless of format. The number of +// components N is 'req_comp' if req_comp is non-zero, or *comp otherwise. +// If req_comp is non-zero, *comp has the number of components that _would_ +// have been output otherwise. E.g. if you set req_comp to 4, you will always +// get RGBA output, but you can check *comp to see if it's trivially opaque +// because e.g. there were only 3 channels in the source image. +// +// An output image with N components has the following components interleaved +// in this order in each pixel: +// +// N=#comp components +// 1 grey +// 2 grey, alpha +// 3 red, green, blue +// 4 red, green, blue, alpha +// +// If image loading fails for any reason, the return value will be NULL, +// and *x, *y, *comp will be unchanged. The function stbi_failure_reason() +// can be queried for an extremely brief, end-user unfriendly explanation +// of why the load failed. Define STBI_NO_FAILURE_STRINGS to avoid +// compiling these strings at all, and STBI_FAILURE_USERMSG to get slightly +// more user-friendly ones. +// +// Paletted PNG, BMP, GIF, and PIC images are automatically depalettized. +// +// =========================================================================== +// +// Philosophy +// +// stb libraries are designed with the following priorities: +// +// 1. easy to use +// 2. easy to maintain +// 3. good performance +// +// Sometimes I let "good performance" creep up in priority over "easy to maintain", +// and for best performance I may provide less-easy-to-use APIs that give higher +// performance, in addition to the easy to use ones. Nevertheless, it's important +// to keep in mind that from the standpoint of you, a client of this library, +// all you care about is #1 and #3, and stb libraries do not emphasize #3 above all. +// +// Some secondary priorities arise directly from the first two, some of which +// make more explicit reasons why performance can't be emphasized. +// +// - Portable ("ease of use") +// - Small footprint ("easy to maintain") +// - No dependencies ("ease of use") +// +// =========================================================================== +// +// I/O callbacks +// +// I/O callbacks allow you to read from arbitrary sources, like packaged +// files or some other source. Data read from callbacks are processed +// through a small internal buffer (currently 128 bytes) to try to reduce +// overhead. +// +// The three functions you must define are "read" (reads some bytes of data), +// "skip" (skips some bytes of data), "eof" (reports if the stream is at the end). +// +// =========================================================================== +// +// SIMD support +// +// The JPEG decoder will try to automatically use SIMD kernels on x86 when +// supported by the compiler. For ARM Neon support, you must explicitly +// request it. +// +// (The old do-it-yourself SIMD API is no longer supported in the current +// code.) +// +// On x86, SSE2 will automatically be used when available based on a run-time +// test; if not, the generic C versions are used as a fall-back. On ARM targets, +// the typical path is to have separate builds for NEON and non-NEON devices +// (at least this is true for iOS and Android). Therefore, the NEON support is +// toggled by a build flag: define STBI_NEON to get NEON loops. +// +// The output of the JPEG decoder is slightly different from versions where +// SIMD support was introduced (that is, for versions before 1.49). The +// difference is only +-1 in the 8-bit RGB channels, and only on a small +// fraction of pixels. You can force the pre-1.49 behavior by defining +// STBI_JPEG_OLD, but this will disable some of the SIMD decoding path +// and hence cost some performance. +// +// If for some reason you do not want to use any of SIMD code, or if +// you have issues compiling it, you can disable it entirely by +// defining STBI_NO_SIMD. +// +// =========================================================================== +// +// HDR image support (disable by defining STBI_NO_HDR) +// +// stb_image now supports loading HDR images in general, and currently +// the Radiance .HDR file format, although the support is provided +// generically. You can still load any file through the existing interface; +// if you attempt to load an HDR file, it will be automatically remapped to +// LDR, assuming gamma 2.2 and an arbitrary scale factor defaulting to 1; +// both of these constants can be reconfigured through this interface: +// +// stbi_hdr_to_ldr_gamma(2.2f); +// stbi_hdr_to_ldr_scale(1.0f); +// +// (note, do not use _inverse_ constants; stbi_image will invert them +// appropriately). +// +// Additionally, there is a new, parallel interface for loading files as +// (linear) floats to preserve the full dynamic range: +// +// float *data = stbi_loadf(filename, &x, &y, &n, 0); +// +// If you load LDR images through this interface, those images will +// be promoted to floating point values, run through the inverse of +// constants corresponding to the above: +// +// stbi_ldr_to_hdr_scale(1.0f); +// stbi_ldr_to_hdr_gamma(2.2f); +// +// Finally, given a filename (or an open file or memory block--see header +// file for details) containing image data, you can query for the "most +// appropriate" interface to use (that is, whether the image is HDR or +// not), using: +// +// stbi_is_hdr(char *filename); +// +// =========================================================================== +// +// iPhone PNG support: +// +// By default we convert iphone-formatted PNGs back to RGB, even though +// they are internally encoded differently. You can disable this conversion +// by by calling stbi_convert_iphone_png_to_rgb(0), in which case +// you will always just get the native iphone "format" through (which +// is BGR stored in RGB). +// +// Call stbi_set_unpremultiply_on_load(1) as well to force a divide per +// pixel to remove any premultiplied alpha *only* if the image file explicitly +// says there's premultiplied data (currently only happens in iPhone images, +// and only if iPhone convert-to-rgb processing is on). +// + + +#ifndef STBI_NO_STDIO +#include +#endif // STBI_NO_STDIO + +#define STBI_VERSION 1 + +enum +{ + STBI_default = 0, // only used for req_comp + + STBI_grey = 1, + STBI_grey_alpha = 2, + STBI_rgb = 3, + STBI_rgb_alpha = 4 +}; + +typedef unsigned char stbi_uc; + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef STB_IMAGE_STATIC +#define STBIDEF static +#else +#define STBIDEF extern +#endif + +////////////////////////////////////////////////////////////////////////////// +// +// PRIMARY API - works on images of any type +// + +// +// load image by filename, open file, or memory buffer +// + +typedef struct +{ + int (*read) (void *user,char *data,int size); // fill 'data' with 'size' bytes. return number of bytes actually read + void (*skip) (void *user,int n); // skip the next 'n' bytes, or 'unget' the last -n bytes if negative + int (*eof) (void *user); // returns nonzero if we are at end of file/data +} stbi_io_callbacks; + +STBIDEF stbi_uc *stbi_load (char const *filename, int *x, int *y, int *comp, int req_comp); +STBIDEF stbi_uc *stbi_load_from_memory (stbi_uc const *buffer, int len , int *x, int *y, int *comp, int req_comp); +STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk , void *user, int *x, int *y, int *comp, int req_comp); + +#ifndef STBI_NO_STDIO +STBIDEF stbi_uc *stbi_load_from_file (FILE *f, int *x, int *y, int *comp, int req_comp); +// for stbi_load_from_file, file pointer is left pointing immediately after image +#endif + +#ifndef STBI_NO_LINEAR + STBIDEF float *stbi_loadf (char const *filename, int *x, int *y, int *comp, int req_comp); + STBIDEF float *stbi_loadf_from_memory (stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp); + STBIDEF float *stbi_loadf_from_callbacks (stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp); + + #ifndef STBI_NO_STDIO + STBIDEF float *stbi_loadf_from_file (FILE *f, int *x, int *y, int *comp, int req_comp); + #endif +#endif + +#ifndef STBI_NO_HDR + STBIDEF void stbi_hdr_to_ldr_gamma(float gamma); + STBIDEF void stbi_hdr_to_ldr_scale(float scale); +#endif + +#ifndef STBI_NO_LINEAR + STBIDEF void stbi_ldr_to_hdr_gamma(float gamma); + STBIDEF void stbi_ldr_to_hdr_scale(float scale); +#endif // STBI_NO_HDR + +// stbi_is_hdr is always defined, but always returns false if STBI_NO_HDR +STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user); +STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len); +#ifndef STBI_NO_STDIO +STBIDEF int stbi_is_hdr (char const *filename); +STBIDEF int stbi_is_hdr_from_file(FILE *f); +#endif // STBI_NO_STDIO + + +// get a VERY brief reason for failure +// NOT THREADSAFE +STBIDEF const char *stbi_failure_reason (void); + +// free the loaded image -- this is just free() +STBIDEF void stbi_image_free (void *retval_from_stbi_load); + +// get image dimensions & components without fully decoding +STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp); +STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp); + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_info (char const *filename, int *x, int *y, int *comp); +STBIDEF int stbi_info_from_file (FILE *f, int *x, int *y, int *comp); + +#endif + + + +// for image formats that explicitly notate that they have premultiplied alpha, +// we just return the colors as stored in the file. set this flag to force +// unpremultiplication. results are undefined if the unpremultiply overflow. +STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply); + +// indicate whether we should process iphone images back to canonical format, +// or just pass them through "as-is" +STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert); + +// flip the image vertically, so the first pixel in the output array is the bottom left +STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip); + +// ZLIB client - used by PNG, available for other purposes + +STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen); +STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header); +STBIDEF char *stbi_zlib_decode_malloc(const char *buffer, int len, int *outlen); +STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); + +STBIDEF char *stbi_zlib_decode_noheader_malloc(const char *buffer, int len, int *outlen); +STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); + + +#ifdef __cplusplus +} +#endif + +// +// +//// end header file ///////////////////////////////////////////////////// +#endif // STBI_INCLUDE_STB_IMAGE_H + +#ifdef STB_IMAGE_IMPLEMENTATION + +#if defined(STBI_ONLY_JPEG) || defined(STBI_ONLY_PNG) || defined(STBI_ONLY_BMP) \ + || defined(STBI_ONLY_TGA) || defined(STBI_ONLY_GIF) || defined(STBI_ONLY_PSD) \ + || defined(STBI_ONLY_HDR) || defined(STBI_ONLY_PIC) || defined(STBI_ONLY_PNM) \ + || defined(STBI_ONLY_ZLIB) + #ifndef STBI_ONLY_JPEG + #define STBI_NO_JPEG + #endif + #ifndef STBI_ONLY_PNG + #define STBI_NO_PNG + #endif + #ifndef STBI_ONLY_BMP + #define STBI_NO_BMP + #endif + #ifndef STBI_ONLY_PSD + #define STBI_NO_PSD + #endif + #ifndef STBI_ONLY_TGA + #define STBI_NO_TGA + #endif + #ifndef STBI_ONLY_GIF + #define STBI_NO_GIF + #endif + #ifndef STBI_ONLY_HDR + #define STBI_NO_HDR + #endif + #ifndef STBI_ONLY_PIC + #define STBI_NO_PIC + #endif + #ifndef STBI_ONLY_PNM + #define STBI_NO_PNM + #endif +#endif + +#if defined(STBI_NO_PNG) && !defined(STBI_SUPPORT_ZLIB) && !defined(STBI_NO_ZLIB) +#define STBI_NO_ZLIB +#endif + + +#include +#include // ptrdiff_t on osx +#include +#include + +#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) +#include // ldexp +#endif + +#ifndef STBI_NO_STDIO +#include +#endif + +#ifndef STBI_ASSERT +#include +#define STBI_ASSERT(x) assert(x) +#endif + + +#ifndef _MSC_VER + #ifdef __cplusplus + #define stbi_inline inline + #else + #define stbi_inline + #endif +#else + #define stbi_inline __forceinline +#endif + + +#ifdef _MSC_VER +typedef unsigned short stbi__uint16; +typedef signed short stbi__int16; +typedef unsigned int stbi__uint32; +typedef signed int stbi__int32; +#else +#include +typedef uint16_t stbi__uint16; +typedef int16_t stbi__int16; +typedef uint32_t stbi__uint32; +typedef int32_t stbi__int32; +#endif + +// should produce compiler error if size is wrong +typedef unsigned char validate_uint32[sizeof(stbi__uint32)==4 ? 1 : -1]; + +#ifdef _MSC_VER +#define STBI_NOTUSED(v) (void)(v) +#else +#define STBI_NOTUSED(v) (void)sizeof(v) +#endif + +#ifdef _MSC_VER +#define STBI_HAS_LROTL +#endif + +#ifdef STBI_HAS_LROTL + #define stbi_lrot(x,y) _lrotl(x,y) +#else + #define stbi_lrot(x,y) (((x) << (y)) | ((x) >> (32 - (y)))) +#endif + +#if defined(STBI_MALLOC) && defined(STBI_FREE) && defined(STBI_REALLOC) +// ok +#elif !defined(STBI_MALLOC) && !defined(STBI_FREE) && !defined(STBI_REALLOC) +// ok +#else +#error "Must define all or none of STBI_MALLOC, STBI_FREE, and STBI_REALLOC." +#endif + +#ifndef STBI_MALLOC +#define STBI_MALLOC(sz) malloc(sz) +#define STBI_REALLOC(p,sz) realloc(p,sz) +#define STBI_FREE(p) free(p) +#endif + +// x86/x64 detection +#if defined(__x86_64__) || defined(_M_X64) +#define STBI__X64_TARGET +#elif defined(__i386) || defined(_M_IX86) +#define STBI__X86_TARGET +#endif + +#if defined(__GNUC__) && (defined(STBI__X86_TARGET) || defined(STBI__X64_TARGET)) && !defined(__SSE2__) && !defined(STBI_NO_SIMD) +// NOTE: not clear do we actually need this for the 64-bit path? +// gcc doesn't support sse2 intrinsics unless you compile with -msse2, +// (but compiling with -msse2 allows the compiler to use SSE2 everywhere; +// this is just broken and gcc are jerks for not fixing it properly +// http://www.virtualdub.org/blog/pivot/entry.php?id=363 ) +#define STBI_NO_SIMD +#endif + +#if defined(__MINGW32__) && defined(STBI__X86_TARGET) && !defined(STBI_MINGW_ENABLE_SSE2) && !defined(STBI_NO_SIMD) +// Note that __MINGW32__ doesn't actually mean 32-bit, so we have to avoid STBI__X64_TARGET +// +// 32-bit MinGW wants ESP to be 16-byte aligned, but this is not in the +// Windows ABI and VC++ as well as Windows DLLs don't maintain that invariant. +// As a result, enabling SSE2 on 32-bit MinGW is dangerous when not +// simultaneously enabling "-mstackrealign". +// +// See https://github.com/nothings/stb/issues/81 for more information. +// +// So default to no SSE2 on 32-bit MinGW. If you've read this far and added +// -mstackrealign to your build settings, feel free to #define STBI_MINGW_ENABLE_SSE2. +#define STBI_NO_SIMD +#endif + +#if !defined(STBI_NO_SIMD) && defined(STBI__X86_TARGET) +#define STBI_SSE2 +#include + +#ifdef _MSC_VER + +#if _MSC_VER >= 1400 // not VC6 +#include // __cpuid +static int stbi__cpuid3(void) +{ + int info[4]; + __cpuid(info,1); + return info[3]; +} +#else +static int stbi__cpuid3(void) +{ + int res; + __asm { + mov eax,1 + cpuid + mov res,edx + } + return res; +} +#endif + +#define STBI_SIMD_ALIGN(type, name) __declspec(align(16)) type name + +static int stbi__sse2_available() +{ + int info3 = stbi__cpuid3(); + return ((info3 >> 26) & 1) != 0; +} +#else // assume GCC-style if not VC++ +#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) + +static int stbi__sse2_available() +{ +#if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 408 // GCC 4.8 or later + // GCC 4.8+ has a nice way to do this + return __builtin_cpu_supports("sse2"); +#else + // portable way to do this, preferably without using GCC inline ASM? + // just bail for now. + return 0; +#endif +} +#endif +#endif + +// ARM NEON +#if defined(STBI_NO_SIMD) && defined(STBI_NEON) +#undef STBI_NEON +#endif + +#ifdef STBI_NEON +#include +// assume GCC or Clang on ARM targets +#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) +#endif + +#ifndef STBI_SIMD_ALIGN +#define STBI_SIMD_ALIGN(type, name) type name +#endif + +/////////////////////////////////////////////// +// +// stbi__context struct and start_xxx functions + +// stbi__context structure is our basic context used by all images, so it +// contains all the IO context, plus some basic image information +typedef struct +{ + stbi__uint32 img_x, img_y; + int img_n, img_out_n; + + stbi_io_callbacks io; + void *io_user_data; + + int read_from_callbacks; + int buflen; + stbi_uc buffer_start[128]; + + stbi_uc *img_buffer, *img_buffer_end; + stbi_uc *img_buffer_original, *img_buffer_original_end; +} stbi__context; + + +static void stbi__refill_buffer(stbi__context *s); + +// initialize a memory-decode context +static void stbi__start_mem(stbi__context *s, stbi_uc const *buffer, int len) +{ + s->io.read = NULL; + s->read_from_callbacks = 0; + s->img_buffer = s->img_buffer_original = (stbi_uc *) buffer; + s->img_buffer_end = s->img_buffer_original_end = (stbi_uc *) buffer+len; +} + +// initialize a callback-based context +static void stbi__start_callbacks(stbi__context *s, stbi_io_callbacks *c, void *user) +{ + s->io = *c; + s->io_user_data = user; + s->buflen = sizeof(s->buffer_start); + s->read_from_callbacks = 1; + s->img_buffer_original = s->buffer_start; + stbi__refill_buffer(s); + s->img_buffer_original_end = s->img_buffer_end; +} + +#ifndef STBI_NO_STDIO + +static int stbi__stdio_read(void *user, char *data, int size) +{ + return (int) fread(data,1,size,(FILE*) user); +} + +static void stbi__stdio_skip(void *user, int n) +{ + fseek((FILE*) user, n, SEEK_CUR); +} + +static int stbi__stdio_eof(void *user) +{ + return feof((FILE*) user); +} + +static stbi_io_callbacks stbi__stdio_callbacks = +{ + stbi__stdio_read, + stbi__stdio_skip, + stbi__stdio_eof, +}; + +static void stbi__start_file(stbi__context *s, FILE *f) +{ + stbi__start_callbacks(s, &stbi__stdio_callbacks, (void *) f); +} + +//static void stop_file(stbi__context *s) { } + +#endif // !STBI_NO_STDIO + +static void stbi__rewind(stbi__context *s) +{ + // conceptually rewind SHOULD rewind to the beginning of the stream, + // but we just rewind to the beginning of the initial buffer, because + // we only use it after doing 'test', which only ever looks at at most 92 bytes + s->img_buffer = s->img_buffer_original; + s->img_buffer_end = s->img_buffer_original_end; +} + +#ifndef STBI_NO_JPEG +static int stbi__jpeg_test(stbi__context *s); +static stbi_uc *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PNG +static int stbi__png_test(stbi__context *s); +static stbi_uc *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_BMP +static int stbi__bmp_test(stbi__context *s); +static stbi_uc *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_TGA +static int stbi__tga_test(stbi__context *s); +static stbi_uc *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PSD +static int stbi__psd_test(stbi__context *s); +static stbi_uc *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_HDR +static int stbi__hdr_test(stbi__context *s); +static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PIC +static int stbi__pic_test(stbi__context *s); +static stbi_uc *stbi__pic_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_GIF +static int stbi__gif_test(stbi__context *s); +static stbi_uc *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PNM +static int stbi__pnm_test(stbi__context *s); +static stbi_uc *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp); +static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +// this is not threadsafe +static const char *stbi__g_failure_reason; + +STBIDEF const char *stbi_failure_reason(void) +{ + return stbi__g_failure_reason; +} + +static int stbi__err(const char *str) +{ + stbi__g_failure_reason = str; + return 0; +} + +static void *stbi__malloc(size_t size) +{ + return STBI_MALLOC(size); +} + +// stbi__err - error +// stbi__errpf - error returning pointer to float +// stbi__errpuc - error returning pointer to unsigned char + +#ifdef STBI_NO_FAILURE_STRINGS + #define stbi__err(x,y) 0 +#elif defined(STBI_FAILURE_USERMSG) + #define stbi__err(x,y) stbi__err(y) +#else + #define stbi__err(x,y) stbi__err(x) +#endif + +#define stbi__errpf(x,y) ((float *)(size_t) (stbi__err(x,y)?NULL:NULL)) +#define stbi__errpuc(x,y) ((unsigned char *)(size_t) (stbi__err(x,y)?NULL:NULL)) + +STBIDEF void stbi_image_free(void *retval_from_stbi_load) +{ + STBI_FREE(retval_from_stbi_load); +} + +#ifndef STBI_NO_LINEAR +static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp); +#endif + +#ifndef STBI_NO_HDR +static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp); +#endif + +static int stbi__vertically_flip_on_load = 0; + +STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip) +{ + stbi__vertically_flip_on_load = flag_true_if_should_flip; +} + +static unsigned char *stbi__load_main(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + #ifndef STBI_NO_JPEG + if (stbi__jpeg_test(s)) return stbi__jpeg_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_PNG + if (stbi__png_test(s)) return stbi__png_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_BMP + if (stbi__bmp_test(s)) return stbi__bmp_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_GIF + if (stbi__gif_test(s)) return stbi__gif_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_PSD + if (stbi__psd_test(s)) return stbi__psd_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_PIC + if (stbi__pic_test(s)) return stbi__pic_load(s,x,y,comp,req_comp); + #endif + #ifndef STBI_NO_PNM + if (stbi__pnm_test(s)) return stbi__pnm_load(s,x,y,comp,req_comp); + #endif + + #ifndef STBI_NO_HDR + if (stbi__hdr_test(s)) { + float *hdr = stbi__hdr_load(s, x,y,comp,req_comp); + return stbi__hdr_to_ldr(hdr, *x, *y, req_comp ? req_comp : *comp); + } + #endif + + #ifndef STBI_NO_TGA + // test tga last because it's a crappy test! + if (stbi__tga_test(s)) + return stbi__tga_load(s,x,y,comp,req_comp); + #endif + + return stbi__errpuc("unknown image type", "Image not of any known type, or corrupt"); +} + +static unsigned char *stbi__load_flip(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + unsigned char *result = stbi__load_main(s, x, y, comp, req_comp); + + if (stbi__vertically_flip_on_load && result != NULL) { + int w = *x, h = *y; + int depth = req_comp ? req_comp : *comp; + int row,col,z; + stbi_uc temp; + + // @OPTIMIZE: use a bigger temp buffer and memcpy multiple pixels at once + for (row = 0; row < (h>>1); row++) { + for (col = 0; col < w; col++) { + for (z = 0; z < depth; z++) { + temp = result[(row * w + col) * depth + z]; + result[(row * w + col) * depth + z] = result[((h - row - 1) * w + col) * depth + z]; + result[((h - row - 1) * w + col) * depth + z] = temp; + } + } + } + } + + return result; +} + +#ifndef STBI_NO_HDR +static void stbi__float_postprocess(float *result, int *x, int *y, int *comp, int req_comp) +{ + if (stbi__vertically_flip_on_load && result != NULL) { + int w = *x, h = *y; + int depth = req_comp ? req_comp : *comp; + int row,col,z; + float temp; + + // @OPTIMIZE: use a bigger temp buffer and memcpy multiple pixels at once + for (row = 0; row < (h>>1); row++) { + for (col = 0; col < w; col++) { + for (z = 0; z < depth; z++) { + temp = result[(row * w + col) * depth + z]; + result[(row * w + col) * depth + z] = result[((h - row - 1) * w + col) * depth + z]; + result[((h - row - 1) * w + col) * depth + z] = temp; + } + } + } + } +} +#endif + +#ifndef STBI_NO_STDIO + +static FILE *stbi__fopen(char const *filename, char const *mode) +{ + FILE *f; +#if defined(_MSC_VER) && _MSC_VER >= 1400 + if (0 != fopen_s(&f, filename, mode)) + f=0; +#else + f = fopen(filename, mode); +#endif + return f; +} + + +STBIDEF stbi_uc *stbi_load(char const *filename, int *x, int *y, int *comp, int req_comp) +{ + FILE *f = stbi__fopen(filename, "rb"); + unsigned char *result; + if (!f) return stbi__errpuc("can't fopen", "Unable to open file"); + result = stbi_load_from_file(f,x,y,comp,req_comp); + fclose(f); + return result; +} + +STBIDEF stbi_uc *stbi_load_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) +{ + unsigned char *result; + stbi__context s; + stbi__start_file(&s,f); + result = stbi__load_flip(&s,x,y,comp,req_comp); + if (result) { + // need to 'unget' all the characters in the IO buffer + fseek(f, - (int) (s.img_buffer_end - s.img_buffer), SEEK_CUR); + } + return result; +} +#endif //!STBI_NO_STDIO + +STBIDEF stbi_uc *stbi_load_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__load_flip(&s,x,y,comp,req_comp); +} + +STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__load_flip(&s,x,y,comp,req_comp); +} + +#ifndef STBI_NO_LINEAR +static float *stbi__loadf_main(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + unsigned char *data; + #ifndef STBI_NO_HDR + if (stbi__hdr_test(s)) { + float *hdr_data = stbi__hdr_load(s,x,y,comp,req_comp); + if (hdr_data) + stbi__float_postprocess(hdr_data,x,y,comp,req_comp); + return hdr_data; + } + #endif + data = stbi__load_flip(s, x, y, comp, req_comp); + if (data) + return stbi__ldr_to_hdr(data, *x, *y, req_comp ? req_comp : *comp); + return stbi__errpf("unknown image type", "Image not of any known type, or corrupt"); +} + +STBIDEF float *stbi_loadf_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} + +STBIDEF float *stbi_loadf_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} + +#ifndef STBI_NO_STDIO +STBIDEF float *stbi_loadf(char const *filename, int *x, int *y, int *comp, int req_comp) +{ + float *result; + FILE *f = stbi__fopen(filename, "rb"); + if (!f) return stbi__errpf("can't fopen", "Unable to open file"); + result = stbi_loadf_from_file(f,x,y,comp,req_comp); + fclose(f); + return result; +} + +STBIDEF float *stbi_loadf_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_file(&s,f); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} +#endif // !STBI_NO_STDIO + +#endif // !STBI_NO_LINEAR + +// these is-hdr-or-not is defined independent of whether STBI_NO_LINEAR is +// defined, for API simplicity; if STBI_NO_LINEAR is defined, it always +// reports false! + +STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len) +{ + #ifndef STBI_NO_HDR + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__hdr_test(&s); + #else + STBI_NOTUSED(buffer); + STBI_NOTUSED(len); + return 0; + #endif +} + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_is_hdr (char const *filename) +{ + FILE *f = stbi__fopen(filename, "rb"); + int result=0; + if (f) { + result = stbi_is_hdr_from_file(f); + fclose(f); + } + return result; +} + +STBIDEF int stbi_is_hdr_from_file(FILE *f) +{ + #ifndef STBI_NO_HDR + stbi__context s; + stbi__start_file(&s,f); + return stbi__hdr_test(&s); + #else + STBI_NOTUSED(f); + return 0; + #endif +} +#endif // !STBI_NO_STDIO + +STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user) +{ + #ifndef STBI_NO_HDR + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__hdr_test(&s); + #else + STBI_NOTUSED(clbk); + STBI_NOTUSED(user); + return 0; + #endif +} + +static float stbi__h2l_gamma_i=1.0f/2.2f, stbi__h2l_scale_i=1.0f; +static float stbi__l2h_gamma=2.2f, stbi__l2h_scale=1.0f; + +#ifndef STBI_NO_LINEAR +STBIDEF void stbi_ldr_to_hdr_gamma(float gamma) { stbi__l2h_gamma = gamma; } +STBIDEF void stbi_ldr_to_hdr_scale(float scale) { stbi__l2h_scale = scale; } +#endif + +STBIDEF void stbi_hdr_to_ldr_gamma(float gamma) { stbi__h2l_gamma_i = 1/gamma; } +STBIDEF void stbi_hdr_to_ldr_scale(float scale) { stbi__h2l_scale_i = 1/scale; } + + +////////////////////////////////////////////////////////////////////////////// +// +// Common code used by all image loaders +// + +enum +{ + STBI__SCAN_load=0, + STBI__SCAN_type, + STBI__SCAN_header +}; + +static void stbi__refill_buffer(stbi__context *s) +{ + int n = (s->io.read)(s->io_user_data,(char*)s->buffer_start,s->buflen); + if (n == 0) { + // at end of file, treat same as if from memory, but need to handle case + // where s->img_buffer isn't pointing to safe memory, e.g. 0-byte file + s->read_from_callbacks = 0; + s->img_buffer = s->buffer_start; + s->img_buffer_end = s->buffer_start+1; + *s->img_buffer = 0; + } else { + s->img_buffer = s->buffer_start; + s->img_buffer_end = s->buffer_start + n; + } +} + +stbi_inline static stbi_uc stbi__get8(stbi__context *s) +{ + if (s->img_buffer < s->img_buffer_end) + return *s->img_buffer++; + if (s->read_from_callbacks) { + stbi__refill_buffer(s); + return *s->img_buffer++; + } + return 0; +} + +stbi_inline static int stbi__at_eof(stbi__context *s) +{ + if (s->io.read) { + if (!(s->io.eof)(s->io_user_data)) return 0; + // if feof() is true, check if buffer = end + // special case: we've only got the special 0 character at the end + if (s->read_from_callbacks == 0) return 1; + } + + return s->img_buffer >= s->img_buffer_end; +} + +static void stbi__skip(stbi__context *s, int n) +{ + if (n < 0) { + s->img_buffer = s->img_buffer_end; + return; + } + if (s->io.read) { + int blen = (int) (s->img_buffer_end - s->img_buffer); + if (blen < n) { + s->img_buffer = s->img_buffer_end; + (s->io.skip)(s->io_user_data, n - blen); + return; + } + } + s->img_buffer += n; +} + +static int stbi__getn(stbi__context *s, stbi_uc *buffer, int n) +{ + if (s->io.read) { + int blen = (int) (s->img_buffer_end - s->img_buffer); + if (blen < n) { + int res, count; + + memcpy(buffer, s->img_buffer, blen); + + count = (s->io.read)(s->io_user_data, (char*) buffer + blen, n - blen); + res = (count == (n-blen)); + s->img_buffer = s->img_buffer_end; + return res; + } + } + + if (s->img_buffer+n <= s->img_buffer_end) { + memcpy(buffer, s->img_buffer, n); + s->img_buffer += n; + return 1; + } else + return 0; +} + +static int stbi__get16be(stbi__context *s) +{ + int z = stbi__get8(s); + return (z << 8) + stbi__get8(s); +} + +static stbi__uint32 stbi__get32be(stbi__context *s) +{ + stbi__uint32 z = stbi__get16be(s); + return (z << 16) + stbi__get16be(s); +} + +#if defined(STBI_NO_BMP) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) +// nothing +#else +static int stbi__get16le(stbi__context *s) +{ + int z = stbi__get8(s); + return z + (stbi__get8(s) << 8); +} +#endif + +#ifndef STBI_NO_BMP +static stbi__uint32 stbi__get32le(stbi__context *s) +{ + stbi__uint32 z = stbi__get16le(s); + return z + (stbi__get16le(s) << 16); +} +#endif + +#define STBI__BYTECAST(x) ((stbi_uc) ((x) & 255)) // truncate int to byte without warnings + + +////////////////////////////////////////////////////////////////////////////// +// +// generic converter from built-in img_n to req_comp +// individual types do this automatically as much as possible (e.g. jpeg +// does all cases internally since it needs to colorspace convert anyway, +// and it never has alpha, so very few cases ). png can automatically +// interleave an alpha=255 channel, but falls back to this for other cases +// +// assume data buffer is malloced, so malloc a new one and free that one +// only failure mode is malloc failing + +static stbi_uc stbi__compute_y(int r, int g, int b) +{ + return (stbi_uc) (((r*77) + (g*150) + (29*b)) >> 8); +} + +static unsigned char *stbi__convert_format(unsigned char *data, int img_n, int req_comp, unsigned int x, unsigned int y) +{ + int i,j; + unsigned char *good; + + if (req_comp == img_n) return data; + STBI_ASSERT(req_comp >= 1 && req_comp <= 4); + + good = (unsigned char *) stbi__malloc(req_comp * x * y); + if (good == NULL) { + STBI_FREE(data); + return stbi__errpuc("outofmem", "Out of memory"); + } + + for (j=0; j < (int) y; ++j) { + unsigned char *src = data + j * x * img_n ; + unsigned char *dest = good + j * x * req_comp; + + #define COMBO(a,b) ((a)*8+(b)) + #define CASE(a,b) case COMBO(a,b): for(i=x-1; i >= 0; --i, src += a, dest += b) + // convert source image with img_n components to one with req_comp components; + // avoid switch per pixel, so use switch per scanline and massive macros + switch (COMBO(img_n, req_comp)) { + CASE(1,2) dest[0]=src[0], dest[1]=255; break; + CASE(1,3) dest[0]=dest[1]=dest[2]=src[0]; break; + CASE(1,4) dest[0]=dest[1]=dest[2]=src[0], dest[3]=255; break; + CASE(2,1) dest[0]=src[0]; break; + CASE(2,3) dest[0]=dest[1]=dest[2]=src[0]; break; + CASE(2,4) dest[0]=dest[1]=dest[2]=src[0], dest[3]=src[1]; break; + CASE(3,4) dest[0]=src[0],dest[1]=src[1],dest[2]=src[2],dest[3]=255; break; + CASE(3,1) dest[0]=stbi__compute_y(src[0],src[1],src[2]); break; + CASE(3,2) dest[0]=stbi__compute_y(src[0],src[1],src[2]), dest[1] = 255; break; + CASE(4,1) dest[0]=stbi__compute_y(src[0],src[1],src[2]); break; + CASE(4,2) dest[0]=stbi__compute_y(src[0],src[1],src[2]), dest[1] = src[3]; break; + CASE(4,3) dest[0]=src[0],dest[1]=src[1],dest[2]=src[2]; break; + default: STBI_ASSERT(0); + } + #undef CASE + } + + STBI_FREE(data); + return good; +} + +#ifndef STBI_NO_LINEAR +static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp) +{ + int i,k,n; + float *output = (float *) stbi__malloc(x * y * comp * sizeof(float)); + if (output == NULL) { STBI_FREE(data); return stbi__errpf("outofmem", "Out of memory"); } + // compute number of non-alpha components + if (comp & 1) n = comp; else n = comp-1; + for (i=0; i < x*y; ++i) { + for (k=0; k < n; ++k) { + output[i*comp + k] = (float) (pow(data[i*comp+k]/255.0f, stbi__l2h_gamma) * stbi__l2h_scale); + } + if (k < comp) output[i*comp + k] = data[i*comp+k]/255.0f; + } + STBI_FREE(data); + return output; +} +#endif + +#ifndef STBI_NO_HDR +#define stbi__float2int(x) ((int) (x)) +static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp) +{ + int i,k,n; + stbi_uc *output = (stbi_uc *) stbi__malloc(x * y * comp); + if (output == NULL) { STBI_FREE(data); return stbi__errpuc("outofmem", "Out of memory"); } + // compute number of non-alpha components + if (comp & 1) n = comp; else n = comp-1; + for (i=0; i < x*y; ++i) { + for (k=0; k < n; ++k) { + float z = (float) pow(data[i*comp+k]*stbi__h2l_scale_i, stbi__h2l_gamma_i) * 255 + 0.5f; + if (z < 0) z = 0; + if (z > 255) z = 255; + output[i*comp + k] = (stbi_uc) stbi__float2int(z); + } + if (k < comp) { + float z = data[i*comp+k] * 255 + 0.5f; + if (z < 0) z = 0; + if (z > 255) z = 255; + output[i*comp + k] = (stbi_uc) stbi__float2int(z); + } + } + STBI_FREE(data); + return output; +} +#endif + +////////////////////////////////////////////////////////////////////////////// +// +// "baseline" JPEG/JFIF decoder +// +// simple implementation +// - doesn't support delayed output of y-dimension +// - simple interface (only one output format: 8-bit interleaved RGB) +// - doesn't try to recover corrupt jpegs +// - doesn't allow partial loading, loading multiple at once +// - still fast on x86 (copying globals into locals doesn't help x86) +// - allocates lots of intermediate memory (full size of all components) +// - non-interleaved case requires this anyway +// - allows good upsampling (see next) +// high-quality +// - upsampled channels are bilinearly interpolated, even across blocks +// - quality integer IDCT derived from IJG's 'slow' +// performance +// - fast huffman; reasonable integer IDCT +// - some SIMD kernels for common paths on targets with SSE2/NEON +// - uses a lot of intermediate memory, could cache poorly + +#ifndef STBI_NO_JPEG + +// huffman decoding acceleration +#define FAST_BITS 9 // larger handles more cases; smaller stomps less cache + +typedef struct +{ + stbi_uc fast[1 << FAST_BITS]; + // weirdly, repacking this into AoS is a 10% speed loss, instead of a win + stbi__uint16 code[256]; + stbi_uc values[256]; + stbi_uc size[257]; + unsigned int maxcode[18]; + int delta[17]; // old 'firstsymbol' - old 'firstcode' +} stbi__huffman; + +typedef struct +{ + stbi__context *s; + stbi__huffman huff_dc[4]; + stbi__huffman huff_ac[4]; + stbi_uc dequant[4][64]; + stbi__int16 fast_ac[4][1 << FAST_BITS]; + +// sizes for components, interleaved MCUs + int img_h_max, img_v_max; + int img_mcu_x, img_mcu_y; + int img_mcu_w, img_mcu_h; + +// definition of jpeg image component + struct + { + int id; + int h,v; + int tq; + int hd,ha; + int dc_pred; + + int x,y,w2,h2; + stbi_uc *data; + void *raw_data, *raw_coeff; + stbi_uc *linebuf; + short *coeff; // progressive only + int coeff_w, coeff_h; // number of 8x8 coefficient blocks + } img_comp[4]; + + stbi__uint32 code_buffer; // jpeg entropy-coded buffer + int code_bits; // number of valid bits + unsigned char marker; // marker seen while filling entropy buffer + int nomore; // flag if we saw a marker so must stop + + int progressive; + int spec_start; + int spec_end; + int succ_high; + int succ_low; + int eob_run; + + int scan_n, order[4]; + int restart_interval, todo; + +// kernels + void (*idct_block_kernel)(stbi_uc *out, int out_stride, short data[64]); + void (*YCbCr_to_RGB_kernel)(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step); + stbi_uc *(*resample_row_hv_2_kernel)(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs); +} stbi__jpeg; + +static int stbi__build_huffman(stbi__huffman *h, int *count) +{ + int i,j,k=0,code; + // build size list for each symbol (from JPEG spec) + for (i=0; i < 16; ++i) + for (j=0; j < count[i]; ++j) + h->size[k++] = (stbi_uc) (i+1); + h->size[k] = 0; + + // compute actual symbols (from jpeg spec) + code = 0; + k = 0; + for(j=1; j <= 16; ++j) { + // compute delta to add to code to compute symbol id + h->delta[j] = k - code; + if (h->size[k] == j) { + while (h->size[k] == j) + h->code[k++] = (stbi__uint16) (code++); + if (code-1 >= (1 << j)) return stbi__err("bad code lengths","Corrupt JPEG"); + } + // compute largest code + 1 for this size, preshifted as needed later + h->maxcode[j] = code << (16-j); + code <<= 1; + } + h->maxcode[j] = 0xffffffff; + + // build non-spec acceleration table; 255 is flag for not-accelerated + memset(h->fast, 255, 1 << FAST_BITS); + for (i=0; i < k; ++i) { + int s = h->size[i]; + if (s <= FAST_BITS) { + int c = h->code[i] << (FAST_BITS-s); + int m = 1 << (FAST_BITS-s); + for (j=0; j < m; ++j) { + h->fast[c+j] = (stbi_uc) i; + } + } + } + return 1; +} + +// build a table that decodes both magnitude and value of small ACs in +// one go. +static void stbi__build_fast_ac(stbi__int16 *fast_ac, stbi__huffman *h) +{ + int i; + for (i=0; i < (1 << FAST_BITS); ++i) { + stbi_uc fast = h->fast[i]; + fast_ac[i] = 0; + if (fast < 255) { + int rs = h->values[fast]; + int run = (rs >> 4) & 15; + int magbits = rs & 15; + int len = h->size[fast]; + + if (magbits && len + magbits <= FAST_BITS) { + // magnitude code followed by receive_extend code + int k = ((i << len) & ((1 << FAST_BITS) - 1)) >> (FAST_BITS - magbits); + int m = 1 << (magbits - 1); + if (k < m) k += (-1 << magbits) + 1; + // if the result is small enough, we can fit it in fast_ac table + if (k >= -128 && k <= 127) + fast_ac[i] = (stbi__int16) ((k << 8) + (run << 4) + (len + magbits)); + } + } + } +} + +static void stbi__grow_buffer_unsafe(stbi__jpeg *j) +{ + do { + int b = j->nomore ? 0 : stbi__get8(j->s); + if (b == 0xff) { + int c = stbi__get8(j->s); + if (c != 0) { + j->marker = (unsigned char) c; + j->nomore = 1; + return; + } + } + j->code_buffer |= b << (24 - j->code_bits); + j->code_bits += 8; + } while (j->code_bits <= 24); +} + +// (1 << n) - 1 +static stbi__uint32 stbi__bmask[17]={0,1,3,7,15,31,63,127,255,511,1023,2047,4095,8191,16383,32767,65535}; + +// decode a jpeg huffman value from the bitstream +stbi_inline static int stbi__jpeg_huff_decode(stbi__jpeg *j, stbi__huffman *h) +{ + unsigned int temp; + int c,k; + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + + // look at the top FAST_BITS and determine what symbol ID it is, + // if the code is <= FAST_BITS + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + k = h->fast[c]; + if (k < 255) { + int s = h->size[k]; + if (s > j->code_bits) + return -1; + j->code_buffer <<= s; + j->code_bits -= s; + return h->values[k]; + } + + // naive test is to shift the code_buffer down so k bits are + // valid, then test against maxcode. To speed this up, we've + // preshifted maxcode left so that it has (16-k) 0s at the + // end; in other words, regardless of the number of bits, it + // wants to be compared against something shifted to have 16; + // that way we don't need to shift inside the loop. + temp = j->code_buffer >> 16; + for (k=FAST_BITS+1 ; ; ++k) + if (temp < h->maxcode[k]) + break; + if (k == 17) { + // error! code not found + j->code_bits -= 16; + return -1; + } + + if (k > j->code_bits) + return -1; + + // convert the huffman code to the symbol id + c = ((j->code_buffer >> (32 - k)) & stbi__bmask[k]) + h->delta[k]; + STBI_ASSERT((((j->code_buffer) >> (32 - h->size[c])) & stbi__bmask[h->size[c]]) == h->code[c]); + + // convert the id to a symbol + j->code_bits -= k; + j->code_buffer <<= k; + return h->values[c]; +} + +// bias[n] = (-1<code_bits < n) stbi__grow_buffer_unsafe(j); + + sgn = (stbi__int32)j->code_buffer >> 31; // sign bit is always in MSB + k = stbi_lrot(j->code_buffer, n); + STBI_ASSERT(n >= 0 && n < (int) (sizeof(stbi__bmask)/sizeof(*stbi__bmask))); + j->code_buffer = k & ~stbi__bmask[n]; + k &= stbi__bmask[n]; + j->code_bits -= n; + return k + (stbi__jbias[n] & ~sgn); +} + +// get some unsigned bits +stbi_inline static int stbi__jpeg_get_bits(stbi__jpeg *j, int n) +{ + unsigned int k; + if (j->code_bits < n) stbi__grow_buffer_unsafe(j); + k = stbi_lrot(j->code_buffer, n); + j->code_buffer = k & ~stbi__bmask[n]; + k &= stbi__bmask[n]; + j->code_bits -= n; + return k; +} + +stbi_inline static int stbi__jpeg_get_bit(stbi__jpeg *j) +{ + unsigned int k; + if (j->code_bits < 1) stbi__grow_buffer_unsafe(j); + k = j->code_buffer; + j->code_buffer <<= 1; + --j->code_bits; + return k & 0x80000000; +} + +// given a value that's at position X in the zigzag stream, +// where does it appear in the 8x8 matrix coded as row-major? +static stbi_uc stbi__jpeg_dezigzag[64+15] = +{ + 0, 1, 8, 16, 9, 2, 3, 10, + 17, 24, 32, 25, 18, 11, 4, 5, + 12, 19, 26, 33, 40, 48, 41, 34, + 27, 20, 13, 6, 7, 14, 21, 28, + 35, 42, 49, 56, 57, 50, 43, 36, + 29, 22, 15, 23, 30, 37, 44, 51, + 58, 59, 52, 45, 38, 31, 39, 46, + 53, 60, 61, 54, 47, 55, 62, 63, + // let corrupt input sample past end + 63, 63, 63, 63, 63, 63, 63, 63, + 63, 63, 63, 63, 63, 63, 63 +}; + +// decode one 64-entry block-- +static int stbi__jpeg_decode_block(stbi__jpeg *j, short data[64], stbi__huffman *hdc, stbi__huffman *hac, stbi__int16 *fac, int b, stbi_uc *dequant) +{ + int diff,dc,k; + int t; + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + t = stbi__jpeg_huff_decode(j, hdc); + if (t < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + + // 0 all the ac values now so we can do it 32-bits at a time + memset(data,0,64*sizeof(data[0])); + + diff = t ? stbi__extend_receive(j, t) : 0; + dc = j->img_comp[b].dc_pred + diff; + j->img_comp[b].dc_pred = dc; + data[0] = (short) (dc * dequant[0]); + + // decode AC components, see JPEG spec + k = 1; + do { + unsigned int zig; + int c,r,s; + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + r = fac[c]; + if (r) { // fast-AC path + k += (r >> 4) & 15; // run + s = r & 15; // combined length + j->code_buffer <<= s; + j->code_bits -= s; + // decode into unzigzag'd location + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) ((r >> 8) * dequant[zig]); + } else { + int rs = stbi__jpeg_huff_decode(j, hac); + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (rs != 0xf0) break; // end block + k += 16; + } else { + k += r; + // decode into unzigzag'd location + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) (stbi__extend_receive(j,s) * dequant[zig]); + } + } + } while (k < 64); + return 1; +} + +static int stbi__jpeg_decode_block_prog_dc(stbi__jpeg *j, short data[64], stbi__huffman *hdc, int b) +{ + int diff,dc; + int t; + if (j->spec_end != 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + + if (j->succ_high == 0) { + // first scan for DC coefficient, must be first + memset(data,0,64*sizeof(data[0])); // 0 all the ac values now + t = stbi__jpeg_huff_decode(j, hdc); + diff = t ? stbi__extend_receive(j, t) : 0; + + dc = j->img_comp[b].dc_pred + diff; + j->img_comp[b].dc_pred = dc; + data[0] = (short) (dc << j->succ_low); + } else { + // refinement scan for DC coefficient + if (stbi__jpeg_get_bit(j)) + data[0] += (short) (1 << j->succ_low); + } + return 1; +} + +// @OPTIMIZE: store non-zigzagged during the decode passes, +// and only de-zigzag when dequantizing +static int stbi__jpeg_decode_block_prog_ac(stbi__jpeg *j, short data[64], stbi__huffman *hac, stbi__int16 *fac) +{ + int k; + if (j->spec_start == 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + + if (j->succ_high == 0) { + int shift = j->succ_low; + + if (j->eob_run) { + --j->eob_run; + return 1; + } + + k = j->spec_start; + do { + unsigned int zig; + int c,r,s; + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + r = fac[c]; + if (r) { // fast-AC path + k += (r >> 4) & 15; // run + s = r & 15; // combined length + j->code_buffer <<= s; + j->code_bits -= s; + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) ((r >> 8) << shift); + } else { + int rs = stbi__jpeg_huff_decode(j, hac); + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (r < 15) { + j->eob_run = (1 << r); + if (r) + j->eob_run += stbi__jpeg_get_bits(j, r); + --j->eob_run; + break; + } + k += 16; + } else { + k += r; + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) (stbi__extend_receive(j,s) << shift); + } + } + } while (k <= j->spec_end); + } else { + // refinement scan for these AC coefficients + + short bit = (short) (1 << j->succ_low); + + if (j->eob_run) { + --j->eob_run; + for (k = j->spec_start; k <= j->spec_end; ++k) { + short *p = &data[stbi__jpeg_dezigzag[k]]; + if (*p != 0) + if (stbi__jpeg_get_bit(j)) + if ((*p & bit)==0) { + if (*p > 0) + *p += bit; + else + *p -= bit; + } + } + } else { + k = j->spec_start; + do { + int r,s; + int rs = stbi__jpeg_huff_decode(j, hac); // @OPTIMIZE see if we can use the fast path here, advance-by-r is so slow, eh + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (r < 15) { + j->eob_run = (1 << r) - 1; + if (r) + j->eob_run += stbi__jpeg_get_bits(j, r); + r = 64; // force end of block + } else { + // r=15 s=0 should write 16 0s, so we just do + // a run of 15 0s and then write s (which is 0), + // so we don't have to do anything special here + } + } else { + if (s != 1) return stbi__err("bad huffman code", "Corrupt JPEG"); + // sign bit + if (stbi__jpeg_get_bit(j)) + s = bit; + else + s = -bit; + } + + // advance by r + while (k <= j->spec_end) { + short *p = &data[stbi__jpeg_dezigzag[k++]]; + if (*p != 0) { + if (stbi__jpeg_get_bit(j)) + if ((*p & bit)==0) { + if (*p > 0) + *p += bit; + else + *p -= bit; + } + } else { + if (r == 0) { + *p = (short) s; + break; + } + --r; + } + } + } while (k <= j->spec_end); + } + } + return 1; +} + +// take a -128..127 value and stbi__clamp it and convert to 0..255 +stbi_inline static stbi_uc stbi__clamp(int x) +{ + // trick to use a single test to catch both cases + if ((unsigned int) x > 255) { + if (x < 0) return 0; + if (x > 255) return 255; + } + return (stbi_uc) x; +} + +#define stbi__f2f(x) ((int) (((x) * 4096 + 0.5))) +#define stbi__fsh(x) ((x) << 12) + +// derived from jidctint -- DCT_ISLOW +#define STBI__IDCT_1D(s0,s1,s2,s3,s4,s5,s6,s7) \ + int t0,t1,t2,t3,p1,p2,p3,p4,p5,x0,x1,x2,x3; \ + p2 = s2; \ + p3 = s6; \ + p1 = (p2+p3) * stbi__f2f(0.5411961f); \ + t2 = p1 + p3*stbi__f2f(-1.847759065f); \ + t3 = p1 + p2*stbi__f2f( 0.765366865f); \ + p2 = s0; \ + p3 = s4; \ + t0 = stbi__fsh(p2+p3); \ + t1 = stbi__fsh(p2-p3); \ + x0 = t0+t3; \ + x3 = t0-t3; \ + x1 = t1+t2; \ + x2 = t1-t2; \ + t0 = s7; \ + t1 = s5; \ + t2 = s3; \ + t3 = s1; \ + p3 = t0+t2; \ + p4 = t1+t3; \ + p1 = t0+t3; \ + p2 = t1+t2; \ + p5 = (p3+p4)*stbi__f2f( 1.175875602f); \ + t0 = t0*stbi__f2f( 0.298631336f); \ + t1 = t1*stbi__f2f( 2.053119869f); \ + t2 = t2*stbi__f2f( 3.072711026f); \ + t3 = t3*stbi__f2f( 1.501321110f); \ + p1 = p5 + p1*stbi__f2f(-0.899976223f); \ + p2 = p5 + p2*stbi__f2f(-2.562915447f); \ + p3 = p3*stbi__f2f(-1.961570560f); \ + p4 = p4*stbi__f2f(-0.390180644f); \ + t3 += p1+p4; \ + t2 += p2+p3; \ + t1 += p2+p4; \ + t0 += p1+p3; + +static void stbi__idct_block(stbi_uc *out, int out_stride, short data[64]) +{ + int i,val[64],*v=val; + stbi_uc *o; + short *d = data; + + // columns + for (i=0; i < 8; ++i,++d, ++v) { + // if all zeroes, shortcut -- this avoids dequantizing 0s and IDCTing + if (d[ 8]==0 && d[16]==0 && d[24]==0 && d[32]==0 + && d[40]==0 && d[48]==0 && d[56]==0) { + // no shortcut 0 seconds + // (1|2|3|4|5|6|7)==0 0 seconds + // all separate -0.047 seconds + // 1 && 2|3 && 4|5 && 6|7: -0.047 seconds + int dcterm = d[0] << 2; + v[0] = v[8] = v[16] = v[24] = v[32] = v[40] = v[48] = v[56] = dcterm; + } else { + STBI__IDCT_1D(d[ 0],d[ 8],d[16],d[24],d[32],d[40],d[48],d[56]) + // constants scaled things up by 1<<12; let's bring them back + // down, but keep 2 extra bits of precision + x0 += 512; x1 += 512; x2 += 512; x3 += 512; + v[ 0] = (x0+t3) >> 10; + v[56] = (x0-t3) >> 10; + v[ 8] = (x1+t2) >> 10; + v[48] = (x1-t2) >> 10; + v[16] = (x2+t1) >> 10; + v[40] = (x2-t1) >> 10; + v[24] = (x3+t0) >> 10; + v[32] = (x3-t0) >> 10; + } + } + + for (i=0, v=val, o=out; i < 8; ++i,v+=8,o+=out_stride) { + // no fast case since the first 1D IDCT spread components out + STBI__IDCT_1D(v[0],v[1],v[2],v[3],v[4],v[5],v[6],v[7]) + // constants scaled things up by 1<<12, plus we had 1<<2 from first + // loop, plus horizontal and vertical each scale by sqrt(8) so together + // we've got an extra 1<<3, so 1<<17 total we need to remove. + // so we want to round that, which means adding 0.5 * 1<<17, + // aka 65536. Also, we'll end up with -128 to 127 that we want + // to encode as 0..255 by adding 128, so we'll add that before the shift + x0 += 65536 + (128<<17); + x1 += 65536 + (128<<17); + x2 += 65536 + (128<<17); + x3 += 65536 + (128<<17); + // tried computing the shifts into temps, or'ing the temps to see + // if any were out of range, but that was slower + o[0] = stbi__clamp((x0+t3) >> 17); + o[7] = stbi__clamp((x0-t3) >> 17); + o[1] = stbi__clamp((x1+t2) >> 17); + o[6] = stbi__clamp((x1-t2) >> 17); + o[2] = stbi__clamp((x2+t1) >> 17); + o[5] = stbi__clamp((x2-t1) >> 17); + o[3] = stbi__clamp((x3+t0) >> 17); + o[4] = stbi__clamp((x3-t0) >> 17); + } +} + +#ifdef STBI_SSE2 +// sse2 integer IDCT. not the fastest possible implementation but it +// produces bit-identical results to the generic C version so it's +// fully "transparent". +static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) +{ + // This is constructed to match our regular (generic) integer IDCT exactly. + __m128i row0, row1, row2, row3, row4, row5, row6, row7; + __m128i tmp; + + // dot product constant: even elems=x, odd elems=y + #define dct_const(x,y) _mm_setr_epi16((x),(y),(x),(y),(x),(y),(x),(y)) + + // out(0) = c0[even]*x + c0[odd]*y (c0, x, y 16-bit, out 32-bit) + // out(1) = c1[even]*x + c1[odd]*y + #define dct_rot(out0,out1, x,y,c0,c1) \ + __m128i c0##lo = _mm_unpacklo_epi16((x),(y)); \ + __m128i c0##hi = _mm_unpackhi_epi16((x),(y)); \ + __m128i out0##_l = _mm_madd_epi16(c0##lo, c0); \ + __m128i out0##_h = _mm_madd_epi16(c0##hi, c0); \ + __m128i out1##_l = _mm_madd_epi16(c0##lo, c1); \ + __m128i out1##_h = _mm_madd_epi16(c0##hi, c1) + + // out = in << 12 (in 16-bit, out 32-bit) + #define dct_widen(out, in) \ + __m128i out##_l = _mm_srai_epi32(_mm_unpacklo_epi16(_mm_setzero_si128(), (in)), 4); \ + __m128i out##_h = _mm_srai_epi32(_mm_unpackhi_epi16(_mm_setzero_si128(), (in)), 4) + + // wide add + #define dct_wadd(out, a, b) \ + __m128i out##_l = _mm_add_epi32(a##_l, b##_l); \ + __m128i out##_h = _mm_add_epi32(a##_h, b##_h) + + // wide sub + #define dct_wsub(out, a, b) \ + __m128i out##_l = _mm_sub_epi32(a##_l, b##_l); \ + __m128i out##_h = _mm_sub_epi32(a##_h, b##_h) + + // butterfly a/b, add bias, then shift by "s" and pack + #define dct_bfly32o(out0, out1, a,b,bias,s) \ + { \ + __m128i abiased_l = _mm_add_epi32(a##_l, bias); \ + __m128i abiased_h = _mm_add_epi32(a##_h, bias); \ + dct_wadd(sum, abiased, b); \ + dct_wsub(dif, abiased, b); \ + out0 = _mm_packs_epi32(_mm_srai_epi32(sum_l, s), _mm_srai_epi32(sum_h, s)); \ + out1 = _mm_packs_epi32(_mm_srai_epi32(dif_l, s), _mm_srai_epi32(dif_h, s)); \ + } + + // 8-bit interleave step (for transposes) + #define dct_interleave8(a, b) \ + tmp = a; \ + a = _mm_unpacklo_epi8(a, b); \ + b = _mm_unpackhi_epi8(tmp, b) + + // 16-bit interleave step (for transposes) + #define dct_interleave16(a, b) \ + tmp = a; \ + a = _mm_unpacklo_epi16(a, b); \ + b = _mm_unpackhi_epi16(tmp, b) + + #define dct_pass(bias,shift) \ + { \ + /* even part */ \ + dct_rot(t2e,t3e, row2,row6, rot0_0,rot0_1); \ + __m128i sum04 = _mm_add_epi16(row0, row4); \ + __m128i dif04 = _mm_sub_epi16(row0, row4); \ + dct_widen(t0e, sum04); \ + dct_widen(t1e, dif04); \ + dct_wadd(x0, t0e, t3e); \ + dct_wsub(x3, t0e, t3e); \ + dct_wadd(x1, t1e, t2e); \ + dct_wsub(x2, t1e, t2e); \ + /* odd part */ \ + dct_rot(y0o,y2o, row7,row3, rot2_0,rot2_1); \ + dct_rot(y1o,y3o, row5,row1, rot3_0,rot3_1); \ + __m128i sum17 = _mm_add_epi16(row1, row7); \ + __m128i sum35 = _mm_add_epi16(row3, row5); \ + dct_rot(y4o,y5o, sum17,sum35, rot1_0,rot1_1); \ + dct_wadd(x4, y0o, y4o); \ + dct_wadd(x5, y1o, y5o); \ + dct_wadd(x6, y2o, y5o); \ + dct_wadd(x7, y3o, y4o); \ + dct_bfly32o(row0,row7, x0,x7,bias,shift); \ + dct_bfly32o(row1,row6, x1,x6,bias,shift); \ + dct_bfly32o(row2,row5, x2,x5,bias,shift); \ + dct_bfly32o(row3,row4, x3,x4,bias,shift); \ + } + + __m128i rot0_0 = dct_const(stbi__f2f(0.5411961f), stbi__f2f(0.5411961f) + stbi__f2f(-1.847759065f)); + __m128i rot0_1 = dct_const(stbi__f2f(0.5411961f) + stbi__f2f( 0.765366865f), stbi__f2f(0.5411961f)); + __m128i rot1_0 = dct_const(stbi__f2f(1.175875602f) + stbi__f2f(-0.899976223f), stbi__f2f(1.175875602f)); + __m128i rot1_1 = dct_const(stbi__f2f(1.175875602f), stbi__f2f(1.175875602f) + stbi__f2f(-2.562915447f)); + __m128i rot2_0 = dct_const(stbi__f2f(-1.961570560f) + stbi__f2f( 0.298631336f), stbi__f2f(-1.961570560f)); + __m128i rot2_1 = dct_const(stbi__f2f(-1.961570560f), stbi__f2f(-1.961570560f) + stbi__f2f( 3.072711026f)); + __m128i rot3_0 = dct_const(stbi__f2f(-0.390180644f) + stbi__f2f( 2.053119869f), stbi__f2f(-0.390180644f)); + __m128i rot3_1 = dct_const(stbi__f2f(-0.390180644f), stbi__f2f(-0.390180644f) + stbi__f2f( 1.501321110f)); + + // rounding biases in column/row passes, see stbi__idct_block for explanation. + __m128i bias_0 = _mm_set1_epi32(512); + __m128i bias_1 = _mm_set1_epi32(65536 + (128<<17)); + + // load + row0 = _mm_load_si128((const __m128i *) (data + 0*8)); + row1 = _mm_load_si128((const __m128i *) (data + 1*8)); + row2 = _mm_load_si128((const __m128i *) (data + 2*8)); + row3 = _mm_load_si128((const __m128i *) (data + 3*8)); + row4 = _mm_load_si128((const __m128i *) (data + 4*8)); + row5 = _mm_load_si128((const __m128i *) (data + 5*8)); + row6 = _mm_load_si128((const __m128i *) (data + 6*8)); + row7 = _mm_load_si128((const __m128i *) (data + 7*8)); + + // column pass + dct_pass(bias_0, 10); + + { + // 16bit 8x8 transpose pass 1 + dct_interleave16(row0, row4); + dct_interleave16(row1, row5); + dct_interleave16(row2, row6); + dct_interleave16(row3, row7); + + // transpose pass 2 + dct_interleave16(row0, row2); + dct_interleave16(row1, row3); + dct_interleave16(row4, row6); + dct_interleave16(row5, row7); + + // transpose pass 3 + dct_interleave16(row0, row1); + dct_interleave16(row2, row3); + dct_interleave16(row4, row5); + dct_interleave16(row6, row7); + } + + // row pass + dct_pass(bias_1, 17); + + { + // pack + __m128i p0 = _mm_packus_epi16(row0, row1); // a0a1a2a3...a7b0b1b2b3...b7 + __m128i p1 = _mm_packus_epi16(row2, row3); + __m128i p2 = _mm_packus_epi16(row4, row5); + __m128i p3 = _mm_packus_epi16(row6, row7); + + // 8bit 8x8 transpose pass 1 + dct_interleave8(p0, p2); // a0e0a1e1... + dct_interleave8(p1, p3); // c0g0c1g1... + + // transpose pass 2 + dct_interleave8(p0, p1); // a0c0e0g0... + dct_interleave8(p2, p3); // b0d0f0h0... + + // transpose pass 3 + dct_interleave8(p0, p2); // a0b0c0d0... + dct_interleave8(p1, p3); // a4b4c4d4... + + // store + _mm_storel_epi64((__m128i *) out, p0); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p0, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p2); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p2, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p1); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p1, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p3); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p3, 0x4e)); + } + +#undef dct_const +#undef dct_rot +#undef dct_widen +#undef dct_wadd +#undef dct_wsub +#undef dct_bfly32o +#undef dct_interleave8 +#undef dct_interleave16 +#undef dct_pass +} + +#endif // STBI_SSE2 + +#ifdef STBI_NEON + +// NEON integer IDCT. should produce bit-identical +// results to the generic C version. +static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) +{ + int16x8_t row0, row1, row2, row3, row4, row5, row6, row7; + + int16x4_t rot0_0 = vdup_n_s16(stbi__f2f(0.5411961f)); + int16x4_t rot0_1 = vdup_n_s16(stbi__f2f(-1.847759065f)); + int16x4_t rot0_2 = vdup_n_s16(stbi__f2f( 0.765366865f)); + int16x4_t rot1_0 = vdup_n_s16(stbi__f2f( 1.175875602f)); + int16x4_t rot1_1 = vdup_n_s16(stbi__f2f(-0.899976223f)); + int16x4_t rot1_2 = vdup_n_s16(stbi__f2f(-2.562915447f)); + int16x4_t rot2_0 = vdup_n_s16(stbi__f2f(-1.961570560f)); + int16x4_t rot2_1 = vdup_n_s16(stbi__f2f(-0.390180644f)); + int16x4_t rot3_0 = vdup_n_s16(stbi__f2f( 0.298631336f)); + int16x4_t rot3_1 = vdup_n_s16(stbi__f2f( 2.053119869f)); + int16x4_t rot3_2 = vdup_n_s16(stbi__f2f( 3.072711026f)); + int16x4_t rot3_3 = vdup_n_s16(stbi__f2f( 1.501321110f)); + +#define dct_long_mul(out, inq, coeff) \ + int32x4_t out##_l = vmull_s16(vget_low_s16(inq), coeff); \ + int32x4_t out##_h = vmull_s16(vget_high_s16(inq), coeff) + +#define dct_long_mac(out, acc, inq, coeff) \ + int32x4_t out##_l = vmlal_s16(acc##_l, vget_low_s16(inq), coeff); \ + int32x4_t out##_h = vmlal_s16(acc##_h, vget_high_s16(inq), coeff) + +#define dct_widen(out, inq) \ + int32x4_t out##_l = vshll_n_s16(vget_low_s16(inq), 12); \ + int32x4_t out##_h = vshll_n_s16(vget_high_s16(inq), 12) + +// wide add +#define dct_wadd(out, a, b) \ + int32x4_t out##_l = vaddq_s32(a##_l, b##_l); \ + int32x4_t out##_h = vaddq_s32(a##_h, b##_h) + +// wide sub +#define dct_wsub(out, a, b) \ + int32x4_t out##_l = vsubq_s32(a##_l, b##_l); \ + int32x4_t out##_h = vsubq_s32(a##_h, b##_h) + +// butterfly a/b, then shift using "shiftop" by "s" and pack +#define dct_bfly32o(out0,out1, a,b,shiftop,s) \ + { \ + dct_wadd(sum, a, b); \ + dct_wsub(dif, a, b); \ + out0 = vcombine_s16(shiftop(sum_l, s), shiftop(sum_h, s)); \ + out1 = vcombine_s16(shiftop(dif_l, s), shiftop(dif_h, s)); \ + } + +#define dct_pass(shiftop, shift) \ + { \ + /* even part */ \ + int16x8_t sum26 = vaddq_s16(row2, row6); \ + dct_long_mul(p1e, sum26, rot0_0); \ + dct_long_mac(t2e, p1e, row6, rot0_1); \ + dct_long_mac(t3e, p1e, row2, rot0_2); \ + int16x8_t sum04 = vaddq_s16(row0, row4); \ + int16x8_t dif04 = vsubq_s16(row0, row4); \ + dct_widen(t0e, sum04); \ + dct_widen(t1e, dif04); \ + dct_wadd(x0, t0e, t3e); \ + dct_wsub(x3, t0e, t3e); \ + dct_wadd(x1, t1e, t2e); \ + dct_wsub(x2, t1e, t2e); \ + /* odd part */ \ + int16x8_t sum15 = vaddq_s16(row1, row5); \ + int16x8_t sum17 = vaddq_s16(row1, row7); \ + int16x8_t sum35 = vaddq_s16(row3, row5); \ + int16x8_t sum37 = vaddq_s16(row3, row7); \ + int16x8_t sumodd = vaddq_s16(sum17, sum35); \ + dct_long_mul(p5o, sumodd, rot1_0); \ + dct_long_mac(p1o, p5o, sum17, rot1_1); \ + dct_long_mac(p2o, p5o, sum35, rot1_2); \ + dct_long_mul(p3o, sum37, rot2_0); \ + dct_long_mul(p4o, sum15, rot2_1); \ + dct_wadd(sump13o, p1o, p3o); \ + dct_wadd(sump24o, p2o, p4o); \ + dct_wadd(sump23o, p2o, p3o); \ + dct_wadd(sump14o, p1o, p4o); \ + dct_long_mac(x4, sump13o, row7, rot3_0); \ + dct_long_mac(x5, sump24o, row5, rot3_1); \ + dct_long_mac(x6, sump23o, row3, rot3_2); \ + dct_long_mac(x7, sump14o, row1, rot3_3); \ + dct_bfly32o(row0,row7, x0,x7,shiftop,shift); \ + dct_bfly32o(row1,row6, x1,x6,shiftop,shift); \ + dct_bfly32o(row2,row5, x2,x5,shiftop,shift); \ + dct_bfly32o(row3,row4, x3,x4,shiftop,shift); \ + } + + // load + row0 = vld1q_s16(data + 0*8); + row1 = vld1q_s16(data + 1*8); + row2 = vld1q_s16(data + 2*8); + row3 = vld1q_s16(data + 3*8); + row4 = vld1q_s16(data + 4*8); + row5 = vld1q_s16(data + 5*8); + row6 = vld1q_s16(data + 6*8); + row7 = vld1q_s16(data + 7*8); + + // add DC bias + row0 = vaddq_s16(row0, vsetq_lane_s16(1024, vdupq_n_s16(0), 0)); + + // column pass + dct_pass(vrshrn_n_s32, 10); + + // 16bit 8x8 transpose + { +// these three map to a single VTRN.16, VTRN.32, and VSWP, respectively. +// whether compilers actually get this is another story, sadly. +#define dct_trn16(x, y) { int16x8x2_t t = vtrnq_s16(x, y); x = t.val[0]; y = t.val[1]; } +#define dct_trn32(x, y) { int32x4x2_t t = vtrnq_s32(vreinterpretq_s32_s16(x), vreinterpretq_s32_s16(y)); x = vreinterpretq_s16_s32(t.val[0]); y = vreinterpretq_s16_s32(t.val[1]); } +#define dct_trn64(x, y) { int16x8_t x0 = x; int16x8_t y0 = y; x = vcombine_s16(vget_low_s16(x0), vget_low_s16(y0)); y = vcombine_s16(vget_high_s16(x0), vget_high_s16(y0)); } + + // pass 1 + dct_trn16(row0, row1); // a0b0a2b2a4b4a6b6 + dct_trn16(row2, row3); + dct_trn16(row4, row5); + dct_trn16(row6, row7); + + // pass 2 + dct_trn32(row0, row2); // a0b0c0d0a4b4c4d4 + dct_trn32(row1, row3); + dct_trn32(row4, row6); + dct_trn32(row5, row7); + + // pass 3 + dct_trn64(row0, row4); // a0b0c0d0e0f0g0h0 + dct_trn64(row1, row5); + dct_trn64(row2, row6); + dct_trn64(row3, row7); + +#undef dct_trn16 +#undef dct_trn32 +#undef dct_trn64 + } + + // row pass + // vrshrn_n_s32 only supports shifts up to 16, we need + // 17. so do a non-rounding shift of 16 first then follow + // up with a rounding shift by 1. + dct_pass(vshrn_n_s32, 16); + + { + // pack and round + uint8x8_t p0 = vqrshrun_n_s16(row0, 1); + uint8x8_t p1 = vqrshrun_n_s16(row1, 1); + uint8x8_t p2 = vqrshrun_n_s16(row2, 1); + uint8x8_t p3 = vqrshrun_n_s16(row3, 1); + uint8x8_t p4 = vqrshrun_n_s16(row4, 1); + uint8x8_t p5 = vqrshrun_n_s16(row5, 1); + uint8x8_t p6 = vqrshrun_n_s16(row6, 1); + uint8x8_t p7 = vqrshrun_n_s16(row7, 1); + + // again, these can translate into one instruction, but often don't. +#define dct_trn8_8(x, y) { uint8x8x2_t t = vtrn_u8(x, y); x = t.val[0]; y = t.val[1]; } +#define dct_trn8_16(x, y) { uint16x4x2_t t = vtrn_u16(vreinterpret_u16_u8(x), vreinterpret_u16_u8(y)); x = vreinterpret_u8_u16(t.val[0]); y = vreinterpret_u8_u16(t.val[1]); } +#define dct_trn8_32(x, y) { uint32x2x2_t t = vtrn_u32(vreinterpret_u32_u8(x), vreinterpret_u32_u8(y)); x = vreinterpret_u8_u32(t.val[0]); y = vreinterpret_u8_u32(t.val[1]); } + + // sadly can't use interleaved stores here since we only write + // 8 bytes to each scan line! + + // 8x8 8-bit transpose pass 1 + dct_trn8_8(p0, p1); + dct_trn8_8(p2, p3); + dct_trn8_8(p4, p5); + dct_trn8_8(p6, p7); + + // pass 2 + dct_trn8_16(p0, p2); + dct_trn8_16(p1, p3); + dct_trn8_16(p4, p6); + dct_trn8_16(p5, p7); + + // pass 3 + dct_trn8_32(p0, p4); + dct_trn8_32(p1, p5); + dct_trn8_32(p2, p6); + dct_trn8_32(p3, p7); + + // store + vst1_u8(out, p0); out += out_stride; + vst1_u8(out, p1); out += out_stride; + vst1_u8(out, p2); out += out_stride; + vst1_u8(out, p3); out += out_stride; + vst1_u8(out, p4); out += out_stride; + vst1_u8(out, p5); out += out_stride; + vst1_u8(out, p6); out += out_stride; + vst1_u8(out, p7); + +#undef dct_trn8_8 +#undef dct_trn8_16 +#undef dct_trn8_32 + } + +#undef dct_long_mul +#undef dct_long_mac +#undef dct_widen +#undef dct_wadd +#undef dct_wsub +#undef dct_bfly32o +#undef dct_pass +} + +#endif // STBI_NEON + +#define STBI__MARKER_none 0xff +// if there's a pending marker from the entropy stream, return that +// otherwise, fetch from the stream and get a marker. if there's no +// marker, return 0xff, which is never a valid marker value +static stbi_uc stbi__get_marker(stbi__jpeg *j) +{ + stbi_uc x; + if (j->marker != STBI__MARKER_none) { x = j->marker; j->marker = STBI__MARKER_none; return x; } + x = stbi__get8(j->s); + if (x != 0xff) return STBI__MARKER_none; + while (x == 0xff) + x = stbi__get8(j->s); + return x; +} + +// in each scan, we'll have scan_n components, and the order +// of the components is specified by order[] +#define STBI__RESTART(x) ((x) >= 0xd0 && (x) <= 0xd7) + +// after a restart interval, stbi__jpeg_reset the entropy decoder and +// the dc prediction +static void stbi__jpeg_reset(stbi__jpeg *j) +{ + j->code_bits = 0; + j->code_buffer = 0; + j->nomore = 0; + j->img_comp[0].dc_pred = j->img_comp[1].dc_pred = j->img_comp[2].dc_pred = 0; + j->marker = STBI__MARKER_none; + j->todo = j->restart_interval ? j->restart_interval : 0x7fffffff; + j->eob_run = 0; + // no more than 1<<31 MCUs if no restart_interal? that's plenty safe, + // since we don't even allow 1<<30 pixels +} + +static int stbi__parse_entropy_coded_data(stbi__jpeg *z) +{ + stbi__jpeg_reset(z); + if (!z->progressive) { + if (z->scan_n == 1) { + int i,j; + STBI_SIMD_ALIGN(short, data[64]); + int n = z->order[0]; + // non-interleaved data, we just need to process one block at a time, + // in trivial scanline order + // number of blocks to do just depends on how many actual "pixels" this + // component has, independent of interleaved MCU blocking and such + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); + // every data block is an MCU, so countdown the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + // if it's NOT a restart, then just bail, so we get corrupt data + // rather than no data + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } else { // interleaved + int i,j,k,x,y; + STBI_SIMD_ALIGN(short, data[64]); + for (j=0; j < z->img_mcu_y; ++j) { + for (i=0; i < z->img_mcu_x; ++i) { + // scan an interleaved mcu... process scan_n components in order + for (k=0; k < z->scan_n; ++k) { + int n = z->order[k]; + // scan out an mcu's worth of this component; that's just determined + // by the basic H and V specified for the component + for (y=0; y < z->img_comp[n].v; ++y) { + for (x=0; x < z->img_comp[n].h; ++x) { + int x2 = (i*z->img_comp[n].h + x)*8; + int y2 = (j*z->img_comp[n].v + y)*8; + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*y2+x2, z->img_comp[n].w2, data); + } + } + } + // after all interleaved components, that's an interleaved MCU, + // so now count down the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } + } else { + if (z->scan_n == 1) { + int i,j; + int n = z->order[0]; + // non-interleaved data, we just need to process one block at a time, + // in trivial scanline order + // number of blocks to do just depends on how many actual "pixels" this + // component has, independent of interleaved MCU blocking and such + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); + if (z->spec_start == 0) { + if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) + return 0; + } else { + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block_prog_ac(z, data, &z->huff_ac[ha], z->fast_ac[ha])) + return 0; + } + // every data block is an MCU, so countdown the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } else { // interleaved + int i,j,k,x,y; + for (j=0; j < z->img_mcu_y; ++j) { + for (i=0; i < z->img_mcu_x; ++i) { + // scan an interleaved mcu... process scan_n components in order + for (k=0; k < z->scan_n; ++k) { + int n = z->order[k]; + // scan out an mcu's worth of this component; that's just determined + // by the basic H and V specified for the component + for (y=0; y < z->img_comp[n].v; ++y) { + for (x=0; x < z->img_comp[n].h; ++x) { + int x2 = (i*z->img_comp[n].h + x); + int y2 = (j*z->img_comp[n].v + y); + short *data = z->img_comp[n].coeff + 64 * (x2 + y2 * z->img_comp[n].coeff_w); + if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) + return 0; + } + } + } + // after all interleaved components, that's an interleaved MCU, + // so now count down the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } + } +} + +static void stbi__jpeg_dequantize(short *data, stbi_uc *dequant) +{ + int i; + for (i=0; i < 64; ++i) + data[i] *= dequant[i]; +} + +static void stbi__jpeg_finish(stbi__jpeg *z) +{ + if (z->progressive) { + // dequantize and idct the data + int i,j,n; + for (n=0; n < z->s->img_n; ++n) { + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); + stbi__jpeg_dequantize(data, z->dequant[z->img_comp[n].tq]); + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); + } + } + } + } +} + +static int stbi__process_marker(stbi__jpeg *z, int m) +{ + int L; + switch (m) { + case STBI__MARKER_none: // no marker found + return stbi__err("expected marker","Corrupt JPEG"); + + case 0xDD: // DRI - specify restart interval + if (stbi__get16be(z->s) != 4) return stbi__err("bad DRI len","Corrupt JPEG"); + z->restart_interval = stbi__get16be(z->s); + return 1; + + case 0xDB: // DQT - define quantization table + L = stbi__get16be(z->s)-2; + while (L > 0) { + int q = stbi__get8(z->s); + int p = q >> 4; + int t = q & 15,i; + if (p != 0) return stbi__err("bad DQT type","Corrupt JPEG"); + if (t > 3) return stbi__err("bad DQT table","Corrupt JPEG"); + for (i=0; i < 64; ++i) + z->dequant[t][stbi__jpeg_dezigzag[i]] = stbi__get8(z->s); + L -= 65; + } + return L==0; + + case 0xC4: // DHT - define huffman table + L = stbi__get16be(z->s)-2; + while (L > 0) { + stbi_uc *v; + int sizes[16],i,n=0; + int q = stbi__get8(z->s); + int tc = q >> 4; + int th = q & 15; + if (tc > 1 || th > 3) return stbi__err("bad DHT header","Corrupt JPEG"); + for (i=0; i < 16; ++i) { + sizes[i] = stbi__get8(z->s); + n += sizes[i]; + } + L -= 17; + if (tc == 0) { + if (!stbi__build_huffman(z->huff_dc+th, sizes)) return 0; + v = z->huff_dc[th].values; + } else { + if (!stbi__build_huffman(z->huff_ac+th, sizes)) return 0; + v = z->huff_ac[th].values; + } + for (i=0; i < n; ++i) + v[i] = stbi__get8(z->s); + if (tc != 0) + stbi__build_fast_ac(z->fast_ac[th], z->huff_ac + th); + L -= n; + } + return L==0; + } + // check for comment block or APP blocks + if ((m >= 0xE0 && m <= 0xEF) || m == 0xFE) { + stbi__skip(z->s, stbi__get16be(z->s)-2); + return 1; + } + return 0; +} + +// after we see SOS +static int stbi__process_scan_header(stbi__jpeg *z) +{ + int i; + int Ls = stbi__get16be(z->s); + z->scan_n = stbi__get8(z->s); + if (z->scan_n < 1 || z->scan_n > 4 || z->scan_n > (int) z->s->img_n) return stbi__err("bad SOS component count","Corrupt JPEG"); + if (Ls != 6+2*z->scan_n) return stbi__err("bad SOS len","Corrupt JPEG"); + for (i=0; i < z->scan_n; ++i) { + int id = stbi__get8(z->s), which; + int q = stbi__get8(z->s); + for (which = 0; which < z->s->img_n; ++which) + if (z->img_comp[which].id == id) + break; + if (which == z->s->img_n) return 0; // no match + z->img_comp[which].hd = q >> 4; if (z->img_comp[which].hd > 3) return stbi__err("bad DC huff","Corrupt JPEG"); + z->img_comp[which].ha = q & 15; if (z->img_comp[which].ha > 3) return stbi__err("bad AC huff","Corrupt JPEG"); + z->order[i] = which; + } + + { + int aa; + z->spec_start = stbi__get8(z->s); + z->spec_end = stbi__get8(z->s); // should be 63, but might be 0 + aa = stbi__get8(z->s); + z->succ_high = (aa >> 4); + z->succ_low = (aa & 15); + if (z->progressive) { + if (z->spec_start > 63 || z->spec_end > 63 || z->spec_start > z->spec_end || z->succ_high > 13 || z->succ_low > 13) + return stbi__err("bad SOS", "Corrupt JPEG"); + } else { + if (z->spec_start != 0) return stbi__err("bad SOS","Corrupt JPEG"); + if (z->succ_high != 0 || z->succ_low != 0) return stbi__err("bad SOS","Corrupt JPEG"); + z->spec_end = 63; + } + } + + return 1; +} + +static int stbi__process_frame_header(stbi__jpeg *z, int scan) +{ + stbi__context *s = z->s; + int Lf,p,i,q, h_max=1,v_max=1,c; + Lf = stbi__get16be(s); if (Lf < 11) return stbi__err("bad SOF len","Corrupt JPEG"); // JPEG + p = stbi__get8(s); if (p != 8) return stbi__err("only 8-bit","JPEG format not supported: 8-bit only"); // JPEG baseline + s->img_y = stbi__get16be(s); if (s->img_y == 0) return stbi__err("no header height", "JPEG format not supported: delayed height"); // Legal, but we don't handle it--but neither does IJG + s->img_x = stbi__get16be(s); if (s->img_x == 0) return stbi__err("0 width","Corrupt JPEG"); // JPEG requires + c = stbi__get8(s); + if (c != 3 && c != 1) return stbi__err("bad component count","Corrupt JPEG"); // JFIF requires + s->img_n = c; + for (i=0; i < c; ++i) { + z->img_comp[i].data = NULL; + z->img_comp[i].linebuf = NULL; + } + + if (Lf != 8+3*s->img_n) return stbi__err("bad SOF len","Corrupt JPEG"); + + for (i=0; i < s->img_n; ++i) { + z->img_comp[i].id = stbi__get8(s); + if (z->img_comp[i].id != i+1) // JFIF requires + if (z->img_comp[i].id != i) // some version of jpegtran outputs non-JFIF-compliant files! + return stbi__err("bad component ID","Corrupt JPEG"); + q = stbi__get8(s); + z->img_comp[i].h = (q >> 4); if (!z->img_comp[i].h || z->img_comp[i].h > 4) return stbi__err("bad H","Corrupt JPEG"); + z->img_comp[i].v = q & 15; if (!z->img_comp[i].v || z->img_comp[i].v > 4) return stbi__err("bad V","Corrupt JPEG"); + z->img_comp[i].tq = stbi__get8(s); if (z->img_comp[i].tq > 3) return stbi__err("bad TQ","Corrupt JPEG"); + } + + if (scan != STBI__SCAN_load) return 1; + + if ((1 << 30) / s->img_x / s->img_n < s->img_y) return stbi__err("too large", "Image too large to decode"); + + for (i=0; i < s->img_n; ++i) { + if (z->img_comp[i].h > h_max) h_max = z->img_comp[i].h; + if (z->img_comp[i].v > v_max) v_max = z->img_comp[i].v; + } + + // compute interleaved mcu info + z->img_h_max = h_max; + z->img_v_max = v_max; + z->img_mcu_w = h_max * 8; + z->img_mcu_h = v_max * 8; + z->img_mcu_x = (s->img_x + z->img_mcu_w-1) / z->img_mcu_w; + z->img_mcu_y = (s->img_y + z->img_mcu_h-1) / z->img_mcu_h; + + for (i=0; i < s->img_n; ++i) { + // number of effective pixels (e.g. for non-interleaved MCU) + z->img_comp[i].x = (s->img_x * z->img_comp[i].h + h_max-1) / h_max; + z->img_comp[i].y = (s->img_y * z->img_comp[i].v + v_max-1) / v_max; + // to simplify generation, we'll allocate enough memory to decode + // the bogus oversized data from using interleaved MCUs and their + // big blocks (e.g. a 16x16 iMCU on an image of width 33); we won't + // discard the extra data until colorspace conversion + z->img_comp[i].w2 = z->img_mcu_x * z->img_comp[i].h * 8; + z->img_comp[i].h2 = z->img_mcu_y * z->img_comp[i].v * 8; + z->img_comp[i].raw_data = stbi__malloc(z->img_comp[i].w2 * z->img_comp[i].h2+15); + + if (z->img_comp[i].raw_data == NULL) { + for(--i; i >= 0; --i) { + STBI_FREE(z->img_comp[i].raw_data); + z->img_comp[i].raw_data = NULL; + } + return stbi__err("outofmem", "Out of memory"); + } + // align blocks for idct using mmx/sse + z->img_comp[i].data = (stbi_uc*) (((size_t) z->img_comp[i].raw_data + 15) & ~15); + z->img_comp[i].linebuf = NULL; + if (z->progressive) { + z->img_comp[i].coeff_w = (z->img_comp[i].w2 + 7) >> 3; + z->img_comp[i].coeff_h = (z->img_comp[i].h2 + 7) >> 3; + z->img_comp[i].raw_coeff = STBI_MALLOC(z->img_comp[i].coeff_w * z->img_comp[i].coeff_h * 64 * sizeof(short) + 15); + z->img_comp[i].coeff = (short*) (((size_t) z->img_comp[i].raw_coeff + 15) & ~15); + } else { + z->img_comp[i].coeff = 0; + z->img_comp[i].raw_coeff = 0; + } + } + + return 1; +} + +// use comparisons since in some cases we handle more than one case (e.g. SOF) +#define stbi__DNL(x) ((x) == 0xdc) +#define stbi__SOI(x) ((x) == 0xd8) +#define stbi__EOI(x) ((x) == 0xd9) +#define stbi__SOF(x) ((x) == 0xc0 || (x) == 0xc1 || (x) == 0xc2) +#define stbi__SOS(x) ((x) == 0xda) + +#define stbi__SOF_progressive(x) ((x) == 0xc2) + +static int stbi__decode_jpeg_header(stbi__jpeg *z, int scan) +{ + int m; + z->marker = STBI__MARKER_none; // initialize cached marker to empty + m = stbi__get_marker(z); + if (!stbi__SOI(m)) return stbi__err("no SOI","Corrupt JPEG"); + if (scan == STBI__SCAN_type) return 1; + m = stbi__get_marker(z); + while (!stbi__SOF(m)) { + if (!stbi__process_marker(z,m)) return 0; + m = stbi__get_marker(z); + while (m == STBI__MARKER_none) { + // some files have extra padding after their blocks, so ok, we'll scan + if (stbi__at_eof(z->s)) return stbi__err("no SOF", "Corrupt JPEG"); + m = stbi__get_marker(z); + } + } + z->progressive = stbi__SOF_progressive(m); + if (!stbi__process_frame_header(z, scan)) return 0; + return 1; +} + +// decode image to YCbCr format +static int stbi__decode_jpeg_image(stbi__jpeg *j) +{ + int m; + for (m = 0; m < 4; m++) { + j->img_comp[m].raw_data = NULL; + j->img_comp[m].raw_coeff = NULL; + } + j->restart_interval = 0; + if (!stbi__decode_jpeg_header(j, STBI__SCAN_load)) return 0; + m = stbi__get_marker(j); + while (!stbi__EOI(m)) { + if (stbi__SOS(m)) { + if (!stbi__process_scan_header(j)) return 0; + if (!stbi__parse_entropy_coded_data(j)) return 0; + if (j->marker == STBI__MARKER_none ) { + // handle 0s at the end of image data from IP Kamera 9060 + while (!stbi__at_eof(j->s)) { + int x = stbi__get8(j->s); + if (x == 255) { + j->marker = stbi__get8(j->s); + break; + } else if (x != 0) { + return stbi__err("junk before marker", "Corrupt JPEG"); + } + } + // if we reach eof without hitting a marker, stbi__get_marker() below will fail and we'll eventually return 0 + } + } else { + if (!stbi__process_marker(j, m)) return 0; + } + m = stbi__get_marker(j); + } + if (j->progressive) + stbi__jpeg_finish(j); + return 1; +} + +// static jfif-centered resampling (across block boundaries) + +typedef stbi_uc *(*resample_row_func)(stbi_uc *out, stbi_uc *in0, stbi_uc *in1, + int w, int hs); + +#define stbi__div4(x) ((stbi_uc) ((x) >> 2)) + +static stbi_uc *resample_row_1(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + STBI_NOTUSED(out); + STBI_NOTUSED(in_far); + STBI_NOTUSED(w); + STBI_NOTUSED(hs); + return in_near; +} + +static stbi_uc* stbi__resample_row_v_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate two samples vertically for every one in input + int i; + STBI_NOTUSED(hs); + for (i=0; i < w; ++i) + out[i] = stbi__div4(3*in_near[i] + in_far[i] + 2); + return out; +} + +static stbi_uc* stbi__resample_row_h_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate two samples horizontally for every one in input + int i; + stbi_uc *input = in_near; + + if (w == 1) { + // if only one sample, can't do any interpolation + out[0] = out[1] = input[0]; + return out; + } + + out[0] = input[0]; + out[1] = stbi__div4(input[0]*3 + input[1] + 2); + for (i=1; i < w-1; ++i) { + int n = 3*input[i]+2; + out[i*2+0] = stbi__div4(n+input[i-1]); + out[i*2+1] = stbi__div4(n+input[i+1]); + } + out[i*2+0] = stbi__div4(input[w-2]*3 + input[w-1] + 2); + out[i*2+1] = input[w-1]; + + STBI_NOTUSED(in_far); + STBI_NOTUSED(hs); + + return out; +} + +#define stbi__div16(x) ((stbi_uc) ((x) >> 4)) + +static stbi_uc *stbi__resample_row_hv_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate 2x2 samples for every one in input + int i,t0,t1; + if (w == 1) { + out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); + return out; + } + + t1 = 3*in_near[0] + in_far[0]; + out[0] = stbi__div4(t1+2); + for (i=1; i < w; ++i) { + t0 = t1; + t1 = 3*in_near[i]+in_far[i]; + out[i*2-1] = stbi__div16(3*t0 + t1 + 8); + out[i*2 ] = stbi__div16(3*t1 + t0 + 8); + } + out[w*2-1] = stbi__div4(t1+2); + + STBI_NOTUSED(hs); + + return out; +} + +#if defined(STBI_SSE2) || defined(STBI_NEON) +static stbi_uc *stbi__resample_row_hv_2_simd(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate 2x2 samples for every one in input + int i=0,t0,t1; + + if (w == 1) { + out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); + return out; + } + + t1 = 3*in_near[0] + in_far[0]; + // process groups of 8 pixels for as long as we can. + // note we can't handle the last pixel in a row in this loop + // because we need to handle the filter boundary conditions. + for (; i < ((w-1) & ~7); i += 8) { +#if defined(STBI_SSE2) + // load and perform the vertical filtering pass + // this uses 3*x + y = 4*x + (y - x) + __m128i zero = _mm_setzero_si128(); + __m128i farb = _mm_loadl_epi64((__m128i *) (in_far + i)); + __m128i nearb = _mm_loadl_epi64((__m128i *) (in_near + i)); + __m128i farw = _mm_unpacklo_epi8(farb, zero); + __m128i nearw = _mm_unpacklo_epi8(nearb, zero); + __m128i diff = _mm_sub_epi16(farw, nearw); + __m128i nears = _mm_slli_epi16(nearw, 2); + __m128i curr = _mm_add_epi16(nears, diff); // current row + + // horizontal filter works the same based on shifted vers of current + // row. "prev" is current row shifted right by 1 pixel; we need to + // insert the previous pixel value (from t1). + // "next" is current row shifted left by 1 pixel, with first pixel + // of next block of 8 pixels added in. + __m128i prv0 = _mm_slli_si128(curr, 2); + __m128i nxt0 = _mm_srli_si128(curr, 2); + __m128i prev = _mm_insert_epi16(prv0, t1, 0); + __m128i next = _mm_insert_epi16(nxt0, 3*in_near[i+8] + in_far[i+8], 7); + + // horizontal filter, polyphase implementation since it's convenient: + // even pixels = 3*cur + prev = cur*4 + (prev - cur) + // odd pixels = 3*cur + next = cur*4 + (next - cur) + // note the shared term. + __m128i bias = _mm_set1_epi16(8); + __m128i curs = _mm_slli_epi16(curr, 2); + __m128i prvd = _mm_sub_epi16(prev, curr); + __m128i nxtd = _mm_sub_epi16(next, curr); + __m128i curb = _mm_add_epi16(curs, bias); + __m128i even = _mm_add_epi16(prvd, curb); + __m128i odd = _mm_add_epi16(nxtd, curb); + + // interleave even and odd pixels, then undo scaling. + __m128i int0 = _mm_unpacklo_epi16(even, odd); + __m128i int1 = _mm_unpackhi_epi16(even, odd); + __m128i de0 = _mm_srli_epi16(int0, 4); + __m128i de1 = _mm_srli_epi16(int1, 4); + + // pack and write output + __m128i outv = _mm_packus_epi16(de0, de1); + _mm_storeu_si128((__m128i *) (out + i*2), outv); +#elif defined(STBI_NEON) + // load and perform the vertical filtering pass + // this uses 3*x + y = 4*x + (y - x) + uint8x8_t farb = vld1_u8(in_far + i); + uint8x8_t nearb = vld1_u8(in_near + i); + int16x8_t diff = vreinterpretq_s16_u16(vsubl_u8(farb, nearb)); + int16x8_t nears = vreinterpretq_s16_u16(vshll_n_u8(nearb, 2)); + int16x8_t curr = vaddq_s16(nears, diff); // current row + + // horizontal filter works the same based on shifted vers of current + // row. "prev" is current row shifted right by 1 pixel; we need to + // insert the previous pixel value (from t1). + // "next" is current row shifted left by 1 pixel, with first pixel + // of next block of 8 pixels added in. + int16x8_t prv0 = vextq_s16(curr, curr, 7); + int16x8_t nxt0 = vextq_s16(curr, curr, 1); + int16x8_t prev = vsetq_lane_s16(t1, prv0, 0); + int16x8_t next = vsetq_lane_s16(3*in_near[i+8] + in_far[i+8], nxt0, 7); + + // horizontal filter, polyphase implementation since it's convenient: + // even pixels = 3*cur + prev = cur*4 + (prev - cur) + // odd pixels = 3*cur + next = cur*4 + (next - cur) + // note the shared term. + int16x8_t curs = vshlq_n_s16(curr, 2); + int16x8_t prvd = vsubq_s16(prev, curr); + int16x8_t nxtd = vsubq_s16(next, curr); + int16x8_t even = vaddq_s16(curs, prvd); + int16x8_t odd = vaddq_s16(curs, nxtd); + + // undo scaling and round, then store with even/odd phases interleaved + uint8x8x2_t o; + o.val[0] = vqrshrun_n_s16(even, 4); + o.val[1] = vqrshrun_n_s16(odd, 4); + vst2_u8(out + i*2, o); +#endif + + // "previous" value for next iter + t1 = 3*in_near[i+7] + in_far[i+7]; + } + + t0 = t1; + t1 = 3*in_near[i] + in_far[i]; + out[i*2] = stbi__div16(3*t1 + t0 + 8); + + for (++i; i < w; ++i) { + t0 = t1; + t1 = 3*in_near[i]+in_far[i]; + out[i*2-1] = stbi__div16(3*t0 + t1 + 8); + out[i*2 ] = stbi__div16(3*t1 + t0 + 8); + } + out[w*2-1] = stbi__div4(t1+2); + + STBI_NOTUSED(hs); + + return out; +} +#endif + +static stbi_uc *stbi__resample_row_generic(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // resample with nearest-neighbor + int i,j; + STBI_NOTUSED(in_far); + for (i=0; i < w; ++i) + for (j=0; j < hs; ++j) + out[i*hs+j] = in_near[i]; + return out; +} + +#ifdef STBI_JPEG_OLD +// this is the same YCbCr-to-RGB calculation that stb_image has used +// historically before the algorithm changes in 1.49 +#define float2fixed(x) ((int) ((x) * 65536 + 0.5)) +static void stbi__YCbCr_to_RGB_row(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step) +{ + int i; + for (i=0; i < count; ++i) { + int y_fixed = (y[i] << 16) + 32768; // rounding + int r,g,b; + int cr = pcr[i] - 128; + int cb = pcb[i] - 128; + r = y_fixed + cr*float2fixed(1.40200f); + g = y_fixed - cr*float2fixed(0.71414f) - cb*float2fixed(0.34414f); + b = y_fixed + cb*float2fixed(1.77200f); + r >>= 16; + g >>= 16; + b >>= 16; + if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } + if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } + if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } + out[0] = (stbi_uc)r; + out[1] = (stbi_uc)g; + out[2] = (stbi_uc)b; + out[3] = 255; + out += step; + } +} +#else +// this is a reduced-precision calculation of YCbCr-to-RGB introduced +// to make sure the code produces the same results in both SIMD and scalar +#define float2fixed(x) (((int) ((x) * 4096.0f + 0.5f)) << 8) +static void stbi__YCbCr_to_RGB_row(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step) +{ + int i; + for (i=0; i < count; ++i) { + int y_fixed = (y[i] << 20) + (1<<19); // rounding + int r,g,b; + int cr = pcr[i] - 128; + int cb = pcb[i] - 128; + r = y_fixed + cr* float2fixed(1.40200f); + g = y_fixed + (cr*-float2fixed(0.71414f)) + ((cb*-float2fixed(0.34414f)) & 0xffff0000); + b = y_fixed + cb* float2fixed(1.77200f); + r >>= 20; + g >>= 20; + b >>= 20; + if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } + if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } + if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } + out[0] = (stbi_uc)r; + out[1] = (stbi_uc)g; + out[2] = (stbi_uc)b; + out[3] = 255; + out += step; + } +} +#endif + +#if defined(STBI_SSE2) || defined(STBI_NEON) +static void stbi__YCbCr_to_RGB_simd(stbi_uc *out, stbi_uc const *y, stbi_uc const *pcb, stbi_uc const *pcr, int count, int step) +{ + int i = 0; + +#ifdef STBI_SSE2 + // step == 3 is pretty ugly on the final interleave, and i'm not convinced + // it's useful in practice (you wouldn't use it for textures, for example). + // so just accelerate step == 4 case. + if (step == 4) { + // this is a fairly straightforward implementation and not super-optimized. + __m128i signflip = _mm_set1_epi8(-0x80); + __m128i cr_const0 = _mm_set1_epi16( (short) ( 1.40200f*4096.0f+0.5f)); + __m128i cr_const1 = _mm_set1_epi16( - (short) ( 0.71414f*4096.0f+0.5f)); + __m128i cb_const0 = _mm_set1_epi16( - (short) ( 0.34414f*4096.0f+0.5f)); + __m128i cb_const1 = _mm_set1_epi16( (short) ( 1.77200f*4096.0f+0.5f)); + __m128i y_bias = _mm_set1_epi8((char) (unsigned char) 128); + __m128i xw = _mm_set1_epi16(255); // alpha channel + + for (; i+7 < count; i += 8) { + // load + __m128i y_bytes = _mm_loadl_epi64((__m128i *) (y+i)); + __m128i cr_bytes = _mm_loadl_epi64((__m128i *) (pcr+i)); + __m128i cb_bytes = _mm_loadl_epi64((__m128i *) (pcb+i)); + __m128i cr_biased = _mm_xor_si128(cr_bytes, signflip); // -128 + __m128i cb_biased = _mm_xor_si128(cb_bytes, signflip); // -128 + + // unpack to short (and left-shift cr, cb by 8) + __m128i yw = _mm_unpacklo_epi8(y_bias, y_bytes); + __m128i crw = _mm_unpacklo_epi8(_mm_setzero_si128(), cr_biased); + __m128i cbw = _mm_unpacklo_epi8(_mm_setzero_si128(), cb_biased); + + // color transform + __m128i yws = _mm_srli_epi16(yw, 4); + __m128i cr0 = _mm_mulhi_epi16(cr_const0, crw); + __m128i cb0 = _mm_mulhi_epi16(cb_const0, cbw); + __m128i cb1 = _mm_mulhi_epi16(cbw, cb_const1); + __m128i cr1 = _mm_mulhi_epi16(crw, cr_const1); + __m128i rws = _mm_add_epi16(cr0, yws); + __m128i gwt = _mm_add_epi16(cb0, yws); + __m128i bws = _mm_add_epi16(yws, cb1); + __m128i gws = _mm_add_epi16(gwt, cr1); + + // descale + __m128i rw = _mm_srai_epi16(rws, 4); + __m128i bw = _mm_srai_epi16(bws, 4); + __m128i gw = _mm_srai_epi16(gws, 4); + + // back to byte, set up for transpose + __m128i brb = _mm_packus_epi16(rw, bw); + __m128i gxb = _mm_packus_epi16(gw, xw); + + // transpose to interleave channels + __m128i t0 = _mm_unpacklo_epi8(brb, gxb); + __m128i t1 = _mm_unpackhi_epi8(brb, gxb); + __m128i o0 = _mm_unpacklo_epi16(t0, t1); + __m128i o1 = _mm_unpackhi_epi16(t0, t1); + + // store + _mm_storeu_si128((__m128i *) (out + 0), o0); + _mm_storeu_si128((__m128i *) (out + 16), o1); + out += 32; + } + } +#endif + +#ifdef STBI_NEON + // in this version, step=3 support would be easy to add. but is there demand? + if (step == 4) { + // this is a fairly straightforward implementation and not super-optimized. + uint8x8_t signflip = vdup_n_u8(0x80); + int16x8_t cr_const0 = vdupq_n_s16( (short) ( 1.40200f*4096.0f+0.5f)); + int16x8_t cr_const1 = vdupq_n_s16( - (short) ( 0.71414f*4096.0f+0.5f)); + int16x8_t cb_const0 = vdupq_n_s16( - (short) ( 0.34414f*4096.0f+0.5f)); + int16x8_t cb_const1 = vdupq_n_s16( (short) ( 1.77200f*4096.0f+0.5f)); + + for (; i+7 < count; i += 8) { + // load + uint8x8_t y_bytes = vld1_u8(y + i); + uint8x8_t cr_bytes = vld1_u8(pcr + i); + uint8x8_t cb_bytes = vld1_u8(pcb + i); + int8x8_t cr_biased = vreinterpret_s8_u8(vsub_u8(cr_bytes, signflip)); + int8x8_t cb_biased = vreinterpret_s8_u8(vsub_u8(cb_bytes, signflip)); + + // expand to s16 + int16x8_t yws = vreinterpretq_s16_u16(vshll_n_u8(y_bytes, 4)); + int16x8_t crw = vshll_n_s8(cr_biased, 7); + int16x8_t cbw = vshll_n_s8(cb_biased, 7); + + // color transform + int16x8_t cr0 = vqdmulhq_s16(crw, cr_const0); + int16x8_t cb0 = vqdmulhq_s16(cbw, cb_const0); + int16x8_t cr1 = vqdmulhq_s16(crw, cr_const1); + int16x8_t cb1 = vqdmulhq_s16(cbw, cb_const1); + int16x8_t rws = vaddq_s16(yws, cr0); + int16x8_t gws = vaddq_s16(vaddq_s16(yws, cb0), cr1); + int16x8_t bws = vaddq_s16(yws, cb1); + + // undo scaling, round, convert to byte + uint8x8x4_t o; + o.val[0] = vqrshrun_n_s16(rws, 4); + o.val[1] = vqrshrun_n_s16(gws, 4); + o.val[2] = vqrshrun_n_s16(bws, 4); + o.val[3] = vdup_n_u8(255); + + // store, interleaving r/g/b/a + vst4_u8(out, o); + out += 8*4; + } + } +#endif + + for (; i < count; ++i) { + int y_fixed = (y[i] << 20) + (1<<19); // rounding + int r,g,b; + int cr = pcr[i] - 128; + int cb = pcb[i] - 128; + r = y_fixed + cr* float2fixed(1.40200f); + g = y_fixed + cr*-float2fixed(0.71414f) + ((cb*-float2fixed(0.34414f)) & 0xffff0000); + b = y_fixed + cb* float2fixed(1.77200f); + r >>= 20; + g >>= 20; + b >>= 20; + if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } + if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } + if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } + out[0] = (stbi_uc)r; + out[1] = (stbi_uc)g; + out[2] = (stbi_uc)b; + out[3] = 255; + out += step; + } +} +#endif + +// set up the kernels +static void stbi__setup_jpeg(stbi__jpeg *j) +{ + j->idct_block_kernel = stbi__idct_block; + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_row; + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2; + +#ifdef STBI_SSE2 + if (stbi__sse2_available()) { + j->idct_block_kernel = stbi__idct_simd; + #ifndef STBI_JPEG_OLD + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; + #endif + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; + } +#endif + +#ifdef STBI_NEON + j->idct_block_kernel = stbi__idct_simd; + #ifndef STBI_JPEG_OLD + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; + #endif + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; +#endif +} + +// clean up the temporary component buffers +static void stbi__cleanup_jpeg(stbi__jpeg *j) +{ + int i; + for (i=0; i < j->s->img_n; ++i) { + if (j->img_comp[i].raw_data) { + STBI_FREE(j->img_comp[i].raw_data); + j->img_comp[i].raw_data = NULL; + j->img_comp[i].data = NULL; + } + if (j->img_comp[i].raw_coeff) { + STBI_FREE(j->img_comp[i].raw_coeff); + j->img_comp[i].raw_coeff = 0; + j->img_comp[i].coeff = 0; + } + if (j->img_comp[i].linebuf) { + STBI_FREE(j->img_comp[i].linebuf); + j->img_comp[i].linebuf = NULL; + } + } +} + +typedef struct +{ + resample_row_func resample; + stbi_uc *line0,*line1; + int hs,vs; // expansion factor in each axis + int w_lores; // horizontal pixels pre-expansion + int ystep; // how far through vertical expansion we are + int ypos; // which pre-expansion row we're on +} stbi__resample; + +static stbi_uc *load_jpeg_image(stbi__jpeg *z, int *out_x, int *out_y, int *comp, int req_comp) +{ + int n, decode_n; + z->s->img_n = 0; // make stbi__cleanup_jpeg safe + + // validate req_comp + if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); + + // load a jpeg image from whichever source, but leave in YCbCr format + if (!stbi__decode_jpeg_image(z)) { stbi__cleanup_jpeg(z); return NULL; } + + // determine actual number of components to generate + n = req_comp ? req_comp : z->s->img_n; + + if (z->s->img_n == 3 && n < 3) + decode_n = 1; + else + decode_n = z->s->img_n; + + // resample and color-convert + { + int k; + unsigned int i,j; + stbi_uc *output; + stbi_uc *coutput[4]; + + stbi__resample res_comp[4]; + + for (k=0; k < decode_n; ++k) { + stbi__resample *r = &res_comp[k]; + + // allocate line buffer big enough for upsampling off the edges + // with upsample factor of 4 + z->img_comp[k].linebuf = (stbi_uc *) stbi__malloc(z->s->img_x + 3); + if (!z->img_comp[k].linebuf) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } + + r->hs = z->img_h_max / z->img_comp[k].h; + r->vs = z->img_v_max / z->img_comp[k].v; + r->ystep = r->vs >> 1; + r->w_lores = (z->s->img_x + r->hs-1) / r->hs; + r->ypos = 0; + r->line0 = r->line1 = z->img_comp[k].data; + + if (r->hs == 1 && r->vs == 1) r->resample = resample_row_1; + else if (r->hs == 1 && r->vs == 2) r->resample = stbi__resample_row_v_2; + else if (r->hs == 2 && r->vs == 1) r->resample = stbi__resample_row_h_2; + else if (r->hs == 2 && r->vs == 2) r->resample = z->resample_row_hv_2_kernel; + else r->resample = stbi__resample_row_generic; + } + + // can't error after this so, this is safe + output = (stbi_uc *) stbi__malloc(n * z->s->img_x * z->s->img_y + 1); + if (!output) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } + + // now go ahead and resample + for (j=0; j < z->s->img_y; ++j) { + stbi_uc *out = output + n * z->s->img_x * j; + for (k=0; k < decode_n; ++k) { + stbi__resample *r = &res_comp[k]; + int y_bot = r->ystep >= (r->vs >> 1); + coutput[k] = r->resample(z->img_comp[k].linebuf, + y_bot ? r->line1 : r->line0, + y_bot ? r->line0 : r->line1, + r->w_lores, r->hs); + if (++r->ystep >= r->vs) { + r->ystep = 0; + r->line0 = r->line1; + if (++r->ypos < z->img_comp[k].y) + r->line1 += z->img_comp[k].w2; + } + } + if (n >= 3) { + stbi_uc *y = coutput[0]; + if (z->s->img_n == 3) { + z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); + } else + for (i=0; i < z->s->img_x; ++i) { + out[0] = out[1] = out[2] = y[i]; + out[3] = 255; // not used if n==3 + out += n; + } + } else { + stbi_uc *y = coutput[0]; + if (n == 1) + for (i=0; i < z->s->img_x; ++i) out[i] = y[i]; + else + for (i=0; i < z->s->img_x; ++i) *out++ = y[i], *out++ = 255; + } + } + stbi__cleanup_jpeg(z); + *out_x = z->s->img_x; + *out_y = z->s->img_y; + if (comp) *comp = z->s->img_n; // report original components, not output + return output; + } +} + +static unsigned char *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi__jpeg j; + j.s = s; + stbi__setup_jpeg(&j); + return load_jpeg_image(&j, x,y,comp,req_comp); +} + +static int stbi__jpeg_test(stbi__context *s) +{ + int r; + stbi__jpeg j; + j.s = s; + stbi__setup_jpeg(&j); + r = stbi__decode_jpeg_header(&j, STBI__SCAN_type); + stbi__rewind(s); + return r; +} + +static int stbi__jpeg_info_raw(stbi__jpeg *j, int *x, int *y, int *comp) +{ + if (!stbi__decode_jpeg_header(j, STBI__SCAN_header)) { + stbi__rewind( j->s ); + return 0; + } + if (x) *x = j->s->img_x; + if (y) *y = j->s->img_y; + if (comp) *comp = j->s->img_n; + return 1; +} + +static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp) +{ + stbi__jpeg j; + j.s = s; + return stbi__jpeg_info_raw(&j, x, y, comp); +} +#endif + +// public domain zlib decode v0.2 Sean Barrett 2006-11-18 +// simple implementation +// - all input must be provided in an upfront buffer +// - all output is written to a single output buffer (can malloc/realloc) +// performance +// - fast huffman + +#ifndef STBI_NO_ZLIB + +// fast-way is faster to check than jpeg huffman, but slow way is slower +#define STBI__ZFAST_BITS 9 // accelerate all cases in default tables +#define STBI__ZFAST_MASK ((1 << STBI__ZFAST_BITS) - 1) + +// zlib-style huffman encoding +// (jpegs packs from left, zlib from right, so can't share code) +typedef struct +{ + stbi__uint16 fast[1 << STBI__ZFAST_BITS]; + stbi__uint16 firstcode[16]; + int maxcode[17]; + stbi__uint16 firstsymbol[16]; + stbi_uc size[288]; + stbi__uint16 value[288]; +} stbi__zhuffman; + +stbi_inline static int stbi__bitreverse16(int n) +{ + n = ((n & 0xAAAA) >> 1) | ((n & 0x5555) << 1); + n = ((n & 0xCCCC) >> 2) | ((n & 0x3333) << 2); + n = ((n & 0xF0F0) >> 4) | ((n & 0x0F0F) << 4); + n = ((n & 0xFF00) >> 8) | ((n & 0x00FF) << 8); + return n; +} + +stbi_inline static int stbi__bit_reverse(int v, int bits) +{ + STBI_ASSERT(bits <= 16); + // to bit reverse n bits, reverse 16 and shift + // e.g. 11 bits, bit reverse and shift away 5 + return stbi__bitreverse16(v) >> (16-bits); +} + +static int stbi__zbuild_huffman(stbi__zhuffman *z, stbi_uc *sizelist, int num) +{ + int i,k=0; + int code, next_code[16], sizes[17]; + + // DEFLATE spec for generating codes + memset(sizes, 0, sizeof(sizes)); + memset(z->fast, 0, sizeof(z->fast)); + for (i=0; i < num; ++i) + ++sizes[sizelist[i]]; + sizes[0] = 0; + for (i=1; i < 16; ++i) + if (sizes[i] > (1 << i)) + return stbi__err("bad sizes", "Corrupt PNG"); + code = 0; + for (i=1; i < 16; ++i) { + next_code[i] = code; + z->firstcode[i] = (stbi__uint16) code; + z->firstsymbol[i] = (stbi__uint16) k; + code = (code + sizes[i]); + if (sizes[i]) + if (code-1 >= (1 << i)) return stbi__err("bad codelengths","Corrupt PNG"); + z->maxcode[i] = code << (16-i); // preshift for inner loop + code <<= 1; + k += sizes[i]; + } + z->maxcode[16] = 0x10000; // sentinel + for (i=0; i < num; ++i) { + int s = sizelist[i]; + if (s) { + int c = next_code[s] - z->firstcode[s] + z->firstsymbol[s]; + stbi__uint16 fastv = (stbi__uint16) ((s << 9) | i); + z->size [c] = (stbi_uc ) s; + z->value[c] = (stbi__uint16) i; + if (s <= STBI__ZFAST_BITS) { + int j = stbi__bit_reverse(next_code[s],s); + while (j < (1 << STBI__ZFAST_BITS)) { + z->fast[j] = fastv; + j += (1 << s); + } + } + ++next_code[s]; + } + } + return 1; +} + +// zlib-from-memory implementation for PNG reading +// because PNG allows splitting the zlib stream arbitrarily, +// and it's annoying structurally to have PNG call ZLIB call PNG, +// we require PNG read all the IDATs and combine them into a single +// memory buffer + +typedef struct +{ + stbi_uc *zbuffer, *zbuffer_end; + int num_bits; + stbi__uint32 code_buffer; + + char *zout; + char *zout_start; + char *zout_end; + int z_expandable; + + stbi__zhuffman z_length, z_distance; +} stbi__zbuf; + +stbi_inline static stbi_uc stbi__zget8(stbi__zbuf *z) +{ + if (z->zbuffer >= z->zbuffer_end) return 0; + return *z->zbuffer++; +} + +static void stbi__fill_bits(stbi__zbuf *z) +{ + do { + STBI_ASSERT(z->code_buffer < (1U << z->num_bits)); + z->code_buffer |= (unsigned int) stbi__zget8(z) << z->num_bits; + z->num_bits += 8; + } while (z->num_bits <= 24); +} + +stbi_inline static unsigned int stbi__zreceive(stbi__zbuf *z, int n) +{ + unsigned int k; + if (z->num_bits < n) stbi__fill_bits(z); + k = z->code_buffer & ((1 << n) - 1); + z->code_buffer >>= n; + z->num_bits -= n; + return k; +} + +static int stbi__zhuffman_decode_slowpath(stbi__zbuf *a, stbi__zhuffman *z) +{ + int b,s,k; + // not resolved by fast table, so compute it the slow way + // use jpeg approach, which requires MSbits at top + k = stbi__bit_reverse(a->code_buffer, 16); + for (s=STBI__ZFAST_BITS+1; ; ++s) + if (k < z->maxcode[s]) + break; + if (s == 16) return -1; // invalid code! + // code size is s, so: + b = (k >> (16-s)) - z->firstcode[s] + z->firstsymbol[s]; + STBI_ASSERT(z->size[b] == s); + a->code_buffer >>= s; + a->num_bits -= s; + return z->value[b]; +} + +stbi_inline static int stbi__zhuffman_decode(stbi__zbuf *a, stbi__zhuffman *z) +{ + int b,s; + if (a->num_bits < 16) stbi__fill_bits(a); + b = z->fast[a->code_buffer & STBI__ZFAST_MASK]; + if (b) { + s = b >> 9; + a->code_buffer >>= s; + a->num_bits -= s; + return b & 511; + } + return stbi__zhuffman_decode_slowpath(a, z); +} + +static int stbi__zexpand(stbi__zbuf *z, char *zout, int n) // need to make room for n bytes +{ + char *q; + int cur, limit; + z->zout = zout; + if (!z->z_expandable) return stbi__err("output buffer limit","Corrupt PNG"); + cur = (int) (z->zout - z->zout_start); + limit = (int) (z->zout_end - z->zout_start); + while (cur + n > limit) + limit *= 2; + q = (char *) STBI_REALLOC(z->zout_start, limit); + if (q == NULL) return stbi__err("outofmem", "Out of memory"); + z->zout_start = q; + z->zout = q + cur; + z->zout_end = q + limit; + return 1; +} + +static int stbi__zlength_base[31] = { + 3,4,5,6,7,8,9,10,11,13, + 15,17,19,23,27,31,35,43,51,59, + 67,83,99,115,131,163,195,227,258,0,0 }; + +static int stbi__zlength_extra[31]= +{ 0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0,0,0 }; + +static int stbi__zdist_base[32] = { 1,2,3,4,5,7,9,13,17,25,33,49,65,97,129,193, +257,385,513,769,1025,1537,2049,3073,4097,6145,8193,12289,16385,24577,0,0}; + +static int stbi__zdist_extra[32] = +{ 0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13}; + +static int stbi__parse_huffman_block(stbi__zbuf *a) +{ + char *zout = a->zout; + for(;;) { + int z = stbi__zhuffman_decode(a, &a->z_length); + if (z < 256) { + if (z < 0) return stbi__err("bad huffman code","Corrupt PNG"); // error in huffman codes + if (zout >= a->zout_end) { + if (!stbi__zexpand(a, zout, 1)) return 0; + zout = a->zout; + } + *zout++ = (char) z; + } else { + stbi_uc *p; + int len,dist; + if (z == 256) { + a->zout = zout; + return 1; + } + z -= 257; + len = stbi__zlength_base[z]; + if (stbi__zlength_extra[z]) len += stbi__zreceive(a, stbi__zlength_extra[z]); + z = stbi__zhuffman_decode(a, &a->z_distance); + if (z < 0) return stbi__err("bad huffman code","Corrupt PNG"); + dist = stbi__zdist_base[z]; + if (stbi__zdist_extra[z]) dist += stbi__zreceive(a, stbi__zdist_extra[z]); + if (zout - a->zout_start < dist) return stbi__err("bad dist","Corrupt PNG"); + if (zout + len > a->zout_end) { + if (!stbi__zexpand(a, zout, len)) return 0; + zout = a->zout; + } + p = (stbi_uc *) (zout - dist); + if (dist == 1) { // run of one byte; common in images. + stbi_uc v = *p; + if (len) { do *zout++ = v; while (--len); } + } else { + if (len) { do *zout++ = *p++; while (--len); } + } + } + } +} + +static int stbi__compute_huffman_codes(stbi__zbuf *a) +{ + static stbi_uc length_dezigzag[19] = { 16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15 }; + stbi__zhuffman z_codelength; + stbi_uc lencodes[286+32+137];//padding for maximum single op + stbi_uc codelength_sizes[19]; + int i,n; + + int hlit = stbi__zreceive(a,5) + 257; + int hdist = stbi__zreceive(a,5) + 1; + int hclen = stbi__zreceive(a,4) + 4; + + memset(codelength_sizes, 0, sizeof(codelength_sizes)); + for (i=0; i < hclen; ++i) { + int s = stbi__zreceive(a,3); + codelength_sizes[length_dezigzag[i]] = (stbi_uc) s; + } + if (!stbi__zbuild_huffman(&z_codelength, codelength_sizes, 19)) return 0; + + n = 0; + while (n < hlit + hdist) { + int c = stbi__zhuffman_decode(a, &z_codelength); + if (c < 0 || c >= 19) return stbi__err("bad codelengths", "Corrupt PNG"); + if (c < 16) + lencodes[n++] = (stbi_uc) c; + else if (c == 16) { + c = stbi__zreceive(a,2)+3; + memset(lencodes+n, lencodes[n-1], c); + n += c; + } else if (c == 17) { + c = stbi__zreceive(a,3)+3; + memset(lencodes+n, 0, c); + n += c; + } else { + STBI_ASSERT(c == 18); + c = stbi__zreceive(a,7)+11; + memset(lencodes+n, 0, c); + n += c; + } + } + if (n != hlit+hdist) return stbi__err("bad codelengths","Corrupt PNG"); + if (!stbi__zbuild_huffman(&a->z_length, lencodes, hlit)) return 0; + if (!stbi__zbuild_huffman(&a->z_distance, lencodes+hlit, hdist)) return 0; + return 1; +} + +static int stbi__parse_uncomperssed_block(stbi__zbuf *a) +{ + stbi_uc header[4]; + int len,nlen,k; + if (a->num_bits & 7) + stbi__zreceive(a, a->num_bits & 7); // discard + // drain the bit-packed data into header + k = 0; + while (a->num_bits > 0) { + header[k++] = (stbi_uc) (a->code_buffer & 255); // suppress MSVC run-time check + a->code_buffer >>= 8; + a->num_bits -= 8; + } + STBI_ASSERT(a->num_bits == 0); + // now fill header the normal way + while (k < 4) + header[k++] = stbi__zget8(a); + len = header[1] * 256 + header[0]; + nlen = header[3] * 256 + header[2]; + if (nlen != (len ^ 0xffff)) return stbi__err("zlib corrupt","Corrupt PNG"); + if (a->zbuffer + len > a->zbuffer_end) return stbi__err("read past buffer","Corrupt PNG"); + if (a->zout + len > a->zout_end) + if (!stbi__zexpand(a, a->zout, len)) return 0; + memcpy(a->zout, a->zbuffer, len); + a->zbuffer += len; + a->zout += len; + return 1; +} + +static int stbi__parse_zlib_header(stbi__zbuf *a) +{ + int cmf = stbi__zget8(a); + int cm = cmf & 15; + /* int cinfo = cmf >> 4; */ + int flg = stbi__zget8(a); + if ((cmf*256+flg) % 31 != 0) return stbi__err("bad zlib header","Corrupt PNG"); // zlib spec + if (flg & 32) return stbi__err("no preset dict","Corrupt PNG"); // preset dictionary not allowed in png + if (cm != 8) return stbi__err("bad compression","Corrupt PNG"); // DEFLATE required for png + // window = 1 << (8 + cinfo)... but who cares, we fully buffer output + return 1; +} + +// @TODO: should statically initialize these for optimal thread safety +static stbi_uc stbi__zdefault_length[288], stbi__zdefault_distance[32]; +static void stbi__init_zdefaults(void) +{ + int i; // use <= to match clearly with spec + for (i=0; i <= 143; ++i) stbi__zdefault_length[i] = 8; + for ( ; i <= 255; ++i) stbi__zdefault_length[i] = 9; + for ( ; i <= 279; ++i) stbi__zdefault_length[i] = 7; + for ( ; i <= 287; ++i) stbi__zdefault_length[i] = 8; + + for (i=0; i <= 31; ++i) stbi__zdefault_distance[i] = 5; +} + +static int stbi__parse_zlib(stbi__zbuf *a, int parse_header) +{ + int final, type; + if (parse_header) + if (!stbi__parse_zlib_header(a)) return 0; + a->num_bits = 0; + a->code_buffer = 0; + do { + final = stbi__zreceive(a,1); + type = stbi__zreceive(a,2); + if (type == 0) { + if (!stbi__parse_uncomperssed_block(a)) return 0; + } else if (type == 3) { + return 0; + } else { + if (type == 1) { + // use fixed code lengths + if (!stbi__zdefault_distance[31]) stbi__init_zdefaults(); + if (!stbi__zbuild_huffman(&a->z_length , stbi__zdefault_length , 288)) return 0; + if (!stbi__zbuild_huffman(&a->z_distance, stbi__zdefault_distance, 32)) return 0; + } else { + if (!stbi__compute_huffman_codes(a)) return 0; + } + if (!stbi__parse_huffman_block(a)) return 0; + } + } while (!final); + return 1; +} + +static int stbi__do_zlib(stbi__zbuf *a, char *obuf, int olen, int exp, int parse_header) +{ + a->zout_start = obuf; + a->zout = obuf; + a->zout_end = obuf + olen; + a->z_expandable = exp; + + return stbi__parse_zlib(a, parse_header); +} + +STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(initial_size); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer + len; + if (stbi__do_zlib(&a, p, initial_size, 1, 1)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF char *stbi_zlib_decode_malloc(char const *buffer, int len, int *outlen) +{ + return stbi_zlib_decode_malloc_guesssize(buffer, len, 16384, outlen); +} + +STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(initial_size); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer + len; + if (stbi__do_zlib(&a, p, initial_size, 1, parse_header)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, char const *ibuffer, int ilen) +{ + stbi__zbuf a; + a.zbuffer = (stbi_uc *) ibuffer; + a.zbuffer_end = (stbi_uc *) ibuffer + ilen; + if (stbi__do_zlib(&a, obuffer, olen, 0, 1)) + return (int) (a.zout - a.zout_start); + else + return -1; +} + +STBIDEF char *stbi_zlib_decode_noheader_malloc(char const *buffer, int len, int *outlen) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(16384); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer+len; + if (stbi__do_zlib(&a, p, 16384, 1, 0)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen) +{ + stbi__zbuf a; + a.zbuffer = (stbi_uc *) ibuffer; + a.zbuffer_end = (stbi_uc *) ibuffer + ilen; + if (stbi__do_zlib(&a, obuffer, olen, 0, 0)) + return (int) (a.zout - a.zout_start); + else + return -1; +} +#endif + +// public domain "baseline" PNG decoder v0.10 Sean Barrett 2006-11-18 +// simple implementation +// - only 8-bit samples +// - no CRC checking +// - allocates lots of intermediate memory +// - avoids problem of streaming data between subsystems +// - avoids explicit window management +// performance +// - uses stb_zlib, a PD zlib implementation with fast huffman decoding + +#ifndef STBI_NO_PNG +typedef struct +{ + stbi__uint32 length; + stbi__uint32 type; +} stbi__pngchunk; + +static stbi__pngchunk stbi__get_chunk_header(stbi__context *s) +{ + stbi__pngchunk c; + c.length = stbi__get32be(s); + c.type = stbi__get32be(s); + return c; +} + +static int stbi__check_png_header(stbi__context *s) +{ + static stbi_uc png_sig[8] = { 137,80,78,71,13,10,26,10 }; + int i; + for (i=0; i < 8; ++i) + if (stbi__get8(s) != png_sig[i]) return stbi__err("bad png sig","Not a PNG"); + return 1; +} + +typedef struct +{ + stbi__context *s; + stbi_uc *idata, *expanded, *out; +} stbi__png; + + +enum { + STBI__F_none=0, + STBI__F_sub=1, + STBI__F_up=2, + STBI__F_avg=3, + STBI__F_paeth=4, + // synthetic filters used for first scanline to avoid needing a dummy row of 0s + STBI__F_avg_first, + STBI__F_paeth_first +}; + +static stbi_uc first_row_filter[5] = +{ + STBI__F_none, + STBI__F_sub, + STBI__F_none, + STBI__F_avg_first, + STBI__F_paeth_first +}; + +static int stbi__paeth(int a, int b, int c) +{ + int p = a + b - c; + int pa = abs(p-a); + int pb = abs(p-b); + int pc = abs(p-c); + if (pa <= pb && pa <= pc) return a; + if (pb <= pc) return b; + return c; +} + +static stbi_uc stbi__depth_scale_table[9] = { 0, 0xff, 0x55, 0, 0x11, 0,0,0, 0x01 }; + +// create the png data from post-deflated data +static int stbi__create_png_image_raw(stbi__png *a, stbi_uc *raw, stbi__uint32 raw_len, int out_n, stbi__uint32 x, stbi__uint32 y, int depth, int color) +{ + stbi__context *s = a->s; + stbi__uint32 i,j,stride = x*out_n; + stbi__uint32 img_len, img_width_bytes; + int k; + int img_n = s->img_n; // copy it into a local for later + + STBI_ASSERT(out_n == s->img_n || out_n == s->img_n+1); + a->out = (stbi_uc *) stbi__malloc(x * y * out_n); // extra bytes to write off the end into + if (!a->out) return stbi__err("outofmem", "Out of memory"); + + img_width_bytes = (((img_n * x * depth) + 7) >> 3); + img_len = (img_width_bytes + 1) * y; + if (s->img_x == x && s->img_y == y) { + if (raw_len != img_len) return stbi__err("not enough pixels","Corrupt PNG"); + } else { // interlaced: + if (raw_len < img_len) return stbi__err("not enough pixels","Corrupt PNG"); + } + + for (j=0; j < y; ++j) { + stbi_uc *cur = a->out + stride*j; + stbi_uc *prior = cur - stride; + int filter = *raw++; + int filter_bytes = img_n; + int width = x; + if (filter > 4) + return stbi__err("invalid filter","Corrupt PNG"); + + if (depth < 8) { + STBI_ASSERT(img_width_bytes <= x); + cur += x*out_n - img_width_bytes; // store output to the rightmost img_len bytes, so we can decode in place + filter_bytes = 1; + width = img_width_bytes; + } + + // if first row, use special filter that doesn't sample previous row + if (j == 0) filter = first_row_filter[filter]; + + // handle first byte explicitly + for (k=0; k < filter_bytes; ++k) { + switch (filter) { + case STBI__F_none : cur[k] = raw[k]; break; + case STBI__F_sub : cur[k] = raw[k]; break; + case STBI__F_up : cur[k] = STBI__BYTECAST(raw[k] + prior[k]); break; + case STBI__F_avg : cur[k] = STBI__BYTECAST(raw[k] + (prior[k]>>1)); break; + case STBI__F_paeth : cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(0,prior[k],0)); break; + case STBI__F_avg_first : cur[k] = raw[k]; break; + case STBI__F_paeth_first: cur[k] = raw[k]; break; + } + } + + if (depth == 8) { + if (img_n != out_n) + cur[img_n] = 255; // first pixel + raw += img_n; + cur += out_n; + prior += out_n; + } else { + raw += 1; + cur += 1; + prior += 1; + } + + // this is a little gross, so that we don't switch per-pixel or per-component + if (depth < 8 || img_n == out_n) { + int nk = (width - 1)*img_n; + #define CASE(f) \ + case f: \ + for (k=0; k < nk; ++k) + switch (filter) { + // "none" filter turns into a memcpy here; make that explicit. + case STBI__F_none: memcpy(cur, raw, nk); break; + CASE(STBI__F_sub) cur[k] = STBI__BYTECAST(raw[k] + cur[k-filter_bytes]); break; + CASE(STBI__F_up) cur[k] = STBI__BYTECAST(raw[k] + prior[k]); break; + CASE(STBI__F_avg) cur[k] = STBI__BYTECAST(raw[k] + ((prior[k] + cur[k-filter_bytes])>>1)); break; + CASE(STBI__F_paeth) cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-filter_bytes],prior[k],prior[k-filter_bytes])); break; + CASE(STBI__F_avg_first) cur[k] = STBI__BYTECAST(raw[k] + (cur[k-filter_bytes] >> 1)); break; + CASE(STBI__F_paeth_first) cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-filter_bytes],0,0)); break; + } + #undef CASE + raw += nk; + } else { + STBI_ASSERT(img_n+1 == out_n); + #define CASE(f) \ + case f: \ + for (i=x-1; i >= 1; --i, cur[img_n]=255,raw+=img_n,cur+=out_n,prior+=out_n) \ + for (k=0; k < img_n; ++k) + switch (filter) { + CASE(STBI__F_none) cur[k] = raw[k]; break; + CASE(STBI__F_sub) cur[k] = STBI__BYTECAST(raw[k] + cur[k-out_n]); break; + CASE(STBI__F_up) cur[k] = STBI__BYTECAST(raw[k] + prior[k]); break; + CASE(STBI__F_avg) cur[k] = STBI__BYTECAST(raw[k] + ((prior[k] + cur[k-out_n])>>1)); break; + CASE(STBI__F_paeth) cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-out_n],prior[k],prior[k-out_n])); break; + CASE(STBI__F_avg_first) cur[k] = STBI__BYTECAST(raw[k] + (cur[k-out_n] >> 1)); break; + CASE(STBI__F_paeth_first) cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-out_n],0,0)); break; + } + #undef CASE + } + } + + // we make a separate pass to expand bits to pixels; for performance, + // this could run two scanlines behind the above code, so it won't + // interfere with filtering but will still be in the cache. + if (depth < 8) { + for (j=0; j < y; ++j) { + stbi_uc *cur = a->out + stride*j; + stbi_uc *in = a->out + stride*j + x*out_n - img_width_bytes; + // unpack 1/2/4-bit into a 8-bit buffer. allows us to keep the common 8-bit path optimal at minimal cost for 1/2/4-bit + // png guarantee byte alignment, if width is not multiple of 8/4/2 we'll decode dummy trailing data that will be skipped in the later loop + stbi_uc scale = (color == 0) ? stbi__depth_scale_table[depth] : 1; // scale grayscale values to 0..255 range + + // note that the final byte might overshoot and write more data than desired. + // we can allocate enough data that this never writes out of memory, but it + // could also overwrite the next scanline. can it overwrite non-empty data + // on the next scanline? yes, consider 1-pixel-wide scanlines with 1-bit-per-pixel. + // so we need to explicitly clamp the final ones + + if (depth == 4) { + for (k=x*img_n; k >= 2; k-=2, ++in) { + *cur++ = scale * ((*in >> 4) ); + *cur++ = scale * ((*in ) & 0x0f); + } + if (k > 0) *cur++ = scale * ((*in >> 4) ); + } else if (depth == 2) { + for (k=x*img_n; k >= 4; k-=4, ++in) { + *cur++ = scale * ((*in >> 6) ); + *cur++ = scale * ((*in >> 4) & 0x03); + *cur++ = scale * ((*in >> 2) & 0x03); + *cur++ = scale * ((*in ) & 0x03); + } + if (k > 0) *cur++ = scale * ((*in >> 6) ); + if (k > 1) *cur++ = scale * ((*in >> 4) & 0x03); + if (k > 2) *cur++ = scale * ((*in >> 2) & 0x03); + } else if (depth == 1) { + for (k=x*img_n; k >= 8; k-=8, ++in) { + *cur++ = scale * ((*in >> 7) ); + *cur++ = scale * ((*in >> 6) & 0x01); + *cur++ = scale * ((*in >> 5) & 0x01); + *cur++ = scale * ((*in >> 4) & 0x01); + *cur++ = scale * ((*in >> 3) & 0x01); + *cur++ = scale * ((*in >> 2) & 0x01); + *cur++ = scale * ((*in >> 1) & 0x01); + *cur++ = scale * ((*in ) & 0x01); + } + if (k > 0) *cur++ = scale * ((*in >> 7) ); + if (k > 1) *cur++ = scale * ((*in >> 6) & 0x01); + if (k > 2) *cur++ = scale * ((*in >> 5) & 0x01); + if (k > 3) *cur++ = scale * ((*in >> 4) & 0x01); + if (k > 4) *cur++ = scale * ((*in >> 3) & 0x01); + if (k > 5) *cur++ = scale * ((*in >> 2) & 0x01); + if (k > 6) *cur++ = scale * ((*in >> 1) & 0x01); + } + if (img_n != out_n) { + int q; + // insert alpha = 255 + cur = a->out + stride*j; + if (img_n == 1) { + for (q=x-1; q >= 0; --q) { + cur[q*2+1] = 255; + cur[q*2+0] = cur[q]; + } + } else { + STBI_ASSERT(img_n == 3); + for (q=x-1; q >= 0; --q) { + cur[q*4+3] = 255; + cur[q*4+2] = cur[q*3+2]; + cur[q*4+1] = cur[q*3+1]; + cur[q*4+0] = cur[q*3+0]; + } + } + } + } + } + + return 1; +} + +static int stbi__create_png_image(stbi__png *a, stbi_uc *image_data, stbi__uint32 image_data_len, int out_n, int depth, int color, int interlaced) +{ + stbi_uc *final; + int p; + if (!interlaced) + return stbi__create_png_image_raw(a, image_data, image_data_len, out_n, a->s->img_x, a->s->img_y, depth, color); + + // de-interlacing + final = (stbi_uc *) stbi__malloc(a->s->img_x * a->s->img_y * out_n); + for (p=0; p < 7; ++p) { + int xorig[] = { 0,4,0,2,0,1,0 }; + int yorig[] = { 0,0,4,0,2,0,1 }; + int xspc[] = { 8,8,4,4,2,2,1 }; + int yspc[] = { 8,8,8,4,4,2,2 }; + int i,j,x,y; + // pass1_x[4] = 0, pass1_x[5] = 1, pass1_x[12] = 1 + x = (a->s->img_x - xorig[p] + xspc[p]-1) / xspc[p]; + y = (a->s->img_y - yorig[p] + yspc[p]-1) / yspc[p]; + if (x && y) { + stbi__uint32 img_len = ((((a->s->img_n * x * depth) + 7) >> 3) + 1) * y; + if (!stbi__create_png_image_raw(a, image_data, image_data_len, out_n, x, y, depth, color)) { + STBI_FREE(final); + return 0; + } + for (j=0; j < y; ++j) { + for (i=0; i < x; ++i) { + int out_y = j*yspc[p]+yorig[p]; + int out_x = i*xspc[p]+xorig[p]; + memcpy(final + out_y*a->s->img_x*out_n + out_x*out_n, + a->out + (j*x+i)*out_n, out_n); + } + } + STBI_FREE(a->out); + image_data += img_len; + image_data_len -= img_len; + } + } + a->out = final; + + return 1; +} + +static int stbi__compute_transparency(stbi__png *z, stbi_uc tc[3], int out_n) +{ + stbi__context *s = z->s; + stbi__uint32 i, pixel_count = s->img_x * s->img_y; + stbi_uc *p = z->out; + + // compute color-based transparency, assuming we've + // already got 255 as the alpha value in the output + STBI_ASSERT(out_n == 2 || out_n == 4); + + if (out_n == 2) { + for (i=0; i < pixel_count; ++i) { + p[1] = (p[0] == tc[0] ? 0 : 255); + p += 2; + } + } else { + for (i=0; i < pixel_count; ++i) { + if (p[0] == tc[0] && p[1] == tc[1] && p[2] == tc[2]) + p[3] = 0; + p += 4; + } + } + return 1; +} + +static int stbi__expand_png_palette(stbi__png *a, stbi_uc *palette, int len, int pal_img_n) +{ + stbi__uint32 i, pixel_count = a->s->img_x * a->s->img_y; + stbi_uc *p, *temp_out, *orig = a->out; + + p = (stbi_uc *) stbi__malloc(pixel_count * pal_img_n); + if (p == NULL) return stbi__err("outofmem", "Out of memory"); + + // between here and free(out) below, exiting would leak + temp_out = p; + + if (pal_img_n == 3) { + for (i=0; i < pixel_count; ++i) { + int n = orig[i]*4; + p[0] = palette[n ]; + p[1] = palette[n+1]; + p[2] = palette[n+2]; + p += 3; + } + } else { + for (i=0; i < pixel_count; ++i) { + int n = orig[i]*4; + p[0] = palette[n ]; + p[1] = palette[n+1]; + p[2] = palette[n+2]; + p[3] = palette[n+3]; + p += 4; + } + } + STBI_FREE(a->out); + a->out = temp_out; + + STBI_NOTUSED(len); + + return 1; +} + +static int stbi__unpremultiply_on_load = 0; +static int stbi__de_iphone_flag = 0; + +STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply) +{ + stbi__unpremultiply_on_load = flag_true_if_should_unpremultiply; +} + +STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert) +{ + stbi__de_iphone_flag = flag_true_if_should_convert; +} + +static void stbi__de_iphone(stbi__png *z) +{ + stbi__context *s = z->s; + stbi__uint32 i, pixel_count = s->img_x * s->img_y; + stbi_uc *p = z->out; + + if (s->img_out_n == 3) { // convert bgr to rgb + for (i=0; i < pixel_count; ++i) { + stbi_uc t = p[0]; + p[0] = p[2]; + p[2] = t; + p += 3; + } + } else { + STBI_ASSERT(s->img_out_n == 4); + if (stbi__unpremultiply_on_load) { + // convert bgr to rgb and unpremultiply + for (i=0; i < pixel_count; ++i) { + stbi_uc a = p[3]; + stbi_uc t = p[0]; + if (a) { + p[0] = p[2] * 255 / a; + p[1] = p[1] * 255 / a; + p[2] = t * 255 / a; + } else { + p[0] = p[2]; + p[2] = t; + } + p += 4; + } + } else { + // convert bgr to rgb + for (i=0; i < pixel_count; ++i) { + stbi_uc t = p[0]; + p[0] = p[2]; + p[2] = t; + p += 4; + } + } + } +} + +#define STBI__PNG_TYPE(a,b,c,d) (((a) << 24) + ((b) << 16) + ((c) << 8) + (d)) + +static int stbi__parse_png_file(stbi__png *z, int scan, int req_comp) +{ + stbi_uc palette[1024], pal_img_n=0; + stbi_uc has_trans=0, tc[3]; + stbi__uint32 ioff=0, idata_limit=0, i, pal_len=0; + int first=1,k,interlace=0, color=0, depth=0, is_iphone=0; + stbi__context *s = z->s; + + z->expanded = NULL; + z->idata = NULL; + z->out = NULL; + + if (!stbi__check_png_header(s)) return 0; + + if (scan == STBI__SCAN_type) return 1; + + for (;;) { + stbi__pngchunk c = stbi__get_chunk_header(s); + switch (c.type) { + case STBI__PNG_TYPE('C','g','B','I'): + is_iphone = 1; + stbi__skip(s, c.length); + break; + case STBI__PNG_TYPE('I','H','D','R'): { + int comp,filter; + if (!first) return stbi__err("multiple IHDR","Corrupt PNG"); + first = 0; + if (c.length != 13) return stbi__err("bad IHDR len","Corrupt PNG"); + s->img_x = stbi__get32be(s); if (s->img_x > (1 << 24)) return stbi__err("too large","Very large image (corrupt?)"); + s->img_y = stbi__get32be(s); if (s->img_y > (1 << 24)) return stbi__err("too large","Very large image (corrupt?)"); + depth = stbi__get8(s); if (depth != 1 && depth != 2 && depth != 4 && depth != 8) return stbi__err("1/2/4/8-bit only","PNG not supported: 1/2/4/8-bit only"); + color = stbi__get8(s); if (color > 6) return stbi__err("bad ctype","Corrupt PNG"); + if (color == 3) pal_img_n = 3; else if (color & 1) return stbi__err("bad ctype","Corrupt PNG"); + comp = stbi__get8(s); if (comp) return stbi__err("bad comp method","Corrupt PNG"); + filter= stbi__get8(s); if (filter) return stbi__err("bad filter method","Corrupt PNG"); + interlace = stbi__get8(s); if (interlace>1) return stbi__err("bad interlace method","Corrupt PNG"); + if (!s->img_x || !s->img_y) return stbi__err("0-pixel image","Corrupt PNG"); + if (!pal_img_n) { + s->img_n = (color & 2 ? 3 : 1) + (color & 4 ? 1 : 0); + if ((1 << 30) / s->img_x / s->img_n < s->img_y) return stbi__err("too large", "Image too large to decode"); + if (scan == STBI__SCAN_header) return 1; + } else { + // if paletted, then pal_n is our final components, and + // img_n is # components to decompress/filter. + s->img_n = 1; + if ((1 << 30) / s->img_x / 4 < s->img_y) return stbi__err("too large","Corrupt PNG"); + // if SCAN_header, have to scan to see if we have a tRNS + } + break; + } + + case STBI__PNG_TYPE('P','L','T','E'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (c.length > 256*3) return stbi__err("invalid PLTE","Corrupt PNG"); + pal_len = c.length / 3; + if (pal_len * 3 != c.length) return stbi__err("invalid PLTE","Corrupt PNG"); + for (i=0; i < pal_len; ++i) { + palette[i*4+0] = stbi__get8(s); + palette[i*4+1] = stbi__get8(s); + palette[i*4+2] = stbi__get8(s); + palette[i*4+3] = 255; + } + break; + } + + case STBI__PNG_TYPE('t','R','N','S'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (z->idata) return stbi__err("tRNS after IDAT","Corrupt PNG"); + if (pal_img_n) { + if (scan == STBI__SCAN_header) { s->img_n = 4; return 1; } + if (pal_len == 0) return stbi__err("tRNS before PLTE","Corrupt PNG"); + if (c.length > pal_len) return stbi__err("bad tRNS len","Corrupt PNG"); + pal_img_n = 4; + for (i=0; i < c.length; ++i) + palette[i*4+3] = stbi__get8(s); + } else { + if (!(s->img_n & 1)) return stbi__err("tRNS with alpha","Corrupt PNG"); + if (c.length != (stbi__uint32) s->img_n*2) return stbi__err("bad tRNS len","Corrupt PNG"); + has_trans = 1; + for (k=0; k < s->img_n; ++k) + tc[k] = (stbi_uc) (stbi__get16be(s) & 255) * stbi__depth_scale_table[depth]; // non 8-bit images will be larger + } + break; + } + + case STBI__PNG_TYPE('I','D','A','T'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (pal_img_n && !pal_len) return stbi__err("no PLTE","Corrupt PNG"); + if (scan == STBI__SCAN_header) { s->img_n = pal_img_n; return 1; } + if ((int)(ioff + c.length) < (int)ioff) return 0; + if (ioff + c.length > idata_limit) { + stbi_uc *p; + if (idata_limit == 0) idata_limit = c.length > 4096 ? c.length : 4096; + while (ioff + c.length > idata_limit) + idata_limit *= 2; + p = (stbi_uc *) STBI_REALLOC(z->idata, idata_limit); if (p == NULL) return stbi__err("outofmem", "Out of memory"); + z->idata = p; + } + if (!stbi__getn(s, z->idata+ioff,c.length)) return stbi__err("outofdata","Corrupt PNG"); + ioff += c.length; + break; + } + + case STBI__PNG_TYPE('I','E','N','D'): { + stbi__uint32 raw_len, bpl; + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (scan != STBI__SCAN_load) return 1; + if (z->idata == NULL) return stbi__err("no IDAT","Corrupt PNG"); + // initial guess for decoded data size to avoid unnecessary reallocs + bpl = (s->img_x * depth + 7) / 8; // bytes per line, per component + raw_len = bpl * s->img_y * s->img_n /* pixels */ + s->img_y /* filter mode per row */; + z->expanded = (stbi_uc *) stbi_zlib_decode_malloc_guesssize_headerflag((char *) z->idata, ioff, raw_len, (int *) &raw_len, !is_iphone); + if (z->expanded == NULL) return 0; // zlib should set error + STBI_FREE(z->idata); z->idata = NULL; + if ((req_comp == s->img_n+1 && req_comp != 3 && !pal_img_n) || has_trans) + s->img_out_n = s->img_n+1; + else + s->img_out_n = s->img_n; + if (!stbi__create_png_image(z, z->expanded, raw_len, s->img_out_n, depth, color, interlace)) return 0; + if (has_trans) + if (!stbi__compute_transparency(z, tc, s->img_out_n)) return 0; + if (is_iphone && stbi__de_iphone_flag && s->img_out_n > 2) + stbi__de_iphone(z); + if (pal_img_n) { + // pal_img_n == 3 or 4 + s->img_n = pal_img_n; // record the actual colors we had + s->img_out_n = pal_img_n; + if (req_comp >= 3) s->img_out_n = req_comp; + if (!stbi__expand_png_palette(z, palette, pal_len, s->img_out_n)) + return 0; + } + STBI_FREE(z->expanded); z->expanded = NULL; + return 1; + } + + default: + // if critical, fail + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if ((c.type & (1 << 29)) == 0) { + #ifndef STBI_NO_FAILURE_STRINGS + // not threadsafe + static char invalid_chunk[] = "XXXX PNG chunk not known"; + invalid_chunk[0] = STBI__BYTECAST(c.type >> 24); + invalid_chunk[1] = STBI__BYTECAST(c.type >> 16); + invalid_chunk[2] = STBI__BYTECAST(c.type >> 8); + invalid_chunk[3] = STBI__BYTECAST(c.type >> 0); + #endif + return stbi__err(invalid_chunk, "PNG not supported: unknown PNG chunk type"); + } + stbi__skip(s, c.length); + break; + } + // end of PNG chunk, read and skip CRC + stbi__get32be(s); + } +} + +static unsigned char *stbi__do_png(stbi__png *p, int *x, int *y, int *n, int req_comp) +{ + unsigned char *result=NULL; + if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); + if (stbi__parse_png_file(p, STBI__SCAN_load, req_comp)) { + result = p->out; + p->out = NULL; + if (req_comp && req_comp != p->s->img_out_n) { + result = stbi__convert_format(result, p->s->img_out_n, req_comp, p->s->img_x, p->s->img_y); + p->s->img_out_n = req_comp; + if (result == NULL) return result; + } + *x = p->s->img_x; + *y = p->s->img_y; + if (n) *n = p->s->img_out_n; + } + STBI_FREE(p->out); p->out = NULL; + STBI_FREE(p->expanded); p->expanded = NULL; + STBI_FREE(p->idata); p->idata = NULL; + + return result; +} + +static unsigned char *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi__png p; + p.s = s; + return stbi__do_png(&p, x,y,comp,req_comp); +} + +static int stbi__png_test(stbi__context *s) +{ + int r; + r = stbi__check_png_header(s); + stbi__rewind(s); + return r; +} + +static int stbi__png_info_raw(stbi__png *p, int *x, int *y, int *comp) +{ + if (!stbi__parse_png_file(p, STBI__SCAN_header, 0)) { + stbi__rewind( p->s ); + return 0; + } + if (x) *x = p->s->img_x; + if (y) *y = p->s->img_y; + if (comp) *comp = p->s->img_n; + return 1; +} + +static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp) +{ + stbi__png p; + p.s = s; + return stbi__png_info_raw(&p, x, y, comp); +} +#endif + +// Microsoft/Windows BMP image + +#ifndef STBI_NO_BMP +static int stbi__bmp_test_raw(stbi__context *s) +{ + int r; + int sz; + if (stbi__get8(s) != 'B') return 0; + if (stbi__get8(s) != 'M') return 0; + stbi__get32le(s); // discard filesize + stbi__get16le(s); // discard reserved + stbi__get16le(s); // discard reserved + stbi__get32le(s); // discard data offset + sz = stbi__get32le(s); + r = (sz == 12 || sz == 40 || sz == 56 || sz == 108 || sz == 124); + return r; +} + +static int stbi__bmp_test(stbi__context *s) +{ + int r = stbi__bmp_test_raw(s); + stbi__rewind(s); + return r; +} + + +// returns 0..31 for the highest set bit +static int stbi__high_bit(unsigned int z) +{ + int n=0; + if (z == 0) return -1; + if (z >= 0x10000) n += 16, z >>= 16; + if (z >= 0x00100) n += 8, z >>= 8; + if (z >= 0x00010) n += 4, z >>= 4; + if (z >= 0x00004) n += 2, z >>= 2; + if (z >= 0x00002) n += 1, z >>= 1; + return n; +} + +static int stbi__bitcount(unsigned int a) +{ + a = (a & 0x55555555) + ((a >> 1) & 0x55555555); // max 2 + a = (a & 0x33333333) + ((a >> 2) & 0x33333333); // max 4 + a = (a + (a >> 4)) & 0x0f0f0f0f; // max 8 per 4, now 8 bits + a = (a + (a >> 8)); // max 16 per 8 bits + a = (a + (a >> 16)); // max 32 per 8 bits + return a & 0xff; +} + +static int stbi__shiftsigned(int v, int shift, int bits) +{ + int result; + int z=0; + + if (shift < 0) v <<= -shift; + else v >>= shift; + result = v; + + z = bits; + while (z < 8) { + result += v >> z; + z += bits; + } + return result; +} + +static stbi_uc *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi_uc *out; + unsigned int mr=0,mg=0,mb=0,ma=0, all_a=255; + stbi_uc pal[256][4]; + int psize=0,i,j,compress=0,width; + int bpp, flip_vertically, pad, target, offset, hsz; + if (stbi__get8(s) != 'B' || stbi__get8(s) != 'M') return stbi__errpuc("not BMP", "Corrupt BMP"); + stbi__get32le(s); // discard filesize + stbi__get16le(s); // discard reserved + stbi__get16le(s); // discard reserved + offset = stbi__get32le(s); + hsz = stbi__get32le(s); + if (hsz != 12 && hsz != 40 && hsz != 56 && hsz != 108 && hsz != 124) return stbi__errpuc("unknown BMP", "BMP type not supported: unknown"); + if (hsz == 12) { + s->img_x = stbi__get16le(s); + s->img_y = stbi__get16le(s); + } else { + s->img_x = stbi__get32le(s); + s->img_y = stbi__get32le(s); + } + if (stbi__get16le(s) != 1) return stbi__errpuc("bad BMP", "bad BMP"); + bpp = stbi__get16le(s); + if (bpp == 1) return stbi__errpuc("monochrome", "BMP type not supported: 1-bit"); + flip_vertically = ((int) s->img_y) > 0; + s->img_y = abs((int) s->img_y); + if (hsz == 12) { + if (bpp < 24) + psize = (offset - 14 - 24) / 3; + } else { + compress = stbi__get32le(s); + if (compress == 1 || compress == 2) return stbi__errpuc("BMP RLE", "BMP type not supported: RLE"); + stbi__get32le(s); // discard sizeof + stbi__get32le(s); // discard hres + stbi__get32le(s); // discard vres + stbi__get32le(s); // discard colorsused + stbi__get32le(s); // discard max important + if (hsz == 40 || hsz == 56) { + if (hsz == 56) { + stbi__get32le(s); + stbi__get32le(s); + stbi__get32le(s); + stbi__get32le(s); + } + if (bpp == 16 || bpp == 32) { + mr = mg = mb = 0; + if (compress == 0) { + if (bpp == 32) { + mr = 0xffu << 16; + mg = 0xffu << 8; + mb = 0xffu << 0; + ma = 0xffu << 24; + all_a = 0; // if all_a is 0 at end, then we loaded alpha channel but it was all 0 + } else { + mr = 31u << 10; + mg = 31u << 5; + mb = 31u << 0; + } + } else if (compress == 3) { + mr = stbi__get32le(s); + mg = stbi__get32le(s); + mb = stbi__get32le(s); + // not documented, but generated by photoshop and handled by mspaint + if (mr == mg && mg == mb) { + // ?!?!? + return stbi__errpuc("bad BMP", "bad BMP"); + } + } else + return stbi__errpuc("bad BMP", "bad BMP"); + } + } else { + STBI_ASSERT(hsz == 108 || hsz == 124); + mr = stbi__get32le(s); + mg = stbi__get32le(s); + mb = stbi__get32le(s); + ma = stbi__get32le(s); + stbi__get32le(s); // discard color space + for (i=0; i < 12; ++i) + stbi__get32le(s); // discard color space parameters + if (hsz == 124) { + stbi__get32le(s); // discard rendering intent + stbi__get32le(s); // discard offset of profile data + stbi__get32le(s); // discard size of profile data + stbi__get32le(s); // discard reserved + } + } + if (bpp < 16) + psize = (offset - 14 - hsz) >> 2; + } + s->img_n = ma ? 4 : 3; + if (req_comp && req_comp >= 3) // we can directly decode 3 or 4 + target = req_comp; + else + target = s->img_n; // if they want monochrome, we'll post-convert + out = (stbi_uc *) stbi__malloc(target * s->img_x * s->img_y); + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + if (bpp < 16) { + int z=0; + if (psize == 0 || psize > 256) { STBI_FREE(out); return stbi__errpuc("invalid", "Corrupt BMP"); } + for (i=0; i < psize; ++i) { + pal[i][2] = stbi__get8(s); + pal[i][1] = stbi__get8(s); + pal[i][0] = stbi__get8(s); + if (hsz != 12) stbi__get8(s); + pal[i][3] = 255; + } + stbi__skip(s, offset - 14 - hsz - psize * (hsz == 12 ? 3 : 4)); + if (bpp == 4) width = (s->img_x + 1) >> 1; + else if (bpp == 8) width = s->img_x; + else { STBI_FREE(out); return stbi__errpuc("bad bpp", "Corrupt BMP"); } + pad = (-width)&3; + for (j=0; j < (int) s->img_y; ++j) { + for (i=0; i < (int) s->img_x; i += 2) { + int v=stbi__get8(s),v2=0; + if (bpp == 4) { + v2 = v & 15; + v >>= 4; + } + out[z++] = pal[v][0]; + out[z++] = pal[v][1]; + out[z++] = pal[v][2]; + if (target == 4) out[z++] = 255; + if (i+1 == (int) s->img_x) break; + v = (bpp == 8) ? stbi__get8(s) : v2; + out[z++] = pal[v][0]; + out[z++] = pal[v][1]; + out[z++] = pal[v][2]; + if (target == 4) out[z++] = 255; + } + stbi__skip(s, pad); + } + } else { + int rshift=0,gshift=0,bshift=0,ashift=0,rcount=0,gcount=0,bcount=0,acount=0; + int z = 0; + int easy=0; + stbi__skip(s, offset - 14 - hsz); + if (bpp == 24) width = 3 * s->img_x; + else if (bpp == 16) width = 2*s->img_x; + else /* bpp = 32 and pad = 0 */ width=0; + pad = (-width) & 3; + if (bpp == 24) { + easy = 1; + } else if (bpp == 32) { + if (mb == 0xff && mg == 0xff00 && mr == 0x00ff0000 && ma == 0xff000000) + easy = 2; + } + if (!easy) { + if (!mr || !mg || !mb) { STBI_FREE(out); return stbi__errpuc("bad masks", "Corrupt BMP"); } + // right shift amt to put high bit in position #7 + rshift = stbi__high_bit(mr)-7; rcount = stbi__bitcount(mr); + gshift = stbi__high_bit(mg)-7; gcount = stbi__bitcount(mg); + bshift = stbi__high_bit(mb)-7; bcount = stbi__bitcount(mb); + ashift = stbi__high_bit(ma)-7; acount = stbi__bitcount(ma); + } + for (j=0; j < (int) s->img_y; ++j) { + if (easy) { + for (i=0; i < (int) s->img_x; ++i) { + unsigned char a; + out[z+2] = stbi__get8(s); + out[z+1] = stbi__get8(s); + out[z+0] = stbi__get8(s); + z += 3; + a = (easy == 2 ? stbi__get8(s) : 255); + all_a |= a; + if (target == 4) out[z++] = a; + } + } else { + for (i=0; i < (int) s->img_x; ++i) { + stbi__uint32 v = (bpp == 16 ? (stbi__uint32) stbi__get16le(s) : stbi__get32le(s)); + int a; + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mr, rshift, rcount)); + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mg, gshift, gcount)); + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mb, bshift, bcount)); + a = (ma ? stbi__shiftsigned(v & ma, ashift, acount) : 255); + all_a |= a; + if (target == 4) out[z++] = STBI__BYTECAST(a); + } + } + stbi__skip(s, pad); + } + } + + // if alpha channel is all 0s, replace with all 255s + if (target == 4 && all_a == 0) + for (i=4*s->img_x*s->img_y-1; i >= 0; i -= 4) + out[i] = 255; + + if (flip_vertically) { + stbi_uc t; + for (j=0; j < (int) s->img_y>>1; ++j) { + stbi_uc *p1 = out + j *s->img_x*target; + stbi_uc *p2 = out + (s->img_y-1-j)*s->img_x*target; + for (i=0; i < (int) s->img_x*target; ++i) { + t = p1[i], p1[i] = p2[i], p2[i] = t; + } + } + } + + if (req_comp && req_comp != target) { + out = stbi__convert_format(out, target, req_comp, s->img_x, s->img_y); + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + + *x = s->img_x; + *y = s->img_y; + if (comp) *comp = s->img_n; + return out; +} +#endif + +// Targa Truevision - TGA +// by Jonathan Dummer +#ifndef STBI_NO_TGA +static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp) +{ + int tga_w, tga_h, tga_comp; + int sz; + stbi__get8(s); // discard Offset + sz = stbi__get8(s); // color type + if( sz > 1 ) { + stbi__rewind(s); + return 0; // only RGB or indexed allowed + } + sz = stbi__get8(s); // image type + // only RGB or grey allowed, +/- RLE + if ((sz != 1) && (sz != 2) && (sz != 3) && (sz != 9) && (sz != 10) && (sz != 11)) return 0; + stbi__skip(s,9); + tga_w = stbi__get16le(s); + if( tga_w < 1 ) { + stbi__rewind(s); + return 0; // test width + } + tga_h = stbi__get16le(s); + if( tga_h < 1 ) { + stbi__rewind(s); + return 0; // test height + } + sz = stbi__get8(s); // bits per pixel + // only RGB or RGBA or grey allowed + if ((sz != 8) && (sz != 16) && (sz != 24) && (sz != 32)) { + stbi__rewind(s); + return 0; + } + tga_comp = sz; + if (x) *x = tga_w; + if (y) *y = tga_h; + if (comp) *comp = tga_comp / 8; + return 1; // seems to have passed everything +} + +static int stbi__tga_test(stbi__context *s) +{ + int res; + int sz; + stbi__get8(s); // discard Offset + sz = stbi__get8(s); // color type + if ( sz > 1 ) return 0; // only RGB or indexed allowed + sz = stbi__get8(s); // image type + if ( (sz != 1) && (sz != 2) && (sz != 3) && (sz != 9) && (sz != 10) && (sz != 11) ) return 0; // only RGB or grey allowed, +/- RLE + stbi__get16be(s); // discard palette start + stbi__get16be(s); // discard palette length + stbi__get8(s); // discard bits per palette color entry + stbi__get16be(s); // discard x origin + stbi__get16be(s); // discard y origin + if ( stbi__get16be(s) < 1 ) return 0; // test width + if ( stbi__get16be(s) < 1 ) return 0; // test height + sz = stbi__get8(s); // bits per pixel + if ( (sz != 8) && (sz != 16) && (sz != 24) && (sz != 32) ) + res = 0; + else + res = 1; + stbi__rewind(s); + return res; +} + +static stbi_uc *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + // read in the TGA header stuff + int tga_offset = stbi__get8(s); + int tga_indexed = stbi__get8(s); + int tga_image_type = stbi__get8(s); + int tga_is_RLE = 0; + int tga_palette_start = stbi__get16le(s); + int tga_palette_len = stbi__get16le(s); + int tga_palette_bits = stbi__get8(s); + int tga_x_origin = stbi__get16le(s); + int tga_y_origin = stbi__get16le(s); + int tga_width = stbi__get16le(s); + int tga_height = stbi__get16le(s); + int tga_bits_per_pixel = stbi__get8(s); + int tga_comp = tga_bits_per_pixel / 8; + int tga_inverted = stbi__get8(s); + // image data + unsigned char *tga_data; + unsigned char *tga_palette = NULL; + int i, j; + unsigned char raw_data[4]; + int RLE_count = 0; + int RLE_repeating = 0; + int read_next_pixel = 1; + + // do a tiny bit of processing + if ( tga_image_type >= 8 ) + { + tga_image_type -= 8; + tga_is_RLE = 1; + } + /* int tga_alpha_bits = tga_inverted & 15; */ + tga_inverted = 1 - ((tga_inverted >> 5) & 1); + + // error check + if ( //(tga_indexed) || + (tga_width < 1) || (tga_height < 1) || + (tga_image_type < 1) || (tga_image_type > 3) || + ((tga_bits_per_pixel != 8) && (tga_bits_per_pixel != 16) && + (tga_bits_per_pixel != 24) && (tga_bits_per_pixel != 32)) + ) + { + return NULL; // we don't report this as a bad TGA because we don't even know if it's TGA + } + + // If I'm paletted, then I'll use the number of bits from the palette + if ( tga_indexed ) + { + tga_comp = tga_palette_bits / 8; + } + + // tga info + *x = tga_width; + *y = tga_height; + if (comp) *comp = tga_comp; + + tga_data = (unsigned char*)stbi__malloc( (size_t)tga_width * tga_height * tga_comp ); + if (!tga_data) return stbi__errpuc("outofmem", "Out of memory"); + + // skip to the data's starting position (offset usually = 0) + stbi__skip(s, tga_offset ); + + if ( !tga_indexed && !tga_is_RLE) { + for (i=0; i < tga_height; ++i) { + int row = tga_inverted ? tga_height -i - 1 : i; + stbi_uc *tga_row = tga_data + row*tga_width*tga_comp; + stbi__getn(s, tga_row, tga_width * tga_comp); + } + } else { + // do I need to load a palette? + if ( tga_indexed) + { + // any data to skip? (offset usually = 0) + stbi__skip(s, tga_palette_start ); + // load the palette + tga_palette = (unsigned char*)stbi__malloc( tga_palette_len * tga_palette_bits / 8 ); + if (!tga_palette) { + STBI_FREE(tga_data); + return stbi__errpuc("outofmem", "Out of memory"); + } + if (!stbi__getn(s, tga_palette, tga_palette_len * tga_palette_bits / 8 )) { + STBI_FREE(tga_data); + STBI_FREE(tga_palette); + return stbi__errpuc("bad palette", "Corrupt TGA"); + } + } + // load the data + for (i=0; i < tga_width * tga_height; ++i) + { + // if I'm in RLE mode, do I need to get a RLE stbi__pngchunk? + if ( tga_is_RLE ) + { + if ( RLE_count == 0 ) + { + // yep, get the next byte as a RLE command + int RLE_cmd = stbi__get8(s); + RLE_count = 1 + (RLE_cmd & 127); + RLE_repeating = RLE_cmd >> 7; + read_next_pixel = 1; + } else if ( !RLE_repeating ) + { + read_next_pixel = 1; + } + } else + { + read_next_pixel = 1; + } + // OK, if I need to read a pixel, do it now + if ( read_next_pixel ) + { + // load however much data we did have + if ( tga_indexed ) + { + // read in 1 byte, then perform the lookup + int pal_idx = stbi__get8(s); + if ( pal_idx >= tga_palette_len ) + { + // invalid index + pal_idx = 0; + } + pal_idx *= tga_bits_per_pixel / 8; + for (j = 0; j*8 < tga_bits_per_pixel; ++j) + { + raw_data[j] = tga_palette[pal_idx+j]; + } + } else + { + // read in the data raw + for (j = 0; j*8 < tga_bits_per_pixel; ++j) + { + raw_data[j] = stbi__get8(s); + } + } + // clear the reading flag for the next pixel + read_next_pixel = 0; + } // end of reading a pixel + + // copy data + for (j = 0; j < tga_comp; ++j) + tga_data[i*tga_comp+j] = raw_data[j]; + + // in case we're in RLE mode, keep counting down + --RLE_count; + } + // do I need to invert the image? + if ( tga_inverted ) + { + for (j = 0; j*2 < tga_height; ++j) + { + int index1 = j * tga_width * tga_comp; + int index2 = (tga_height - 1 - j) * tga_width * tga_comp; + for (i = tga_width * tga_comp; i > 0; --i) + { + unsigned char temp = tga_data[index1]; + tga_data[index1] = tga_data[index2]; + tga_data[index2] = temp; + ++index1; + ++index2; + } + } + } + // clear my palette, if I had one + if ( tga_palette != NULL ) + { + STBI_FREE( tga_palette ); + } + } + + // swap RGB + if (tga_comp >= 3) + { + unsigned char* tga_pixel = tga_data; + for (i=0; i < tga_width * tga_height; ++i) + { + unsigned char temp = tga_pixel[0]; + tga_pixel[0] = tga_pixel[2]; + tga_pixel[2] = temp; + tga_pixel += tga_comp; + } + } + + // convert to target component count + if (req_comp && req_comp != tga_comp) + tga_data = stbi__convert_format(tga_data, tga_comp, req_comp, tga_width, tga_height); + + // the things I do to get rid of an error message, and yet keep + // Microsoft's C compilers happy... [8^( + tga_palette_start = tga_palette_len = tga_palette_bits = + tga_x_origin = tga_y_origin = 0; + // OK, done + return tga_data; +} +#endif + +// ************************************************************************************************* +// Photoshop PSD loader -- PD by Thatcher Ulrich, integration by Nicolas Schulz, tweaked by STB + +#ifndef STBI_NO_PSD +static int stbi__psd_test(stbi__context *s) +{ + int r = (stbi__get32be(s) == 0x38425053); + stbi__rewind(s); + return r; +} + +static stbi_uc *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + int pixelCount; + int channelCount, compression; + int channel, i, count, len; + int bitdepth; + int w,h; + stbi_uc *out; + + // Check identifier + if (stbi__get32be(s) != 0x38425053) // "8BPS" + return stbi__errpuc("not PSD", "Corrupt PSD image"); + + // Check file type version. + if (stbi__get16be(s) != 1) + return stbi__errpuc("wrong version", "Unsupported version of PSD image"); + + // Skip 6 reserved bytes. + stbi__skip(s, 6 ); + + // Read the number of channels (R, G, B, A, etc). + channelCount = stbi__get16be(s); + if (channelCount < 0 || channelCount > 16) + return stbi__errpuc("wrong channel count", "Unsupported number of channels in PSD image"); + + // Read the rows and columns of the image. + h = stbi__get32be(s); + w = stbi__get32be(s); + + // Make sure the depth is 8 bits. + bitdepth = stbi__get16be(s); + if (bitdepth != 8 && bitdepth != 16) + return stbi__errpuc("unsupported bit depth", "PSD bit depth is not 8 or 16 bit"); + + // Make sure the color mode is RGB. + // Valid options are: + // 0: Bitmap + // 1: Grayscale + // 2: Indexed color + // 3: RGB color + // 4: CMYK color + // 7: Multichannel + // 8: Duotone + // 9: Lab color + if (stbi__get16be(s) != 3) + return stbi__errpuc("wrong color format", "PSD is not in RGB color format"); + + // Skip the Mode Data. (It's the palette for indexed color; other info for other modes.) + stbi__skip(s,stbi__get32be(s) ); + + // Skip the image resources. (resolution, pen tool paths, etc) + stbi__skip(s, stbi__get32be(s) ); + + // Skip the reserved data. + stbi__skip(s, stbi__get32be(s) ); + + // Find out if the data is compressed. + // Known values: + // 0: no compression + // 1: RLE compressed + compression = stbi__get16be(s); + if (compression > 1) + return stbi__errpuc("bad compression", "PSD has an unknown compression format"); + + // Create the destination image. + out = (stbi_uc *) stbi__malloc(4 * w*h); + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + pixelCount = w*h; + + // Initialize the data to zero. + //memset( out, 0, pixelCount * 4 ); + + // Finally, the image data. + if (compression) { + // RLE as used by .PSD and .TIFF + // Loop until you get the number of unpacked bytes you are expecting: + // Read the next source byte into n. + // If n is between 0 and 127 inclusive, copy the next n+1 bytes literally. + // Else if n is between -127 and -1 inclusive, copy the next byte -n+1 times. + // Else if n is 128, noop. + // Endloop + + // The RLE-compressed data is preceded by a 2-byte data count for each row in the data, + // which we're going to just skip. + stbi__skip(s, h * channelCount * 2 ); + + // Read the RLE data by channel. + for (channel = 0; channel < 4; channel++) { + stbi_uc *p; + + p = out+channel; + if (channel >= channelCount) { + // Fill this channel with default data. + for (i = 0; i < pixelCount; i++, p += 4) + *p = (channel == 3 ? 255 : 0); + } else { + // Read the RLE data. + count = 0; + while (count < pixelCount) { + len = stbi__get8(s); + if (len == 128) { + // No-op. + } else if (len < 128) { + // Copy next len+1 bytes literally. + len++; + count += len; + while (len) { + *p = stbi__get8(s); + p += 4; + len--; + } + } else if (len > 128) { + stbi_uc val; + // Next -len+1 bytes in the dest are replicated from next source byte. + // (Interpret len as a negative 8-bit int.) + len ^= 0x0FF; + len += 2; + val = stbi__get8(s); + count += len; + while (len) { + *p = val; + p += 4; + len--; + } + } + } + } + } + + } else { + // We're at the raw image data. It's each channel in order (Red, Green, Blue, Alpha, ...) + // where each channel consists of an 8-bit value for each pixel in the image. + + // Read the data by channel. + for (channel = 0; channel < 4; channel++) { + stbi_uc *p; + + p = out + channel; + if (channel >= channelCount) { + // Fill this channel with default data. + stbi_uc val = channel == 3 ? 255 : 0; + for (i = 0; i < pixelCount; i++, p += 4) + *p = val; + } else { + // Read the data. + if (bitdepth == 16) { + for (i = 0; i < pixelCount; i++, p += 4) + *p = (stbi_uc) (stbi__get16be(s) >> 8); + } else { + for (i = 0; i < pixelCount; i++, p += 4) + *p = stbi__get8(s); + } + } + } + } + + if (req_comp && req_comp != 4) { + out = stbi__convert_format(out, 4, req_comp, w, h); + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + + if (comp) *comp = 4; + *y = h; + *x = w; + + return out; +} +#endif + +// ************************************************************************************************* +// Softimage PIC loader +// by Tom Seddon +// +// See http://softimage.wiki.softimage.com/index.php/INFO:_PIC_file_format +// See http://ozviz.wasp.uwa.edu.au/~pbourke/dataformats/softimagepic/ + +#ifndef STBI_NO_PIC +static int stbi__pic_is4(stbi__context *s,const char *str) +{ + int i; + for (i=0; i<4; ++i) + if (stbi__get8(s) != (stbi_uc)str[i]) + return 0; + + return 1; +} + +static int stbi__pic_test_core(stbi__context *s) +{ + int i; + + if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) + return 0; + + for(i=0;i<84;++i) + stbi__get8(s); + + if (!stbi__pic_is4(s,"PICT")) + return 0; + + return 1; +} + +typedef struct +{ + stbi_uc size,type,channel; +} stbi__pic_packet; + +static stbi_uc *stbi__readval(stbi__context *s, int channel, stbi_uc *dest) +{ + int mask=0x80, i; + + for (i=0; i<4; ++i, mask>>=1) { + if (channel & mask) { + if (stbi__at_eof(s)) return stbi__errpuc("bad file","PIC file too short"); + dest[i]=stbi__get8(s); + } + } + + return dest; +} + +static void stbi__copyval(int channel,stbi_uc *dest,const stbi_uc *src) +{ + int mask=0x80,i; + + for (i=0;i<4; ++i, mask>>=1) + if (channel&mask) + dest[i]=src[i]; +} + +static stbi_uc *stbi__pic_load_core(stbi__context *s,int width,int height,int *comp, stbi_uc *result) +{ + int act_comp=0,num_packets=0,y,chained; + stbi__pic_packet packets[10]; + + // this will (should...) cater for even some bizarre stuff like having data + // for the same channel in multiple packets. + do { + stbi__pic_packet *packet; + + if (num_packets==sizeof(packets)/sizeof(packets[0])) + return stbi__errpuc("bad format","too many packets"); + + packet = &packets[num_packets++]; + + chained = stbi__get8(s); + packet->size = stbi__get8(s); + packet->type = stbi__get8(s); + packet->channel = stbi__get8(s); + + act_comp |= packet->channel; + + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (reading packets)"); + if (packet->size != 8) return stbi__errpuc("bad format","packet isn't 8bpp"); + } while (chained); + + *comp = (act_comp & 0x10 ? 4 : 3); // has alpha channel? + + for(y=0; ytype) { + default: + return stbi__errpuc("bad format","packet has bad compression type"); + + case 0: {//uncompressed + int x; + + for(x=0;xchannel,dest)) + return 0; + break; + } + + case 1://Pure RLE + { + int left=width, i; + + while (left>0) { + stbi_uc count,value[4]; + + count=stbi__get8(s); + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pure read count)"); + + if (count > left) + count = (stbi_uc) left; + + if (!stbi__readval(s,packet->channel,value)) return 0; + + for(i=0; ichannel,dest,value); + left -= count; + } + } + break; + + case 2: {//Mixed RLE + int left=width; + while (left>0) { + int count = stbi__get8(s), i; + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (mixed read count)"); + + if (count >= 128) { // Repeated + stbi_uc value[4]; + + if (count==128) + count = stbi__get16be(s); + else + count -= 127; + if (count > left) + return stbi__errpuc("bad file","scanline overrun"); + + if (!stbi__readval(s,packet->channel,value)) + return 0; + + for(i=0;ichannel,dest,value); + } else { // Raw + ++count; + if (count>left) return stbi__errpuc("bad file","scanline overrun"); + + for(i=0;ichannel,dest)) + return 0; + } + left-=count; + } + break; + } + } + } + } + + return result; +} + +static stbi_uc *stbi__pic_load(stbi__context *s,int *px,int *py,int *comp,int req_comp) +{ + stbi_uc *result; + int i, x,y; + + for (i=0; i<92; ++i) + stbi__get8(s); + + x = stbi__get16be(s); + y = stbi__get16be(s); + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pic header)"); + if ((1 << 28) / x < y) return stbi__errpuc("too large", "Image too large to decode"); + + stbi__get32be(s); //skip `ratio' + stbi__get16be(s); //skip `fields' + stbi__get16be(s); //skip `pad' + + // intermediate buffer is RGBA + result = (stbi_uc *) stbi__malloc(x*y*4); + memset(result, 0xff, x*y*4); + + if (!stbi__pic_load_core(s,x,y,comp, result)) { + STBI_FREE(result); + result=0; + } + *px = x; + *py = y; + if (req_comp == 0) req_comp = *comp; + result=stbi__convert_format(result,4,req_comp,x,y); + + return result; +} + +static int stbi__pic_test(stbi__context *s) +{ + int r = stbi__pic_test_core(s); + stbi__rewind(s); + return r; +} +#endif + +// ************************************************************************************************* +// GIF loader -- public domain by Jean-Marc Lienher -- simplified/shrunk by stb + +#ifndef STBI_NO_GIF +typedef struct +{ + stbi__int16 prefix; + stbi_uc first; + stbi_uc suffix; +} stbi__gif_lzw; + +typedef struct +{ + int w,h; + stbi_uc *out, *old_out; // output buffer (always 4 components) + int flags, bgindex, ratio, transparent, eflags, delay; + stbi_uc pal[256][4]; + stbi_uc lpal[256][4]; + stbi__gif_lzw codes[4096]; + stbi_uc *color_table; + int parse, step; + int lflags; + int start_x, start_y; + int max_x, max_y; + int cur_x, cur_y; + int line_size; +} stbi__gif; + +static int stbi__gif_test_raw(stbi__context *s) +{ + int sz; + if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') return 0; + sz = stbi__get8(s); + if (sz != '9' && sz != '7') return 0; + if (stbi__get8(s) != 'a') return 0; + return 1; +} + +static int stbi__gif_test(stbi__context *s) +{ + int r = stbi__gif_test_raw(s); + stbi__rewind(s); + return r; +} + +static void stbi__gif_parse_colortable(stbi__context *s, stbi_uc pal[256][4], int num_entries, int transp) +{ + int i; + for (i=0; i < num_entries; ++i) { + pal[i][2] = stbi__get8(s); + pal[i][1] = stbi__get8(s); + pal[i][0] = stbi__get8(s); + pal[i][3] = transp == i ? 0 : 255; + } +} + +static int stbi__gif_header(stbi__context *s, stbi__gif *g, int *comp, int is_info) +{ + stbi_uc version; + if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') + return stbi__err("not GIF", "Corrupt GIF"); + + version = stbi__get8(s); + if (version != '7' && version != '9') return stbi__err("not GIF", "Corrupt GIF"); + if (stbi__get8(s) != 'a') return stbi__err("not GIF", "Corrupt GIF"); + + stbi__g_failure_reason = ""; + g->w = stbi__get16le(s); + g->h = stbi__get16le(s); + g->flags = stbi__get8(s); + g->bgindex = stbi__get8(s); + g->ratio = stbi__get8(s); + g->transparent = -1; + + if (comp != 0) *comp = 4; // can't actually tell whether it's 3 or 4 until we parse the comments + + if (is_info) return 1; + + if (g->flags & 0x80) + stbi__gif_parse_colortable(s,g->pal, 2 << (g->flags & 7), -1); + + return 1; +} + +static int stbi__gif_info_raw(stbi__context *s, int *x, int *y, int *comp) +{ + stbi__gif g; + if (!stbi__gif_header(s, &g, comp, 1)) { + stbi__rewind( s ); + return 0; + } + if (x) *x = g.w; + if (y) *y = g.h; + return 1; +} + +static void stbi__out_gif_code(stbi__gif *g, stbi__uint16 code) +{ + stbi_uc *p, *c; + + // recurse to decode the prefixes, since the linked-list is backwards, + // and working backwards through an interleaved image would be nasty + if (g->codes[code].prefix >= 0) + stbi__out_gif_code(g, g->codes[code].prefix); + + if (g->cur_y >= g->max_y) return; + + p = &g->out[g->cur_x + g->cur_y]; + c = &g->color_table[g->codes[code].suffix * 4]; + + if (c[3] >= 128) { + p[0] = c[2]; + p[1] = c[1]; + p[2] = c[0]; + p[3] = c[3]; + } + g->cur_x += 4; + + if (g->cur_x >= g->max_x) { + g->cur_x = g->start_x; + g->cur_y += g->step; + + while (g->cur_y >= g->max_y && g->parse > 0) { + g->step = (1 << g->parse) * g->line_size; + g->cur_y = g->start_y + (g->step >> 1); + --g->parse; + } + } +} + +static stbi_uc *stbi__process_gif_raster(stbi__context *s, stbi__gif *g) +{ + stbi_uc lzw_cs; + stbi__int32 len, init_code; + stbi__uint32 first; + stbi__int32 codesize, codemask, avail, oldcode, bits, valid_bits, clear; + stbi__gif_lzw *p; + + lzw_cs = stbi__get8(s); + if (lzw_cs > 12) return NULL; + clear = 1 << lzw_cs; + first = 1; + codesize = lzw_cs + 1; + codemask = (1 << codesize) - 1; + bits = 0; + valid_bits = 0; + for (init_code = 0; init_code < clear; init_code++) { + g->codes[init_code].prefix = -1; + g->codes[init_code].first = (stbi_uc) init_code; + g->codes[init_code].suffix = (stbi_uc) init_code; + } + + // support no starting clear code + avail = clear+2; + oldcode = -1; + + len = 0; + for(;;) { + if (valid_bits < codesize) { + if (len == 0) { + len = stbi__get8(s); // start new block + if (len == 0) + return g->out; + } + --len; + bits |= (stbi__int32) stbi__get8(s) << valid_bits; + valid_bits += 8; + } else { + stbi__int32 code = bits & codemask; + bits >>= codesize; + valid_bits -= codesize; + // @OPTIMIZE: is there some way we can accelerate the non-clear path? + if (code == clear) { // clear code + codesize = lzw_cs + 1; + codemask = (1 << codesize) - 1; + avail = clear + 2; + oldcode = -1; + first = 0; + } else if (code == clear + 1) { // end of stream code + stbi__skip(s, len); + while ((len = stbi__get8(s)) > 0) + stbi__skip(s,len); + return g->out; + } else if (code <= avail) { + if (first) return stbi__errpuc("no clear code", "Corrupt GIF"); + + if (oldcode >= 0) { + p = &g->codes[avail++]; + if (avail > 4096) return stbi__errpuc("too many codes", "Corrupt GIF"); + p->prefix = (stbi__int16) oldcode; + p->first = g->codes[oldcode].first; + p->suffix = (code == avail) ? p->first : g->codes[code].first; + } else if (code == avail) + return stbi__errpuc("illegal code in raster", "Corrupt GIF"); + + stbi__out_gif_code(g, (stbi__uint16) code); + + if ((avail & codemask) == 0 && avail <= 0x0FFF) { + codesize++; + codemask = (1 << codesize) - 1; + } + + oldcode = code; + } else { + return stbi__errpuc("illegal code in raster", "Corrupt GIF"); + } + } + } +} + +static void stbi__fill_gif_background(stbi__gif *g, int x0, int y0, int x1, int y1) +{ + int x, y; + stbi_uc *c = g->pal[g->bgindex]; + for (y = y0; y < y1; y += 4 * g->w) { + for (x = x0; x < x1; x += 4) { + stbi_uc *p = &g->out[y + x]; + p[0] = c[2]; + p[1] = c[1]; + p[2] = c[0]; + p[3] = 0; + } + } +} + +// this function is designed to support animated gifs, although stb_image doesn't support it +static stbi_uc *stbi__gif_load_next(stbi__context *s, stbi__gif *g, int *comp, int req_comp) +{ + int i; + stbi_uc *prev_out = 0; + + if (g->out == 0 && !stbi__gif_header(s, g, comp,0)) + return 0; // stbi__g_failure_reason set by stbi__gif_header + + prev_out = g->out; + g->out = (stbi_uc *) stbi__malloc(4 * g->w * g->h); + if (g->out == 0) return stbi__errpuc("outofmem", "Out of memory"); + + switch ((g->eflags & 0x1C) >> 2) { + case 0: // unspecified (also always used on 1st frame) + stbi__fill_gif_background(g, 0, 0, 4 * g->w, 4 * g->w * g->h); + break; + case 1: // do not dispose + if (prev_out) memcpy(g->out, prev_out, 4 * g->w * g->h); + g->old_out = prev_out; + break; + case 2: // dispose to background + if (prev_out) memcpy(g->out, prev_out, 4 * g->w * g->h); + stbi__fill_gif_background(g, g->start_x, g->start_y, g->max_x, g->max_y); + break; + case 3: // dispose to previous + if (g->old_out) { + for (i = g->start_y; i < g->max_y; i += 4 * g->w) + memcpy(&g->out[i + g->start_x], &g->old_out[i + g->start_x], g->max_x - g->start_x); + } + break; + } + + for (;;) { + switch (stbi__get8(s)) { + case 0x2C: /* Image Descriptor */ + { + int prev_trans = -1; + stbi__int32 x, y, w, h; + stbi_uc *o; + + x = stbi__get16le(s); + y = stbi__get16le(s); + w = stbi__get16le(s); + h = stbi__get16le(s); + if (((x + w) > (g->w)) || ((y + h) > (g->h))) + return stbi__errpuc("bad Image Descriptor", "Corrupt GIF"); + + g->line_size = g->w * 4; + g->start_x = x * 4; + g->start_y = y * g->line_size; + g->max_x = g->start_x + w * 4; + g->max_y = g->start_y + h * g->line_size; + g->cur_x = g->start_x; + g->cur_y = g->start_y; + + g->lflags = stbi__get8(s); + + if (g->lflags & 0x40) { + g->step = 8 * g->line_size; // first interlaced spacing + g->parse = 3; + } else { + g->step = g->line_size; + g->parse = 0; + } + + if (g->lflags & 0x80) { + stbi__gif_parse_colortable(s,g->lpal, 2 << (g->lflags & 7), g->eflags & 0x01 ? g->transparent : -1); + g->color_table = (stbi_uc *) g->lpal; + } else if (g->flags & 0x80) { + if (g->transparent >= 0 && (g->eflags & 0x01)) { + prev_trans = g->pal[g->transparent][3]; + g->pal[g->transparent][3] = 0; + } + g->color_table = (stbi_uc *) g->pal; + } else + return stbi__errpuc("missing color table", "Corrupt GIF"); + + o = stbi__process_gif_raster(s, g); + if (o == NULL) return NULL; + + if (prev_trans != -1) + g->pal[g->transparent][3] = (stbi_uc) prev_trans; + + return o; + } + + case 0x21: // Comment Extension. + { + int len; + if (stbi__get8(s) == 0xF9) { // Graphic Control Extension. + len = stbi__get8(s); + if (len == 4) { + g->eflags = stbi__get8(s); + g->delay = stbi__get16le(s); + g->transparent = stbi__get8(s); + } else { + stbi__skip(s, len); + break; + } + } + while ((len = stbi__get8(s)) != 0) + stbi__skip(s, len); + break; + } + + case 0x3B: // gif stream termination code + return (stbi_uc *) s; // using '1' causes warning on some compilers + + default: + return stbi__errpuc("unknown code", "Corrupt GIF"); + } + } + + STBI_NOTUSED(req_comp); +} + +static stbi_uc *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi_uc *u = 0; + stbi__gif g; + memset(&g, 0, sizeof(g)); + + u = stbi__gif_load_next(s, &g, comp, req_comp); + if (u == (stbi_uc *) s) u = 0; // end of animated gif marker + if (u) { + *x = g.w; + *y = g.h; + if (req_comp && req_comp != 4) + u = stbi__convert_format(u, 4, req_comp, g.w, g.h); + } + else if (g.out) + STBI_FREE(g.out); + + return u; +} + +static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp) +{ + return stbi__gif_info_raw(s,x,y,comp); +} +#endif + +// ************************************************************************************************* +// Radiance RGBE HDR loader +// originally by Nicolas Schulz +#ifndef STBI_NO_HDR +static int stbi__hdr_test_core(stbi__context *s) +{ + const char *signature = "#?RADIANCE\n"; + int i; + for (i=0; signature[i]; ++i) + if (stbi__get8(s) != signature[i]) + return 0; + return 1; +} + +static int stbi__hdr_test(stbi__context* s) +{ + int r = stbi__hdr_test_core(s); + stbi__rewind(s); + return r; +} + +#define STBI__HDR_BUFLEN 1024 +static char *stbi__hdr_gettoken(stbi__context *z, char *buffer) +{ + int len=0; + char c = '\0'; + + c = (char) stbi__get8(z); + + while (!stbi__at_eof(z) && c != '\n') { + buffer[len++] = c; + if (len == STBI__HDR_BUFLEN-1) { + // flush to end of line + while (!stbi__at_eof(z) && stbi__get8(z) != '\n') + ; + break; + } + c = (char) stbi__get8(z); + } + + buffer[len] = 0; + return buffer; +} + +static void stbi__hdr_convert(float *output, stbi_uc *input, int req_comp) +{ + if ( input[3] != 0 ) { + float f1; + // Exponent + f1 = (float) ldexp(1.0f, input[3] - (int)(128 + 8)); + if (req_comp <= 2) + output[0] = (input[0] + input[1] + input[2]) * f1 / 3; + else { + output[0] = input[0] * f1; + output[1] = input[1] * f1; + output[2] = input[2] * f1; + } + if (req_comp == 2) output[1] = 1; + if (req_comp == 4) output[3] = 1; + } else { + switch (req_comp) { + case 4: output[3] = 1; /* fallthrough */ + case 3: output[0] = output[1] = output[2] = 0; + break; + case 2: output[1] = 1; /* fallthrough */ + case 1: output[0] = 0; + break; + } + } +} + +static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + char buffer[STBI__HDR_BUFLEN]; + char *token; + int valid = 0; + int width, height; + stbi_uc *scanline; + float *hdr_data; + int len; + unsigned char count, value; + int i, j, k, c1,c2, z; + + + // Check identifier + if (strcmp(stbi__hdr_gettoken(s,buffer), "#?RADIANCE") != 0) + return stbi__errpf("not HDR", "Corrupt HDR image"); + + // Parse header + for(;;) { + token = stbi__hdr_gettoken(s,buffer); + if (token[0] == 0) break; + if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; + } + + if (!valid) return stbi__errpf("unsupported format", "Unsupported HDR format"); + + // Parse width and height + // can't use sscanf() if we're not using stdio! + token = stbi__hdr_gettoken(s,buffer); + if (strncmp(token, "-Y ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); + token += 3; + height = (int) strtol(token, &token, 10); + while (*token == ' ') ++token; + if (strncmp(token, "+X ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); + token += 3; + width = (int) strtol(token, NULL, 10); + + *x = width; + *y = height; + + if (comp) *comp = 3; + if (req_comp == 0) req_comp = 3; + + // Read data + hdr_data = (float *) stbi__malloc(height * width * req_comp * sizeof(float)); + + // Load image data + // image data is stored as some number of sca + if ( width < 8 || width >= 32768) { + // Read flat data + for (j=0; j < height; ++j) { + for (i=0; i < width; ++i) { + stbi_uc rgbe[4]; + main_decode_loop: + stbi__getn(s, rgbe, 4); + stbi__hdr_convert(hdr_data + j * width * req_comp + i * req_comp, rgbe, req_comp); + } + } + } else { + // Read RLE-encoded data + scanline = NULL; + + for (j = 0; j < height; ++j) { + c1 = stbi__get8(s); + c2 = stbi__get8(s); + len = stbi__get8(s); + if (c1 != 2 || c2 != 2 || (len & 0x80)) { + // not run-length encoded, so we have to actually use THIS data as a decoded + // pixel (note this can't be a valid pixel--one of RGB must be >= 128) + stbi_uc rgbe[4]; + rgbe[0] = (stbi_uc) c1; + rgbe[1] = (stbi_uc) c2; + rgbe[2] = (stbi_uc) len; + rgbe[3] = (stbi_uc) stbi__get8(s); + stbi__hdr_convert(hdr_data, rgbe, req_comp); + i = 1; + j = 0; + STBI_FREE(scanline); + goto main_decode_loop; // yes, this makes no sense + } + len <<= 8; + len |= stbi__get8(s); + if (len != width) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("invalid decoded scanline length", "corrupt HDR"); } + if (scanline == NULL) scanline = (stbi_uc *) stbi__malloc(width * 4); + + for (k = 0; k < 4; ++k) { + i = 0; + while (i < width) { + count = stbi__get8(s); + if (count > 128) { + // Run + value = stbi__get8(s); + count -= 128; + for (z = 0; z < count; ++z) + scanline[i++ * 4 + k] = value; + } else { + // Dump + for (z = 0; z < count; ++z) + scanline[i++ * 4 + k] = stbi__get8(s); + } + } + } + for (i=0; i < width; ++i) + stbi__hdr_convert(hdr_data+(j*width + i)*req_comp, scanline + i*4, req_comp); + } + STBI_FREE(scanline); + } + + return hdr_data; +} + +static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp) +{ + char buffer[STBI__HDR_BUFLEN]; + char *token; + int valid = 0; + + if (strcmp(stbi__hdr_gettoken(s,buffer), "#?RADIANCE") != 0) { + stbi__rewind( s ); + return 0; + } + + for(;;) { + token = stbi__hdr_gettoken(s,buffer); + if (token[0] == 0) break; + if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; + } + + if (!valid) { + stbi__rewind( s ); + return 0; + } + token = stbi__hdr_gettoken(s,buffer); + if (strncmp(token, "-Y ", 3)) { + stbi__rewind( s ); + return 0; + } + token += 3; + *y = (int) strtol(token, &token, 10); + while (*token == ' ') ++token; + if (strncmp(token, "+X ", 3)) { + stbi__rewind( s ); + return 0; + } + token += 3; + *x = (int) strtol(token, NULL, 10); + *comp = 3; + return 1; +} +#endif // STBI_NO_HDR + +#ifndef STBI_NO_BMP +static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp) +{ + int hsz; + if (stbi__get8(s) != 'B' || stbi__get8(s) != 'M') { + stbi__rewind( s ); + return 0; + } + stbi__skip(s,12); + hsz = stbi__get32le(s); + if (hsz != 12 && hsz != 40 && hsz != 56 && hsz != 108 && hsz != 124) { + stbi__rewind( s ); + return 0; + } + if (hsz == 12) { + *x = stbi__get16le(s); + *y = stbi__get16le(s); + } else { + *x = stbi__get32le(s); + *y = stbi__get32le(s); + } + if (stbi__get16le(s) != 1) { + stbi__rewind( s ); + return 0; + } + *comp = stbi__get16le(s) / 8; + return 1; +} +#endif + +#ifndef STBI_NO_PSD +static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp) +{ + int channelCount; + if (stbi__get32be(s) != 0x38425053) { + stbi__rewind( s ); + return 0; + } + if (stbi__get16be(s) != 1) { + stbi__rewind( s ); + return 0; + } + stbi__skip(s, 6); + channelCount = stbi__get16be(s); + if (channelCount < 0 || channelCount > 16) { + stbi__rewind( s ); + return 0; + } + *y = stbi__get32be(s); + *x = stbi__get32be(s); + if (stbi__get16be(s) != 8) { + stbi__rewind( s ); + return 0; + } + if (stbi__get16be(s) != 3) { + stbi__rewind( s ); + return 0; + } + *comp = 4; + return 1; +} +#endif + +#ifndef STBI_NO_PIC +static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp) +{ + int act_comp=0,num_packets=0,chained; + stbi__pic_packet packets[10]; + + if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) { + stbi__rewind(s); + return 0; + } + + stbi__skip(s, 88); + + *x = stbi__get16be(s); + *y = stbi__get16be(s); + if (stbi__at_eof(s)) { + stbi__rewind( s); + return 0; + } + if ( (*x) != 0 && (1 << 28) / (*x) < (*y)) { + stbi__rewind( s ); + return 0; + } + + stbi__skip(s, 8); + + do { + stbi__pic_packet *packet; + + if (num_packets==sizeof(packets)/sizeof(packets[0])) + return 0; + + packet = &packets[num_packets++]; + chained = stbi__get8(s); + packet->size = stbi__get8(s); + packet->type = stbi__get8(s); + packet->channel = stbi__get8(s); + act_comp |= packet->channel; + + if (stbi__at_eof(s)) { + stbi__rewind( s ); + return 0; + } + if (packet->size != 8) { + stbi__rewind( s ); + return 0; + } + } while (chained); + + *comp = (act_comp & 0x10 ? 4 : 3); + + return 1; +} +#endif + +// ************************************************************************************************* +// Portable Gray Map and Portable Pixel Map loader +// by Ken Miller +// +// PGM: http://netpbm.sourceforge.net/doc/pgm.html +// PPM: http://netpbm.sourceforge.net/doc/ppm.html +// +// Known limitations: +// Does not support comments in the header section +// Does not support ASCII image data (formats P2 and P3) +// Does not support 16-bit-per-channel + +#ifndef STBI_NO_PNM + +static int stbi__pnm_test(stbi__context *s) +{ + char p, t; + p = (char) stbi__get8(s); + t = (char) stbi__get8(s); + if (p != 'P' || (t != '5' && t != '6')) { + stbi__rewind( s ); + return 0; + } + return 1; +} + +static stbi_uc *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi_uc *out; + if (!stbi__pnm_info(s, (int *)&s->img_x, (int *)&s->img_y, (int *)&s->img_n)) + return 0; + *x = s->img_x; + *y = s->img_y; + *comp = s->img_n; + + out = (stbi_uc *) stbi__malloc(s->img_n * s->img_x * s->img_y); + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + stbi__getn(s, out, s->img_n * s->img_x * s->img_y); + + if (req_comp && req_comp != s->img_n) { + out = stbi__convert_format(out, s->img_n, req_comp, s->img_x, s->img_y); + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + return out; +} + +static int stbi__pnm_isspace(char c) +{ + return c == ' ' || c == '\t' || c == '\n' || c == '\v' || c == '\f' || c == '\r'; +} + +static void stbi__pnm_skip_whitespace(stbi__context *s, char *c) +{ + while (!stbi__at_eof(s) && stbi__pnm_isspace(*c)) + *c = (char) stbi__get8(s); +} + +static int stbi__pnm_isdigit(char c) +{ + return c >= '0' && c <= '9'; +} + +static int stbi__pnm_getinteger(stbi__context *s, char *c) +{ + int value = 0; + + while (!stbi__at_eof(s) && stbi__pnm_isdigit(*c)) { + value = value*10 + (*c - '0'); + *c = (char) stbi__get8(s); + } + + return value; +} + +static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp) +{ + int maxv; + char c, p, t; + + stbi__rewind( s ); + + // Get identifier + p = (char) stbi__get8(s); + t = (char) stbi__get8(s); + if (p != 'P' || (t != '5' && t != '6')) { + stbi__rewind( s ); + return 0; + } + + *comp = (t == '6') ? 3 : 1; // '5' is 1-component .pgm; '6' is 3-component .ppm + + c = (char) stbi__get8(s); + stbi__pnm_skip_whitespace(s, &c); + + *x = stbi__pnm_getinteger(s, &c); // read width + stbi__pnm_skip_whitespace(s, &c); + + *y = stbi__pnm_getinteger(s, &c); // read height + stbi__pnm_skip_whitespace(s, &c); + + maxv = stbi__pnm_getinteger(s, &c); // read max value + + if (maxv > 255) + return stbi__err("max value > 255", "PPM image not 8-bit"); + else + return 1; +} +#endif + +static int stbi__info_main(stbi__context *s, int *x, int *y, int *comp) +{ + #ifndef STBI_NO_JPEG + if (stbi__jpeg_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PNG + if (stbi__png_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_GIF + if (stbi__gif_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_BMP + if (stbi__bmp_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PSD + if (stbi__psd_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PIC + if (stbi__pic_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PNM + if (stbi__pnm_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_HDR + if (stbi__hdr_info(s, x, y, comp)) return 1; + #endif + + // test tga last because it's a crappy test! + #ifndef STBI_NO_TGA + if (stbi__tga_info(s, x, y, comp)) + return 1; + #endif + return stbi__err("unknown image type", "Image not of any known type, or corrupt"); +} + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_info(char const *filename, int *x, int *y, int *comp) +{ + FILE *f = stbi__fopen(filename, "rb"); + int result; + if (!f) return stbi__err("can't fopen", "Unable to open file"); + result = stbi_info_from_file(f, x, y, comp); + fclose(f); + return result; +} + +STBIDEF int stbi_info_from_file(FILE *f, int *x, int *y, int *comp) +{ + int r; + stbi__context s; + long pos = ftell(f); + stbi__start_file(&s, f); + r = stbi__info_main(&s,x,y,comp); + fseek(f,pos,SEEK_SET); + return r; +} +#endif // !STBI_NO_STDIO + +STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__info_main(&s,x,y,comp); +} + +STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *c, void *user, int *x, int *y, int *comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) c, user); + return stbi__info_main(&s,x,y,comp); +} + +#endif // STB_IMAGE_IMPLEMENTATION + +/* + revision history: + 2.08 (2015-09-13) fix to 2.07 cleanup, reading RGB PSD as RGBA + 2.07 (2015-09-13) fix compiler warnings + partial animated GIF support + limited 16-bit PSD support + #ifdef unused functions + bug with < 92 byte PIC,PNM,HDR,TGA + 2.06 (2015-04-19) fix bug where PSD returns wrong '*comp' value + 2.05 (2015-04-19) fix bug in progressive JPEG handling, fix warning + 2.04 (2015-04-15) try to re-enable SIMD on MinGW 64-bit + 2.03 (2015-04-12) extra corruption checking (mmozeiko) + stbi_set_flip_vertically_on_load (nguillemot) + fix NEON support; fix mingw support + 2.02 (2015-01-19) fix incorrect assert, fix warning + 2.01 (2015-01-17) fix various warnings; suppress SIMD on gcc 32-bit without -msse2 + 2.00b (2014-12-25) fix STBI_MALLOC in progressive JPEG + 2.00 (2014-12-25) optimize JPG, including x86 SSE2 & NEON SIMD (ryg) + progressive JPEG (stb) + PGM/PPM support (Ken Miller) + STBI_MALLOC,STBI_REALLOC,STBI_FREE + GIF bugfix -- seemingly never worked + STBI_NO_*, STBI_ONLY_* + 1.48 (2014-12-14) fix incorrectly-named assert() + 1.47 (2014-12-14) 1/2/4-bit PNG support, both direct and paletted (Omar Cornut & stb) + optimize PNG (ryg) + fix bug in interlaced PNG with user-specified channel count (stb) + 1.46 (2014-08-26) + fix broken tRNS chunk (colorkey-style transparency) in non-paletted PNG + 1.45 (2014-08-16) + fix MSVC-ARM internal compiler error by wrapping malloc + 1.44 (2014-08-07) + various warning fixes from Ronny Chevalier + 1.43 (2014-07-15) + fix MSVC-only compiler problem in code changed in 1.42 + 1.42 (2014-07-09) + don't define _CRT_SECURE_NO_WARNINGS (affects user code) + fixes to stbi__cleanup_jpeg path + added STBI_ASSERT to avoid requiring assert.h + 1.41 (2014-06-25) + fix search&replace from 1.36 that messed up comments/error messages + 1.40 (2014-06-22) + fix gcc struct-initialization warning + 1.39 (2014-06-15) + fix to TGA optimization when req_comp != number of components in TGA; + fix to GIF loading because BMP wasn't rewinding (whoops, no GIFs in my test suite) + add support for BMP version 5 (more ignored fields) + 1.38 (2014-06-06) + suppress MSVC warnings on integer casts truncating values + fix accidental rename of 'skip' field of I/O + 1.37 (2014-06-04) + remove duplicate typedef + 1.36 (2014-06-03) + convert to header file single-file library + if de-iphone isn't set, load iphone images color-swapped instead of returning NULL + 1.35 (2014-05-27) + various warnings + fix broken STBI_SIMD path + fix bug where stbi_load_from_file no longer left file pointer in correct place + fix broken non-easy path for 32-bit BMP (possibly never used) + TGA optimization by Arseny Kapoulkine + 1.34 (unknown) + use STBI_NOTUSED in stbi__resample_row_generic(), fix one more leak in tga failure case + 1.33 (2011-07-14) + make stbi_is_hdr work in STBI_NO_HDR (as specified), minor compiler-friendly improvements + 1.32 (2011-07-13) + support for "info" function for all supported filetypes (SpartanJ) + 1.31 (2011-06-20) + a few more leak fixes, bug in PNG handling (SpartanJ) + 1.30 (2011-06-11) + added ability to load files via callbacks to accommodate custom input streams (Ben Wenger) + removed deprecated format-specific test/load functions + removed support for installable file formats (stbi_loader) -- would have been broken for IO callbacks anyway + error cases in bmp and tga give messages and don't leak (Raymond Barbiero, grisha) + fix inefficiency in decoding 32-bit BMP (David Woo) + 1.29 (2010-08-16) + various warning fixes from Aurelien Pocheville + 1.28 (2010-08-01) + fix bug in GIF palette transparency (SpartanJ) + 1.27 (2010-08-01) + cast-to-stbi_uc to fix warnings + 1.26 (2010-07-24) + fix bug in file buffering for PNG reported by SpartanJ + 1.25 (2010-07-17) + refix trans_data warning (Won Chun) + 1.24 (2010-07-12) + perf improvements reading from files on platforms with lock-heavy fgetc() + minor perf improvements for jpeg + deprecated type-specific functions so we'll get feedback if they're needed + attempt to fix trans_data warning (Won Chun) + 1.23 fixed bug in iPhone support + 1.22 (2010-07-10) + removed image *writing* support + stbi_info support from Jetro Lauha + GIF support from Jean-Marc Lienher + iPhone PNG-extensions from James Brown + warning-fixes from Nicolas Schulz and Janez Zemva (i.stbi__err. Janez (U+017D)emva) + 1.21 fix use of 'stbi_uc' in header (reported by jon blow) + 1.20 added support for Softimage PIC, by Tom Seddon + 1.19 bug in interlaced PNG corruption check (found by ryg) + 1.18 (2008-08-02) + fix a threading bug (local mutable static) + 1.17 support interlaced PNG + 1.16 major bugfix - stbi__convert_format converted one too many pixels + 1.15 initialize some fields for thread safety + 1.14 fix threadsafe conversion bug + header-file-only version (#define STBI_HEADER_FILE_ONLY before including) + 1.13 threadsafe + 1.12 const qualifiers in the API + 1.11 Support installable IDCT, colorspace conversion routines + 1.10 Fixes for 64-bit (don't use "unsigned long") + optimized upsampling by Fabian "ryg" Giesen + 1.09 Fix format-conversion for PSD code (bad global variables!) + 1.08 Thatcher Ulrich's PSD code integrated by Nicolas Schulz + 1.07 attempt to fix C++ warning/errors again + 1.06 attempt to fix C++ warning/errors again + 1.05 fix TGA loading to return correct *comp and use good luminance calc + 1.04 default float alpha is 1, not 255; use 'void *' for stbi_image_free + 1.03 bugfixes to STBI_NO_STDIO, STBI_NO_HDR + 1.02 support for (subset of) HDR files, float interface for preferred access to them + 1.01 fix bug: possible bug in handling right-side up bmps... not sure + fix bug: the stbi__bmp_load() and stbi__tga_load() functions didn't work at all + 1.00 interface to zlib that skips zlib header + 0.99 correct handling of alpha in palette + 0.98 TGA loader by lonesock; dynamically add loaders (untested) + 0.97 jpeg errors on too large a file; also catch another malloc failure + 0.96 fix detection of invalid v value - particleman@mollyrocket forum + 0.95 during header scan, seek to markers in case of padding + 0.94 STBI_NO_STDIO to disable stdio usage; rename all #defines the same + 0.93 handle jpegtran output; verbose errors + 0.92 read 4,8,16,24,32-bit BMP files of several formats + 0.91 output 24-bit Windows 3.0 BMP files + 0.90 fix a few more warnings; bump version number to approach 1.0 + 0.61 bugfixes due to Marc LeBlanc, Christopher Lloyd + 0.60 fix compiling as c++ + 0.59 fix warnings: merge Dave Moore's -Wall fixes + 0.58 fix bug: zlib uncompressed mode len/nlen was wrong endian + 0.57 fix bug: jpg last huffman symbol before marker was >9 bits but less than 16 available + 0.56 fix bug: zlib uncompressed mode len vs. nlen + 0.55 fix bug: restart_interval not initialized to 0 + 0.54 allow NULL for 'int *comp' + 0.53 fix bug in png 3->4; speedup png decoding + 0.52 png handles req_comp=3,4 directly; minor cleanup; jpeg comments + 0.51 obey req_comp requests, 1-component jpegs return as 1-component, + on 'test' only check type, not whether we support this variant + 0.50 (2006-11-19) + first released version +*/ diff --git a/demo/node_editor.c b/demo/common/node_editor.c similarity index 100% rename from demo/node_editor.c rename to demo/common/node_editor.c diff --git a/demo/overview.c b/demo/common/overview.c similarity index 99% rename from demo/overview.c rename to demo/common/overview.c index 5d8dadc..b696011 100644 --- a/demo/overview.c +++ b/demo/common/overview.c @@ -199,7 +199,7 @@ overview(struct nk_context *ctx) /* Basic widgets */ static int int_slider = 5; static float float_slider = 2.5f; - static size_t prog_value = 40; + static nk_size prog_value = 40; static float property_float = 2; static int property_int = 10; static int property_neg = 10; @@ -226,7 +226,7 @@ overview(struct nk_context *ctx) nk_label(ctx, "Slider float", NK_TEXT_LEFT); nk_slider_float(ctx, 0, &float_slider, 5.0, 0.5f); - nk_labelf(ctx, NK_TEXT_LEFT, "Progressbar: %zu" , prog_value); + nk_labelf(ctx, NK_TEXT_LEFT, "Progressbar: %u" , (int)prog_value); nk_progress(ctx, &prog_value, 100, NK_MODIFIABLE); nk_layout_row(ctx, NK_STATIC, 25, 2, ratio); @@ -623,13 +623,11 @@ overview(struct nk_context *ctx) int i; int index = -1; - struct nk_rect bounds; /* line chart */ id = 0; index = -1; nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin(ctx, NK_CHART_LINES, 32, -1.0f, 1.0f)) { for (i = 0; i < 32; ++i) { nk_flags res = nk_chart_push(ctx, (float)cos(id)); @@ -651,7 +649,6 @@ overview(struct nk_context *ctx) /* column chart */ nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin(ctx, NK_CHART_COLUMN, 32, 0.0f, 1.0f)) { for (i = 0; i < 32; ++i) { nk_flags res = nk_chart_push(ctx, (float)fabs(sin(id))); @@ -672,7 +669,6 @@ overview(struct nk_context *ctx) /* mixed chart */ nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin(ctx, NK_CHART_COLUMN, 32, 0.0f, 1.0f)) { nk_chart_add_slot(ctx, NK_CHART_LINES, 32, -1.0f, 1.0f); nk_chart_add_slot(ctx, NK_CHART_LINES, 32, -1.0f, 1.0f); @@ -687,7 +683,6 @@ overview(struct nk_context *ctx) /* mixed colored chart */ nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin_colored(ctx, NK_CHART_LINES, nk_rgb(255,0,0), nk_rgb(150,0,0), 32, 0.0f, 1.0f)) { nk_chart_add_slot_colored(ctx, NK_CHART_LINES, nk_rgb(0,0,255), nk_rgb(0,0,150),32, -1.0f, 1.0f); nk_chart_add_slot_colored(ctx, NK_CHART_LINES, nk_rgb(0,255,0), nk_rgb(0,150,0), 32, -1.0f, 1.0f); @@ -765,7 +760,7 @@ overview(struct nk_context *ctx) if (nk_popup_begin(ctx, NK_POPUP_STATIC, "Error", 0, s)) { nk_layout_row_dynamic(ctx, 25, 1); - nk_label(ctx, "A terrible error as occured", NK_TEXT_LEFT); + nk_label(ctx, "A terrible error as occurred", NK_TEXT_LEFT); nk_layout_row_dynamic(ctx, 25, 2); if (nk_button_label(ctx, "OK")) { popup_active = 0; @@ -946,7 +941,6 @@ overview(struct nk_context *ctx) if (nk_tree_push(ctx, NK_TREE_NODE, "Notebook", NK_MINIMIZED)) { static int current_tab = 0; - struct nk_rect bounds; float step = (2*3.141592654f) / 32; enum chart_type {CHART_LINE, CHART_HISTO, CHART_MIXED}; const char *names[] = {"Lines", "Columns", "Mixed"}; @@ -982,7 +976,6 @@ overview(struct nk_context *ctx) default: break; case CHART_LINE: nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin_colored(ctx, NK_CHART_LINES, nk_rgb(255,0,0), nk_rgb(150,0,0), 32, 0.0f, 1.0f)) { nk_chart_add_slot_colored(ctx, NK_CHART_LINES, nk_rgb(0,0,255), nk_rgb(0,0,150),32, -1.0f, 1.0f); for (i = 0, id = 0; i < 32; ++i) { @@ -995,7 +988,6 @@ overview(struct nk_context *ctx) break; case CHART_HISTO: nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin_colored(ctx, NK_CHART_COLUMN, nk_rgb(255,0,0), nk_rgb(150,0,0), 32, 0.0f, 1.0f)) { for (i = 0, id = 0; i < 32; ++i) { nk_chart_push_slot(ctx, (float)fabs(sin(id)), 0); @@ -1006,7 +998,6 @@ overview(struct nk_context *ctx) break; case CHART_MIXED: nk_layout_row_dynamic(ctx, 100, 1); - bounds = nk_widget_bounds(ctx); if (nk_chart_begin_colored(ctx, NK_CHART_LINES, nk_rgb(255,0,0), nk_rgb(150,0,0), 32, 0.0f, 1.0f)) { nk_chart_add_slot_colored(ctx, NK_CHART_LINES, nk_rgb(0,0,255), nk_rgb(0,0,150),32, -1.0f, 1.0f); nk_chart_add_slot_colored(ctx, NK_CHART_COLUMN, nk_rgb(0,255,0), nk_rgb(0,150,0), 32, 0.0f, 1.0f); diff --git a/demo/style.c b/demo/common/style.c similarity index 100% rename from demo/style.c rename to demo/common/style.c diff --git a/demo/d3d11/main.c b/demo/d3d11/main.c index 14d0d1c..ff2ac95 100644 --- a/demo/d3d11/main.c +++ b/demo/d3d11/main.c @@ -36,27 +36,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -205,10 +210,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -264,6 +275,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/d3d11/nuklear_d3d11.h b/demo/d3d11/nuklear_d3d11.h index fe69c02..27fa2c1 100644 --- a/demo/d3d11/nuklear_d3d11.h +++ b/demo/d3d11/nuklear_d3d11.h @@ -61,7 +61,7 @@ static struct struct nk_font_atlas atlas; struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; unsigned int max_vertex_buffer; unsigned int max_index_buffer; @@ -137,7 +137,7 @@ nk_d3d11_render(ID3D11DeviceContext *context, enum nk_anti_aliasing AA) config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; - config.null = d3d11.null; + config.tex_null = d3d11.tex_null; {/* setup buffers to load vertices and elements */ struct nk_buffer vbuf, ibuf; @@ -179,11 +179,15 @@ nk_d3d11_get_projection_matrix(int width, int height, float *result) const float B = (float)height; float matrix[4][4] = { - { 2.0f / (R - L), 0.0f, 0.0f, 0.0f }, - { 0.0f, 2.0f / (T - B), 0.0f, 0.0f }, - { 0.0f, 0.0f, 0.5f, 0.0f }, - { (R + L) / (L - R), (T + B) / (B - T), 0.5f, 1.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.5f, 0.0f }, + { 0.0f, 0.0f, 0.5f, 1.0f }, }; + matrix[0][0] = 2.0f / (R - L); + matrix[1][1] = 2.0f / (T - B); + matrix[3][0] = (R + L) / (L - R); + matrix[3][1] = (T + B) / (B - T); memcpy(result, matrix, sizeof(matrix)); } @@ -369,7 +373,7 @@ nk_d3d11_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) (void)usr; if (IsClipboardFormatAvailable(CF_UNICODETEXT) && OpenClipboard(NULL)) { - HGLOBAL mem = GetClipboardData(CF_UNICODETEXT); + HGLOBAL mem = GetClipboardData(CF_UNICODETEXT); if (mem) { SIZE_T size = GlobalSize(mem) - 1; @@ -389,7 +393,7 @@ nk_d3d11_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) free(utf8); } } - GlobalUnlock(mem); + GlobalUnlock(mem); } } } @@ -415,7 +419,7 @@ nk_d3d11_clipboard_copy(nk_handle usr, const char *text, int len) MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); wstr[wsize] = 0; GlobalUnlock(mem); - SetClipboardData(CF_UNICODETEXT, mem); + SetClipboardData(CF_UNICODETEXT, mem); } } } @@ -599,7 +603,7 @@ nk_d3d11_font_stash_end(void) assert(SUCCEEDED(hr));} ID3D11Texture2D_Release(font_texture);} - nk_font_atlas_end(&d3d11.atlas, nk_handle_ptr(d3d11.font_texture_view), &d3d11.null); + nk_font_atlas_end(&d3d11.atlas, nk_handle_ptr(d3d11.font_texture_view), &d3d11.tex_null); if (d3d11.atlas.default_font) nk_style_set_font(&d3d11.ctx, &d3d11.atlas.default_font->handle); } diff --git a/demo/d3d12/build.bat b/demo/d3d12/build.bat new file mode 100644 index 0000000..4230207 --- /dev/null +++ b/demo/d3d12/build.bat @@ -0,0 +1,9 @@ +@echo off + +rem This will use VS2015 for compiler... if you have vs 2015 and it is installed at this / the default path +call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86 + +fxc.exe /nologo /T vs_5_1 /E vs /O3 /Zpc /Ges /Fh nuklear_d3d12_vertex_shader.h /Vn nk_d3d12_vertex_shader /Qstrip_reflect /Qstrip_debug /Qstrip_priv nuklear_d3d12.hlsl +fxc.exe /nologo /T ps_5_1 /E ps /O3 /Zpc /Ges /Fh nuklear_d3d12_pixel_shader.h /Vn nk_d3d12_pixel_shader /Qstrip_reflect /Qstrip_debug /Qstrip_priv /enable_unbounded_descriptor_tables nuklear_d3d12.hlsl + +cl /D_CRT_SECURE_NO_DEPRECATE /nologo /W3 /O2 /fp:fast /Gm- /Fedemo.exe main.c user32.lib dxguid.lib dxgi.lib d3d12.lib /link /incremental:no diff --git a/demo/d3d12/main.c b/demo/d3d12/main.c new file mode 100644 index 0000000..f6891e5 --- /dev/null +++ b/demo/d3d12/main.c @@ -0,0 +1,445 @@ +/* nuklear - 1.32.0 - public domain */ +#define COBJMACROS +#define WIN32_LEAN_AND_MEAN +#include +#include +#include +#include +#include +#include +#include +#include + +#define WINDOW_WIDTH 800 +#define WINDOW_HEIGHT 600 +#define USER_TEXTURES 6 + +#define MAX_VERTEX_BUFFER 512 * 1024 +#define MAX_INDEX_BUFFER 128 * 1024 + +#define NK_INCLUDE_FIXED_TYPES +#define NK_INCLUDE_STANDARD_IO +#define NK_INCLUDE_STANDARD_VARARGS +#define NK_INCLUDE_DEFAULT_ALLOCATOR +#define NK_INCLUDE_VERTEX_BUFFER_OUTPUT +#define NK_INCLUDE_FONT_BAKING +#define NK_INCLUDE_DEFAULT_FONT +#define NK_IMPLEMENTATION +#define NK_D3D12_IMPLEMENTATION +#include "../../nuklear.h" +#include "nuklear_d3d12.h" + +/* =============================================================== + * + * EXAMPLE + * + * ===============================================================*/ +/* This are some code examples to provide a small overview of what can be + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ +/*#define INCLUDE_OVERVIEW */ +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif + +/* =============================================================== + * + * DEMO + * + * ===============================================================*/ +/* DXGI & Window related device objects */ +static IDXGIFactory2 *dxgi_factory; +static IDXGISwapChain1 *swap_chain; +static ID3D12DescriptorHeap *rtv_descriptor_heap; +static D3D12_CPU_DESCRIPTOR_HANDLE rtv_handles[2]; +static ID3D12Resource *rtv_buffers[2]; +static UINT rtv_desc_increment; +static UINT rtv_index; +/* DirectX common device objects */ +static ID3D12Device *device; +static ID3D12CommandQueue *command_queue; +static ID3D12Fence *queue_fence; +static UINT64 fence_value; +static ID3D12CommandAllocator *command_allocator; +static ID3D12GraphicsCommandList *command_list; + +static void signal_and_wait() +{ + HRESULT hr; + + /* Signal fence when execution finishes */ + hr = ID3D12CommandQueue_Signal(command_queue, queue_fence, ++fence_value); + assert(SUCCEEDED(hr)); + + /* Wait for queue to finish */ + while(ID3D12Fence_GetCompletedValue(queue_fence) != fence_value) + { + SwitchToThread(); /* Allow windows to do other work */ + } +} + +static void execute_commands() +{ + /* Prepare command list for execution */ + ID3D12GraphicsCommandList_Close(command_list); + + /* Execute on command queue */ + ID3D12CommandList* cmd_lists[] = { (ID3D12CommandList*)command_list}; + ID3D12CommandQueue_ExecuteCommandLists(command_queue, 1, cmd_lists); + + /* Wait for execution */ + signal_and_wait(); + + /* Reset command allocator and list */ + ID3D12CommandAllocator_Reset(command_allocator); + ID3D12GraphicsCommandList_Reset(command_list, command_allocator, NULL); +} + +static void get_swap_chain_buffers() +{ + HRESULT hr; + D3D12_CPU_DESCRIPTOR_HANDLE descriptor_handle; + + /* Get resource objects from swap chain */ + hr = IDXGISwapChain1_GetBuffer(swap_chain, 0, &IID_ID3D12Resource, &rtv_buffers[0]); + assert(SUCCEEDED(hr)); + hr = IDXGISwapChain1_GetBuffer(swap_chain, 1, &IID_ID3D12Resource, &rtv_buffers[1]); + assert(SUCCEEDED(hr)); + + /* Recreate render target views */ + ID3D12DescriptorHeap_GetCPUDescriptorHandleForHeapStart(rtv_descriptor_heap, &descriptor_handle); + ID3D12Device_CreateRenderTargetView(device, rtv_buffers[0], NULL, descriptor_handle); + rtv_handles[0] = descriptor_handle; + descriptor_handle.ptr += rtv_desc_increment; + ID3D12Device_CreateRenderTargetView(device, rtv_buffers[1], NULL, descriptor_handle); + rtv_handles[1] = descriptor_handle; +} + +static void +set_swap_chain_size(int width, int height) +{ + HRESULT hr; + + /* Wait for pending work */ + signal_and_wait(); + signal_and_wait(); /* Two times because we have two buffers in flight */ + + /* Release all open refereces to the buffers */ + ID3D12Resource_Release(rtv_buffers[0]); + ID3D12Resource_Release(rtv_buffers[1]); + + /* DXGI can now perform resizing */ + hr = IDXGISwapChain1_ResizeBuffers(swap_chain, 2, width, height, DXGI_FORMAT_UNKNOWN, DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH); + assert(SUCCEEDED(hr)); + + /* Get references for the new resized buffers */ + get_swap_chain_buffers(); + + /* Reset RTV index */ + rtv_index = 0; +} + +static LRESULT CALLBACK +WindowProc(HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) +{ + switch (msg) + { + case WM_DESTROY: + PostQuitMessage(0); + return 0; + + case WM_SIZE: + if (swap_chain) + { + int width = LOWORD(lparam); + int height = HIWORD(lparam); + set_swap_chain_size(width, height); + nk_d3d12_resize(width, height); + } + break; + } + + if (nk_d3d12_handle_event(wnd, msg, wparam, lparam)) + return 0; + + return DefWindowProcW(wnd, msg, wparam, lparam); +} + +int main(void) +{ + struct nk_context *ctx; + struct nk_colorf bg; + + WNDCLASSW wc; + RECT rect = { 0, 0, WINDOW_WIDTH, WINDOW_HEIGHT }; + DWORD style = WS_OVERLAPPEDWINDOW; + DWORD exstyle = WS_EX_APPWINDOW; + HWND wnd; + int running = 1; + HRESULT hr; + + D3D12_COMMAND_QUEUE_DESC command_queue_desc; + DXGI_SWAP_CHAIN_DESC1 swap_chain_desc; + D3D12_DESCRIPTOR_HEAP_DESC rtv_desc_heap_desc; + + /* Win32 */ + memset(&wc, 0, sizeof(wc)); + wc.style = CS_DBLCLKS; + wc.lpfnWndProc = WindowProc; + wc.hInstance = GetModuleHandleW(0); + wc.hIcon = LoadIcon(NULL, IDI_APPLICATION); + wc.hCursor = LoadCursor(NULL, IDC_ARROW); + wc.lpszClassName = L"NuklearWindowClass"; + RegisterClassW(&wc); + + AdjustWindowRectEx(&rect, style, FALSE, exstyle); + + wnd = CreateWindowExW(exstyle, wc.lpszClassName, L"Nuklear Demo", + style | WS_VISIBLE, CW_USEDEFAULT, CW_USEDEFAULT, + rect.right - rect.left, rect.bottom - rect.top, + NULL, NULL, wc.hInstance, NULL); + + /* D3D12 setup */ + /* Create default Device */ + hr = D3D12CreateDevice(NULL, D3D_FEATURE_LEVEL_11_0, &IID_ID3D12Device, &device); + assert(SUCCEEDED(hr)); + /* Create a command queue */ + command_queue_desc.Type = D3D12_COMMAND_LIST_TYPE_DIRECT; + command_queue_desc.Priority = D3D12_COMMAND_QUEUE_PRIORITY_NORMAL; + command_queue_desc.Flags = D3D12_COMMAND_QUEUE_FLAG_NONE; + command_queue_desc.NodeMask = 0; + hr = ID3D12Device_CreateCommandQueue(device, &command_queue_desc, &IID_ID3D12CommandQueue, &command_queue); + assert(SUCCEEDED(hr)); + /* Create a fence for command queue executions */ + fence_value = 0; + hr = ID3D12Device_CreateFence(device, fence_value, D3D12_FENCE_FLAG_NONE, &IID_ID3D12Fence, &queue_fence); + assert(SUCCEEDED(hr)); + /* Create a command allocator */ + hr = ID3D12Device_CreateCommandAllocator(device, D3D12_COMMAND_LIST_TYPE_DIRECT, &IID_ID3D12CommandAllocator, &command_allocator); + assert(SUCCEEDED(hr)); + /* Create a command list that will use our allocator */ + hr = ID3D12Device_CreateCommandList(device, 0, D3D12_COMMAND_LIST_TYPE_DIRECT, command_allocator, NULL, &IID_ID3D12GraphicsCommandList1, &command_list); + assert(SUCCEEDED(hr)); + + /* DXGI Setup (Swap chain & resources) */ + /* Create a descriptor heap for the back buffers */ + rtv_desc_heap_desc.Type = D3D12_DESCRIPTOR_HEAP_TYPE_RTV; + rtv_desc_heap_desc.NumDescriptors = 2; + rtv_desc_heap_desc.Flags = D3D12_DESCRIPTOR_HEAP_FLAG_NONE; + rtv_desc_heap_desc.NodeMask = 0; + hr = ID3D12Device_CreateDescriptorHeap(device, &rtv_desc_heap_desc, &IID_ID3D12DescriptorHeap, &rtv_descriptor_heap); + assert(SUCCEEDED(hr)); + /* Get descriptor increment */ + rtv_desc_increment = ID3D12Device_GetDescriptorHandleIncrementSize(device, D3D12_DESCRIPTOR_HEAP_TYPE_RTV); + /* Get the DXGI factory */ + hr = CreateDXGIFactory1(&IID_IDXGIFactory2, &dxgi_factory); + assert(SUCCEEDED(hr)); + /* Create the swap chain */ + swap_chain_desc.Width = WINDOW_WIDTH; + swap_chain_desc.Height = WINDOW_HEIGHT; + swap_chain_desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; + swap_chain_desc.Stereo = 0; + swap_chain_desc.SampleDesc.Count = 1; + swap_chain_desc.SampleDesc.Quality = 0; + swap_chain_desc.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT; + swap_chain_desc.BufferCount = 2; + swap_chain_desc.Scaling = DXGI_SCALING_STRETCH; + swap_chain_desc.SwapEffect = DXGI_SWAP_EFFECT_FLIP_SEQUENTIAL ; + swap_chain_desc.AlphaMode = DXGI_ALPHA_MODE_IGNORE; + swap_chain_desc.Flags = DXGI_SWAP_CHAIN_FLAG_ALLOW_MODE_SWITCH; + hr = IDXGIFactory2_CreateSwapChainForHwnd(dxgi_factory, (IUnknown*)command_queue, wnd, &swap_chain_desc, NULL, NULL, &swap_chain); + assert(SUCCEEDED(hr)); + get_swap_chain_buffers(); + + /* GUI */ + ctx = nk_d3d12_init(device, WINDOW_WIDTH, WINDOW_HEIGHT, MAX_VERTEX_BUFFER, MAX_INDEX_BUFFER, USER_TEXTURES); + + /* Load Fonts: if none of these are loaded a default font will be used */ + /* Load Cursor: if you uncomment cursor loading please hide the cursor */ + { + struct nk_font_atlas *atlas; + nk_d3d12_font_stash_begin(&atlas); + /*struct nk_font *droid = nk_font_atlas_add_from_file(atlas, "../../extra_font/DroidSans.ttf", 14, 0);*/ + /*struct nk_font *robot = nk_font_atlas_add_from_file(atlas, "../../extra_font/Roboto-Regular.ttf", 14, 0);*/ + /*struct nk_font *future = nk_font_atlas_add_from_file(atlas, "../../extra_font/kenvector_future_thin.ttf", 13, 0);*/ + /*struct nk_font *clean = nk_font_atlas_add_from_file(atlas, "../../extra_font/ProggyClean.ttf", 12, 0);*/ + /*struct nk_font *tiny = nk_font_atlas_add_from_file(atlas, "../../extra_font/ProggyTiny.ttf", 10, 0);*/ + /*struct nk_font *cousine = nk_font_atlas_add_from_file(atlas, "../../extra_font/Cousine-Regular.ttf", 13, 0);*/ + nk_d3d12_font_stash_end(command_list); + /*nk_style_load_all_cursors(ctx, atlas->cursors);*/ + /*nk_style_set_font(ctx, &droid->handle)*/; + } + + /* Execute the command list to make sure all texture (font) data has been uploaded */ + execute_commands(); + /* Now we can cleanup all resources consumed by font stashing that are no longer used */ + nk_d3d12_font_stash_cleanup(); + + /* style.c */ + #ifdef INCLUDE_STYLE + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif + #endif + + bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; + while (running) + { + /* Input */ + MSG msg; + nk_input_begin(ctx); + while (PeekMessageW(&msg, NULL, 0, 0, PM_REMOVE)) + { + if (msg.message == WM_QUIT) + running = 0; + TranslateMessage(&msg); + DispatchMessageW(&msg); + } + nk_input_end(ctx); + + /* GUI */ + if (nk_begin(ctx, "Demo", nk_rect(50, 50, 230, 250), + NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_SCALABLE| + NK_WINDOW_MINIMIZABLE|NK_WINDOW_TITLE)) + { + enum {EASY, HARD}; + static int op = EASY; + static int property = 20; + + nk_layout_row_static(ctx, 30, 80, 1); + if (nk_button_label(ctx, "button")) + fprintf(stdout, "button pressed\n"); + nk_layout_row_dynamic(ctx, 30, 2); + if (nk_option_label(ctx, "easy", op == EASY)) op = EASY; + if (nk_option_label(ctx, "hard", op == HARD)) op = HARD; + nk_layout_row_dynamic(ctx, 22, 1); + nk_property_int(ctx, "Compression:", 0, &property, 100, 10, 1); + + nk_layout_row_dynamic(ctx, 20, 1); + nk_label(ctx, "background:", NK_TEXT_LEFT); + nk_layout_row_dynamic(ctx, 25, 1); + if (nk_combo_begin_color(ctx, nk_rgb_cf(bg), nk_vec2(nk_widget_width(ctx),400))) { + nk_layout_row_dynamic(ctx, 120, 1); + bg = nk_color_picker(ctx, bg, NK_RGBA); + nk_layout_row_dynamic(ctx, 25, 1); + bg.r = nk_propertyf(ctx, "#R:", 0, bg.r, 1.0f, 0.01f,0.005f); + bg.g = nk_propertyf(ctx, "#G:", 0, bg.g, 1.0f, 0.01f,0.005f); + bg.b = nk_propertyf(ctx, "#B:", 0, bg.b, 1.0f, 0.01f,0.005f); + bg.a = nk_propertyf(ctx, "#A:", 0, bg.a, 1.0f, 0.01f,0.005f); + nk_combo_end(ctx); + } + } + nk_end(ctx); + + /* -------------- EXAMPLES ---------------- */ + #ifdef INCLUDE_CALCULATOR + calculator(ctx); + #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif + #ifdef INCLUDE_OVERVIEW + overview(ctx); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(ctx); + #endif + /* ----------------------------------------- */ + + /* Set rtv resource state */ + D3D12_RESOURCE_BARRIER resource_barrier; + resource_barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barrier.Transition.pResource = rtv_buffers[rtv_index]; + resource_barrier.Transition.Subresource = 0; + resource_barrier.Transition.StateBefore = D3D12_RESOURCE_STATE_PRESENT; + resource_barrier.Transition.StateAfter = D3D12_RESOURCE_STATE_RENDER_TARGET; + resource_barrier.Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + ID3D12GraphicsCommandList_ResourceBarrier(command_list, 1, &resource_barrier); + + /* Clear and set the rtv */ + ID3D12GraphicsCommandList_ClearRenderTargetView(command_list, rtv_handles[rtv_index], &bg.r, 0, NULL); + ID3D12GraphicsCommandList_OMSetRenderTargets(command_list, 1, &rtv_handles[rtv_index], FALSE, NULL); + + /* Draw */ + nk_d3d12_render(command_list, NK_ANTI_ALIASING_ON); + + /* Bring the rtv resource back to present state */ + resource_barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barrier.Transition.pResource = rtv_buffers[rtv_index]; + resource_barrier.Transition.Subresource = 0; + resource_barrier.Transition.StateBefore = D3D12_RESOURCE_STATE_RENDER_TARGET; + resource_barrier.Transition.StateAfter = D3D12_RESOURCE_STATE_PRESENT; + resource_barrier.Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + ID3D12GraphicsCommandList_ResourceBarrier(command_list, 1, &resource_barrier); + + /* Execute command list and wait */ + execute_commands(); + + /* Present frame */ + hr = IDXGISwapChain2_Present(swap_chain, 1, 0); + rtv_index = (rtv_index + 1) % 2; + if (hr == DXGI_ERROR_DEVICE_RESET || hr == DXGI_ERROR_DEVICE_REMOVED) { + /* to recover from this, you'll need to recreate device and all the resources */ + MessageBoxW(NULL, L"D3D12 device is lost or removed!", L"Error", 0); + break; + } else if (hr == DXGI_STATUS_OCCLUDED) { + /* window is not visible, so vsync won't work. Let's sleep a bit to reduce CPU usage */ + Sleep(10); + } + assert(SUCCEEDED(hr)); + } + + /* Nuklear shutdown */ + nk_d3d12_shutdown(); + + /* D3D12 and DXGI shutdown */ + signal_and_wait(); + signal_and_wait(); /* Two times because we have two buffers in flight */ + ID3D12Resource_Release(rtv_buffers[0]); + ID3D12Resource_Release(rtv_buffers[1]); + ID3D12DescriptorHeap_Release(rtv_descriptor_heap); + IDXGISwapChain1_Release(swap_chain); + IDXGIFactory2_Release(dxgi_factory); + ID3D12GraphicsCommandList_Release(command_list); + ID3D12CommandAllocator_Release(command_allocator); + ID3D12CommandQueue_Release(command_queue); + ID3D12Fence_Release(queue_fence); + ID3D12Device_Release(device); + + /* win32 shutdown */ + UnregisterClassW(wc.lpszClassName, wc.hInstance); + + return 0; +} diff --git a/demo/d3d12/nuklear_d3d12.h b/demo/d3d12/nuklear_d3d12.h new file mode 100644 index 0000000..5b86ea1 --- /dev/null +++ b/demo/d3d12/nuklear_d3d12.h @@ -0,0 +1,928 @@ +/* + * Nuklear - 1.32.0 - public domain + * no warrenty implied; use at your own risk. + * authored from 2015-2016 by Micha Mettke + * + * D3D12 backend created by Ludwig Fuechsl (2022) + */ +/* + * ============================================================== + * + * API + * + * =============================================================== + */ +#ifndef NK_D3D12_H_ +#define NK_D3D12_H_ + +#define WIN32_LEAN_AND_MEAN +#include + +/* + * USAGE: + * - This function will initialize a new nuklear rendering context. The context will be bound to a GLOBAL DirectX 12 rendering state. + */ +NK_API struct nk_context *nk_d3d12_init(ID3D12Device *device, int width, int height, unsigned int max_vertex_buffer, unsigned int max_index_buffer, unsigned int max_user_textures); +/* + * USAGE: + * - A call to this function prepares the global nuklear d3d12 backend for receiving font information’s. Use the obtained atlas pointer to load all required fonts and do all required font setup. + */ +NK_API void nk_d3d12_font_stash_begin(struct nk_font_atlas **atlas); +/* + * USAGE: + * - Call this function after a call to nk_d3d12_font_stash_begin(...) when all fonts have been loaded and configured. + * - This function will place commands on the supplied ID3D12GraphicsCommandList. + * - This function will allocate temporary data that is required until the command list has finish executing. The temporary data can be free by calling nk_d3d12_font_stash_cleanup(...) + */ +NK_API void nk_d3d12_font_stash_end(ID3D12GraphicsCommandList *command_list); +/* + * USAGE: + * - This function will free temporary data that was allocated by nk_d3d12_font_stash_begin(...) + * - Only call this function after the command list used in the nk_d3d12_font_stash_begin(...) function call has finished executing. + * - It is NOT required to call this function but highly recommended. + */ +NK_API void nk_d3d12_font_stash_cleanup(); +/* + * USAGE: + * - This function will setup the supplied texture (ID3D12Resource) for rendering custom images using the supplied D3D12_SHADER_RESOURCE_VIEW_DESC. + * - This function may override any previous calls to nk_d3d12_set_user_texture(...) while using the same index. + * - The returned handle can be used as texture handle to render custom images. + * - The caller must keep track of the state of the texture when it comes to rendering with nk_d3d12_render(...). + */ +NK_API nk_bool nk_d3d12_set_user_texture(unsigned int index, ID3D12Resource* texture, const D3D12_SHADER_RESOURCE_VIEW_DESC* description, nk_handle* handle_out); +/* + * USAGE: + * - This function should be called within the user window proc to allow nuklear to listen to window events + */ +NK_API int nk_d3d12_handle_event(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam); +/* + * USAGE: + * - A call to this function renders any previous placed nuklear draw calls and will flush all nuklear buffers for the next frame + * - This function will place commands on the supplied ID3D12GraphicsCommandList. + * - When using custom images for rendering make sure they are in the correct resource state (D3D12_RESOURCE_STATE_PIXEL_SHADER_RESOURCE) when calling this function. + * - This function will upload data to the gpu (64 + max_vertex_buffer + max_index_buffer BYTES). + */ +NK_API void nk_d3d12_render(ID3D12GraphicsCommandList *command_list, enum nk_anti_aliasing AA); +/* + * USAGE: + * - This function will notify nuklear that the framebuffer dimensions have changed. + */ +NK_API void nk_d3d12_resize(int width, int height); +/* + * USAGE: + * - This function will free the global d3d12 rendering state. + */ +NK_API void nk_d3d12_shutdown(void); + +#endif +/* + * ============================================================== + * + * IMPLEMENTATION + * + * =============================================================== + */ +#ifdef NK_D3D12_IMPLEMENTATION + +#define WIN32_LEAN_AND_MEAN +#define COBJMACROS +#include + +#include +#include +#include +#include + +#include "nuklear_d3d12_vertex_shader.h" +#include "nuklear_d3d12_pixel_shader.h" + +struct nk_d3d12_vertex +{ + float position[2]; + float uv[2]; + nk_byte col[4]; +}; + +static struct +{ + struct nk_context ctx; + struct nk_font_atlas atlas; + struct nk_buffer cmds; + + struct nk_draw_null_texture tex_null; + unsigned int max_vertex_buffer; + unsigned int max_index_buffer; + unsigned int max_user_textures; + + D3D12_HEAP_PROPERTIES heap_prop_default; + D3D12_HEAP_PROPERTIES heap_prop_upload; + + UINT cbv_srv_uav_desc_increment; + + D3D12_VIEWPORT viewport; + ID3D12Device *device; + ID3D12RootSignature *root_signature; + ID3D12PipelineState *pipeline_state; + ID3D12DescriptorHeap *desc_heap; + ID3D12Resource *font_texture; + ID3D12Resource *font_upload_buffer; + ID3D12Resource *upload_buffer; + ID3D12Resource *const_buffer; + ID3D12Resource *index_buffer; + ID3D12Resource *vertex_buffer; + + D3D12_CPU_DESCRIPTOR_HANDLE cpu_descriptor_handle; + D3D12_GPU_DESCRIPTOR_HANDLE gpu_descriptor_handle; + D3D12_GPU_VIRTUAL_ADDRESS gpu_vertex_buffer_address; + D3D12_GPU_VIRTUAL_ADDRESS gpu_index_buffer_address; +} d3d12; + +NK_API void +nk_d3d12_render(ID3D12GraphicsCommandList *command_list, enum nk_anti_aliasing AA) +{ + HRESULT hr; +#ifdef NK_UINT_DRAW_INDEX + DXGI_FORMAT index_buffer_format = DXGI_FORMAT_R32_UINT; +#else + DXGI_FORMAT index_buffer_format = DXGI_FORMAT_R16_UINT; +#endif + const UINT stride = sizeof(struct nk_d3d12_vertex); + const struct nk_draw_command *cmd; + UINT offset = 0; + D3D12_VERTEX_BUFFER_VIEW vertex_buffer_view; + D3D12_INDEX_BUFFER_VIEW index_buffer_view; + unsigned char* ptr_data; + D3D12_RANGE map_range; + D3D12_RESOURCE_BARRIER resource_barriers[3]; + + /* Activate D3D12 pipeline state and config root signature */ + ID3D12GraphicsCommandList_SetPipelineState(command_list, d3d12.pipeline_state); + ID3D12GraphicsCommandList_SetGraphicsRootSignature(command_list, d3d12.root_signature); + ID3D12GraphicsCommandList_SetDescriptorHeaps(command_list, 1, &d3d12.desc_heap); + ID3D12GraphicsCommandList_SetGraphicsRootDescriptorTable(command_list, 0, d3d12.gpu_descriptor_handle); + + /* Configure rendering pipeline */ + ID3D12GraphicsCommandList_IASetPrimitiveTopology(command_list, D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST); + vertex_buffer_view.BufferLocation = d3d12.gpu_vertex_buffer_address; + vertex_buffer_view.SizeInBytes = d3d12.max_vertex_buffer; + vertex_buffer_view.StrideInBytes = stride; + ID3D12GraphicsCommandList_IASetVertexBuffers(command_list, 0, 1, &vertex_buffer_view); + index_buffer_view.BufferLocation = d3d12.gpu_index_buffer_address; + index_buffer_view.Format = index_buffer_format; + index_buffer_view.SizeInBytes = d3d12.max_index_buffer; + ID3D12GraphicsCommandList_IASetIndexBuffer(command_list, &index_buffer_view); + ID3D12GraphicsCommandList_RSSetViewports(command_list, 1, &d3d12.viewport); + + /* Map upload buffer to cpu accessible pointer */ + map_range.Begin = sizeof(float) * 4 * 4; + map_range.End = map_range.Begin + d3d12.max_vertex_buffer + d3d12.max_index_buffer; + hr = ID3D12Resource_Map(d3d12.upload_buffer, 0, &map_range, &ptr_data); + NK_ASSERT(SUCCEEDED(hr)); + + /* Nuklear convert and copy to upload buffer */ + { + struct nk_convert_config config; + NK_STORAGE const struct nk_draw_vertex_layout_element vertex_layout[] = { + {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_d3d12_vertex, position)}, + {NK_VERTEX_TEXCOORD, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_d3d12_vertex, uv)}, + {NK_VERTEX_COLOR, NK_FORMAT_R8G8B8A8, NK_OFFSETOF(struct nk_d3d12_vertex, col)}, + {NK_VERTEX_LAYOUT_END} + }; + memset(&config, 0, sizeof(config)); + config.vertex_layout = vertex_layout; + config.vertex_size = sizeof(struct nk_d3d12_vertex); + config.vertex_alignment = NK_ALIGNOF(struct nk_d3d12_vertex); + config.global_alpha = 1.0f; + config.shape_AA = AA; + config.line_AA = AA; + config.circle_segment_count = 22; + config.curve_segment_count = 22; + config.arc_segment_count = 22; + config.tex_null = d3d12.tex_null; + + struct nk_buffer vbuf, ibuf; + nk_buffer_init_fixed(&vbuf, &ptr_data[sizeof(float) * 4 * 4], (size_t)d3d12.max_vertex_buffer); + nk_buffer_init_fixed(&ibuf, &ptr_data[sizeof(float) * 4 * 4 + d3d12.max_vertex_buffer], (size_t)d3d12.max_index_buffer); + nk_convert(&d3d12.ctx, &d3d12.cmds, &vbuf, &ibuf, &config); + } + + /* Close mapping range */ + ID3D12Resource_Unmap(d3d12.upload_buffer, 0, &map_range); + + /* Issue GPU resource change for copying */ + resource_barriers[0].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[0].Transition.pResource = d3d12.const_buffer; + resource_barriers[0].Transition.Subresource = 0; + resource_barriers[0].Transition.StateBefore = D3D12_RESOURCE_STATE_VERTEX_AND_CONSTANT_BUFFER; + resource_barriers[0].Transition.StateAfter = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[0].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + resource_barriers[1].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[1].Transition.pResource = d3d12.vertex_buffer; + resource_barriers[1].Transition.Subresource = 0; + resource_barriers[1].Transition.StateBefore = D3D12_RESOURCE_STATE_VERTEX_AND_CONSTANT_BUFFER; + resource_barriers[1].Transition.StateAfter = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[1].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + resource_barriers[2].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[2].Transition.pResource = d3d12.index_buffer; + resource_barriers[2].Transition.Subresource = 0; + resource_barriers[2].Transition.StateBefore = D3D12_RESOURCE_STATE_INDEX_BUFFER; + resource_barriers[2].Transition.StateAfter = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[2].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + ID3D12GraphicsCommandList_ResourceBarrier(command_list, 3, resource_barriers); + + /* Copy from upload buffer to gpu buffers */ + ID3D12GraphicsCommandList_CopyBufferRegion(command_list, d3d12.const_buffer, 0, d3d12.upload_buffer, 0, sizeof(float) * 4 * 4); + ID3D12GraphicsCommandList_CopyBufferRegion(command_list, d3d12.vertex_buffer, 0, d3d12.upload_buffer, sizeof(float) * 4 * 4, d3d12.max_vertex_buffer); + ID3D12GraphicsCommandList_CopyBufferRegion(command_list, d3d12.index_buffer, 0, d3d12.upload_buffer, sizeof(float) * 4 * 4 + d3d12.max_vertex_buffer, d3d12.max_index_buffer); + + /* Issue GPU resource change for rendering */ + resource_barriers[0].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[0].Transition.pResource = d3d12.const_buffer; + resource_barriers[0].Transition.Subresource = 0; + resource_barriers[0].Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[0].Transition.StateAfter = D3D12_RESOURCE_STATE_VERTEX_AND_CONSTANT_BUFFER; + resource_barriers[0].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + resource_barriers[1].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[1].Transition.pResource = d3d12.vertex_buffer; + resource_barriers[1].Transition.Subresource = 0; + resource_barriers[1].Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[1].Transition.StateAfter = D3D12_RESOURCE_STATE_VERTEX_AND_CONSTANT_BUFFER; + resource_barriers[1].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + resource_barriers[2].Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barriers[2].Transition.pResource = d3d12.index_buffer; + resource_barriers[2].Transition.Subresource = 0; + resource_barriers[2].Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barriers[2].Transition.StateAfter = D3D12_RESOURCE_STATE_INDEX_BUFFER; + resource_barriers[2].Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + ID3D12GraphicsCommandList_ResourceBarrier(command_list, 3, resource_barriers); + + /* Issue draw commands */ + nk_draw_foreach(cmd, &d3d12.ctx, &d3d12.cmds) + { + D3D12_RECT scissor; + UINT32 texture_id; + + /* Only place a drawcall in case the command contains drawable data */ + if(cmd->elem_count) + { + /* Setup scissor rect */ + scissor.left = (LONG)cmd->clip_rect.x; + scissor.right = (LONG)(cmd->clip_rect.x + cmd->clip_rect.w); + scissor.top = (LONG)cmd->clip_rect.y; + scissor.bottom = (LONG)(cmd->clip_rect.y + cmd->clip_rect.h); + ID3D12GraphicsCommandList_RSSetScissorRects(command_list, 1, &scissor); + + /* Setup texture (index to descriptor heap table) to use for draw call */ + texture_id = (UINT32)cmd->texture.id; + ID3D12GraphicsCommandList_SetGraphicsRoot32BitConstants(command_list, 1, 1, &texture_id, 0); + + /* Dispatch draw call */ + ID3D12GraphicsCommandList_DrawIndexedInstanced(command_list, (UINT)cmd->elem_count, 1, offset, 0, 0); + offset += cmd->elem_count; + } + } + + /* Default nuklear context and command buffer clear */ + nk_clear(&d3d12.ctx); + nk_buffer_clear(&d3d12.cmds); +} + +static void +nk_d3d12_get_projection_matrix(int width, int height, float *result) +{ + const float L = 0.0f; + const float R = (float)width; + const float T = 0.0f; + const float B = (float)height; + float matrix[4][4] = + { + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.5f, 0.0f }, + { 0.0f, 0.0f, 0.5f, 1.0f }, + }; + matrix[0][0] = 2.0f / (R - L); + matrix[1][1] = 2.0f / (T - B); + matrix[3][0] = (R + L) / (L - R); + matrix[3][1] = (T + B) / (B - T); + memcpy(result, matrix, sizeof(matrix)); +} + +NK_API void +nk_d3d12_resize(int width, int height) +{ + D3D12_RANGE map_range; + void* ptr_data; + + /* Describe area to be mapped (the upload buffer region where the constant buffer / projection matrix) lives */ + map_range.Begin = 0; + map_range.End = sizeof(float) * 4 * 4; + + /* Map area to cpu accassible pointer (from upload buffer) */ + if (SUCCEEDED(ID3D12Resource_Map(d3d12.upload_buffer, 0, &map_range, &ptr_data))) + { + /* Compute projection matrix into upload buffer */ + nk_d3d12_get_projection_matrix(width, height, (float*)ptr_data); + ID3D12Resource_Unmap(d3d12.upload_buffer, 0, &map_range); + + /* Update internal viewport state to relect resize changes */ + d3d12.viewport.Width = (float)width; + d3d12.viewport.Height = (float)height; + } + + /* + NOTE: + When mapping and copying succeeds, the data will still be in CPU sided memory + copying to the GPU is done in the nk_d3d12_render function + */ +} + +NK_API int +nk_d3d12_handle_event(HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) +{ + switch (msg) + { + case WM_KEYDOWN: + case WM_KEYUP: + case WM_SYSKEYDOWN: + case WM_SYSKEYUP: + { + int down = !((lparam >> 31) & 1); + int ctrl = GetKeyState(VK_CONTROL) & (1 << 15); + + switch (wparam) + { + case VK_SHIFT: + case VK_LSHIFT: + case VK_RSHIFT: + nk_input_key(&d3d12.ctx, NK_KEY_SHIFT, down); + return 1; + + case VK_DELETE: + nk_input_key(&d3d12.ctx, NK_KEY_DEL, down); + return 1; + + case VK_RETURN: + nk_input_key(&d3d12.ctx, NK_KEY_ENTER, down); + return 1; + + case VK_TAB: + nk_input_key(&d3d12.ctx, NK_KEY_TAB, down); + return 1; + + case VK_LEFT: + if (ctrl) + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_WORD_LEFT, down); + else + nk_input_key(&d3d12.ctx, NK_KEY_LEFT, down); + return 1; + + case VK_RIGHT: + if (ctrl) + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else + nk_input_key(&d3d12.ctx, NK_KEY_RIGHT, down); + return 1; + + case VK_BACK: + nk_input_key(&d3d12.ctx, NK_KEY_BACKSPACE, down); + return 1; + + case VK_HOME: + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_START, down); + nk_input_key(&d3d12.ctx, NK_KEY_SCROLL_START, down); + return 1; + + case VK_END: + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_END, down); + nk_input_key(&d3d12.ctx, NK_KEY_SCROLL_END, down); + return 1; + + case VK_NEXT: + nk_input_key(&d3d12.ctx, NK_KEY_SCROLL_DOWN, down); + return 1; + + case VK_PRIOR: + nk_input_key(&d3d12.ctx, NK_KEY_SCROLL_UP, down); + return 1; + + case 'C': + if (ctrl) { + nk_input_key(&d3d12.ctx, NK_KEY_COPY, down); + return 1; + } + break; + + case 'V': + if (ctrl) { + nk_input_key(&d3d12.ctx, NK_KEY_PASTE, down); + return 1; + } + break; + + case 'X': + if (ctrl) { + nk_input_key(&d3d12.ctx, NK_KEY_CUT, down); + return 1; + } + break; + + case 'Z': + if (ctrl) { + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_UNDO, down); + return 1; + } + break; + + case 'R': + if (ctrl) { + nk_input_key(&d3d12.ctx, NK_KEY_TEXT_REDO, down); + return 1; + } + break; + } + return 0; + } + + case WM_CHAR: + if (wparam >= 32) + { + nk_input_unicode(&d3d12.ctx, (nk_rune)wparam); + return 1; + } + break; + + case WM_LBUTTONDOWN: + nk_input_button(&d3d12.ctx, NK_BUTTON_LEFT, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_LBUTTONUP: + nk_input_button(&d3d12.ctx, NK_BUTTON_DOUBLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + nk_input_button(&d3d12.ctx, NK_BUTTON_LEFT, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_RBUTTONDOWN: + nk_input_button(&d3d12.ctx, NK_BUTTON_RIGHT, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_RBUTTONUP: + nk_input_button(&d3d12.ctx, NK_BUTTON_RIGHT, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_MBUTTONDOWN: + nk_input_button(&d3d12.ctx, NK_BUTTON_MIDDLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_MBUTTONUP: + nk_input_button(&d3d12.ctx, NK_BUTTON_MIDDLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_MOUSEWHEEL: + nk_input_scroll(&d3d12.ctx, nk_vec2(0,(float)(short)HIWORD(wparam) / WHEEL_DELTA)); + return 1; + + case WM_MOUSEMOVE: + nk_input_motion(&d3d12.ctx, (short)LOWORD(lparam), (short)HIWORD(lparam)); + return 1; + + case WM_LBUTTONDBLCLK: + nk_input_button(&d3d12.ctx, NK_BUTTON_DOUBLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + return 1; + } + + return 0; +} + +static void +nk_d3d12_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) +{ + (void)usr; + if (IsClipboardFormatAvailable(CF_UNICODETEXT) && OpenClipboard(NULL)) + { + HGLOBAL mem = GetClipboardData(CF_UNICODETEXT); + if (mem) + { + SIZE_T size = GlobalSize(mem) - 1; + if (size) + { + LPCWSTR wstr = (LPCWSTR)GlobalLock(mem); + if (wstr) + { + int utf8size = WideCharToMultiByte(CP_UTF8, 0, wstr, size / sizeof(wchar_t), NULL, 0, NULL, NULL); + if (utf8size) + { + char* utf8 = (char*)malloc(utf8size); + if (utf8) + { + WideCharToMultiByte(CP_UTF8, 0, wstr, size / sizeof(wchar_t), utf8, utf8size, NULL, NULL); + nk_textedit_paste(edit, utf8, utf8size); + free(utf8); + } + } + GlobalUnlock(mem); + } + } + } + CloseClipboard(); + } +} + +static void +nk_d3d12_clipboard_copy(nk_handle usr, const char *text, int len) +{ + (void)usr; + if (OpenClipboard(NULL)) + { + int wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); + if (wsize) + { + HGLOBAL mem = GlobalAlloc(GMEM_MOVEABLE, (wsize + 1) * sizeof(wchar_t)); + if (mem) + { + wchar_t* wstr = (wchar_t*)GlobalLock(mem); + if (wstr) + { + MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); + wstr[wsize] = 0; + GlobalUnlock(mem); + SetClipboardData(CF_UNICODETEXT, mem); + } + } + } + CloseClipboard(); + } +} + +NK_API struct nk_context* +nk_d3d12_init(ID3D12Device *device, int width, int height, unsigned int max_vertex_buffer, unsigned int max_index_buffer, unsigned int max_user_textures) +{ + HRESULT hr; + D3D12_CONSTANT_BUFFER_VIEW_DESC cbv; + D3D12_CPU_DESCRIPTOR_HANDLE cbv_handle; + + /* Do plain object / ref copys */ + d3d12.max_vertex_buffer = max_vertex_buffer; + d3d12.max_index_buffer = max_index_buffer; + d3d12.max_user_textures = max_user_textures; + d3d12.device = device; + ID3D12Device_AddRef(device); + d3d12.font_texture = NULL; + d3d12.font_upload_buffer = NULL; + + /* Init nuklear context */ + nk_init_default(&d3d12.ctx, 0); + d3d12.ctx.clip.copy = nk_d3d12_clipboard_copy; + d3d12.ctx.clip.paste = nk_d3d12_clipboard_paste; + d3d12.ctx.clip.userdata = nk_handle_ptr(0); + + /* Init nuklear buffer */ + nk_buffer_init_default(&d3d12.cmds); + + /* Define Heap properties */ + d3d12.heap_prop_default.Type = D3D12_HEAP_TYPE_DEFAULT; + d3d12.heap_prop_default.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN; + d3d12.heap_prop_default.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN; + d3d12.heap_prop_default.CreationNodeMask = 0; + d3d12.heap_prop_default.VisibleNodeMask = 0; + d3d12.heap_prop_upload.Type = D3D12_HEAP_TYPE_UPLOAD; + d3d12.heap_prop_upload.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN; + d3d12.heap_prop_upload.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN; + d3d12.heap_prop_upload.CreationNodeMask = 0; + d3d12.heap_prop_upload.VisibleNodeMask = 0; + + /* Create data objects */ + /* Create upload buffer */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = (sizeof(float) * 4 * 4) + max_vertex_buffer + max_index_buffer; /* Needs to hold matrix + vertices + indicies */ + desc.Height = 1; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_UNKNOWN; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(device, &d3d12.heap_prop_upload, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COPY_SOURCE, NULL, &IID_ID3D12Resource, &d3d12.upload_buffer); + NK_ASSERT(SUCCEEDED(hr)); + } + /* Create constant buffer */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = 256; /* Should be sizeof(float) * 4 * 4 - but this does not match how d3d12 works (min CBV size of 256) */ + desc.Height = 1; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_UNKNOWN; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(device, &d3d12.heap_prop_default, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COMMON, NULL, &IID_ID3D12Resource, &d3d12.const_buffer); + NK_ASSERT(SUCCEEDED(hr)); + } + /* Create vertex buffer */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = max_vertex_buffer; + desc.Height = 1; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_UNKNOWN; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(device, &d3d12.heap_prop_default, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COMMON, NULL, &IID_ID3D12Resource, &d3d12.vertex_buffer); + NK_ASSERT(SUCCEEDED(hr)); + } + /* Create index buffer */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = max_index_buffer; + desc.Height = 1; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_UNKNOWN; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(device, &d3d12.heap_prop_default, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COMMON, NULL, &IID_ID3D12Resource, &d3d12.index_buffer); + NK_ASSERT(SUCCEEDED(hr)); + } + + /* Create descriptor heap for shader root signature */ + { + D3D12_DESCRIPTOR_HEAP_DESC desc; + desc.Type = D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV; + desc.NumDescriptors = 2 + max_user_textures; + desc.Flags = D3D12_DESCRIPTOR_HEAP_FLAG_SHADER_VISIBLE; + desc.NodeMask = 0; + ID3D12Device_CreateDescriptorHeap(device, &desc, &IID_ID3D12DescriptorHeap, &d3d12.desc_heap); + } + + /* Get address of first handle (CPU and GPU) */ + ID3D12DescriptorHeap_GetCPUDescriptorHandleForHeapStart(d3d12.desc_heap, &d3d12.cpu_descriptor_handle); + ID3D12DescriptorHeap_GetGPUDescriptorHandleForHeapStart(d3d12.desc_heap, &d3d12.gpu_descriptor_handle); + + /* Get addresses of vertex & index buffers */ + d3d12.gpu_vertex_buffer_address = ID3D12Resource_GetGPUVirtualAddress(d3d12.vertex_buffer); + d3d12.gpu_index_buffer_address = ID3D12Resource_GetGPUVirtualAddress(d3d12.index_buffer); + + /* Get handle increment */ + d3d12.cbv_srv_uav_desc_increment = ID3D12Device_GetDescriptorHandleIncrementSize(device, D3D12_DESCRIPTOR_HEAP_TYPE_CBV_SRV_UAV); + + /* Create view to constant buffer */ + cbv.BufferLocation = ID3D12Resource_GetGPUVirtualAddress(d3d12.const_buffer); + cbv.SizeInBytes = 256; + cbv_handle = d3d12.cpu_descriptor_handle; + ID3D12Device_CreateConstantBufferView(device, &cbv, cbv_handle); + + /* Create root signature */ + hr = ID3D12Device_CreateRootSignature(device, 0, nk_d3d12_vertex_shader, sizeof(nk_d3d12_vertex_shader), &IID_ID3D12RootSignature, &d3d12.root_signature); + NK_ASSERT(SUCCEEDED(hr)); + + /* Create pipeline state */ + { + /* Describe input layout */ + const D3D12_INPUT_ELEMENT_DESC layout[] = { + { "POSITION", 0, DXGI_FORMAT_R32G32B32A32_FLOAT, 0, NK_OFFSETOF(struct nk_d3d12_vertex, position), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 }, + { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, NK_OFFSETOF(struct nk_d3d12_vertex, uv), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 }, + { "COLOR", 0, DXGI_FORMAT_R8G8B8A8_UNORM, 0, NK_OFFSETOF(struct nk_d3d12_vertex, col), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 }, + }; + + /* Describe pipeline state */ + D3D12_GRAPHICS_PIPELINE_STATE_DESC desc; + memset(&desc, 0, sizeof(desc)); + desc.pRootSignature = d3d12.root_signature; + desc.VS.pShaderBytecode = nk_d3d12_vertex_shader; + desc.VS.BytecodeLength = sizeof(nk_d3d12_vertex_shader); + desc.PS.pShaderBytecode = nk_d3d12_pixel_shader; + desc.PS.BytecodeLength = sizeof(nk_d3d12_pixel_shader); + desc.BlendState.RenderTarget[0].BlendEnable = TRUE; + desc.BlendState.RenderTarget[0].SrcBlend = D3D12_BLEND_SRC_ALPHA; + desc.BlendState.RenderTarget[0].DestBlend = D3D12_BLEND_INV_SRC_ALPHA; + desc.BlendState.RenderTarget[0].BlendOp = D3D12_BLEND_OP_ADD; + desc.BlendState.RenderTarget[0].SrcBlendAlpha = D3D12_BLEND_INV_SRC_ALPHA; + desc.BlendState.RenderTarget[0].DestBlendAlpha = D3D12_BLEND_ZERO; + desc.BlendState.RenderTarget[0].BlendOpAlpha = D3D12_BLEND_OP_ADD; + desc.BlendState.RenderTarget[0].RenderTargetWriteMask = D3D12_COLOR_WRITE_ENABLE_ALL; + desc.SampleMask = UINT_MAX; + desc.RasterizerState.FillMode = D3D12_FILL_MODE_SOLID; + desc.RasterizerState.CullMode= D3D12_CULL_MODE_NONE; + desc.RasterizerState.DepthClipEnable = TRUE; + desc.InputLayout.NumElements = _countof(layout); + desc.InputLayout.pInputElementDescs = layout; + desc.PrimitiveTopologyType = D3D12_PRIMITIVE_TOPOLOGY_TYPE_TRIANGLE; + desc.NumRenderTargets = 1; + desc.RTVFormats[0] = DXGI_FORMAT_R8G8B8A8_UNORM; /* NOTE: When using HDR rendering you might have a different framebuffer format */ + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.NodeMask = 0; + + /* Create PSO */ + hr = ID3D12Device_CreateGraphicsPipelineState(device, &desc, &IID_ID3D12PipelineState, &d3d12.pipeline_state); + NK_ASSERT(SUCCEEDED(hr)); + } + + /* First time const buffer init */ + nk_d3d12_resize(width, height); + + /* viewport */ + d3d12.viewport.TopLeftX = 0.0f; + d3d12.viewport.TopLeftY = 0.0f; + d3d12.viewport.Width = (float)width; + d3d12.viewport.Height = (float)height; + d3d12.viewport.MinDepth = 0.0f; + d3d12.viewport.MaxDepth = 1.0f; + + return &d3d12.ctx; +} + +NK_API void +nk_d3d12_font_stash_begin(struct nk_font_atlas **atlas) +{ + /* Default nuklear font stash */ + nk_font_atlas_init_default(&d3d12.atlas); + nk_font_atlas_begin(&d3d12.atlas); + *atlas = &d3d12.atlas; +} + +NK_API void +nk_d3d12_font_stash_end(ID3D12GraphicsCommandList *command_list) +{ + HRESULT hr; + D3D12_TEXTURE_COPY_LOCATION cpy_src, cpy_dest; + D3D12_BOX cpy_box; + D3D12_RESOURCE_BARRIER resource_barrier; + D3D12_SHADER_RESOURCE_VIEW_DESC srv_desc; + D3D12_CPU_DESCRIPTOR_HANDLE srv_handle; + const void *image; + void* ptr_data; + int w, h; + + /* Bake nuklear font atlas */ + image = nk_font_atlas_bake(&d3d12.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); + NK_ASSERT(image); + + /* Create font texture */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = w; + desc.Height = h; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_UNKNOWN; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(d3d12.device, &d3d12.heap_prop_default, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COPY_DEST, NULL, &IID_ID3D12Resource, &d3d12.font_texture); + NK_ASSERT(SUCCEEDED(hr)); + } + + /* Create font upload buffer */ + { + D3D12_RESOURCE_DESC desc; + desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER; + desc.Alignment = D3D12_DEFAULT_RESOURCE_PLACEMENT_ALIGNMENT; + desc.Width = w * h * 4; + desc.Height = 1; + desc.DepthOrArraySize = 1; + desc.MipLevels = 1; + desc.Format = DXGI_FORMAT_UNKNOWN; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR; + desc.Flags = D3D12_RESOURCE_FLAG_NONE; + hr = ID3D12Device_CreateCommittedResource(d3d12.device, &d3d12.heap_prop_upload, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_COPY_SOURCE, NULL, &IID_ID3D12Resource, &d3d12.font_upload_buffer); + NK_ASSERT(SUCCEEDED(hr)); + } + + /* Copy image data to upload buffer */ + hr = ID3D12Resource_Map(d3d12.font_upload_buffer, 0, NULL, &ptr_data); + NK_ASSERT(SUCCEEDED(hr)); + memcpy(ptr_data, image, w * h * 4); + ID3D12Resource_Unmap(d3d12.font_upload_buffer, 0, NULL); + + /* Execute copy operation */ + cpy_src.pResource = d3d12.font_upload_buffer; + cpy_src.Type = D3D12_TEXTURE_COPY_TYPE_PLACED_FOOTPRINT; + cpy_src.PlacedFootprint.Offset = 0; + cpy_src.PlacedFootprint.Footprint.Format = DXGI_FORMAT_R8G8B8A8_UNORM; + cpy_src.PlacedFootprint.Footprint.Width = w; + cpy_src.PlacedFootprint.Footprint.Height = h; + cpy_src.PlacedFootprint.Footprint.Depth = 1; + cpy_src.PlacedFootprint.Footprint.RowPitch = w * 4; + cpy_dest.pResource = d3d12.font_texture; + cpy_dest.Type = D3D12_TEXTURE_COPY_TYPE_SUBRESOURCE_INDEX; + cpy_dest.SubresourceIndex = 0; + cpy_box.top = 0; + cpy_box.left = 0; + cpy_box.back = 1; + cpy_box.bottom = h; + cpy_box.right = w; + cpy_box.front = 0; + ID3D12GraphicsCommandList_CopyTextureRegion(command_list, &cpy_dest, 0, 0, 0, &cpy_src, &cpy_box); + + /* Bring texture in the right state for rendering */ + resource_barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION; + resource_barrier.Transition.pResource = d3d12.font_texture; + resource_barrier.Transition.Subresource = 0; + resource_barrier.Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_DEST; + resource_barrier.Transition.StateAfter = D3D12_RESOURCE_STATE_PIXEL_SHADER_RESOURCE; + resource_barrier.Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE; + ID3D12GraphicsCommandList_ResourceBarrier(command_list, 1, &resource_barrier); + + /* Create the SRV for the font texture */ + srv_desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; + srv_desc.ViewDimension = D3D12_SRV_DIMENSION_TEXTURE2D; + srv_desc.Shader4ComponentMapping = D3D12_DEFAULT_SHADER_4_COMPONENT_MAPPING; + srv_desc.Texture2D.MipLevels = 1; + srv_desc.Texture2D.MostDetailedMip = 0; + srv_desc.Texture2D.PlaneSlice = 0; + srv_desc.Texture2D.ResourceMinLODClamp = 0.0f; + srv_handle.ptr = d3d12.cpu_descriptor_handle.ptr + d3d12.cbv_srv_uav_desc_increment; + ID3D12Device_CreateShaderResourceView(d3d12.device, d3d12.font_texture, &srv_desc, srv_handle); + + /* Done with nk atlas data. Atlas will be served with texture id 0 */ + nk_font_atlas_end(&d3d12.atlas, nk_handle_id(0), &d3d12.tex_null); + + /* Setup default font */ + if (d3d12.atlas.default_font) + nk_style_set_font(&d3d12.ctx, &d3d12.atlas.default_font->handle); +} + +NK_API +void nk_d3d12_font_stash_cleanup() +{ + if(d3d12.font_upload_buffer) + { + ID3D12Resource_Release(d3d12.font_upload_buffer); + d3d12.font_upload_buffer = NULL; + } +} + +NK_API +nk_bool nk_d3d12_set_user_texture(unsigned int index, ID3D12Resource* texture, const D3D12_SHADER_RESOURCE_VIEW_DESC* description, nk_handle* handle_out) +{ + nk_bool result = nk_false; + if(index < d3d12.max_user_textures) + { + D3D12_CPU_DESCRIPTOR_HANDLE srv_handle; + + /* Get handle to texture (0 - Const Buffer; 1 - Font Texture; 2 - First user texture) */ + srv_handle.ptr = d3d12.cpu_descriptor_handle.ptr + ((2 + index) * d3d12.cbv_srv_uav_desc_increment); + + /* Create SRV */ + ID3D12Device_CreateShaderResourceView(d3d12.device, texture, description, srv_handle); + + /* Set nk handle (0 - Font Texture; 1 - First user texture) */ + *handle_out = nk_handle_id(1 + index); + result = nk_true; + } + + return result; +} + +NK_API +void nk_d3d12_shutdown(void) +{ + /* Nuklear cleanup */ + nk_font_atlas_clear(&d3d12.atlas); + nk_buffer_free(&d3d12.cmds); + nk_free(&d3d12.ctx); + + /* DirectX 12 cleanup */ + ID3D12Device_Release(d3d12.device); + ID3D12PipelineState_Release(d3d12.pipeline_state); + ID3D12RootSignature_Release(d3d12.root_signature); + ID3D12DescriptorHeap_Release(d3d12.desc_heap); + ID3D12Resource_Release(d3d12.upload_buffer); + ID3D12Resource_Release(d3d12.const_buffer); + ID3D12Resource_Release(d3d12.index_buffer); + ID3D12Resource_Release(d3d12.vertex_buffer); + if(d3d12.font_texture) + ID3D12Resource_Release(d3d12.font_texture); + if(d3d12.font_upload_buffer) + ID3D12Resource_Release(d3d12.font_upload_buffer); +} + +#endif diff --git a/demo/d3d12/nuklear_d3d12.hlsl b/demo/d3d12/nuklear_d3d12.hlsl new file mode 100644 index 0000000..33b0d28 --- /dev/null +++ b/demo/d3d12/nuklear_d3d12.hlsl @@ -0,0 +1,53 @@ +#define NK_ROOTSIGNATURE ""\ +"RootFlags(ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT),"\ +"DescriptorTable("\ + "CBV(b0, numDescriptors = 1, flags = DATA_VOLATILE),"\ + "SRV(t0, numDescriptors = unbounded, flags = DESCRIPTORS_VOLATILE)"\ +"),"\ +"RootConstants(num32BitConstants = 1, b1),"\ +"StaticSampler(s0, "\ + "filter = FILTER_MIN_MAG_MIP_LINEAR,"\ + "addressU = TEXTURE_ADDRESS_CLAMP,"\ + "addressV = TEXTURE_ADDRESS_CLAMP,"\ + "addressW = TEXTURE_ADDRESS_CLAMP,"\ + "comparisonFunc = COMPARISON_ALWAYS"\ +")" + +cbuffer buffer0 : register(b0) +{ + float4x4 ProjectionMatrix; +}; +static uint texture_index : register(b1); + +sampler sampler0 : register(s0); +Texture2D textures[] : register(t0); + +struct VS_INPUT +{ + float2 pos : POSITION; + float4 col : COLOR0; + float2 uv : TEXCOORD0; +}; + +struct PS_INPUT +{ + float4 pos : SV_POSITION; + float4 col : COLOR0; + float2 uv : TEXCOORD0; +}; + +[RootSignature(NK_ROOTSIGNATURE)] +PS_INPUT vs(VS_INPUT input) +{ + PS_INPUT output; + output.pos = mul(ProjectionMatrix, float4(input.pos.xy, 0.f, 1.f)); + output.col = input.col; + output.uv = input.uv; + return output; +} + +[RootSignature(NK_ROOTSIGNATURE)] +float4 ps(PS_INPUT input) : SV_Target +{ + return input.col * textures[texture_index].Sample(sampler0, input.uv); +} diff --git a/demo/d3d12/nuklear_d3d12_pixel_shader.h b/demo/d3d12/nuklear_d3d12_pixel_shader.h new file mode 100644 index 0000000..804943e --- /dev/null +++ b/demo/d3d12/nuklear_d3d12_pixel_shader.h @@ -0,0 +1,135 @@ +#if 0 +// +// Generated by Microsoft (R) D3D Shader Disassembler +// +// +// Input signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_POSITION 0 xyzw 0 POS float +// COLOR 0 xyzw 1 NONE float xyzw +// TEXCOORD 0 xy 2 NONE float xy +// +// +// Output signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_Target 0 xyzw 0 TARGET float xyzw +// +ps_5_1 +dcl_globalFlags refactoringAllowed +dcl_sampler S0[0:0], mode_default, space=0 +dcl_resource_texture2d (float,float,float,float) T0[0:*], space=0 +dcl_input_ps linear v1.xyzw +dcl_input_ps linear v2.xy +dcl_output o0.xyzw +dcl_temps 1 +sample r0.xyzw, v2.xyxx, T0[0].xyzw, S0[0] +mul o0.xyzw, r0.xyzw, v1.xyzw +ret +// Approximately 0 instruction slots used +#endif + +const BYTE nk_d3d12_pixel_shader[] = +{ + 68, 88, 66, 67, 228, 128, + 250, 93, 94, 248, 174, 160, + 102, 133, 107, 228, 84, 49, + 109, 253, 1, 0, 0, 0, + 72, 2, 0, 0, 4, 0, + 0, 0, 48, 0, 0, 0, + 164, 0, 0, 0, 216, 0, + 0, 0, 152, 1, 0, 0, + 73, 83, 71, 78, 108, 0, + 0, 0, 3, 0, 0, 0, + 8, 0, 0, 0, 80, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 15, 0, 0, 0, 92, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 1, 0, 0, 0, + 15, 15, 0, 0, 98, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 2, 0, 0, 0, + 3, 3, 0, 0, 83, 86, + 95, 80, 79, 83, 73, 84, + 73, 79, 78, 0, 67, 79, + 76, 79, 82, 0, 84, 69, + 88, 67, 79, 79, 82, 68, + 0, 171, 79, 83, 71, 78, + 44, 0, 0, 0, 1, 0, + 0, 0, 8, 0, 0, 0, + 32, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 3, 0, 0, 0, 0, 0, + 0, 0, 15, 0, 0, 0, + 83, 86, 95, 84, 97, 114, + 103, 101, 116, 0, 171, 171, + 83, 72, 69, 88, 184, 0, + 0, 0, 81, 0, 0, 0, + 46, 0, 0, 0, 106, 8, + 0, 1, 90, 0, 0, 6, + 70, 110, 48, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 88, 24, 0, 7, + 70, 126, 48, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 255, 255, 255, 255, 85, 85, + 0, 0, 0, 0, 0, 0, + 98, 16, 0, 3, 242, 16, + 16, 0, 1, 0, 0, 0, + 98, 16, 0, 3, 50, 16, + 16, 0, 2, 0, 0, 0, + 101, 0, 0, 3, 242, 32, + 16, 0, 0, 0, 0, 0, + 104, 0, 0, 2, 1, 0, + 0, 0, 69, 0, 0, 11, + 242, 0, 16, 0, 0, 0, + 0, 0, 70, 16, 16, 0, + 2, 0, 0, 0, 70, 126, + 32, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 96, + 32, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 56, 0, + 0, 7, 242, 32, 16, 0, + 0, 0, 0, 0, 70, 14, + 16, 0, 0, 0, 0, 0, + 70, 30, 16, 0, 1, 0, + 0, 0, 62, 0, 0, 1, + 82, 84, 83, 48, 168, 0, + 0, 0, 2, 0, 0, 0, + 2, 0, 0, 0, 24, 0, + 0, 0, 1, 0, 0, 0, + 116, 0, 0, 0, 1, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 48, 0, + 0, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 104, 0, + 0, 0, 2, 0, 0, 0, + 56, 0, 0, 0, 2, 0, + 0, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 2, 0, 0, 0, + 255, 255, 255, 255, 0, 0, + 0, 0, 255, 255, 255, 255, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 0, 0, + 255, 255, 255, 255, 1, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 21, 0, + 0, 0, 3, 0, 0, 0, + 3, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 16, 0, 0, 0, 8, 0, + 0, 0, 2, 0, 0, 0, + 0, 0, 0, 0, 255, 255, + 127, 127, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0 +}; diff --git a/demo/d3d12/nuklear_d3d12_vertex_shader.h b/demo/d3d12/nuklear_d3d12_vertex_shader.h new file mode 100644 index 0000000..fd0b1bc --- /dev/null +++ b/demo/d3d12/nuklear_d3d12_vertex_shader.h @@ -0,0 +1,168 @@ +#if 0 +// +// Generated by Microsoft (R) D3D Shader Disassembler +// +// +// Input signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// POSITION 0 xy 0 NONE float xy +// COLOR 0 xyzw 1 NONE float xyzw +// TEXCOORD 0 xy 2 NONE float xy +// +// +// Output signature: +// +// Name Index Mask Register SysValue Format Used +// -------------------- ----- ------ -------- -------- ------- ------ +// SV_POSITION 0 xyzw 0 POS float xyzw +// COLOR 0 xyzw 1 NONE float xyzw +// TEXCOORD 0 xy 2 NONE float xy +// +vs_5_1 +dcl_globalFlags refactoringAllowed +dcl_constantbuffer CB0[0:0][4], immediateIndexed, space=0 +dcl_input v0.xy +dcl_input v1.xyzw +dcl_input v2.xy +dcl_output_siv o0.xyzw, position +dcl_output o1.xyzw +dcl_output o2.xy +dcl_temps 1 +mul r0.xyzw, v0.yyyy, CB0[0][1].xyzw +mad r0.xyzw, CB0[0][0].xyzw, v0.xxxx, r0.xyzw +add o0.xyzw, r0.xyzw, CB0[0][3].xyzw +mov o1.xyzw, v1.xyzw +mov o2.xy, v2.xyxx +ret +// Approximately 0 instruction slots used +#endif + +const BYTE nk_d3d12_vertex_shader[] = +{ + 68, 88, 66, 67, 187, 129, + 163, 57, 169, 94, 219, 158, + 174, 23, 30, 91, 108, 150, + 135, 141, 1, 0, 0, 0, + 232, 2, 0, 0, 4, 0, + 0, 0, 48, 0, 0, 0, + 160, 0, 0, 0, 20, 1, + 0, 0, 56, 2, 0, 0, + 73, 83, 71, 78, 104, 0, + 0, 0, 3, 0, 0, 0, + 8, 0, 0, 0, 80, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 0, 0, 0, 0, + 3, 3, 0, 0, 89, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 1, 0, 0, 0, + 15, 15, 0, 0, 95, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 2, 0, 0, 0, + 3, 3, 0, 0, 80, 79, + 83, 73, 84, 73, 79, 78, + 0, 67, 79, 76, 79, 82, + 0, 84, 69, 88, 67, 79, + 79, 82, 68, 0, 79, 83, + 71, 78, 108, 0, 0, 0, + 3, 0, 0, 0, 8, 0, + 0, 0, 80, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 0, 0, 3, 0, 0, 0, + 0, 0, 0, 0, 15, 0, + 0, 0, 92, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 3, 0, 0, 0, + 1, 0, 0, 0, 15, 0, + 0, 0, 98, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 3, 0, 0, 0, + 2, 0, 0, 0, 3, 12, + 0, 0, 83, 86, 95, 80, + 79, 83, 73, 84, 73, 79, + 78, 0, 67, 79, 76, 79, + 82, 0, 84, 69, 88, 67, + 79, 79, 82, 68, 0, 171, + 83, 72, 69, 88, 28, 1, + 0, 0, 81, 0, 1, 0, + 71, 0, 0, 0, 106, 8, + 0, 1, 89, 0, 0, 7, + 70, 142, 48, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 4, 0, + 0, 0, 0, 0, 0, 0, + 95, 0, 0, 3, 50, 16, + 16, 0, 0, 0, 0, 0, + 95, 0, 0, 3, 242, 16, + 16, 0, 1, 0, 0, 0, + 95, 0, 0, 3, 50, 16, + 16, 0, 2, 0, 0, 0, + 103, 0, 0, 4, 242, 32, + 16, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 101, 0, + 0, 3, 242, 32, 16, 0, + 1, 0, 0, 0, 101, 0, + 0, 3, 50, 32, 16, 0, + 2, 0, 0, 0, 104, 0, + 0, 2, 1, 0, 0, 0, + 56, 0, 0, 9, 242, 0, + 16, 0, 0, 0, 0, 0, + 86, 21, 16, 0, 0, 0, + 0, 0, 70, 142, 48, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 1, 0, 0, 0, + 50, 0, 0, 11, 242, 0, + 16, 0, 0, 0, 0, 0, + 70, 142, 48, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 6, 16, + 16, 0, 0, 0, 0, 0, + 70, 14, 16, 0, 0, 0, + 0, 0, 0, 0, 0, 9, + 242, 32, 16, 0, 0, 0, + 0, 0, 70, 14, 16, 0, + 0, 0, 0, 0, 70, 142, + 48, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 3, 0, + 0, 0, 54, 0, 0, 5, + 242, 32, 16, 0, 1, 0, + 0, 0, 70, 30, 16, 0, + 1, 0, 0, 0, 54, 0, + 0, 5, 50, 32, 16, 0, + 2, 0, 0, 0, 70, 16, + 16, 0, 2, 0, 0, 0, + 62, 0, 0, 1, 82, 84, + 83, 48, 168, 0, 0, 0, + 2, 0, 0, 0, 2, 0, + 0, 0, 24, 0, 0, 0, + 1, 0, 0, 0, 116, 0, + 0, 0, 1, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 0, 0, 48, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 104, 0, 0, 0, + 2, 0, 0, 0, 56, 0, + 0, 0, 2, 0, 0, 0, + 1, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0, + 2, 0, 0, 0, 255, 255, + 255, 255, 0, 0, 0, 0, + 255, 255, 255, 255, 0, 0, + 0, 0, 0, 0, 0, 0, + 1, 0, 0, 0, 255, 255, + 255, 255, 1, 0, 0, 0, + 0, 0, 0, 0, 1, 0, + 0, 0, 21, 0, 0, 0, + 3, 0, 0, 0, 3, 0, + 0, 0, 3, 0, 0, 0, + 0, 0, 0, 0, 16, 0, + 0, 0, 8, 0, 0, 0, + 2, 0, 0, 0, 0, 0, + 0, 0, 255, 255, 127, 127, + 0, 0, 0, 0, 0, 0, + 0, 0, 0, 0, 0, 0 +}; diff --git a/demo/d3d9/main.c b/demo/d3d9/main.c index cdd0fb3..c6b8a5d 100644 --- a/demo/d3d9/main.c +++ b/demo/d3d9/main.c @@ -33,27 +33,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -82,10 +87,11 @@ WindowProc(HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) if (width != 0 && height != 0 && (width != present.BackBufferWidth || height != present.BackBufferHeight)) { + HRESULT hr; nk_d3d9_release(); present.BackBufferWidth = width; present.BackBufferHeight = height; - HRESULT hr = IDirect3DDevice9_Reset(device, &present); + hr = IDirect3DDevice9_Reset(device, &present); NK_ASSERT(SUCCEEDED(hr)); nk_d3d9_resize(width, height); } @@ -210,10 +216,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -268,6 +280,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/d3d9/nuklear_d3d9.h b/demo/d3d9/nuklear_d3d9.h index 3f23e1e..f967678 100644 --- a/demo/d3d9/nuklear_d3d9.h +++ b/demo/d3d9/nuklear_d3d9.h @@ -58,7 +58,7 @@ static struct { struct nk_font_atlas atlas; struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; D3DVIEWPORT9 viewport; D3DMATRIX projection; @@ -150,7 +150,7 @@ nk_d3d9_render(enum nk_anti_aliasing AA) config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; - config.null = d3d9.null; + config.tex_null = d3d9.tex_null; /* convert shapes into vertexes */ nk_buffer_init_default(&vbuf); @@ -204,11 +204,15 @@ nk_d3d9_get_projection_matrix(int width, int height, float *result) const float T = 0.5f; const float B = (float)height + 0.5f; float matrix[4][4] = { - { 2.0f / (R - L), 0.0f, 0.0f, 0.0f }, - { 0.0f, 2.0f / (T - B), 0.0f, 0.0f }, - { 0.0f, 0.0f, 0.0f, 0.0f }, - { (R + L) / (L - R), (T + B) / (B - T), 0.0f, 1.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.0f, 0.0f }, + { 0.0f, 0.0f, 0.0f, 1.0f }, }; + matrix[0][0] = 2.0f / (R - L); + matrix[1][1] = 2.0f / (T - B); + matrix[3][0] = (R + L) / (L - R); + matrix[3][1] = (T + B) / (B - T); memcpy(result, matrix, sizeof(matrix)); } @@ -244,7 +248,7 @@ nk_d3d9_create_font_texture() hr = IDirect3DTexture9_UnlockRect(d3d9.texture, 0); NK_ASSERT(SUCCEEDED(hr)); - nk_font_atlas_end(&d3d9.atlas, nk_handle_ptr(d3d9.texture), &d3d9.null); + nk_font_atlas_end(&d3d9.atlas, nk_handle_ptr(d3d9.texture), &d3d9.tex_null); } NK_API void @@ -426,30 +430,35 @@ nk_d3d9_handle_event(HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) static void nk_d3d9_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) { + HGLOBAL mem; + SIZE_T size; + LPCWSTR wstr; + int utf8size; + (void)usr; if (!IsClipboardFormatAvailable(CF_UNICODETEXT) && OpenClipboard(NULL)) { return; } - HGLOBAL mem = GetClipboardData(CF_UNICODETEXT); + mem = GetClipboardData(CF_UNICODETEXT); if (!mem) { CloseClipboard(); return; } - SIZE_T size = GlobalSize(mem) - 1; + size = GlobalSize(mem) - 1; if (!size) { CloseClipboard(); return; } - LPCWSTR wstr = (LPCWSTR)GlobalLock(mem); + wstr = (LPCWSTR)GlobalLock(mem); if (!wstr) { CloseClipboard(); return; } - int utf8size = WideCharToMultiByte(CP_UTF8, 0, wstr, (int)size / sizeof(wchar_t), NULL, 0, NULL, NULL); + utf8size = WideCharToMultiByte(CP_UTF8, 0, wstr, (int)size / sizeof(wchar_t), NULL, 0, NULL, NULL); if (utf8size) { char *utf8 = (char *)malloc(utf8size); if (utf8) { @@ -459,19 +468,21 @@ nk_d3d9_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) } } - GlobalUnlock(mem); + GlobalUnlock(mem); CloseClipboard(); } static void nk_d3d9_clipboard_copy(nk_handle usr, const char *text, int len) { + int wsize; + (void)usr; if (!OpenClipboard(NULL)) { return; } - int wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); + wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); if (wsize) { HGLOBAL mem = GlobalAlloc(GMEM_MOVEABLE, (wsize + 1) * sizeof(wchar_t)); if (mem) { @@ -480,7 +491,7 @@ nk_d3d9_clipboard_copy(nk_handle usr, const char *text, int len) MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); wstr[wsize] = 0; GlobalUnlock(mem); - SetClipboardData(CF_UNICODETEXT, mem); + SetClipboardData(CF_UNICODETEXT, mem); } } } diff --git a/demo/gdi/main.c b/demo/gdi/main.c index 1755b9c..f588c07 100644 --- a/demo/gdi/main.c +++ b/demo/gdi/main.c @@ -28,27 +28,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -110,10 +115,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif while (running) @@ -164,6 +175,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/gdi/nuklear_gdi.h b/demo/gdi/nuklear_gdi.h index 6937016..8efc8da 100644 --- a/demo/gdi/nuklear_gdi.h +++ b/demo/gdi/nuklear_gdi.h @@ -15,6 +15,7 @@ #define WIN32_LEAN_AND_MEAN #include +#include typedef struct GdiFont GdiFont; NK_API struct nk_context* nk_gdi_init(GdiFont *font, HDC window_dc, unsigned int width, unsigned int height); @@ -62,6 +63,13 @@ nk_create_image(struct nk_image * image, const char * frame_buffer, const int wi { if (image && frame_buffer && (width > 0) && (height > 0)) { + const unsigned char * src = (const unsigned char *)frame_buffer; + INT row = ((width * 3 + 3) & ~3); + LPBYTE lpBuf, pb = NULL; + BITMAPINFO bi = { 0 }; + HBITMAP hbm; + int v, i; + image->w = width; image->h = height; image->region[0] = 0; @@ -69,8 +77,6 @@ nk_create_image(struct nk_image * image, const char * frame_buffer, const int wi image->region[2] = width; image->region[3] = height; - INT row = ((width * 3 + 3) & ~3); - BITMAPINFO bi = { 0 }; bi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER); bi.bmiHeader.biWidth = width; bi.bmiHeader.biHeight = height; @@ -79,15 +85,13 @@ nk_create_image(struct nk_image * image, const char * frame_buffer, const int wi bi.bmiHeader.biCompression = BI_RGB; bi.bmiHeader.biSizeImage = row * height; - LPBYTE lpBuf, pb = NULL; - HBITMAP hbm = CreateDIBSection(NULL, &bi, DIB_RGB_COLORS, (void**)&lpBuf, NULL, 0); + hbm = CreateDIBSection(NULL, &bi, DIB_RGB_COLORS, (void**)&lpBuf, NULL, 0); pb = lpBuf + row * height; - unsigned char * src = (unsigned char *)frame_buffer; - for (int v = 0; vx = x; + p->y = y; + return TRUE; +} + static void nk_gdi_fill_triangle(HDC dc, short x0, short y0, short x1, short y1, short x2, short y2, struct nk_color col) { COLORREF color = convert_color(col); - POINT points[] = { - { x0, y0 }, - { x1, y1 }, - { x2, y2 }, - }; + POINT points[3]; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); SetDCPenColor(dc, color); SetDCBrushColor(dc, color); @@ -283,14 +299,14 @@ nk_gdi_stroke_triangle(HDC dc, short x0, short y0, short x1, short y1, short x2, short y2, unsigned short line_thickness, struct nk_color col) { COLORREF color = convert_color(col); - POINT points[] = { - { x0, y0 }, - { x1, y1 }, - { x2, y2 }, - { x0, y0 }, - }; - + POINT points[4]; HPEN pen = NULL; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); + SetPoint(&points[3], x0, y0); + if (line_thickness == 1) { SetDCPenColor(dc, color); } else { @@ -376,6 +392,62 @@ nk_gdi_stroke_polyline(HDC dc, const struct nk_vec2i *pnts, } } +static void +nk_gdi_stroke_arc(HDC dc, short cx, short cy, unsigned short r, float amin, float adelta, unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + + /* setup pen */ + HPEN pen = NULL; + if (line_thickness == 1) + SetDCPenColor(dc, color); + else + { + /* the flat endcap makes thick arcs look better */ + DWORD pen_style = PS_SOLID | PS_ENDCAP_FLAT | PS_GEOMETRIC; + + LOGBRUSH brush; + brush.lbStyle = BS_SOLID; + brush.lbColor = color; + brush.lbHatch = 0; + + pen = ExtCreatePen(pen_style, line_thickness, &brush, 0, NULL); + SelectObject(dc, pen); + } + + /* calculate arc and draw */ + int start_x = cx + (int) ((float)r*nk_cos(amin+adelta)), + start_y = cy + (int) ((float)r*nk_sin(amin+adelta)), + end_x = cx + (int) ((float)r*nk_cos(amin)), + end_y = cy + (int) ((float)r*nk_sin(amin)); + + HGDIOBJ br = SelectObject(dc, GetStockObject(NULL_BRUSH)); + SetArcDirection(dc, AD_COUNTERCLOCKWISE); + Pie(dc, cx-r, cy-r, cx+r, cy+r, start_x, start_y, end_x, end_y); + SelectObject(dc, br); + + if (pen) + { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_fill_arc(HDC dc, short cx, short cy, unsigned short r, float amin, float adelta, struct nk_color col) +{ + COLORREF color = convert_color(col); + SetDCBrushColor(dc, color); + SetDCPenColor(dc, color); + + int start_x = cx + (int) ((float)r*nk_cos(amin+adelta)), + start_y = cy + (int) ((float)r*nk_sin(amin+adelta)), + end_x = cx + (int) ((float)r*nk_cos(amin)), + end_y = cy + (int) ((float)r*nk_sin(amin)); + + Pie(dc, cx-r, cy-r, cx+r, cy+r, start_x, start_y, end_x, end_y); +} + static void nk_gdi_fill_circle(HDC dc, short x, short y, unsigned short w, unsigned short h, struct nk_color col) @@ -398,9 +470,11 @@ nk_gdi_stroke_circle(HDC dc, short x, short y, unsigned short w, pen = CreatePen(PS_SOLID, line_thickness, color); SelectObject(dc, pen); } - + + HGDIOBJ br = SelectObject(dc, GetStockObject(NULL_BRUSH)); SetDCBrushColor(dc, OPAQUE); Ellipse(dc, x, y, x + w, y + h); + SelectObject(dc, br); if (pen) { SelectObject(dc, GetStockObject(DC_PEN)); @@ -414,14 +488,14 @@ nk_gdi_stroke_curve(HDC dc, struct nk_vec2i p1, unsigned short line_thickness, struct nk_color col) { COLORREF color = convert_color(col); - POINT p[] = { - { p1.x, p1.y }, - { p2.x, p2.y }, - { p3.x, p3.y }, - { p4.x, p4.y }, - }; - + POINT p[4]; HPEN pen = NULL; + + SetPoint(&p[0], p1.x, p1.y); + SetPoint(&p[1], p2.x, p2.y); + SetPoint(&p[2], p3.x, p3.y); + SetPoint(&p[3], p4.x, p4.y); + if (line_thickness == 1) { SetDCPenColor(dc, color); } else { @@ -462,7 +536,8 @@ static void nk_gdi_clear(HDC dc, struct nk_color col) { COLORREF color = convert_color(col); - RECT rect = { 0, 0, gdi.width, gdi.height }; + RECT rect; + SetRect(&rect, 0, 0, gdi.width, gdi.height); SetBkColor(dc, color); ExtTextOutW(dc, 0, 0, ETO_OPAQUE, &rect, NULL, 0, NULL); @@ -700,6 +775,13 @@ nk_gdi_handle_event(HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) case VK_PRIOR: nk_input_key(&gdi.ctx, NK_KEY_SCROLL_UP, down); return 1; + + case 'A': + if (ctrl) { + nk_input_key(&gdi.ctx, NK_KEY_TEXT_SELECT_ALL, down); + return 1; + } + break; case 'C': if (ctrl) { @@ -843,6 +925,14 @@ nk_gdi_render(struct nk_color clear) const struct nk_command_circle_filled *c = (const struct nk_command_circle_filled *)cmd; nk_gdi_fill_circle(memory_dc, c->x, c->y, c->w, c->h, c->color); } break; + case NK_COMMAND_ARC: { + const struct nk_command_arc *q = (const struct nk_command_arc *)cmd; + nk_gdi_stroke_arc(memory_dc, q->cx, q->cy, q->r, q->a[0], q->a[1], q->line_thickness, q->color); + } break; + case NK_COMMAND_ARC_FILLED: { + const struct nk_command_arc_filled *q = (const struct nk_command_arc_filled *)cmd; + nk_gdi_fill_arc(memory_dc, q->cx, q->cy, q->r, q->a[0], q->a[1], q->color); + } break; case NK_COMMAND_TRIANGLE: { const struct nk_command_triangle*t = (const struct nk_command_triangle*)cmd; nk_gdi_stroke_triangle(memory_dc, t->a.x, t->a.y, t->b.x, t->b.y, @@ -885,8 +975,7 @@ nk_gdi_render(struct nk_color clear) const struct nk_command_image *i = (const struct nk_command_image *)cmd; nk_gdi_draw_image(i->x, i->y, i->w, i->h, i->img, i->col); } break; - case NK_COMMAND_ARC: - case NK_COMMAND_ARC_FILLED: + case NK_COMMAND_CUSTOM: default: break; } } diff --git a/demo/gdi_native_nuklear/build.bat b/demo/gdi_native_nuklear/build.bat new file mode 100644 index 0000000..2f87f8e --- /dev/null +++ b/demo/gdi_native_nuklear/build.bat @@ -0,0 +1,6 @@ +@echo off + +rem This will use VS2015 for compiler +call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" x86 + +cl /nologo /W3 /O2 /fp:fast /Gm- /D_CRT_SECURE_NO_DEPRECATE /Fedemo.exe main.c user32.lib gdi32.lib Msimg32.lib /link /incremental:no diff --git a/demo/gdi_native_nuklear/main.c b/demo/gdi_native_nuklear/main.c new file mode 100644 index 0000000..d12f972 --- /dev/null +++ b/demo/gdi_native_nuklear/main.c @@ -0,0 +1,128 @@ +#include + +#pragma comment(linker,"\"/manifestdependency:type='win32' \ +name='Microsoft.Windows.Common-Controls' version='6.0.0.0' \ +processorArchitecture='*' publicKeyToken='6595b64144ccf1df' language='*'\"") + +/* Includes the default nuklear implementation + * Includes the modified GDI backend (No more global state to allow multiple hwnd's) + */ +#define NK_INCLUDE_FIXED_TYPES +#define NK_INCLUDE_STANDARD_IO +#define NK_INCLUDE_STANDARD_VARARGS +#define NK_INCLUDE_DEFAULT_ALLOCATOR +#define NK_IMPLEMENTATION +#define NK_GDI_IMPLEMENTATION +#include "../../nuklear.h" +#include "nuklear_gdi.h" + +/* Include the window framework (the new fancy code of this demo) */ +#define NKGDI_IMPLEMENT_WINDOW +#include "window.h" + +/* This callback will be called when the window is draw + * You will NOT need to call nk_begin(...) and nk_end(...) + * begin and end are handled by the parent code calling this + * callback + */ +int drawCallback(struct nk_context* ctx) +{ + /* Code is from ../calculator.c */ + static int set = 0, prev = 0, op = 0; + static const char numbers[] = "789456123"; + static const char ops[] = "+-*/"; + static double a = 0, b = 0; + static double *current = &a; + + size_t i = 0; + int solve = 0; + {int len; char buffer[256]; + nk_layout_row_dynamic(ctx, 35, 1); + len = snprintf(buffer, 256, "%.2f", *current); + nk_edit_string(ctx, NK_EDIT_SIMPLE, buffer, &len, 255, nk_filter_float); + buffer[len] = 0; + *current = atof(buffer);} + + nk_layout_row_dynamic(ctx, 35, 4); + for (i = 0; i < 16; ++i) { + if (i >= 12 && i < 15) { + if (i > 12) continue; + if (nk_button_label(ctx, "C")) { + a = b = op = 0; current = &a; set = 0; + } if (nk_button_label(ctx, "0")) { + *current = *current*10.0f; set = 0; + } if (nk_button_label(ctx, "=")) { + solve = 1; prev = op; op = 0; + } + } else if (((i+1) % 4)) { + if (nk_button_text(ctx, &numbers[(i/4)*3+i%4], 1)) { + *current = *current * 10.0f + numbers[(i/4)*3+i%4] - '0'; + set = 0; + } + } else if (nk_button_text(ctx, &ops[i/4], 1)) { + if (!set) { + if (current != &b) { + current = &b; + } else { + prev = op; + solve = 1; + } + } + op = ops[i/4]; + set = 1; + } + } + if (solve) { + if (prev == '+') a = a + b; + if (prev == '-') a = a - b; + if (prev == '*') a = a * b; + if (prev == '/') a = a / b; + current = &a; + if (set) current = &b; + b = 0; set = 0; + } + return 1; +} + +/* Main entry point - wWinMain used for UNICODE + * (You can also use _tWinMain(...) to automaticaly use the ASCII or WIDE char entry point base on your build) + */ +INT WINAPI wWinMain(HINSTANCE _In_ hInstance, HINSTANCE _In_opt_ hPrevInstance, PWSTR _In_ cmdArgs, INT _In_ cmdShow) +{ + /* Call this first to setup all required prerequisites */ + nkgdi_window_init(); + + /* Preparing two window contexts */ + struct nkgdi_window w1, w2; + memset(&w1, 0x0, sizeof(struct nkgdi_window)); + memset(&w2, 0x0, sizeof(struct nkgdi_window)); + + /* Configure and create window 1. + * Note: You can allways change the direct accesible parameters later as well! + */ + w1.allow_sizing = 0; + w1.allow_maximize = 0; + w1.allow_move = 0; + w1.has_titlebar = 0; + w1.cb_on_draw = &drawCallback; + nkgdi_window_create(&w1, 500, 500, "F1", 10, 10); + + /* Configure and create window 2 */ + w2.allow_sizing = 1; + w2.allow_maximize = 1; + w2.allow_move = 1; + w2.has_titlebar = 1; + w2.cb_on_draw = &drawCallback; + nkgdi_window_create(&w2, 500, 500, "F2", 520, 10); + + /* As long as both windows are valid (nkgdi_window_update returning 1) */ + while (nkgdi_window_update(&w1) && nkgdi_window_update(&w2)) Sleep(20); + + /* Destroy both windows context */ + nkgdi_window_destroy(&w1); + nkgdi_window_destroy(&w2); + + /* Call nkgdi_window_shutdown to properly shutdown the gdi window framework */ + nkgdi_window_shutdown(); + return 0; +} diff --git a/demo/gdi_native_nuklear/nuklear_gdi.h b/demo/gdi_native_nuklear/nuklear_gdi.h new file mode 100644 index 0000000..5c2f1f8 --- /dev/null +++ b/demo/gdi_native_nuklear/nuklear_gdi.h @@ -0,0 +1,937 @@ +/* + * Nuklear - 1.32.0 - public domain + * no warrenty implied; use at your own risk. + * authored from 2015-2016 by Micha Mettke + * + * Modified GDI backend 2022 + * Now based on a context that is required for each API function call. + * Removes the global state --> you can have multiple windows :-) + * + */ + /* + * ============================================================== + * + * API + * + * =============================================================== + */ +#ifndef NK_GDI_H_ +#define NK_GDI_H_ + +#ifdef __cplusplus +extern "C"{ +#endif + +typedef struct GdiFont GdiFont; +struct _nk_gdi_ctx; +typedef struct _nk_gdi_ctx* nk_gdi_ctx; + +NK_API struct nk_context* nk_gdi_init(nk_gdi_ctx* gdi, GdiFont* font, HDC window_dc, unsigned int width, unsigned int height); +NK_API int nk_gdi_handle_event(nk_gdi_ctx gdi, HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam); +NK_API void nk_gdi_render(nk_gdi_ctx gdi, struct nk_color clear); +NK_API void nk_gdi_shutdown(nk_gdi_ctx gdi); + +/* font */ +NK_API GdiFont* nk_gdifont_create(const char* name, int size); +NK_API void nk_gdifont_del(GdiFont* font); +NK_API void nk_gdi_set_font(nk_gdi_ctx gdi, GdiFont* font); + +#ifdef __cplusplus +} +#endif + +#endif + +/* + * ============================================================== + * + * IMPLEMENTATION + * + * =============================================================== + */ +#ifdef NK_GDI_IMPLEMENTATION + +#include +#include + +struct GdiFont { + struct nk_user_font nk; + int height; + HFONT handle; + HDC dc; +}; + +struct _nk_gdi_ctx { + HBITMAP bitmap; + HDC window_dc; + HDC memory_dc; + unsigned int width; + unsigned int height; + struct nk_context ctx; +}; + +static void +nk_create_image(struct nk_image* image, const char* frame_buffer, const int width, const int height) +{ + if (image && frame_buffer && (width > 0) && (height > 0)) + { + const unsigned char* src = (const unsigned char*)frame_buffer; + INT row = ((width * 3 + 3) & ~3); + LPBYTE lpBuf, pb = NULL; + BITMAPINFO bi = { 0 }; + HBITMAP hbm; + int v, i; + + image->w = width; + image->h = height; + image->region[0] = 0; + image->region[1] = 0; + image->region[2] = width; + image->region[3] = height; + + bi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER); + bi.bmiHeader.biWidth = width; + bi.bmiHeader.biHeight = height; + bi.bmiHeader.biPlanes = 1; + bi.bmiHeader.biBitCount = 24; + bi.bmiHeader.biCompression = BI_RGB; + bi.bmiHeader.biSizeImage = row * height; + + hbm = CreateDIBSection(NULL, &bi, DIB_RGB_COLORS, (void**)&lpBuf, NULL, 0); + + pb = lpBuf + row * height; + for (v = 0; v < height; v++) + { + pb -= row; + for (i = 0; i < row; i += 3) + { + pb[i + 0] = src[0]; + pb[i + 1] = src[1]; + pb[i + 2] = src[2]; + src += 3; + } + } + SetDIBits(NULL, hbm, 0, height, lpBuf, &bi, DIB_RGB_COLORS); + image->handle.ptr = hbm; + } +} + +static void +nk_delete_image(struct nk_image* image) +{ + if (image && image->handle.id != 0) + { + HBITMAP hbm = (HBITMAP)image->handle.ptr; + DeleteObject(hbm); + memset(image, 0, sizeof(struct nk_image)); + } +} + +static void +nk_gdi_draw_image(nk_gdi_ctx gdi, short x, short y, unsigned short w, unsigned short h, + struct nk_image img, struct nk_color col) +{ + HBITMAP hbm = (HBITMAP)img.handle.ptr; + HDC hDCBits; + BITMAP bitmap; + + if (!gdi->memory_dc || !hbm) + return; + + hDCBits = CreateCompatibleDC(gdi->memory_dc); + GetObject(hbm, sizeof(BITMAP), (LPSTR)&bitmap); + SelectObject(hDCBits, hbm); + StretchBlt(gdi->memory_dc, x, y, w, h, hDCBits, 0, 0, bitmap.bmWidth, bitmap.bmHeight, SRCCOPY); + DeleteDC(hDCBits); +} + +static COLORREF +convert_color(struct nk_color c) +{ + return c.r | (c.g << 8) | (c.b << 16); +} + +static void +nk_gdi_scissor(HDC dc, float x, float y, float w, float h) +{ + SelectClipRgn(dc, NULL); + IntersectClipRect(dc, (int)x, (int)y, (int)(x + w + 1), (int)(y + h + 1)); +} + +static void +nk_gdi_stroke_line(HDC dc, short x0, short y0, short x1, + short y1, unsigned int line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + + HPEN pen = NULL; + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + MoveToEx(dc, x0, y0, NULL); + LineTo(dc, x1, y1); + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_stroke_rect(HDC dc, short x, short y, unsigned short w, + unsigned short h, unsigned short r, unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + HGDIOBJ br; + HPEN pen = NULL; + + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + br = SelectObject(dc, GetStockObject(NULL_BRUSH)); + if (r == 0) { + Rectangle(dc, x, y, x + w, y + h); + } + else { + RoundRect(dc, x, y, x + w, y + h, r, r); + } + SelectObject(dc, br); + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_fill_rect(HDC dc, short x, short y, unsigned short w, + unsigned short h, unsigned short r, struct nk_color col) +{ + COLORREF color = convert_color(col); + + if (r == 0) { + RECT rect; + SetRect(&rect, x, y, x + w, y + h); + SetBkColor(dc, color); + ExtTextOutW(dc, 0, 0, ETO_OPAQUE, &rect, NULL, 0, NULL); + } + else { + SetDCPenColor(dc, color); + SetDCBrushColor(dc, color); + RoundRect(dc, x, y, x + w, y + h, r, r); + } +} +static void +nk_gdi_set_vertexColor(PTRIVERTEX tri, struct nk_color col) +{ + tri->Red = col.r << 8; + tri->Green = col.g << 8; + tri->Blue = col.b << 8; + tri->Alpha = 0xff << 8; +} + +static void +nk_gdi_rect_multi_color(nk_gdi_ctx gdi, HDC dc, short x, short y, unsigned short w, + unsigned short h, struct nk_color left, struct nk_color top, + struct nk_color right, struct nk_color bottom) +{ + BLENDFUNCTION alphaFunction; + // GRADIENT_RECT gRect; + GRADIENT_TRIANGLE gTri[2]; + TRIVERTEX vt[4]; + alphaFunction.BlendOp = AC_SRC_OVER; + alphaFunction.BlendFlags = 0; + alphaFunction.SourceConstantAlpha = 0; + alphaFunction.AlphaFormat = AC_SRC_ALPHA; + + /* TODO: This Case Needs Repair.*/ + /* Top Left Corner */ + vt[0].x = x; + vt[0].y = y; + nk_gdi_set_vertexColor(&vt[0], left); + /* Top Right Corner */ + vt[1].x = x + w; + vt[1].y = y; + nk_gdi_set_vertexColor(&vt[1], top); + /* Bottom Left Corner */ + vt[2].x = x; + vt[2].y = y + h; + nk_gdi_set_vertexColor(&vt[2], right); + + /* Bottom Right Corner */ + vt[3].x = x + w; + vt[3].y = y + h; + nk_gdi_set_vertexColor(&vt[3], bottom); + + gTri[0].Vertex1 = 0; + gTri[0].Vertex2 = 1; + gTri[0].Vertex3 = 2; + gTri[1].Vertex1 = 2; + gTri[1].Vertex2 = 1; + gTri[1].Vertex3 = 3; + GdiGradientFill(dc, vt, 4, gTri, 2, GRADIENT_FILL_TRIANGLE); + AlphaBlend(gdi->window_dc, x, y, x + w, y + h, gdi->memory_dc, x, y, x + w, y + h, alphaFunction); + +} + +static BOOL +SetPoint(POINT* p, LONG x, LONG y) +{ + if (!p) + return FALSE; + p->x = x; + p->y = y; + return TRUE; +} + +static void +nk_gdi_fill_triangle(HDC dc, short x0, short y0, short x1, + short y1, short x2, short y2, struct nk_color col) +{ + COLORREF color = convert_color(col); + POINT points[3]; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); + + SetDCPenColor(dc, color); + SetDCBrushColor(dc, color); + Polygon(dc, points, 3); +} + +static void +nk_gdi_stroke_triangle(HDC dc, short x0, short y0, short x1, + short y1, short x2, short y2, unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + POINT points[4]; + HPEN pen = NULL; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); + SetPoint(&points[3], x0, y0); + + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + Polyline(dc, points, 4); + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_fill_polygon(HDC dc, const struct nk_vec2i* pnts, int count, struct nk_color col) +{ + int i = 0; +#define MAX_POINTS 64 + POINT points[MAX_POINTS]; + COLORREF color = convert_color(col); + SetDCBrushColor(dc, color); + SetDCPenColor(dc, color); + for (i = 0; i < count && i < MAX_POINTS; ++i) { + points[i].x = pnts[i].x; + points[i].y = pnts[i].y; + } + Polygon(dc, points, i); +#undef MAX_POINTS +} + +static void +nk_gdi_stroke_polygon(HDC dc, const struct nk_vec2i* pnts, int count, + unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + HPEN pen = NULL; + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + if (count > 0) { + int i; + MoveToEx(dc, pnts[0].x, pnts[0].y, NULL); + for (i = 1; i < count; ++i) + LineTo(dc, pnts[i].x, pnts[i].y); + LineTo(dc, pnts[0].x, pnts[0].y); + } + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_stroke_polyline(HDC dc, const struct nk_vec2i* pnts, + int count, unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + HPEN pen = NULL; + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + if (count > 0) { + int i; + MoveToEx(dc, pnts[0].x, pnts[0].y, NULL); + for (i = 1; i < count; ++i) + LineTo(dc, pnts[i].x, pnts[i].y); + } + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_fill_circle(HDC dc, short x, short y, unsigned short w, + unsigned short h, struct nk_color col) +{ + COLORREF color = convert_color(col); + SetDCBrushColor(dc, color); + SetDCPenColor(dc, color); + Ellipse(dc, x, y, x + w, y + h); +} + +static void +nk_gdi_stroke_circle(HDC dc, short x, short y, unsigned short w, + unsigned short h, unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + HPEN pen = NULL; + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + SetDCBrushColor(dc, OPAQUE); + Ellipse(dc, x, y, x + w, y + h); + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_stroke_curve(HDC dc, struct nk_vec2i p1, + struct nk_vec2i p2, struct nk_vec2i p3, struct nk_vec2i p4, + unsigned short line_thickness, struct nk_color col) +{ + COLORREF color = convert_color(col); + POINT p[4]; + HPEN pen = NULL; + + SetPoint(&p[0], p1.x, p1.y); + SetPoint(&p[1], p2.x, p2.y); + SetPoint(&p[2], p3.x, p3.y); + SetPoint(&p[3], p4.x, p4.y); + + if (line_thickness == 1) { + SetDCPenColor(dc, color); + } + else { + pen = CreatePen(PS_SOLID, line_thickness, color); + SelectObject(dc, pen); + } + + SetDCBrushColor(dc, OPAQUE); + PolyBezier(dc, p, 4); + + if (pen) { + SelectObject(dc, GetStockObject(DC_PEN)); + DeleteObject(pen); + } +} + +static void +nk_gdi_draw_text(HDC dc, short x, short y, unsigned short w, unsigned short h, + const char* text, int len, GdiFont* font, struct nk_color cbg, struct nk_color cfg) +{ + int wsize; + WCHAR* wstr; + + if (!text || !font || !len) return; + + wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); + wstr = (WCHAR*)_alloca(wsize * sizeof(wchar_t)); + MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); + + SetBkColor(dc, convert_color(cbg)); + SetTextColor(dc, convert_color(cfg)); + + SelectObject(dc, font->handle); + ExtTextOutW(dc, x, y, ETO_OPAQUE, NULL, wstr, wsize, NULL); +} + +static void +nk_gdi_clear(nk_gdi_ctx gdi, HDC dc, struct nk_color col) +{ + COLORREF color = convert_color(col); + RECT rect; + SetRect(&rect, 0, 0, gdi->width, gdi->height); + SetBkColor(dc, color); + + ExtTextOutW(dc, 0, 0, ETO_OPAQUE, &rect, NULL, 0, NULL); +} + +static void +nk_gdi_blit(nk_gdi_ctx gdi, HDC dc) +{ + BitBlt(dc, 0, 0, gdi->width, gdi->height, gdi->memory_dc, 0, 0, SRCCOPY); + +} + +GdiFont* +nk_gdifont_create(const char* name, int size) +{ + TEXTMETRICW metric; + GdiFont* font = (GdiFont*)calloc(1, sizeof(GdiFont)); + if (!font) + return NULL; + font->dc = CreateCompatibleDC(0); + font->handle = CreateFontA(size, 0, 0, 0, FW_NORMAL, FALSE, FALSE, FALSE, DEFAULT_CHARSET, OUT_DEFAULT_PRECIS, CLIP_DEFAULT_PRECIS, CLEARTYPE_QUALITY, DEFAULT_PITCH | FF_DONTCARE, name); + SelectObject(font->dc, font->handle); + GetTextMetricsW(font->dc, &metric); + font->height = metric.tmHeight; + return font; +} + +static float +nk_gdifont_get_text_width(nk_handle handle, float height, const char* text, int len) +{ + GdiFont* font = (GdiFont*)handle.ptr; + SIZE size; + int wsize; + WCHAR* wstr; + if (!font || !text) + return 0; + + wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); + wstr = (WCHAR*)_alloca(wsize * sizeof(wchar_t)); + MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); + if (GetTextExtentPoint32W(font->dc, wstr, wsize, &size)) + return (float)size.cx; + return -1.0f; +} + +void +nk_gdifont_del(GdiFont* font) +{ + if (!font) return; + DeleteObject(font->handle); + DeleteDC(font->dc); + free(font); +} + +static void +nk_gdi_clipboard_paste(nk_handle usr, struct nk_text_edit* edit) +{ + (void)usr; + if (IsClipboardFormatAvailable(CF_UNICODETEXT) && OpenClipboard(NULL)) + { + HGLOBAL mem = GetClipboardData(CF_UNICODETEXT); + if (mem) + { + SIZE_T size = GlobalSize(mem) - 1; + if (size) + { + LPCWSTR wstr = (LPCWSTR)GlobalLock(mem); + if (wstr) + { + int utf8size = WideCharToMultiByte(CP_UTF8, 0, wstr, (int)(size / sizeof(wchar_t)), NULL, 0, NULL, NULL); + if (utf8size) + { + char* utf8 = (char*)malloc(utf8size); + if (utf8) + { + WideCharToMultiByte(CP_UTF8, 0, wstr, (int)(size / sizeof(wchar_t)), utf8, utf8size, NULL, NULL); + nk_textedit_paste(edit, utf8, utf8size); + free(utf8); + } + } + GlobalUnlock(mem); + } + } + } + CloseClipboard(); + } +} + +static void +nk_gdi_clipboard_copy(nk_handle usr, const char* text, int len) +{ + if (OpenClipboard(NULL)) + { + int wsize = MultiByteToWideChar(CP_UTF8, 0, text, len, NULL, 0); + if (wsize) + { + HGLOBAL mem = (HGLOBAL)GlobalAlloc(GMEM_MOVEABLE, (wsize + 1) * sizeof(wchar_t)); + if (mem) + { + wchar_t* wstr = (wchar_t*)GlobalLock(mem); + if (wstr) + { + MultiByteToWideChar(CP_UTF8, 0, text, len, wstr, wsize); + wstr[wsize] = 0; + GlobalUnlock(mem); + + SetClipboardData(CF_UNICODETEXT, mem); + } + } + } + CloseClipboard(); + } +} + +NK_API struct nk_context* +nk_gdi_init(nk_gdi_ctx* gdi, GdiFont* gdifont, HDC window_dc, unsigned int width, unsigned int height) +{ + *gdi = (nk_gdi_ctx)malloc(sizeof(struct _nk_gdi_ctx)); + + struct nk_user_font* font = &gdifont->nk; + font->userdata = nk_handle_ptr(gdifont); + font->height = (float)gdifont->height; + font->width = nk_gdifont_get_text_width; + + (*gdi)->bitmap = CreateCompatibleBitmap(window_dc, width, height); + (*gdi)->window_dc = window_dc; + (*gdi)->memory_dc = CreateCompatibleDC(window_dc); + (*gdi)->width = width; + (*gdi)->height = height; + SelectObject((*gdi)->memory_dc, (*gdi)->bitmap); + + nk_init_default(&(*gdi)->ctx, font); + (*gdi)->ctx.clip.copy = nk_gdi_clipboard_copy; + (*gdi)->ctx.clip.paste = nk_gdi_clipboard_paste; + return &(*gdi)->ctx; +} + +NK_API void +nk_gdi_set_font(nk_gdi_ctx gdi, GdiFont* gdifont) +{ + struct nk_user_font* font = &gdifont->nk; + font->userdata = nk_handle_ptr(gdifont); + font->height = (float)gdifont->height; + font->width = nk_gdifont_get_text_width; + nk_style_set_font(&gdi->ctx, font); +} + +NK_API int +nk_gdi_handle_event(nk_gdi_ctx gdi, HWND wnd, UINT msg, WPARAM wparam, LPARAM lparam) +{ + switch (msg) + { + case WM_SIZE: + { + unsigned width = LOWORD(lparam); + unsigned height = HIWORD(lparam); + if (width != gdi->width || height != gdi->height) + { + DeleteObject(gdi->bitmap); + gdi->bitmap = CreateCompatibleBitmap(gdi->window_dc, width, height); + gdi->width = width; + gdi->height = height; + SelectObject(gdi->memory_dc, gdi->bitmap); + } + break; + } + + case WM_PAINT: + { + PAINTSTRUCT paint; + HDC dc = BeginPaint(wnd, &paint); + nk_gdi_blit(gdi, dc); + EndPaint(wnd, &paint); + return 1; + } + + case WM_KEYDOWN: + case WM_KEYUP: + case WM_SYSKEYDOWN: + case WM_SYSKEYUP: + { + int down = !((lparam >> 31) & 1); + int ctrl = GetKeyState(VK_CONTROL) & (1 << 15); + + switch (wparam) + { + case VK_SHIFT: + case VK_LSHIFT: + case VK_RSHIFT: + nk_input_key(&gdi->ctx, NK_KEY_SHIFT, down); + return 1; + + case VK_DELETE: + nk_input_key(&gdi->ctx, NK_KEY_DEL, down); + return 1; + + case VK_RETURN: + nk_input_key(&gdi->ctx, NK_KEY_ENTER, down); + return 1; + + case VK_TAB: + nk_input_key(&gdi->ctx, NK_KEY_TAB, down); + return 1; + + case VK_LEFT: + if (ctrl) + nk_input_key(&gdi->ctx, NK_KEY_TEXT_WORD_LEFT, down); + else + nk_input_key(&gdi->ctx, NK_KEY_LEFT, down); + return 1; + + case VK_RIGHT: + if (ctrl) + nk_input_key(&gdi->ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else + nk_input_key(&gdi->ctx, NK_KEY_RIGHT, down); + return 1; + + case VK_BACK: + nk_input_key(&gdi->ctx, NK_KEY_BACKSPACE, down); + return 1; + + case VK_HOME: + nk_input_key(&gdi->ctx, NK_KEY_TEXT_START, down); + nk_input_key(&gdi->ctx, NK_KEY_SCROLL_START, down); + return 1; + + case VK_END: + nk_input_key(&gdi->ctx, NK_KEY_TEXT_END, down); + nk_input_key(&gdi->ctx, NK_KEY_SCROLL_END, down); + return 1; + + case VK_NEXT: + nk_input_key(&gdi->ctx, NK_KEY_SCROLL_DOWN, down); + return 1; + + case VK_PRIOR: + nk_input_key(&gdi->ctx, NK_KEY_SCROLL_UP, down); + return 1; + + case 'C': + if (ctrl) { + nk_input_key(&gdi->ctx, NK_KEY_COPY, down); + return 1; + } + break; + + case 'V': + if (ctrl) { + nk_input_key(&gdi->ctx, NK_KEY_PASTE, down); + return 1; + } + break; + + case 'X': + if (ctrl) { + nk_input_key(&gdi->ctx, NK_KEY_CUT, down); + return 1; + } + break; + + case 'Z': + if (ctrl) { + nk_input_key(&gdi->ctx, NK_KEY_TEXT_UNDO, down); + return 1; + } + break; + + case 'R': + if (ctrl) { + nk_input_key(&gdi->ctx, NK_KEY_TEXT_REDO, down); + return 1; + } + break; + } + return 0; + } + + case WM_CHAR: + if (wparam >= 32) + { + nk_input_unicode(&gdi->ctx, (nk_rune)wparam); + return 1; + } + break; + + case WM_LBUTTONDOWN: + nk_input_button(&gdi->ctx, NK_BUTTON_LEFT, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_LBUTTONUP: + nk_input_button(&gdi->ctx, NK_BUTTON_DOUBLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + nk_input_button(&gdi->ctx, NK_BUTTON_LEFT, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_RBUTTONDOWN: + nk_input_button(&gdi->ctx, NK_BUTTON_RIGHT, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_RBUTTONUP: + nk_input_button(&gdi->ctx, NK_BUTTON_RIGHT, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_MBUTTONDOWN: + nk_input_button(&gdi->ctx, NK_BUTTON_MIDDLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + SetCapture(wnd); + return 1; + + case WM_MBUTTONUP: + nk_input_button(&gdi->ctx, NK_BUTTON_MIDDLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 0); + ReleaseCapture(); + return 1; + + case WM_MOUSEWHEEL: + nk_input_scroll(&gdi->ctx, nk_vec2(0, (float)(short)HIWORD(wparam) / WHEEL_DELTA)); + return 1; + + case WM_MOUSEMOVE: + nk_input_motion(&gdi->ctx, (short)LOWORD(lparam), (short)HIWORD(lparam)); + return 1; + + case WM_LBUTTONDBLCLK: + nk_input_button(&gdi->ctx, NK_BUTTON_DOUBLE, (short)LOWORD(lparam), (short)HIWORD(lparam), 1); + return 1; + } + + return 0; +} + +NK_API void +nk_gdi_shutdown(nk_gdi_ctx gdi) +{ + DeleteObject(gdi->memory_dc); + DeleteObject(gdi->bitmap); + nk_free(&gdi->ctx); +} + +NK_API void +nk_gdi_render(nk_gdi_ctx gdi, struct nk_color clear) +{ + const struct nk_command* cmd; + + HDC memory_dc = gdi->memory_dc; + SelectObject(memory_dc, GetStockObject(DC_PEN)); + SelectObject(memory_dc, GetStockObject(DC_BRUSH)); + nk_gdi_clear(gdi, memory_dc, clear); + + nk_foreach(cmd, &gdi->ctx) + { + switch (cmd->type) { + case NK_COMMAND_NOP: break; + case NK_COMMAND_SCISSOR: { + const struct nk_command_scissor* s = (const struct nk_command_scissor*)cmd; + nk_gdi_scissor(memory_dc, s->x, s->y, s->w, s->h); + } break; + case NK_COMMAND_LINE: { + const struct nk_command_line* l = (const struct nk_command_line*)cmd; + nk_gdi_stroke_line(memory_dc, l->begin.x, l->begin.y, l->end.x, + l->end.y, l->line_thickness, l->color); + } break; + case NK_COMMAND_RECT: { + const struct nk_command_rect* r = (const struct nk_command_rect*)cmd; + nk_gdi_stroke_rect(memory_dc, r->x, r->y, r->w, r->h, + (unsigned short)r->rounding, r->line_thickness, r->color); + } break; + case NK_COMMAND_RECT_FILLED: { + const struct nk_command_rect_filled* r = (const struct nk_command_rect_filled*)cmd; + nk_gdi_fill_rect(memory_dc, r->x, r->y, r->w, r->h, + (unsigned short)r->rounding, r->color); + } break; + case NK_COMMAND_CIRCLE: { + const struct nk_command_circle* c = (const struct nk_command_circle*)cmd; + nk_gdi_stroke_circle(memory_dc, c->x, c->y, c->w, c->h, c->line_thickness, c->color); + } break; + case NK_COMMAND_CIRCLE_FILLED: { + const struct nk_command_circle_filled* c = (const struct nk_command_circle_filled*)cmd; + nk_gdi_fill_circle(memory_dc, c->x, c->y, c->w, c->h, c->color); + } break; + case NK_COMMAND_TRIANGLE: { + const struct nk_command_triangle* t = (const struct nk_command_triangle*)cmd; + nk_gdi_stroke_triangle(memory_dc, t->a.x, t->a.y, t->b.x, t->b.y, + t->c.x, t->c.y, t->line_thickness, t->color); + } break; + case NK_COMMAND_TRIANGLE_FILLED: { + const struct nk_command_triangle_filled* t = (const struct nk_command_triangle_filled*)cmd; + nk_gdi_fill_triangle(memory_dc, t->a.x, t->a.y, t->b.x, t->b.y, + t->c.x, t->c.y, t->color); + } break; + case NK_COMMAND_POLYGON: { + const struct nk_command_polygon* p = (const struct nk_command_polygon*)cmd; + nk_gdi_stroke_polygon(memory_dc, p->points, p->point_count, p->line_thickness, p->color); + } break; + case NK_COMMAND_POLYGON_FILLED: { + const struct nk_command_polygon_filled* p = (const struct nk_command_polygon_filled*)cmd; + nk_gdi_fill_polygon(memory_dc, p->points, p->point_count, p->color); + } break; + case NK_COMMAND_POLYLINE: { + const struct nk_command_polyline* p = (const struct nk_command_polyline*)cmd; + nk_gdi_stroke_polyline(memory_dc, p->points, p->point_count, p->line_thickness, p->color); + } break; + case NK_COMMAND_TEXT: { + const struct nk_command_text* t = (const struct nk_command_text*)cmd; + nk_gdi_draw_text(memory_dc, t->x, t->y, t->w, t->h, + (const char*)t->string, t->length, + (GdiFont*)t->font->userdata.ptr, + t->background, t->foreground); + } break; + case NK_COMMAND_CURVE: { + const struct nk_command_curve* q = (const struct nk_command_curve*)cmd; + nk_gdi_stroke_curve(memory_dc, q->begin, q->ctrl[0], q->ctrl[1], + q->end, q->line_thickness, q->color); + } break; + case NK_COMMAND_RECT_MULTI_COLOR: { + const struct nk_command_rect_multi_color* r = (const struct nk_command_rect_multi_color*)cmd; + nk_gdi_rect_multi_color(gdi, memory_dc, r->x, r->y, r->w, r->h, r->left, r->top, r->right, r->bottom); + } break; + case NK_COMMAND_IMAGE: { + const struct nk_command_image* i = (const struct nk_command_image*)cmd; + nk_gdi_draw_image(gdi, i->x, i->y, i->w, i->h, i->img, i->col); + } break; + case NK_COMMAND_ARC: + case NK_COMMAND_ARC_FILLED: + default: break; + } + } + nk_gdi_blit(gdi, gdi->window_dc); + nk_clear(&gdi->ctx); +} + +#endif diff --git a/demo/gdi_native_nuklear/window.h b/demo/gdi_native_nuklear/window.h new file mode 100644 index 0000000..f78d574 --- /dev/null +++ b/demo/gdi_native_nuklear/window.h @@ -0,0 +1,387 @@ +#ifndef NK_GDI_WINDOW +#define NK_GDI_WINDOW + +#define NK_GDI_WINDOW_CLS L"WNDCLS_NkGdi" + +#include + +/* Functin pointer types for window callbacks */ +typedef int(*nkgdi_window_func_close)(void); +typedef int(*nkgdi_window_func_draw)(struct nk_context*); + +/* Window container / context */ +struct nkgdi_window +{ + /* The window can be sized */ + int allow_sizing; + /* The window can be maximized by double clicking the titlebar */ + int allow_maximize; + /* The window is allowed to be moved by the user */ + int allow_move; + /* The window will render it's title bar */ + int has_titlebar; + + /* Callbacks */ + /* Called when the user or os requests a window close (return 1 to accept the reqest)*/ + nkgdi_window_func_close cb_on_close; + /* Called each time the window content should be drawn. Here you will do your nuklear drawing code + * but WITHOUT nk_begin and nk_end. Return 1 to keep the window open. + */ + nkgdi_window_func_draw cb_on_draw; + + /* Internal Data */ + struct + { + /* Window handle */ + HWND window_handle; + + /* Nuklear & GDI context */ + nk_gdi_ctx nk_gdi_ctx; + struct nk_context* nk_ctx; + + /* GDI required objects */ + GdiFont* gdi_font; + HDC window_dc; + + /* Internally used state variables */ + int is_open; + int is_draggin; + int ws_override; + int is_maximized; + POINT drag_offset; + int width; + int height; + }_internal; +}; + +/* API */ +/* This function will init all resources used by the implementation */ +void nkgdi_window_init(void); +/* This function will free all globally used resources */ +void nkgdi_window_shutdown(void); +/* Creates a new window (for the wnd context) */ +void nkgdi_window_create(struct nkgdi_window* wnd, unsigned int width, unsigned int height, const char* name, int posX, int posY); +/* Updates the window (Windows message loop, nuklear loop and drawing). Returns one as long as the window is valid and open */ +int nkgdi_window_update(struct nkgdi_window* wnd); +/* Destroys the window context wnd */ +void nkgdi_window_destroy(struct nkgdi_window* wnd); + +#ifdef NKGDI_IMPLEMENT_WINDOW + +/* Predeclare the windows window message procs */ +/* This proc will setup the pointer to the window context */ +LRESULT nkgdi_window_proc_setup(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam); +/* This proc will take the window context pointer and performs operations on it*/ +LRESULT nkgdi_window_proc_run(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam); + +void nkgdi_window_init(void) +{ + /* Describe the window class */ + WNDCLASSEXW cls; + cls.cbSize = sizeof(WNDCLASSEXW); + cls.style = CS_OWNDC | CS_DBLCLKS; + cls.lpfnWndProc = &nkgdi_window_proc_setup; + cls.cbClsExtra = 0; + cls.cbWndExtra = 0; + cls.hInstance = GetModuleHandle(NULL); + cls.hIcon = LoadIcon(NULL, IDI_APPLICATION); + cls.hCursor = LoadCursor(NULL, IDC_ARROW); + cls.hbrBackground = NULL; + cls.lpszMenuName = NULL; + cls.lpszClassName = NK_GDI_WINDOW_CLS; + cls.hIconSm = NULL; + + /* Register the window class */ + RegisterClassExW(&cls); +} + +void nkgdi_window_shutdown(void) +{ + /* Windows class no longer required, unregister it */ + UnregisterClassW(NK_GDI_WINDOW_CLS, GetModuleHandle(NULL)); +} + +void nkgdi_window_create(struct nkgdi_window* wnd, unsigned int width, unsigned int height, const char* name, int posX, int posY) +{ + DWORD styleEx = WS_EX_WINDOWEDGE; + DWORD style = WS_POPUP; + + /* Adjust window size to fit selected window styles */ + RECT cr; + cr.left = 0; + cr.top = 0; + cr.right = width; + cr.bottom = height; + AdjustWindowRectEx(&cr, style, FALSE, styleEx); + + /* Create the new window */ + wnd->_internal.window_handle = CreateWindowExW( + styleEx, + NK_GDI_WINDOW_CLS, + L"NkGdi", + style | WS_VISIBLE, + posX, posY, + cr.right - cr.left, cr.bottom - cr.top, + NULL, NULL, + GetModuleHandleW(NULL), + wnd + ); + + /* Give the window the ascii char name */ + SetWindowTextA(wnd->_internal.window_handle, name); + + /* Extract the window dc for gdi drawing */ + wnd->_internal.window_dc = GetWindowDC(wnd->_internal.window_handle); + + /* Create the gdi font required to draw text */ + wnd->_internal.gdi_font = nk_gdifont_create("Arial", 16); + + /* Init the gdi backend */ + wnd->_internal.nk_ctx = nk_gdi_init(&wnd->_internal.nk_gdi_ctx, wnd->_internal.gdi_font, wnd->_internal.window_dc, width, height); + + /* Bring all internal variables to a defined and valid initial state */ + wnd->_internal.is_open = 1; + wnd->_internal.is_draggin = 0; + wnd->_internal.ws_override = 0; + wnd->_internal.is_maximized = 0; + wnd->_internal.drag_offset.x = 0; + wnd->_internal.drag_offset.y = 0; + wnd->_internal.width = width; + wnd->_internal.height = height; +} + +void nkgdi_window_destroy(struct nkgdi_window* wnd) +{ + /* Destroy all objects in reverse order */ + if (wnd->_internal.nk_gdi_ctx) + { + nk_gdi_shutdown(wnd->_internal.nk_gdi_ctx); + } + if (wnd->_internal.gdi_font) + { + nk_gdifont_del(wnd->_internal.gdi_font); + } + if (wnd->_internal.window_dc) + { + ReleaseDC(wnd->_internal.window_handle, wnd->_internal.window_dc); + } + if (wnd->_internal.window_handle) + { + CloseWindow(wnd->_internal.window_handle); + DestroyWindow(wnd->_internal.window_handle); + } +} + +int nkgdi_window_update(struct nkgdi_window* wnd) +{ + /* The window will only be updated when it is open / valid */ + if (wnd->_internal.is_open) + { + /* First all pending window events will be processed */ + MSG msg; + nk_input_begin(wnd->_internal.nk_ctx); + while (PeekMessage(&msg, wnd->_internal.window_handle, 0, 0, PM_REMOVE)) + { + TranslateMessage(&msg); + DispatchMessageW(&msg); + } + nk_input_end(wnd->_internal.nk_ctx); + + /* To setup the nuklear window we need the windows title */ + char title[1024]; + GetWindowTextA(wnd->_internal.window_handle, title, 1024); + + /* The nk window flags are beeing create based on the context setup */ + nk_flags window_flags = NK_WINDOW_BORDER; + if(wnd->has_titlebar) + window_flags |= NK_WINDOW_CLOSABLE | NK_WINDOW_TITLE; + if(!wnd->_internal.is_maximized && wnd->allow_sizing) + window_flags |= NK_WINDOW_SCALABLE; + + /* Override the nuklear windows size when required */ + if (wnd->_internal.ws_override) + nk_window_set_bounds(wnd->_internal.nk_ctx, title, nk_rect(0, 0, wnd->_internal.width, wnd->_internal.height)); + + /* Start the nuklear window */ + if (nk_begin(wnd->_internal.nk_ctx, title, nk_rect(0, 0, wnd->_internal.width, wnd->_internal.height), window_flags)) + { + /* Call user drawing callback */ + if(wnd->cb_on_draw && !wnd->cb_on_draw(wnd->_internal.nk_ctx)) + wnd->_internal.is_open = 0; + + /* Update the windows window to reflect the nuklear windows size */ + struct nk_rect bounds = nk_window_get_bounds(wnd->_internal.nk_ctx); + if(bounds.w != wnd->_internal.width || bounds.h != wnd->_internal.height) + SetWindowPos(wnd->_internal.window_handle, NULL, 0, 0, bounds.w, bounds.h, SWP_NOMOVE | SWP_NOOWNERZORDER); + } + else + { + /* Nuklear window was closed. Handle close internally */ + if(!wnd->cb_on_close || wnd->cb_on_close()) + wnd->_internal.is_open = 0; + } + nk_end(wnd->_internal.nk_ctx); + + /* We no longer need the window size override flag to be set */ + wnd->_internal.ws_override = 0; + + /* Pass context to the nuklear gdi renderer */ + nk_gdi_render(wnd->_internal.nk_gdi_ctx, nk_rgb(0, 0, 0)); + } + + return wnd->_internal.is_open; +} + +LRESULT nkgdi_window_proc_setup(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam) +{ + /* Waiting to receive the NCCREATE message with the custom window data */ + if (msg == WM_NCCREATE) + { + /* Extracting the window context from message parameters */ + CREATESTRUCT* ptrCr = (CREATESTRUCT*)lParam; + struct nkgdi_window* nkgdi_wnd = (struct nkgdi_window*)ptrCr->lpCreateParams; + + /* Store the context in the window and redirect any further message to the run window proc*/ + SetWindowLongPtr(wnd, GWLP_USERDATA, (LONG_PTR)nkgdi_wnd); + SetWindowLongPtr(wnd, GWLP_WNDPROC, (LONG_PTR)&nkgdi_window_proc_run); + + /* Already call the run proc so that it gets the chance to handle NCCREATE as well */ + return nkgdi_window_proc_run(wnd, msg, wParam, lParam); + } + + /* Until we get WM_NCCREATE windows is going to handle the messages */ + return DefWindowProc(wnd, msg, wParam, lParam); +} + +LRESULT nkgdi_window_proc_run(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam) +{ + /* The window context is extracted from the window data */ + struct nkgdi_window* nkwnd = (struct nkgdi_window*)GetWindowLongPtrW(wnd, GWLP_USERDATA); + + /* Switch on the message code to handle all required messages */ + switch (msg) + { + /* Window close event */ + case WM_CLOSE: + /* Call custom close callback */ + if(!nkwnd->cb_on_close || nkwnd->cb_on_close()) + nkwnd->_internal.is_open = 0; + return 0; /* No default behaviour. We do it our own way */ + + /* Window sizing event (is currently beeing sized) */ + case WM_SIZING: + { + /* Size of the client / active are is extracted and stored */ + RECT cr; + GetClientRect(wnd, &cr); + nkwnd->_internal.width = cr.right - cr.left; + nkwnd->_internal.height = cr.bottom - cr.top; + } + break; + + /* Window size event (done sizing, maximize, minimize, ...) */ + case WM_SIZE: + { + /* Window was maximized */ + if (wParam == SIZE_MAXIMIZED) + { + /* Get the nearest monitor and retrive its details */ + HMONITOR monitor = MonitorFromWindow(wnd, MONITOR_DEFAULTTOPRIMARY); + MONITORINFO monitorInfo; + monitorInfo.cbSize = sizeof(MONITORINFO); + if (GetMonitorInfoW(monitor, &monitorInfo)) + { + /* Adjust the window size and position by the monitor working area (without taskbar) */ + nkwnd->_internal.height = monitorInfo.rcWork.bottom - monitorInfo.rcWork.top; + nkwnd->_internal.width = monitorInfo.rcWork.right - monitorInfo.rcWork.left; + nkwnd->_internal.ws_override = 1; /* Sizing was done without nuklear beeing aware. So we need to override it */ + nkwnd->_internal.is_maximized = 1; + SetWindowPos(wnd, NULL, 0, 0, nkwnd->_internal.width, nkwnd->_internal.height, SWP_NOMOVE | SWP_NOZORDER); + } + } + /* Window was restored (no longer maximized) */ + else if (wParam == SIZE_RESTORED) + { + nkwnd->_internal.is_maximized = 0; + } + + /* Always get the new bounds of the window */ + RECT cr; + GetClientRect(wnd, &cr); + nkwnd->_internal.width = cr.right - cr.left; + nkwnd->_internal.height = cr.bottom - cr.top; + } + break; + + /* Mouse started left click */ + case WM_LBUTTONDOWN: + { + /* Handle dragging when allowed, has titlebar and mouse is in titlebar (Y <= 30) */ + if (HIWORD(lParam) <= 30 && nkwnd->allow_move && nkwnd->has_titlebar) + { + /* Mark dragging internally and store mouse click offset */ + nkwnd->_internal.is_draggin = 1; + nkwnd->_internal.drag_offset.x = LOWORD(lParam); + nkwnd->_internal.drag_offset.y = HIWORD(lParam); + } + } + break; + + /* Mouse stoped left click */ + case WM_LBUTTONUP: + /* No longer dragging the window */ + nkwnd->_internal.is_draggin = 0; + break; + + /* Mouse is moving on the window */ + case WM_MOUSEMOVE: + { + /* When we are dragging and are not maximized process dragging */ + if (nkwnd->_internal.is_draggin && !nkwnd->_internal.is_maximized) + { + /* Get the current global position of the mouse */ + POINT cursorPos; + GetCursorPos(&cursorPos); + /* Substract the internal offset */ + cursorPos.x -= nkwnd->_internal.drag_offset.x; + cursorPos.y -= nkwnd->_internal.drag_offset.y; + /* Update position of out window and make sure window is in a movable state (= Restored) */ + ShowWindow(wnd, SW_RESTORE); + SetWindowPos(wnd, NULL, cursorPos.x, cursorPos.y, 0, 0, SWP_NOSIZE | SWP_NOZORDER); + } + } + break; + + /* Mouse double clicked */ + case WM_LBUTTONDBLCLK: + { + /* Will only affect window when on the titlebar */ + if (HIWORD(lParam) <= 30 && nkwnd->allow_maximize && nkwnd->has_titlebar) + { + /* When the window is already maximized restore it */ + if (nkwnd->_internal.is_maximized) + { + ShowWindow(wnd, SW_RESTORE); + } + /* Else we gonna do maximize it*/ + else + { + ShowWindow(wnd, SW_MAXIMIZE); + } + /* We overrideed the window size, make sure to affect the nk window as well */ + nkwnd->_internal.ws_override = 1; + } + } + break; + } + + /* Allow nuklear to handle the message as well */ + if (nkwnd->_internal.nk_gdi_ctx && nk_gdi_handle_event(nkwnd->_internal.nk_gdi_ctx, wnd, msg, wParam, lParam)) + return 0; + + /* In case we reach this line our code and nuklear did not respond to the message. Allow windows to handle it s*/ + return DefWindowProc(wnd, msg, wParam, lParam); +} + +#endif +#endif diff --git a/demo/gdip/main.c b/demo/gdip/main.c index a90a0cf..8f132f5 100644 --- a/demo/gdip/main.c +++ b/demo/gdip/main.c @@ -28,27 +28,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -106,10 +111,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif while (running) @@ -159,6 +170,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/gdip/nuklear_gdip.h b/demo/gdip/nuklear_gdip.h index 3a0a2f0..f83964d 100644 --- a/demo/gdip/nuklear_gdip.h +++ b/demo/gdip/nuklear_gdip.h @@ -47,6 +47,8 @@ NK_API void nk_gdip_image_free(struct nk_image image); #include #include +#define _USE_MATH_DEFINES +#include /* manually declare everything GDI+ needs, because GDI+ headers are not usable from C */ @@ -319,6 +321,10 @@ GpStatus WINGDIPAPI GdipDrawArcI(GpGraphics *graphics, GpPen *pen, INT x, INT y, INT width, INT height, REAL startAngle, REAL sweepAngle); +GpStatus WINGDIPAPI +GdipDrawPieI(GpGraphics *graphics, GpPen *pen, INT x, INT y, + INT width, INT height, REAL startAngle, REAL sweepAngle); + GpStatus WINGDIPAPI GdipFillPieI(GpGraphics *graphics, GpBrush *brush, INT x, INT y, INT width, INT height, REAL startAngle, REAL sweepAngle); @@ -471,15 +477,25 @@ nk_gdip_fill_rect(short x, short y, unsigned short w, } } +static BOOL +SetPoint(POINT *p, LONG x, LONG y) +{ + if (!p) + return FALSE; + p->x = x; + p->y = y; + return TRUE; +} + static void nk_gdip_fill_triangle(short x0, short y0, short x1, short y1, short x2, short y2, struct nk_color col) { - POINT points[] = { - { x0, y0 }, - { x1, y1 }, - { x2, y2 }, - }; + POINT points[3]; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); GdipSetSolidFillColor(gdip.brush, convert_color(col)); GdipFillPolygonI(gdip.memory, gdip.brush, points, 3, FillModeAlternate); @@ -489,12 +505,13 @@ static void nk_gdip_stroke_triangle(short x0, short y0, short x1, short y1, short x2, short y2, unsigned short line_thickness, struct nk_color col) { - POINT points[] = { - { x0, y0 }, - { x1, y1 }, - { x2, y2 }, - { x0, y0 }, - }; + POINT points[4]; + + SetPoint(&points[0], x0, y0); + SetPoint(&points[1], x1, y1); + SetPoint(&points[2], x2, y2); + SetPoint(&points[3], x0, y0); + GdipSetPenWidth(gdip.pen, (REAL)line_thickness); GdipSetPenColor(gdip.pen, convert_color(col)); GdipDrawPolygonI(gdip.memory, gdip.pen, points, 4); @@ -569,13 +586,33 @@ nk_gdip_stroke_curve(struct nk_vec2i p1, GdipDrawBezierI(gdip.memory, gdip.pen, p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, p4.x, p4.y); } +static void +nk_gdip_fill_arc(short cx, short cy, unsigned short r, float amin, float adelta, struct nk_color col) +{ + GdipSetSolidFillColor(gdip.brush, convert_color(col)); + GdipFillPieI(gdip.memory, gdip.brush, cx - r, cy - r, r * 2, r * 2, amin * (180/M_PI), adelta * (180/M_PI)); +} + +static void +nk_gdip_stroke_arc(short cx, short cy, unsigned short r, float amin, float adelta, unsigned short line_thickness, struct nk_color col) +{ + GdipSetPenWidth(gdip.pen, (REAL)line_thickness); + GdipSetPenColor(gdip.pen, convert_color(col)); + GdipDrawPieI(gdip.memory, gdip.pen, cx - r, cy - r, r * 2, r * 2, amin * (180/M_PI), adelta * (180/M_PI)); +} + static void nk_gdip_draw_text(short x, short y, unsigned short w, unsigned short h, const char *text, int len, GdipFont *font, struct nk_color cbg, struct nk_color cfg) { int wsize; WCHAR* wstr; - RectF layout = { (FLOAT)x, (FLOAT)y, (FLOAT)w, (FLOAT)h }; + RectF layout; + + layout.X = x; + layout.Y = y; + layout.Width = w; + layout.Height = h; if(!text || !font || !len) return; @@ -1149,9 +1186,15 @@ nk_gdip_prerender_gui(enum nk_anti_aliasing AA) const struct nk_command_image *i = (const struct nk_command_image *)cmd; nk_gdip_draw_image(i->x, i->y, i->w, i->h, i->img, i->col); } break; + case NK_COMMAND_ARC: { + const struct nk_command_arc *i = (const struct nk_command_arc *)cmd; + nk_gdip_stroke_arc(i->cx, i->cy, i->r, i->a[0], i->a[1], i->line_thickness, i->color); + } break; + case NK_COMMAND_ARC_FILLED: { + const struct nk_command_arc_filled *i = (const struct nk_command_arc_filled *)cmd; + nk_gdip_fill_arc(i->cx, i->cy, i->r, i->a[0], i->a[1], i->color); + } break; case NK_COMMAND_RECT_MULTI_COLOR: - case NK_COMMAND_ARC: - case NK_COMMAND_ARC_FILLED: default: break; } } diff --git a/demo/glfw_opengl2/Makefile b/demo/glfw_opengl2/Makefile index c08d65f..9ac6b10 100644 --- a/demo/glfw_opengl2/Makefile +++ b/demo/glfw_opengl2/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c99 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/glfw_opengl2/main.c b/demo/glfw_opengl2/main.c index f3d3d9d..8d97773 100644 --- a/demo/glfw_opengl2/main.c +++ b/demo/glfw_opengl2/main.c @@ -24,6 +24,9 @@ #include "../../nuklear.h" #include "nuklear_glfw_gl2.h" +#define STB_IMAGE_IMPLEMENTATION +#include "../../demo/common/filebrowser/stb_image.h" + #define WINDOW_WIDTH 1200 #define WINDOW_HEIGHT 800 @@ -34,30 +37,39 @@ * ===============================================================*/ /* This are some code examples to provide a small overview of what can be * done with this library. To try out an example uncomment the defines */ -/*#define INCLUDE_ALL */ -/*#define INCLUDE_STYLE */ -/*#define INCLUDE_CALCULATOR */ -#define INCLUDE_OVERVIEW -/*#define INCLUDE_NODE_EDITOR */ +/* #define INCLUDE_ALL */ +/* #define INCLUDE_STYLE */ +/* #define INCLUDE_CALCULATOR */ +#define INCLUDE_CANVAS +/* #define INCLUDE_FILE_BROWSER */ +/* #define INCLUDE_OVERVIEW */ +/* #define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_FILE_BROWSER + #include "../../demo/common/file_browser.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -73,8 +85,14 @@ int main(void) /* Platform */ static GLFWwindow *win; int width = 0, height = 0; + + /* GUI */ struct nk_context *ctx; struct nk_colorf bg; +#ifdef INCLUDE_FILE_BROWSER + struct file_browser browser; + struct media media; +#endif /* GLFW */ glfwSetErrorCallback(error_callback); @@ -103,13 +121,38 @@ int main(void) /*nk_style_set_font(ctx, &droid->handle);*/} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; + + #ifdef INCLUDE_FILE_BROWSER + /* icons */ + glEnable(GL_TEXTURE_2D); + media.icons.home = icon_load("../../demo/common/filebrowser/icon/home.png"); + media.icons.directory = icon_load("../../demo/common/filebrowser/icon/directory.png"); + media.icons.computer = icon_load("../../demo/common/filebrowser/icon/computer.png"); + media.icons.desktop = icon_load("../../demo/common/filebrowser/icon/desktop.png"); + media.icons.default_file = icon_load("../../demo/common/filebrowser/icon/default.png"); + media.icons.text_file = icon_load("../../demo/common/filebrowser/icon/text.png"); + media.icons.music_file = icon_load("../../demo/common/filebrowser/icon/music.png"); + media.icons.font_file = icon_load("../../demo/common/filebrowser/icon/font.png"); + media.icons.img_file = icon_load("../../demo/common/filebrowser/icon/img.png"); + media.icons.movie_file = icon_load("../../demo/common/filebrowser/icon/movie.png"); + media_init(&media); + + file_browser_init(&browser, &media); + #endif + while (!glfwWindowShouldClose(win)) { /* Input */ @@ -155,6 +198,12 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif + #ifdef INCLUDE_FILE_BROWSER + file_browser_run(&browser, ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif @@ -175,8 +224,23 @@ int main(void) nk_glfw3_render(NK_ANTI_ALIASING_ON); glfwSwapBuffers(win); } + + #ifdef INCLUDE_FILE_BROWSER + glDeleteTextures(1,(const GLuint*)&media.icons.home.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.directory.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.computer.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.desktop.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.default_file.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.text_file.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.music_file.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.font_file.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.img_file.handle.id); + glDeleteTextures(1,(const GLuint*)&media.icons.movie_file.handle.id); + + file_browser_free(&browser); + #endif + nk_glfw3_shutdown(); glfwTerminate(); return 0; } - diff --git a/demo/glfw_opengl2/nuklear_glfw_gl2.h b/demo/glfw_opengl2/nuklear_glfw_gl2.h index a197e90..fb8b31e 100644 --- a/demo/glfw_opengl2/nuklear_glfw_gl2.h +++ b/demo/glfw_opengl2/nuklear_glfw_gl2.h @@ -53,7 +53,7 @@ NK_API void nk_gflw3_scroll_callback(GLFWwindow *win, double xof struct nk_glfw_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint font_tex; }; @@ -140,7 +140,7 @@ nk_glfw3_render(enum nk_anti_aliasing AA) config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -218,6 +218,7 @@ NK_API void nk_glfw3_mouse_button_callback(GLFWwindow* window, int button, int action, int mods) { double x, y; + NK_UNUSED(mods); if (button != GLFW_MOUSE_BUTTON_LEFT) return; glfwGetCursorPos(window, &x, &y); if (action == GLFW_PRESS) { @@ -287,7 +288,7 @@ nk_glfw3_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&glfw.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_glfw3_device_upload_atlas(image, w, h); - nk_font_atlas_end(&glfw.atlas, nk_handle_id((int)glfw.ogl.font_tex), &glfw.ogl.null); + nk_font_atlas_end(&glfw.atlas, nk_handle_id((int)glfw.ogl.font_tex), &glfw.ogl.tex_null); if (glfw.atlas.default_font) nk_style_set_font(&glfw.ctx, &glfw.atlas.default_font->handle); } diff --git a/demo/glfw_opengl3/Makefile b/demo/glfw_opengl3/Makefile index da95261..7c94f3d 100644 --- a/demo/glfw_opengl3/Makefile +++ b/demo/glfw_opengl3/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/glfw_opengl3/main.c b/demo/glfw_opengl3/main.c index b9b09d7..8eb749d 100644 --- a/demo/glfw_opengl3/main.c +++ b/demo/glfw_opengl3/main.c @@ -41,27 +41,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ #define INCLUDE_OVERVIEW /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -121,10 +126,16 @@ int main(void) /*nk_style_set_font(ctx, &droid->handle);*/} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -173,6 +184,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/glfw_opengl3/nuklear_glfw_gl3.h b/demo/glfw_opengl3/nuklear_glfw_gl3.h index aa678fb..663fa0b 100644 --- a/demo/glfw_opengl3/nuklear_glfw_gl3.h +++ b/demo/glfw_opengl3/nuklear_glfw_gl3.h @@ -26,7 +26,7 @@ enum nk_glfw_init_state{ struct nk_glfw_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -266,7 +266,7 @@ nk_glfw3_render(struct nk_glfw* glfw, enum nk_anti_aliasing AA, int max_vertex_b config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -328,9 +328,10 @@ nk_gflw3_scroll_callback(GLFWwindow *win, double xoff, double yoff) NK_API void nk_glfw3_mouse_button_callback(GLFWwindow* win, int button, int action, int mods) { - double x, y; - if (button != GLFW_MOUSE_BUTTON_LEFT) return; struct nk_glfw* glfw = glfwGetWindowUserPointer(win); + double x, y; + NK_UNUSED(mods); + if (button != GLFW_MOUSE_BUTTON_LEFT) return; glfwGetCursorPos(win, &x, &y); if (action == GLFW_PRESS) { double dt = glfwGetTime() - glfw->last_button_click; @@ -345,7 +346,7 @@ nk_glfw3_mouse_button_callback(GLFWwindow* win, int button, int action, int mods NK_INTERN void nk_glfw3_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) { - struct nk_glfw* glfw = usr.ptr; + struct nk_glfw* glfw = (struct nk_glfw*)usr.ptr; const char *text = glfwGetClipboardString(glfw->win); if (text) nk_textedit_paste(edit, text, nk_strlen(text)); (void)usr; @@ -354,13 +355,13 @@ nk_glfw3_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) NK_INTERN void nk_glfw3_clipboard_copy(nk_handle usr, const char *text, int len) { + struct nk_glfw* glfw = (struct nk_glfw*)usr.ptr; char *str = 0; if (!len) return; str = (char*)malloc((size_t)len+1); if (!str) return; memcpy(str, text, (size_t)len); str[len] = '\0'; - struct nk_glfw* glfw = usr.ptr; glfwSetClipboardString(glfw->win, str); free(str); } @@ -402,7 +403,7 @@ nk_glfw3_font_stash_end(struct nk_glfw* glfw) const void *image; int w, h; image = nk_font_atlas_bake(&glfw->atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_glfw3_device_upload_atlas(glfw, image, w, h); - nk_font_atlas_end(&glfw->atlas, nk_handle_id((int)glfw->ogl.font_tex), &glfw->ogl.null); + nk_font_atlas_end(&glfw->atlas, nk_handle_id((int)glfw->ogl.font_tex), &glfw->ogl.tex_null); if (glfw->atlas.default_font) nk_style_set_font(&glfw->ctx, &glfw->atlas.default_font->handle); } diff --git a/demo/glfw_opengl4/Makefile b/demo/glfw_opengl4/Makefile index da95261..7c94f3d 100644 --- a/demo/glfw_opengl4/Makefile +++ b/demo/glfw_opengl4/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/glfw_opengl4/main.c b/demo/glfw_opengl4/main.c index 5385fb3..176a1ef 100644 --- a/demo/glfw_opengl4/main.c +++ b/demo/glfw_opengl4/main.c @@ -41,27 +41,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ #define INCLUDE_OVERVIEW /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -121,10 +126,16 @@ int main(void) /*nk_style_set_font(ctx, &droid->handle);*/} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif /* Create bindless texture. @@ -194,6 +205,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/glfw_opengl4/nuklear_glfw_gl4.h b/demo/glfw_opengl4/nuklear_glfw_gl4.h index 4b644a4..781bfc3 100644 --- a/demo/glfw_opengl4/nuklear_glfw_gl4.h +++ b/demo/glfw_opengl4/nuklear_glfw_gl4.h @@ -72,7 +72,7 @@ struct nk_glfw_vertex { struct nk_glfw_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -116,6 +116,7 @@ NK_API void nk_glfw3_device_create() { GLint status; + GLint len = 0; static const GLchar *vertex_shader = NK_SHADER_VERSION NK_SHADER_BINDLESS @@ -156,7 +157,6 @@ nk_glfw3_device_create() glCompileShader(dev->frag_shdr); glGetShaderiv(dev->vert_shdr, GL_COMPILE_STATUS, &status); - GLint len = 0; glGetShaderiv(dev->vert_shdr, GL_INFO_LOG_LENGTH, &len); if (len > 1) { char *log = (char*)calloc((size_t)len, sizeof(char)); @@ -407,7 +407,7 @@ nk_glfw3_render(enum nk_anti_aliasing AA) config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -477,6 +477,7 @@ NK_API void nk_glfw3_mouse_button_callback(GLFWwindow* window, int button, int action, int mods) { double x, y; + NK_UNUSED(mods); if (button != GLFW_MOUSE_BUTTON_LEFT) return; glfwGetCursorPos(window, &x, &y); if (action == GLFW_PRESS) { @@ -552,7 +553,7 @@ nk_glfw3_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&glfw.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_glfw3_device_upload_atlas(image, w, h); - nk_font_atlas_end(&glfw.atlas, nk_handle_id((int)glfw.ogl.font_tex_index), &glfw.ogl.null); + nk_font_atlas_end(&glfw.atlas, nk_handle_id((int)glfw.ogl.font_tex_index), &glfw.ogl.tex_null); if (glfw.atlas.default_font) nk_style_set_font(&glfw.ctx, &glfw.atlas.default_font->handle); } diff --git a/demo/sdl2surface_rawfb/Makefile b/demo/sdl2surface_rawfb/Makefile index ce71e79..4fabb13 100644 --- a/demo/sdl2surface_rawfb/Makefile +++ b/demo/sdl2surface_rawfb/Makefile @@ -1,4 +1,4 @@ -CFLAGS=`sdl2-config --cflags --libs` -std=c11 -Wall -O0 -g -fvisibility=hidden -Wno-unused `pkg-config SDL2_ttf --cflags --libs` +CFLAGS=`sdl2-config --cflags --libs` -std=c89 -Wall -Wextra -pedantic -Wno-unused-function -O0 -g -fvisibility=hidden `pkg-config SDL2_ttf --cflags --libs` .PHONY: clean diff --git a/demo/sdl2surface_rawfb/main.c b/demo/sdl2surface_rawfb/main.c index 2d3fa78..a8b661a 100644 --- a/demo/sdl2surface_rawfb/main.c +++ b/demo/sdl2surface_rawfb/main.c @@ -2,7 +2,6 @@ #include #include - #ifndef MIN #define MIN(a,b) ((a) < (b) ? (a) : (b)) #endif @@ -23,9 +22,48 @@ #define NK_SDLSURFACE_IMPLEMENTATION #include "sdl2surface_rawfb.h" +/* =============================================================== + * + * EXAMPLE + * + * ===============================================================*/ +/* This are some code examples to provide a small overview of what can be + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ +/*#define INCLUDE_OVERVIEW */ +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif + static int translate_sdl_key(struct SDL_Keysym const *k) { /*keyboard handling left as an exercise for the reader */ + NK_UNUSED(k); return NK_KEY_NONE; } @@ -36,7 +74,7 @@ static int sdl_button_to_nk(int button) switch(button) { default: - //ft + /* ft */ case SDL_BUTTON_LEFT: return NK_BUTTON_LEFT; break; @@ -50,7 +88,7 @@ static int sdl_button_to_nk(int button) } } - +#if 0 static void grid_demo(struct nk_context *ctx) { @@ -85,7 +123,7 @@ grid_demo(struct nk_context *ctx) } nk_end(ctx); } - +#endif int main(int argc, char **argv) @@ -93,20 +131,28 @@ int main(int argc, char **argv) struct nk_color clear = {0,100,0,255}; struct nk_vec2 vec; struct nk_rect bounds = {40,40,0,0}; + struct sdlsurface_context *context; + + SDL_DisplayMode dm; + SDL_Window *window; + SDL_Renderer *renderer; + SDL_Texture *tex; + SDL_Surface *surface; + + NK_UNUSED(argc); + NK_UNUSED(argv); SDL_Init(SDL_INIT_VIDEO); printf("sdl init called...\n"); SDL_SetHint(SDL_HINT_RENDER_SCALE_QUALITY, "linear"); - SDL_DisplayMode dm; - SDL_GetDesktopDisplayMode(0, &dm); printf("desktop display mode %d %d\n", dm.w, dm.h); - SDL_Window *window = SDL_CreateWindow("Puzzle", SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, dm.w-200,dm.h-200, SDL_WINDOW_OPENGL); + window = SDL_CreateWindow("Puzzle", SDL_WINDOWPOS_UNDEFINED, SDL_WINDOWPOS_UNDEFINED, dm.w-200,dm.h-200, SDL_WINDOW_OPENGL); if (!window) { printf("can't open window!\n"); @@ -114,18 +160,18 @@ int main(int argc, char **argv) } - SDL_Renderer *renderer = SDL_CreateRenderer(window, -1, 0); + renderer = SDL_CreateRenderer(window, -1, 0); - SDL_Surface *surface = SDL_CreateRGBSurfaceWithFormat(0, dm.w-200, dm.h-200, 32, SDL_PIXELFORMAT_ARGB8888); + surface = SDL_CreateRGBSurfaceWithFormat(0, dm.w-200, dm.h-200, 32, SDL_PIXELFORMAT_ARGB8888); - struct sdlsurface_context *context = nk_sdlsurface_init(surface, 13.0f); + context = nk_sdlsurface_init(surface, 13.0f); while(1) { - nk_input_begin(&(context->ctx)); SDL_Event event; + nk_input_begin(&(context->ctx)); while (SDL_PollEvent(&event)) { switch(event.type) @@ -177,14 +223,29 @@ int main(int argc, char **argv) } nk_end(&(context->ctx)); -// grid_demo(&(context->ctx)); + /* grid_demo(&(context->ctx)); */ + + /* -------------- EXAMPLES ---------------- */ + #ifdef INCLUDE_CALCULATOR + calculator(&(context->ctx)); + #endif + #ifdef INCLUDE_CANVAS + canvas(&(context->ctx)); + #endif + #ifdef INCLUDE_OVERVIEW + overview(&(context->ctx)); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(&(context->ctx)); + #endif + /* ----------------------------------------- */ nk_sdlsurface_render(context, clear, 1); - SDL_Texture *tex = SDL_CreateTextureFromSurface(renderer, surface); + tex = SDL_CreateTextureFromSurface(renderer, surface); SDL_RenderCopy(renderer, tex, NULL, NULL); SDL_RenderPresent(renderer); SDL_DestroyTexture(tex); diff --git a/demo/sdl2surface_rawfb/sdl2surface_rawfb.h b/demo/sdl2surface_rawfb/sdl2surface_rawfb.h index 94496ff..6e2eb59 100644 --- a/demo/sdl2surface_rawfb/sdl2surface_rawfb.h +++ b/demo/sdl2surface_rawfb/sdl2surface_rawfb.h @@ -65,54 +65,18 @@ struct sdlsurface_context { #endif static unsigned int -nk_sdlsurface_color2int(const struct nk_color c, SDL_PixelFormatEnum pl) +nk_sdlsurface_color2int(const struct nk_color c, const SDL_PixelFormat *format) { - unsigned int res = 0; - - switch (pl) { - case SDL_PIXELFORMAT_RGBA8888: - res |= c.r << 24; - res |= c.g << 16; - res |= c.b << 8; - res |= c.a; - break; - case SDL_PIXELFORMAT_ARGB8888: - res |= c.a << 24; - res |= c.r << 16; - res |= c.g << 8; - res |= c.b; - break; - - default: - perror("nk_sdlsurface_color2int(): Unsupported pixel layout.\n"); - break; - } - return (res); + return SDL_MapRGBA(format, c.r, c.g, c.b, c.a); } static struct nk_color -nk_sdlsurface_int2color(const unsigned int i, SDL_PixelFormatEnum pl) +nk_sdlsurface_int2color(const unsigned int i, const SDL_PixelFormat *format) { struct nk_color col = {0,0,0,0}; - switch (pl) { - case SDL_PIXELFORMAT_RGBA8888: - col.r = (i >> 24) & 0xff; - col.g = (i >> 16) & 0xff; - col.b = (i >> 8) & 0xff; - col.a = i & 0xff; - break; - case SDL_PIXELFORMAT_ARGB8888: - col.a = (i >> 24) & 0xff; - col.r = (i >> 16) & 0xff; - col.g = (i >> 8) & 0xff; - col.b = i & 0xff; - break; + SDL_GetRGBA(i, format, &col.r, &col.g, &col.b, &col.a); - default: - perror("nk_sdlsurface_int2color(): Unsupported pixel layout.\n"); - break; - } return col; } @@ -120,16 +84,22 @@ static void nk_sdlsurface_ctx_setpixel(const struct sdlsurface_context *sdlsurface, const short x0, const short y0, const struct nk_color col) { - unsigned int c = nk_sdlsurface_color2int(col, sdlsurface->fb->format->format); + unsigned int c = nk_sdlsurface_color2int(col, sdlsurface->fb->format); unsigned char *pixels = sdlsurface->fb->pixels; - unsigned int *ptr; pixels += y0 * sdlsurface->fb->pitch; - ptr = (unsigned int *)pixels + x0; if (y0 < sdlsurface->scissors.h && y0 >= sdlsurface->scissors.y && - x0 >= sdlsurface->scissors.x && x0 < sdlsurface->scissors.w) - *ptr = c; + x0 >= sdlsurface->scissors.x && x0 < sdlsurface->scissors.w) { + + if (sdlsurface->fb->format->BytesPerPixel == 4) { + *((Uint32 *)pixels + x0) = c; + } else if (sdlsurface->fb->format->BytesPerPixel == 2) { + *((Uint16 *)pixels + x0) = c; + } else { + *((Uint8 *)pixels + x0) = c; + } + } } static void @@ -140,40 +110,49 @@ nk_sdlsurface_line_horizontal(const struct sdlsurface_context *sdlsurface, * It does not check for scissors or image borders. * The caller has to make sure it does no exceed bounds. */ unsigned int i, n; - unsigned int c[16]; + unsigned char c[16 * 4]; unsigned char *pixels = sdlsurface->fb->pixels; - unsigned int *ptr; + unsigned int bpp = sdlsurface->fb->format->BytesPerPixel; - pixels += y * sdlsurface->fb->pitch; - ptr = (unsigned int *)pixels + x0; + pixels += (y * sdlsurface->fb->pitch) + (x0 * bpp); - n = x1 - x0; - for (i = 0; i < sizeof(c) / sizeof(c[0]); i++) - c[i] = nk_sdlsurface_color2int(col, sdlsurface->fb->format->format); + n = (x1 - x0) * bpp; + if (bpp == 4) { + for (i = 0; i < sizeof(c) / bpp; i++) + ((Uint32 *)c)[i] = nk_sdlsurface_color2int(col, sdlsurface->fb->format); + } else if (bpp == 2) { + for (i = 0; i < sizeof(c) / bpp; i++) + ((Uint16 *)c)[i] = nk_sdlsurface_color2int(col, sdlsurface->fb->format); + } else { + for (i = 0; i < sizeof(c) / bpp; i++) + ((Uint8 *)c)[i] = nk_sdlsurface_color2int(col, sdlsurface->fb->format); + } - while (n > 16) { - memcpy((void *)ptr, c, sizeof(c)); - n -= 16; ptr += 16; + while (n > sizeof(c)) { + memcpy((void*)pixels, c, sizeof(c)); + n -= sizeof(c); pixels += sizeof(c); } for (i = 0; i < n; i++) - ptr[i] = c[i]; + pixels[i] = c[i]; } static void nk_sdlsurface_img_setpixel(const struct SDL_Surface *img, const int x0, const int y0, const struct nk_color col) { - unsigned int c = nk_sdlsurface_color2int(col, img->format->format); + unsigned int c = nk_sdlsurface_color2int(col, img->format); unsigned char *ptr; - unsigned int *pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); - pixel = (unsigned int *)ptr; + ptr = (unsigned char *)img->pixels + (img->pitch * y0); if (img->format == NK_FONT_ATLAS_ALPHA8) { ptr[x0] = col.a; + } else if (img->format->BytesPerPixel == 4) { + ((Uint32 *)ptr)[x0] = c; + } else if (img->format->BytesPerPixel == 2) { + ((Uint16 *)ptr)[x0] = c; } else { - pixel[x0] = c; + ((Uint8 *)ptr)[x0] = c; } } } @@ -186,14 +165,20 @@ nk_sdlsurface_img_getpixel(const struct SDL_Surface *img, const int x0, const in unsigned int pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); + ptr = (unsigned char *)img->pixels + (img->pitch * y0); if (img->format == NK_FONT_ATLAS_ALPHA8) { col.a = ptr[x0]; col.b = col.g = col.r = 0xff; + } else if (img->format->BytesPerPixel == 4) { + pixel = ((Uint32 *)ptr)[x0]; + col = nk_sdlsurface_int2color(pixel, img->format); + } else if (img->format->BytesPerPixel == 2) { + pixel = ((Uint16 *)ptr)[x0]; + col = nk_sdlsurface_int2color(pixel, img->format); } else { - pixel = ((unsigned int *)ptr)[x0]; - col = nk_sdlsurface_int2color(pixel, img->format->format); + pixel = ((Uint8 *)ptr)[x0]; + col = nk_sdlsurface_int2color(pixel, img->format); } } return col; } @@ -235,6 +220,8 @@ nk_sdlsurface_stroke_line(const struct sdlsurface_context *sdlsurface, short tmp; int dy, dx, stepx, stepy; + NK_UNUSED(line_thickness); + dy = y1 - y0; dx = x1 - x0; @@ -369,6 +356,8 @@ nk_sdlsurface_stroke_arc(const struct sdlsurface_context *sdlsurface, const int fa2 = 4 * a2, fb2 = 4 * b2; int x, y, sigma; + NK_UNUSED(line_thickness); + if (s != 0 && s != 90 && s != 180 && s != 270) return; if (w < 1 || h < 1) return; @@ -735,6 +724,8 @@ nk_sdlsurface_stroke_circle(const struct sdlsurface_context *sdlsurface, const int fa2 = 4 * a2, fb2 = 4 * b2; int x, y, sigma; + NK_UNUSED(line_thickness); + /* Convert upper left to center */ h = (h + 1) / 2; w = (w + 1) / 2; @@ -802,13 +793,13 @@ nk_sdlsurface_clear(const struct sdlsurface_context *sdlsurface, const struct nk struct sdlsurface_context* nk_sdlsurface_init(SDL_Surface *fb, float fontSize) { - SDL_assert((fb->format->format == SDL_PIXELFORMAT_ARGB8888) - || (fb->format->format == SDL_PIXELFORMAT_RGBA8888)); - const void *tex; int texh, texw; struct sdlsurface_context *sdlsurface; + assert((fb->format->format == SDL_PIXELFORMAT_ARGB8888) + || (fb->format->format == SDL_PIXELFORMAT_RGBA8888)); + sdlsurface = malloc(sizeof(struct sdlsurface_context)); if (!sdlsurface) return NULL; @@ -831,7 +822,7 @@ nk_sdlsurface_init(SDL_Surface *fb, float fontSize) return NULL; } - sdlsurface->font_tex = SDL_CreateRGBSurfaceWithFormat(0, texw, texh, 32, fb->format->format); + sdlsurface->font_tex = SDL_CreateRGBSurface(0, texw, texh, 32, 0xff, 0xff00, 0xff0000, 0xff000000); memcpy(sdlsurface->font_tex->pixels, tex, texw * texh * 4); @@ -841,19 +832,6 @@ nk_sdlsurface_init(SDL_Surface *fb, float fontSize) nk_style_load_all_cursors(&sdlsurface->ctx, sdlsurface->atlas.cursors); nk_sdlsurface_scissor(sdlsurface, 0, 0, sdlsurface->fb->w, sdlsurface->fb->h); - if (fb->format->format == SDL_PIXELFORMAT_RGBA8888) - { - SDL_assert(sdlsurface->font_tex->pitch == sdlsurface->font_tex->w * 4); - uint32_t *fontPixels = (uint32_t *)sdlsurface->font_tex->pixels; - for (int i = 0; i < sdlsurface->font_tex->w * sdlsurface->font_tex->h; i++) - { - uint32_t col = fontPixels[i]; - fontPixels[i] &= 0xFFFF00; - fontPixels[i] |= ((col & 0xFF000000) >> 24); - fontPixels[i] |= ((col & 0xFF) << 24); - } - } - return sdlsurface; } @@ -961,8 +939,8 @@ nk_sdlsurface_draw_text(const struct sdlsurface_context *sdlsurface, dst_rect.x = x + g.offset.x + rect.x; dst_rect.y = g.offset.y + rect.y; - dst_rect.w = ceilf(g.width); - dst_rect.h = ceilf(g.height); + dst_rect.w = ceil(g.width); + dst_rect.h = ceil(g.height); /* Use software rescaling to blit glyph from font_text to framebuffer */ nk_sdlsurface_stretch_image(sdlsurface->fb, sdlsurface->font_tex, &dst_rect, &src_rect, &sdlsurface->scissors, &fg); diff --git a/demo/sdl_opengl2/Makefile b/demo/sdl_opengl2/Makefile index b73174a..64f1af3 100644 --- a/demo/sdl_opengl2/Makefile +++ b/demo/sdl_opengl2/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/sdl_opengl2/main.c b/demo/sdl_opengl2/main.c index e649780..45c51d2 100644 --- a/demo/sdl_opengl2/main.c +++ b/demo/sdl_opengl2/main.c @@ -37,27 +37,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -78,6 +83,9 @@ main(int argc, char *argv[]) struct nk_context *ctx; struct nk_colorf bg; + NK_UNUSED(argc); + NK_UNUSED(argv); + /* SDL setup */ SDL_SetHint(SDL_HINT_VIDEO_HIGHDPI_DISABLED, "0"); SDL_Init(SDL_INIT_VIDEO); @@ -109,10 +117,16 @@ main(int argc, char *argv[]) /*nk_style_set_font(ctx, &roboto->handle)*/;} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -165,6 +179,9 @@ main(int argc, char *argv[]) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/sdl_opengl2/nuklear_sdl_gl2.h b/demo/sdl_opengl2/nuklear_sdl_gl2.h index da2a080..0c6a2fb 100644 --- a/demo/sdl_opengl2/nuklear_sdl_gl2.h +++ b/demo/sdl_opengl2/nuklear_sdl_gl2.h @@ -33,7 +33,7 @@ NK_API void nk_sdl_shutdown(void); struct nk_sdl_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint font_tex; }; @@ -120,7 +120,7 @@ nk_sdl_render(enum nk_anti_aliasing AA) config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_sdl_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_sdl_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -226,7 +226,7 @@ nk_sdl_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&sdl.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_sdl_device_upload_atlas(image, w, h); - nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.null); + nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.tex_null); if (sdl.atlas.default_font) nk_style_set_font(&sdl.ctx, &sdl.atlas.default_font->handle); } @@ -246,89 +246,87 @@ nk_sdl_handle_event(SDL_Event *evt) SDL_WarpMouseInWindow(sdl.win, x, y); ctx->input.mouse.ungrab = 0; } - if (evt->type == SDL_KEYUP || evt->type == SDL_KEYDOWN) { - /* key events */ - int down = evt->type == SDL_KEYDOWN; - const Uint8* state = SDL_GetKeyboardState(0); - SDL_Keycode sym = evt->key.keysym.sym; - if (sym == SDLK_RSHIFT || sym == SDLK_LSHIFT) - nk_input_key(ctx, NK_KEY_SHIFT, down); - else if (sym == SDLK_DELETE) - nk_input_key(ctx, NK_KEY_DEL, down); - else if (sym == SDLK_RETURN) - nk_input_key(ctx, NK_KEY_ENTER, down); - else if (sym == SDLK_TAB) - nk_input_key(ctx, NK_KEY_TAB, down); - else if (sym == SDLK_BACKSPACE) - nk_input_key(ctx, NK_KEY_BACKSPACE, down); - else if (sym == SDLK_HOME) { - nk_input_key(ctx, NK_KEY_TEXT_START, down); - nk_input_key(ctx, NK_KEY_SCROLL_START, down); - } else if (sym == SDLK_END) { - nk_input_key(ctx, NK_KEY_TEXT_END, down); - nk_input_key(ctx, NK_KEY_SCROLL_END, down); - } else if (sym == SDLK_PAGEDOWN) { - nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); - } else if (sym == SDLK_PAGEUP) { - nk_input_key(ctx, NK_KEY_SCROLL_UP, down); - } else if (sym == SDLK_z) - nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_r) - nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_c) - nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_v) - nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_x) - nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_b) - nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_e) - nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_UP) - nk_input_key(ctx, NK_KEY_UP, down); - else if (sym == SDLK_DOWN) - nk_input_key(ctx, NK_KEY_DOWN, down); - else if (sym == SDLK_LEFT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); - else nk_input_key(ctx, NK_KEY_LEFT, down); - } else if (sym == SDLK_RIGHT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); - else nk_input_key(ctx, NK_KEY_RIGHT, down); - } else return 0; - return 1; - } else if (evt->type == SDL_MOUSEBUTTONDOWN || evt->type == SDL_MOUSEBUTTONUP) { - /* mouse button */ - int down = evt->type == SDL_MOUSEBUTTONDOWN; - const int x = evt->button.x, y = evt->button.y; - if (evt->button.button == SDL_BUTTON_LEFT) { - if (evt->button.clicks > 1) - nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); - nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); - } else if (evt->button.button == SDL_BUTTON_MIDDLE) - nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); - else if (evt->button.button == SDL_BUTTON_RIGHT) - nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); - return 1; - } else if (evt->type == SDL_MOUSEMOTION) { - /* mouse motion */ - if (ctx->input.mouse.grabbed) { - int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; - nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); - } else nk_input_motion(ctx, evt->motion.x, evt->motion.y); - return 1; - } else if (evt->type == SDL_TEXTINPUT) { - /* text input */ - nk_glyph glyph; - memcpy(glyph, evt->text.text, NK_UTF_SIZE); - nk_input_glyph(ctx, glyph); - return 1; - } else if (evt->type == SDL_MOUSEWHEEL) { - /* mouse wheel */ - nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); - return 1; + + switch(evt->type) + { + case SDL_KEYUP: /* KEYUP & KEYDOWN share same routine */ + case SDL_KEYDOWN: + { + int down = evt->type == SDL_KEYDOWN; + const Uint8* state = SDL_GetKeyboardState(0); + switch(evt->key.keysym.sym) + { + case SDLK_RSHIFT: /* RSHIFT & LSHIFT share same routine */ + case SDLK_LSHIFT: nk_input_key(ctx, NK_KEY_SHIFT, down); break; + case SDLK_DELETE: nk_input_key(ctx, NK_KEY_DEL, down); break; + case SDLK_RETURN: nk_input_key(ctx, NK_KEY_ENTER, down); break; + case SDLK_TAB: nk_input_key(ctx, NK_KEY_TAB, down); break; + case SDLK_BACKSPACE: nk_input_key(ctx, NK_KEY_BACKSPACE, down); break; + case SDLK_HOME: nk_input_key(ctx, NK_KEY_TEXT_START, down); + nk_input_key(ctx, NK_KEY_SCROLL_START, down); break; + case SDLK_END: nk_input_key(ctx, NK_KEY_TEXT_END, down); + nk_input_key(ctx, NK_KEY_SCROLL_END, down); break; + case SDLK_PAGEDOWN: nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); break; + case SDLK_PAGEUP: nk_input_key(ctx, NK_KEY_SCROLL_UP, down); break; + case SDLK_z: nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_r: nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_c: nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_v: nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_x: nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_b: nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_e: nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_UP: nk_input_key(ctx, NK_KEY_UP, down); break; + case SDLK_DOWN: nk_input_key(ctx, NK_KEY_DOWN, down); break; + case SDLK_LEFT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); + else nk_input_key(ctx, NK_KEY_LEFT, down); + break; + case SDLK_RIGHT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else nk_input_key(ctx, NK_KEY_RIGHT, down); + break; + } + } + return 1; + + case SDL_MOUSEBUTTONUP: /* MOUSEBUTTONUP & MOUSEBUTTONDOWN share same routine */ + case SDL_MOUSEBUTTONDOWN: + { + int down = evt->type == SDL_MOUSEBUTTONDOWN; + const int x = evt->button.x, y = evt->button.y; + switch(evt->button.button) + { + case SDL_BUTTON_LEFT: + if (evt->button.clicks > 1) + nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); + nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); break; + case SDL_BUTTON_MIDDLE: nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); break; + case SDL_BUTTON_RIGHT: nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); break; + } + } + return 1; + + case SDL_MOUSEMOTION: + if (ctx->input.mouse.grabbed) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); + } + else nk_input_motion(ctx, evt->motion.x, evt->motion.y); + return 1; + + case SDL_TEXTINPUT: + { + nk_glyph glyph; + memcpy(glyph, evt->text.text, NK_UTF_SIZE); + nk_input_glyph(ctx, glyph); + } + return 1; + + case SDL_MOUSEWHEEL: + nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); + return 1; } return 0; } diff --git a/demo/sdl_opengl3/Makefile b/demo/sdl_opengl3/Makefile index c6fcb45..fb3acd2 100644 --- a/demo/sdl_opengl3/Makefile +++ b/demo/sdl_opengl3/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/sdl_opengl3/main.c b/demo/sdl_opengl3/main.c index c5b95c1..e039a2f 100644 --- a/demo/sdl_opengl3/main.c +++ b/demo/sdl_opengl3/main.c @@ -41,27 +41,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -81,6 +86,9 @@ int main(int argc, char *argv[]) struct nk_context *ctx; struct nk_colorf bg; + NK_UNUSED(argc); + NK_UNUSED(argv); + /* SDL setup */ SDL_SetHint(SDL_HINT_VIDEO_HIGHDPI_DISABLED, "0"); SDL_Init(SDL_INIT_VIDEO|SDL_INIT_TIMER|SDL_INIT_EVENTS); @@ -120,10 +128,16 @@ int main(int argc, char *argv[]) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -175,6 +189,9 @@ int main(int argc, char *argv[]) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/sdl_opengl3/nuklear_sdl_gl3.h b/demo/sdl_opengl3/nuklear_sdl_gl3.h index e393628..cac8629 100644 --- a/demo/sdl_opengl3/nuklear_sdl_gl3.h +++ b/demo/sdl_opengl3/nuklear_sdl_gl3.h @@ -40,7 +40,7 @@ NK_API void nk_sdl_device_create(void); struct nk_sdl_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -247,7 +247,7 @@ nk_sdl_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_sdl_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_sdl_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -334,7 +334,7 @@ nk_sdl_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&sdl.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_sdl_device_upload_atlas(image, w, h); - nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.null); + nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.tex_null); if (sdl.atlas.default_font) nk_style_set_font(&sdl.ctx, &sdl.atlas.default_font->handle); @@ -344,89 +344,98 @@ NK_API int nk_sdl_handle_event(SDL_Event *evt) { struct nk_context *ctx = &sdl.ctx; - if (evt->type == SDL_KEYUP || evt->type == SDL_KEYDOWN) { - /* key events */ - int down = evt->type == SDL_KEYDOWN; - const Uint8* state = SDL_GetKeyboardState(0); - SDL_Keycode sym = evt->key.keysym.sym; - if (sym == SDLK_RSHIFT || sym == SDLK_LSHIFT) - nk_input_key(ctx, NK_KEY_SHIFT, down); - else if (sym == SDLK_DELETE) - nk_input_key(ctx, NK_KEY_DEL, down); - else if (sym == SDLK_RETURN) - nk_input_key(ctx, NK_KEY_ENTER, down); - else if (sym == SDLK_TAB) - nk_input_key(ctx, NK_KEY_TAB, down); - else if (sym == SDLK_BACKSPACE) - nk_input_key(ctx, NK_KEY_BACKSPACE, down); - else if (sym == SDLK_HOME) { - nk_input_key(ctx, NK_KEY_TEXT_START, down); - nk_input_key(ctx, NK_KEY_SCROLL_START, down); - } else if (sym == SDLK_END) { - nk_input_key(ctx, NK_KEY_TEXT_END, down); - nk_input_key(ctx, NK_KEY_SCROLL_END, down); - } else if (sym == SDLK_PAGEDOWN) { - nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); - } else if (sym == SDLK_PAGEUP) { - nk_input_key(ctx, NK_KEY_SCROLL_UP, down); - } else if (sym == SDLK_z) - nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_r) - nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_c) - nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_v) - nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_x) - nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_b) - nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_e) - nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_UP) - nk_input_key(ctx, NK_KEY_UP, down); - else if (sym == SDLK_DOWN) - nk_input_key(ctx, NK_KEY_DOWN, down); - else if (sym == SDLK_LEFT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); - else nk_input_key(ctx, NK_KEY_LEFT, down); - } else if (sym == SDLK_RIGHT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); - else nk_input_key(ctx, NK_KEY_RIGHT, down); - } else return 0; - return 1; - } else if (evt->type == SDL_MOUSEBUTTONDOWN || evt->type == SDL_MOUSEBUTTONUP) { - /* mouse button */ - int down = evt->type == SDL_MOUSEBUTTONDOWN; - const int x = evt->button.x, y = evt->button.y; - if (evt->button.button == SDL_BUTTON_LEFT) { - if (evt->button.clicks > 1) - nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); - nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); - } else if (evt->button.button == SDL_BUTTON_MIDDLE) - nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); - else if (evt->button.button == SDL_BUTTON_RIGHT) - nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); - return 1; - } else if (evt->type == SDL_MOUSEMOTION) { - /* mouse motion */ - if (ctx->input.mouse.grabbed) { - int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; - nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); - } else nk_input_motion(ctx, evt->motion.x, evt->motion.y); - return 1; - } else if (evt->type == SDL_TEXTINPUT) { - /* text input */ - nk_glyph glyph; - memcpy(glyph, evt->text.text, NK_UTF_SIZE); - nk_input_glyph(ctx, glyph); - return 1; - } else if (evt->type == SDL_MOUSEWHEEL) { - /* mouse wheel */ - nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); - return 1; + + /* optional grabbing behavior */ + if (ctx->input.mouse.grab) { + SDL_SetRelativeMouseMode(SDL_TRUE); + ctx->input.mouse.grab = 0; + } else if (ctx->input.mouse.ungrab) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + SDL_SetRelativeMouseMode(SDL_FALSE); + SDL_WarpMouseInWindow(sdl.win, x, y); + ctx->input.mouse.ungrab = 0; + } + + switch(evt->type) + { + case SDL_KEYUP: /* KEYUP & KEYDOWN share same routine */ + case SDL_KEYDOWN: + { + int down = evt->type == SDL_KEYDOWN; + const Uint8* state = SDL_GetKeyboardState(0); + switch(evt->key.keysym.sym) + { + case SDLK_RSHIFT: /* RSHIFT & LSHIFT share same routine */ + case SDLK_LSHIFT: nk_input_key(ctx, NK_KEY_SHIFT, down); break; + case SDLK_DELETE: nk_input_key(ctx, NK_KEY_DEL, down); break; + case SDLK_RETURN: nk_input_key(ctx, NK_KEY_ENTER, down); break; + case SDLK_TAB: nk_input_key(ctx, NK_KEY_TAB, down); break; + case SDLK_BACKSPACE: nk_input_key(ctx, NK_KEY_BACKSPACE, down); break; + case SDLK_HOME: nk_input_key(ctx, NK_KEY_TEXT_START, down); + nk_input_key(ctx, NK_KEY_SCROLL_START, down); break; + case SDLK_END: nk_input_key(ctx, NK_KEY_TEXT_END, down); + nk_input_key(ctx, NK_KEY_SCROLL_END, down); break; + case SDLK_PAGEDOWN: nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); break; + case SDLK_PAGEUP: nk_input_key(ctx, NK_KEY_SCROLL_UP, down); break; + case SDLK_z: nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_r: nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_c: nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_v: nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_x: nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_b: nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_e: nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_UP: nk_input_key(ctx, NK_KEY_UP, down); break; + case SDLK_DOWN: nk_input_key(ctx, NK_KEY_DOWN, down); break; + case SDLK_LEFT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); + else nk_input_key(ctx, NK_KEY_LEFT, down); + break; + case SDLK_RIGHT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else nk_input_key(ctx, NK_KEY_RIGHT, down); + break; + } + } + return 1; + + case SDL_MOUSEBUTTONUP: /* MOUSEBUTTONUP & MOUSEBUTTONDOWN share same routine */ + case SDL_MOUSEBUTTONDOWN: + { + int down = evt->type == SDL_MOUSEBUTTONDOWN; + const int x = evt->button.x, y = evt->button.y; + switch(evt->button.button) + { + case SDL_BUTTON_LEFT: + if (evt->button.clicks > 1) + nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); + nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); break; + case SDL_BUTTON_MIDDLE: nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); break; + case SDL_BUTTON_RIGHT: nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); break; + } + } + return 1; + + case SDL_MOUSEMOTION: + if (ctx->input.mouse.grabbed) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); + } + else nk_input_motion(ctx, evt->motion.x, evt->motion.y); + return 1; + + case SDL_TEXTINPUT: + { + nk_glyph glyph; + memcpy(glyph, evt->text.text, NK_UTF_SIZE); + nk_input_glyph(ctx, glyph); + } + return 1; + + case SDL_MOUSEWHEEL: + nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); + return 1; } return 0; } diff --git a/demo/sdl_opengles2/Makefile b/demo/sdl_opengles2/Makefile index e1820d7..41d080e 100644 --- a/demo/sdl_opengles2/Makefile +++ b/demo/sdl_opengles2/Makefile @@ -2,7 +2,7 @@ BIN = demo # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/sdl_opengles2/main.c b/demo/sdl_opengles2/main.c index c38f2d0..b114159 100644 --- a/demo/sdl_opengles2/main.c +++ b/demo/sdl_opengles2/main.c @@ -38,12 +38,37 @@ * * ===============================================================*/ /* This are some code examples to provide a small overview of what can be - * done with this library. To try out an example uncomment the include - * and the corresponding function. */ -/*#include "../style.c"*/ -/*#include "../calculator.c"*/ -/*#include "../overview.c"*/ -/*#include "../node_editor.c"*/ + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ +/*#define INCLUDE_OVERVIEW */ +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif /* =============================================================== * @@ -95,24 +120,35 @@ MainLoop(void* loopArg){ nk_layout_row_end(ctx); nk_menubar_end(ctx); - enum {EASY, HARD}; - static int op = EASY; - static int property = 20; - nk_layout_row_static(ctx, 30, 80, 1); - if (nk_button_label(ctx, "button")) - fprintf(stdout, "button pressed\n"); - nk_layout_row_dynamic(ctx, 30, 2); - if (nk_option_label(ctx, "easy", op == EASY)) op = EASY; - if (nk_option_label(ctx, "hard", op == HARD)) op = HARD; - nk_layout_row_dynamic(ctx, 25, 1); - nk_property_int(ctx, "Compression:", 0, &property, 100, 10, 1); + { + enum {EASY, HARD}; + static int op = EASY; + static int property = 20; + nk_layout_row_static(ctx, 30, 80, 1); + if (nk_button_label(ctx, "button")) + fprintf(stdout, "button pressed\n"); + nk_layout_row_dynamic(ctx, 30, 2); + if (nk_option_label(ctx, "easy", op == EASY)) op = EASY; + if (nk_option_label(ctx, "hard", op == HARD)) op = HARD; + nk_layout_row_dynamic(ctx, 25, 1); + nk_property_int(ctx, "Compression:", 0, &property, 100, 10, 1); + } } nk_end(ctx); /* -------------- EXAMPLES ---------------- */ - /*calculator(ctx);*/ - /*overview(ctx);*/ - /*node_editor(ctx);*/ + #ifdef INCLUDE_CALCULATOR + calculator(ctx); + #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif + #ifdef INCLUDE_OVERVIEW + overview(ctx); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(ctx); + #endif /* ----------------------------------------- */ /* Draw */ @@ -137,6 +173,10 @@ int main(int argc, char* argv[]) /* GUI */ struct nk_context *ctx; SDL_GLContext glContext; + + NK_UNUSED(argc); + NK_UNUSED(argv); + /* SDL setup */ SDL_SetHint(SDL_HINT_VIDEO_HIGHDPI_DISABLED, "0"); /*SDL_Init(SDL_INIT_VIDEO|SDL_INIT_TIMER|SDL_INIT_EVENTS); // - do NOT init SDL on GL ES 2 */ @@ -169,10 +209,18 @@ int main(int argc, char* argv[]) /*nk_style_set_font(ctx, &roboto->handle)*/;} /* style.c */ - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + #ifdef INCLUDE_STYLE + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif + #endif #if defined(__EMSCRIPTEN__) #include diff --git a/demo/sdl_opengles2/nuklear_sdl_gles2.h b/demo/sdl_opengles2/nuklear_sdl_gles2.h index 061550b..595d7a7 100644 --- a/demo/sdl_opengles2/nuklear_sdl_gles2.h +++ b/demo/sdl_opengles2/nuklear_sdl_gles2.h @@ -43,7 +43,7 @@ NK_API void nk_sdl_device_create(void); struct nk_sdl_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, ebo; GLuint prog; GLuint vert_shdr; @@ -103,7 +103,7 @@ nk_sdl_device_create(void) "}\n"; struct nk_sdl_device *dev = &sdl.ogl; - + nk_buffer_init_default(&dev->cmds); dev->prog = glCreateProgram(); dev->vert_shdr = glCreateShader(GL_VERTEX_SHADER); @@ -133,7 +133,7 @@ nk_sdl_device_create(void) dev->vp = offsetof(struct nk_sdl_vertex, position); dev->vt = offsetof(struct nk_sdl_vertex, uv); dev->vc = offsetof(struct nk_sdl_vertex, col); - + /* Allocate buffers */ glGenBuffers(1, &dev->vbo); glGenBuffers(1, &dev->ebo); @@ -214,7 +214,7 @@ nk_sdl_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b /* Bind buffers */ glBindBuffer(GL_ARRAY_BUFFER, dev->vbo); glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, dev->ebo); - + { /* buffer setup */ glEnableVertexAttribArray((GLuint)dev->attrib_pos); @@ -245,7 +245,7 @@ nk_sdl_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_sdl_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_sdl_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -335,7 +335,7 @@ nk_sdl_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&sdl.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_sdl_device_upload_atlas(image, w, h); - nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.null); + nk_font_atlas_end(&sdl.atlas, nk_handle_id((int)sdl.ogl.font_tex), &sdl.ogl.tex_null); if (sdl.atlas.default_font) nk_style_set_font(&sdl.ctx, &sdl.atlas.default_font->handle); @@ -345,89 +345,98 @@ NK_API int nk_sdl_handle_event(SDL_Event *evt) { struct nk_context *ctx = &sdl.ctx; - if (evt->type == SDL_KEYUP || evt->type == SDL_KEYDOWN) { - /* key events */ - int down = evt->type == SDL_KEYDOWN; - const Uint8* state = SDL_GetKeyboardState(0); - SDL_Keycode sym = evt->key.keysym.sym; - if (sym == SDLK_RSHIFT || sym == SDLK_LSHIFT) - nk_input_key(ctx, NK_KEY_SHIFT, down); - else if (sym == SDLK_DELETE) - nk_input_key(ctx, NK_KEY_DEL, down); - else if (sym == SDLK_RETURN) - nk_input_key(ctx, NK_KEY_ENTER, down); - else if (sym == SDLK_TAB) - nk_input_key(ctx, NK_KEY_TAB, down); - else if (sym == SDLK_BACKSPACE) - nk_input_key(ctx, NK_KEY_BACKSPACE, down); - else if (sym == SDLK_HOME) { - nk_input_key(ctx, NK_KEY_TEXT_START, down); - nk_input_key(ctx, NK_KEY_SCROLL_START, down); - } else if (sym == SDLK_END) { - nk_input_key(ctx, NK_KEY_TEXT_END, down); - nk_input_key(ctx, NK_KEY_SCROLL_END, down); - } else if (sym == SDLK_PAGEDOWN) { - nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); - } else if (sym == SDLK_PAGEUP) { - nk_input_key(ctx, NK_KEY_SCROLL_UP, down); - } else if (sym == SDLK_z) - nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_r) - nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_c) - nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_v) - nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_x) - nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_b) - nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_e) - nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); - else if (sym == SDLK_UP) - nk_input_key(ctx, NK_KEY_UP, down); - else if (sym == SDLK_DOWN) - nk_input_key(ctx, NK_KEY_DOWN, down); - else if (sym == SDLK_LEFT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); - else nk_input_key(ctx, NK_KEY_LEFT, down); - } else if (sym == SDLK_RIGHT) { - if (state[SDL_SCANCODE_LCTRL]) - nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); - else nk_input_key(ctx, NK_KEY_RIGHT, down); - } else return 0; - return 1; - } else if (evt->type == SDL_MOUSEBUTTONDOWN || evt->type == SDL_MOUSEBUTTONUP) { - /* mouse button */ - int down = evt->type == SDL_MOUSEBUTTONDOWN; - const int x = evt->button.x, y = evt->button.y; - if (evt->button.button == SDL_BUTTON_LEFT) { - if (evt->button.clicks > 1) - nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); - nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); - } else if (evt->button.button == SDL_BUTTON_MIDDLE) - nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); - else if (evt->button.button == SDL_BUTTON_RIGHT) - nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); - return 1; - } else if (evt->type == SDL_MOUSEMOTION) { - /* mouse motion */ - if (ctx->input.mouse.grabbed) { - int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; - nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); - } else nk_input_motion(ctx, evt->motion.x, evt->motion.y); - return 1; - } else if (evt->type == SDL_TEXTINPUT) { - /* text input */ - nk_glyph glyph; - memcpy(glyph, evt->text.text, NK_UTF_SIZE); - nk_input_glyph(ctx, glyph); - return 1; - } else if (evt->type == SDL_MOUSEWHEEL) { - /* mouse wheel */ - nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); - return 1; + + /* optional grabbing behavior */ + if (ctx->input.mouse.grab) { + SDL_SetRelativeMouseMode(SDL_TRUE); + ctx->input.mouse.grab = 0; + } else if (ctx->input.mouse.ungrab) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + SDL_SetRelativeMouseMode(SDL_FALSE); + SDL_WarpMouseInWindow(sdl.win, x, y); + ctx->input.mouse.ungrab = 0; + } + + switch(evt->type) + { + case SDL_KEYUP: /* KEYUP & KEYDOWN share same routine */ + case SDL_KEYDOWN: + { + int down = evt->type == SDL_KEYDOWN; + const Uint8* state = SDL_GetKeyboardState(0); + switch(evt->key.keysym.sym) + { + case SDLK_RSHIFT: /* RSHIFT & LSHIFT share same routine */ + case SDLK_LSHIFT: nk_input_key(ctx, NK_KEY_SHIFT, down); break; + case SDLK_DELETE: nk_input_key(ctx, NK_KEY_DEL, down); break; + case SDLK_RETURN: nk_input_key(ctx, NK_KEY_ENTER, down); break; + case SDLK_TAB: nk_input_key(ctx, NK_KEY_TAB, down); break; + case SDLK_BACKSPACE: nk_input_key(ctx, NK_KEY_BACKSPACE, down); break; + case SDLK_HOME: nk_input_key(ctx, NK_KEY_TEXT_START, down); + nk_input_key(ctx, NK_KEY_SCROLL_START, down); break; + case SDLK_END: nk_input_key(ctx, NK_KEY_TEXT_END, down); + nk_input_key(ctx, NK_KEY_SCROLL_END, down); break; + case SDLK_PAGEDOWN: nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); break; + case SDLK_PAGEUP: nk_input_key(ctx, NK_KEY_SCROLL_UP, down); break; + case SDLK_z: nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_r: nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_c: nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_v: nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_x: nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_b: nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_e: nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_UP: nk_input_key(ctx, NK_KEY_UP, down); break; + case SDLK_DOWN: nk_input_key(ctx, NK_KEY_DOWN, down); break; + case SDLK_LEFT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); + else nk_input_key(ctx, NK_KEY_LEFT, down); + break; + case SDLK_RIGHT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else nk_input_key(ctx, NK_KEY_RIGHT, down); + break; + } + } + return 1; + + case SDL_MOUSEBUTTONUP: /* MOUSEBUTTONUP & MOUSEBUTTONDOWN share same routine */ + case SDL_MOUSEBUTTONDOWN: + { + int down = evt->type == SDL_MOUSEBUTTONDOWN; + const int x = evt->button.x, y = evt->button.y; + switch(evt->button.button) + { + case SDL_BUTTON_LEFT: + if (evt->button.clicks > 1) + nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); + nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); break; + case SDL_BUTTON_MIDDLE: nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); break; + case SDL_BUTTON_RIGHT: nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); break; + } + } + return 1; + + case SDL_MOUSEMOTION: + if (ctx->input.mouse.grabbed) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); + } + else nk_input_motion(ctx, evt->motion.x, evt->motion.y); + return 1; + + case SDL_TEXTINPUT: + { + nk_glyph glyph; + memcpy(glyph, evt->text.text, NK_UTF_SIZE); + nk_input_glyph(ctx, glyph); + } + return 1; + + case SDL_MOUSEWHEEL: + nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); + return 1; } return 0; } diff --git a/demo/sdl_renderer/Makefile b/demo/sdl_renderer/Makefile new file mode 100644 index 0000000..bb3feeb --- /dev/null +++ b/demo/sdl_renderer/Makefile @@ -0,0 +1,27 @@ +# Install +BIN = demo + +# Flags +CFLAGS += -std=c89 -pedantic -O0 +CFLAGS += `sdl2-config --cflags` + +SRC = main.c +OBJ = $(SRC:.c=.o) + +ifeq ($(OS),Windows_NT) +#TODO +#BIN := $(BIN).exe +#LIBS = -lmingw32 -lSDL2main -lSDL2 -lopengl32 -lm -lGLU32 +else + UNAME_S := $(shell uname -s) + ifeq ($(UNAME_S),Darwin) +#TODO LIBS = -lSDL2 -framework OpenGL -lm + else + LIBS += -lm -ldl `sdl2-config --libs` + endif +endif + +$(BIN): + @mkdir -p bin + rm -f bin/$(BIN) $(OBJS) + $(CC) $(SRC) $(CFLAGS) -o bin/$(BIN) $(LIBS) diff --git a/demo/sdl_renderer/main.c b/demo/sdl_renderer/main.c new file mode 100644 index 0000000..940ea84 --- /dev/null +++ b/demo/sdl_renderer/main.c @@ -0,0 +1,245 @@ +/* nuklear - 1.32.0 - public domain */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#define NK_INCLUDE_FIXED_TYPES +#define NK_INCLUDE_STANDARD_IO +#define NK_INCLUDE_STANDARD_VARARGS +#define NK_INCLUDE_DEFAULT_ALLOCATOR +#define NK_INCLUDE_VERTEX_BUFFER_OUTPUT +#define NK_INCLUDE_FONT_BAKING +#define NK_INCLUDE_DEFAULT_FONT +#define NK_IMPLEMENTATION +#define NK_SDL_RENDERER_IMPLEMENTATION +#include "../../nuklear.h" +#include "nuklear_sdl_renderer.h" + +#define WINDOW_WIDTH 1200 +#define WINDOW_HEIGHT 800 + +/* =============================================================== + * + * EXAMPLE + * + * ===============================================================*/ +/* This are some code examples to provide a small overview of what can be + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_OVERVIEW */ +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif + +/* =============================================================== + * + * DEMO + * + * ===============================================================*/ +int +main(int argc, char *argv[]) +{ + /* Platform */ + SDL_Window *win; + SDL_Renderer *renderer; + int running = 1; + int flags = 0; + float font_scale = 1; + + /* GUI */ + struct nk_context *ctx; + struct nk_colorf bg; + + /* SDL setup */ + SDL_SetHint(SDL_HINT_VIDEO_HIGHDPI_DISABLED, "0"); + SDL_Init(SDL_INIT_VIDEO); + + win = SDL_CreateWindow("Demo", + SDL_WINDOWPOS_CENTERED, SDL_WINDOWPOS_CENTERED, + WINDOW_WIDTH, WINDOW_HEIGHT, SDL_WINDOW_SHOWN|SDL_WINDOW_ALLOW_HIGHDPI); + + if (win == NULL) { + SDL_Log("Error SDL_CreateWindow %s", SDL_GetError()); + exit(-1); + } + + flags |= SDL_RENDERER_ACCELERATED; + flags |= SDL_RENDERER_PRESENTVSYNC; + +#if 0 + SDL_SetHint(SDL_HINT_RENDER_BATCHING, "1"); + SDL_SetHint(SDL_HINT_RENDER_DRIVER, "software"); + SDL_SetHint(SDL_HINT_RENDER_DRIVER, "opengl"); + SDL_SetHint(SDL_HINT_RENDER_DRIVER, "software"); + SDL_SetHint(SDL_HINT_RENDER_DRIVER, "opengles2"); +#endif + + renderer = SDL_CreateRenderer(win, -1, flags); + + if (renderer == NULL) { + SDL_Log("Error SDL_CreateRenderer %s", SDL_GetError()); + exit(-1); + } + + /* scale the renderer output for High-DPI displays */ + { + int render_w, render_h; + int window_w, window_h; + float scale_x, scale_y; + SDL_GetRendererOutputSize(renderer, &render_w, &render_h); + SDL_GetWindowSize(win, &window_w, &window_h); + scale_x = (float)(render_w) / (float)(window_w); + scale_y = (float)(render_h) / (float)(window_h); + SDL_RenderSetScale(renderer, scale_x, scale_y); + font_scale = scale_y; + } + + /* GUI */ + ctx = nk_sdl_init(win, renderer); + /* Load Fonts: if none of these are loaded a default font will be used */ + /* Load Cursor: if you uncomment cursor loading please hide the cursor */ + { + struct nk_font_atlas *atlas; + struct nk_font_config config = nk_font_config(0); + struct nk_font *font; + + /* set up the font atlas and add desired font; note that font sizes are + * multiplied by font_scale to produce better results at higher DPIs */ + nk_sdl_font_stash_begin(&atlas); + font = nk_font_atlas_add_default(atlas, 13 * font_scale, &config); + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/DroidSans.ttf", 14 * font_scale, &config);*/ + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/Roboto-Regular.ttf", 16 * font_scale, &config);*/ + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/kenvector_future_thin.ttf", 13 * font_scale, &config);*/ + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/ProggyClean.ttf", 12 * font_scale, &config);*/ + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/ProggyTiny.ttf", 10 * font_scale, &config);*/ + /*font = nk_font_atlas_add_from_file(atlas, "../../../extra_font/Cousine-Regular.ttf", 13 * font_scale, &config);*/ + nk_sdl_font_stash_end(); + + /* this hack makes the font appear to be scaled down to the desired + * size and is only necessary when font_scale > 1 */ + font->handle.height /= font_scale; + /*nk_style_load_all_cursors(ctx, atlas->cursors);*/ + nk_style_set_font(ctx, &font->handle); + } + + #ifdef INCLUDE_STYLE + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif + #endif + + bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; + while (running) + { + /* Input */ + SDL_Event evt; + nk_input_begin(ctx); + while (SDL_PollEvent(&evt)) { + if (evt.type == SDL_QUIT) goto cleanup; + nk_sdl_handle_event(&evt); + } + nk_input_end(ctx); + + /* GUI */ + if (nk_begin(ctx, "Demo", nk_rect(50, 50, 230, 250), + NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_SCALABLE| + NK_WINDOW_MINIMIZABLE|NK_WINDOW_TITLE)) + { + enum {EASY, HARD}; + static int op = EASY; + static int property = 20; + + nk_layout_row_static(ctx, 30, 80, 1); + if (nk_button_label(ctx, "button")) + fprintf(stdout, "button pressed\n"); + nk_layout_row_dynamic(ctx, 30, 2); + if (nk_option_label(ctx, "easy", op == EASY)) op = EASY; + if (nk_option_label(ctx, "hard", op == HARD)) op = HARD; + nk_layout_row_dynamic(ctx, 25, 1); + nk_property_int(ctx, "Compression:", 0, &property, 100, 10, 1); + + nk_layout_row_dynamic(ctx, 20, 1); + nk_label(ctx, "background:", NK_TEXT_LEFT); + nk_layout_row_dynamic(ctx, 25, 1); + if (nk_combo_begin_color(ctx, nk_rgb_cf(bg), nk_vec2(nk_widget_width(ctx),400))) { + nk_layout_row_dynamic(ctx, 120, 1); + bg = nk_color_picker(ctx, bg, NK_RGBA); + nk_layout_row_dynamic(ctx, 25, 1); + bg.r = nk_propertyf(ctx, "#R:", 0, bg.r, 1.0f, 0.01f,0.005f); + bg.g = nk_propertyf(ctx, "#G:", 0, bg.g, 1.0f, 0.01f,0.005f); + bg.b = nk_propertyf(ctx, "#B:", 0, bg.b, 1.0f, 0.01f,0.005f); + bg.a = nk_propertyf(ctx, "#A:", 0, bg.a, 1.0f, 0.01f,0.005f); + nk_combo_end(ctx); + } + } + nk_end(ctx); + + /* -------------- EXAMPLES ---------------- */ + #ifdef INCLUDE_CALCULATOR + calculator(ctx); + #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif + #ifdef INCLUDE_OVERVIEW + overview(ctx); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(ctx); + #endif + /* ----------------------------------------- */ + + SDL_SetRenderDrawColor(renderer, bg.r * 255, bg.g * 255, bg.b * 255, bg.a * 255); + SDL_RenderClear(renderer); + + nk_sdl_render(NK_ANTI_ALIASING_ON); + + SDL_RenderPresent(renderer); + } + +cleanup: + nk_sdl_shutdown(); + SDL_DestroyRenderer(renderer); + SDL_DestroyWindow(win); + SDL_Quit(); + return 0; +} diff --git a/demo/sdl_renderer/nuklear_sdl_renderer.h b/demo/sdl_renderer/nuklear_sdl_renderer.h new file mode 100644 index 0000000..672b81b --- /dev/null +++ b/demo/sdl_renderer/nuklear_sdl_renderer.h @@ -0,0 +1,379 @@ +/* + * Nuklear - 4.9.4 - public domain + */ +/* + * ============================================================== + * + * API + * + * =============================================================== + */ +#ifndef NK_SDL_RENDERER_H_ +#define NK_SDL_RENDERER_H_ + +#include +NK_API struct nk_context* nk_sdl_init(SDL_Window *win, SDL_Renderer *renderer); +NK_API void nk_sdl_font_stash_begin(struct nk_font_atlas **atlas); +NK_API void nk_sdl_font_stash_end(void); +NK_API int nk_sdl_handle_event(SDL_Event *evt); +NK_API void nk_sdl_render(enum nk_anti_aliasing); +NK_API void nk_sdl_shutdown(void); + +#if SDL_COMPILEDVERSION < SDL_VERSIONNUM(2, 0, 22) +/* Metal API does not support cliprects with negative coordinates or large + * dimensions. The issue is fixed in SDL2 with version 2.0.22 but until + * that version is released, the NK_SDL_CLAMP_CLIP_RECT flag can be used to + * ensure the cliprect is itself clipped to the viewport. + * See discussion at https://discourse.libsdl.org/t/rendergeometryraw-producing-different-results-in-metal-vs-opengl/34953 + */ +#define NK_SDL_CLAMP_CLIP_RECT +#endif + +#endif /* NK_SDL_RENDERER_H_ */ + +/* + * ============================================================== + * + * IMPLEMENTATION + * + * =============================================================== + */ +#ifdef NK_SDL_RENDERER_IMPLEMENTATION + +#include + +struct nk_sdl_device { + struct nk_buffer cmds; + struct nk_draw_null_texture tex_null; + SDL_Texture *font_tex; +}; + +struct nk_sdl_vertex { + float position[2]; + float uv[2]; + nk_byte col[4]; +}; + +static struct nk_sdl { + SDL_Window *win; + SDL_Renderer *renderer; + struct nk_sdl_device ogl; + struct nk_context ctx; + struct nk_font_atlas atlas; +} sdl; + + + +NK_INTERN void +nk_sdl_device_upload_atlas(const void *image, int width, int height) +{ + struct nk_sdl_device *dev = &sdl.ogl; + + SDL_Texture *g_SDLFontTexture = SDL_CreateTexture(sdl.renderer, SDL_PIXELFORMAT_ARGB8888, SDL_TEXTUREACCESS_STATIC, width, height); + if (g_SDLFontTexture == NULL) { + SDL_Log("error creating texture"); + return; + } + SDL_UpdateTexture(g_SDLFontTexture, NULL, image, 4 * width); + SDL_SetTextureBlendMode(g_SDLFontTexture, SDL_BLENDMODE_BLEND); + dev->font_tex = g_SDLFontTexture; +} + +NK_API void +nk_sdl_render(enum nk_anti_aliasing AA) +{ + /* setup global state */ + struct nk_sdl_device *dev = &sdl.ogl; + + { + SDL_Rect saved_clip; +#ifdef NK_SDL_CLAMP_CLIP_RECT + SDL_Rect viewport; +#endif + SDL_bool clipping_enabled; + int vs = sizeof(struct nk_sdl_vertex); + size_t vp = offsetof(struct nk_sdl_vertex, position); + size_t vt = offsetof(struct nk_sdl_vertex, uv); + size_t vc = offsetof(struct nk_sdl_vertex, col); + + /* convert from command queue into draw list and draw to screen */ + const struct nk_draw_command *cmd; + const nk_draw_index *offset = NULL; + struct nk_buffer vbuf, ebuf; + + /* fill converting configuration */ + struct nk_convert_config config; + static const struct nk_draw_vertex_layout_element vertex_layout[] = { + {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_sdl_vertex, position)}, + {NK_VERTEX_TEXCOORD, NK_FORMAT_FLOAT, NK_OFFSETOF(struct nk_sdl_vertex, uv)}, + {NK_VERTEX_COLOR, NK_FORMAT_R8G8B8A8, NK_OFFSETOF(struct nk_sdl_vertex, col)}, + {NK_VERTEX_LAYOUT_END} + }; + NK_MEMSET(&config, 0, sizeof(config)); + config.vertex_layout = vertex_layout; + config.vertex_size = sizeof(struct nk_sdl_vertex); + config.vertex_alignment = NK_ALIGNOF(struct nk_sdl_vertex); + config.tex_null = dev->tex_null; + config.circle_segment_count = 22; + config.curve_segment_count = 22; + config.arc_segment_count = 22; + config.global_alpha = 1.0f; + config.shape_AA = AA; + config.line_AA = AA; + + /* convert shapes into vertexes */ + nk_buffer_init_default(&vbuf); + nk_buffer_init_default(&ebuf); + nk_convert(&sdl.ctx, &dev->cmds, &vbuf, &ebuf, &config); + + /* iterate over and execute each draw command */ + offset = (const nk_draw_index*)nk_buffer_memory_const(&ebuf); + + clipping_enabled = SDL_RenderIsClipEnabled(sdl.renderer); + SDL_RenderGetClipRect(sdl.renderer, &saved_clip); +#ifdef NK_SDL_CLAMP_CLIP_RECT + SDL_RenderGetViewport(sdl.renderer, &viewport); +#endif + + nk_draw_foreach(cmd, &sdl.ctx, &dev->cmds) + { + if (!cmd->elem_count) continue; + + { + SDL_Rect r; + r.x = cmd->clip_rect.x; + r.y = cmd->clip_rect.y; + r.w = cmd->clip_rect.w; + r.h = cmd->clip_rect.h; +#ifdef NK_SDL_CLAMP_CLIP_RECT + if (r.x < 0) { + r.w += r.x; + r.x = 0; + } + if (r.y < 0) { + r.h += r.y; + r.y = 0; + } + if (r.h > viewport.h) { + r.h = viewport.h; + } + if (r.w > viewport.w) { + r.w = viewport.w; + } +#endif + SDL_RenderSetClipRect(sdl.renderer, &r); + } + + { + const void *vertices = nk_buffer_memory_const(&vbuf); + + SDL_RenderGeometryRaw(sdl.renderer, + (SDL_Texture *)cmd->texture.ptr, + (const float*)((const nk_byte*)vertices + vp), vs, + (const SDL_Color*)((const nk_byte*)vertices + vc), vs, + (const float*)((const nk_byte*)vertices + vt), vs, + (vbuf.needed / vs), + (void *) offset, cmd->elem_count, 2); + + offset += cmd->elem_count; + } + } + + SDL_RenderSetClipRect(sdl.renderer, &saved_clip); + if (!clipping_enabled) { + SDL_RenderSetClipRect(sdl.renderer, NULL); + } + + nk_clear(&sdl.ctx); + nk_buffer_clear(&dev->cmds); + nk_buffer_free(&vbuf); + nk_buffer_free(&ebuf); + } +} + +static void +nk_sdl_clipboard_paste(nk_handle usr, struct nk_text_edit *edit) +{ + const char *text = SDL_GetClipboardText(); + if (text) nk_textedit_paste(edit, text, nk_strlen(text)); + (void)usr; +} + +static void +nk_sdl_clipboard_copy(nk_handle usr, const char *text, int len) +{ + char *str = 0; + (void)usr; + if (!len) return; + str = (char*)malloc((size_t)len+1); + if (!str) return; + memcpy(str, text, (size_t)len); + str[len] = '\0'; + SDL_SetClipboardText(str); + free(str); +} + +NK_API struct nk_context* +nk_sdl_init(SDL_Window *win, SDL_Renderer *renderer) +{ +#ifndef NK_SDL_CLAMP_CLIP_RECT + SDL_RendererInfo info; + SDL_version runtimeVer; + + /* warn for cases where NK_SDL_CLAMP_CLIP_RECT should have been set but isn't */ + SDL_GetRendererInfo(renderer, &info); + SDL_GetVersion(&runtimeVer); + if (strncmp("metal", info.name, 5) == 0 && + SDL_VERSIONNUM(runtimeVer.major, runtimeVer.minor, runtimeVer.patch) < SDL_VERSIONNUM(2, 0, 22)) + { + SDL_LogWarn( + SDL_LOG_CATEGORY_APPLICATION, + "renderer is using Metal API but runtime SDL version %d.%d.%d is older than compiled version %d.%d.%d, " + "which may cause issues with rendering", + runtimeVer.major, runtimeVer.minor, runtimeVer.patch, + SDL_MAJOR_VERSION, SDL_MINOR_VERSION, SDL_PATCHLEVEL + ); + } +#endif + sdl.win = win; + sdl.renderer = renderer; + nk_init_default(&sdl.ctx, 0); + sdl.ctx.clip.copy = nk_sdl_clipboard_copy; + sdl.ctx.clip.paste = nk_sdl_clipboard_paste; + sdl.ctx.clip.userdata = nk_handle_ptr(0); + nk_buffer_init_default(&sdl.ogl.cmds); + return &sdl.ctx; +} + +NK_API void +nk_sdl_font_stash_begin(struct nk_font_atlas **atlas) +{ + nk_font_atlas_init_default(&sdl.atlas); + nk_font_atlas_begin(&sdl.atlas); + *atlas = &sdl.atlas; +} + +NK_API void +nk_sdl_font_stash_end(void) +{ + const void *image; int w, h; + image = nk_font_atlas_bake(&sdl.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); + nk_sdl_device_upload_atlas(image, w, h); + nk_font_atlas_end(&sdl.atlas, nk_handle_ptr(sdl.ogl.font_tex), &sdl.ogl.tex_null); + if (sdl.atlas.default_font) + nk_style_set_font(&sdl.ctx, &sdl.atlas.default_font->handle); +} + +NK_API int +nk_sdl_handle_event(SDL_Event *evt) +{ + struct nk_context *ctx = &sdl.ctx; + + /* optional grabbing behavior */ + if (ctx->input.mouse.grab) { + SDL_SetRelativeMouseMode(SDL_TRUE); + ctx->input.mouse.grab = 0; + } else if (ctx->input.mouse.ungrab) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + SDL_SetRelativeMouseMode(SDL_FALSE); + SDL_WarpMouseInWindow(sdl.win, x, y); + ctx->input.mouse.ungrab = 0; + } + + switch(evt->type) + { + case SDL_KEYUP: /* KEYUP & KEYDOWN share same routine */ + case SDL_KEYDOWN: + { + int down = evt->type == SDL_KEYDOWN; + const Uint8* state = SDL_GetKeyboardState(0); + switch(evt->key.keysym.sym) + { + case SDLK_RSHIFT: /* RSHIFT & LSHIFT share same routine */ + case SDLK_LSHIFT: nk_input_key(ctx, NK_KEY_SHIFT, down); break; + case SDLK_DELETE: nk_input_key(ctx, NK_KEY_DEL, down); break; + case SDLK_RETURN: nk_input_key(ctx, NK_KEY_ENTER, down); break; + case SDLK_TAB: nk_input_key(ctx, NK_KEY_TAB, down); break; + case SDLK_BACKSPACE: nk_input_key(ctx, NK_KEY_BACKSPACE, down); break; + case SDLK_HOME: nk_input_key(ctx, NK_KEY_TEXT_START, down); + nk_input_key(ctx, NK_KEY_SCROLL_START, down); break; + case SDLK_END: nk_input_key(ctx, NK_KEY_TEXT_END, down); + nk_input_key(ctx, NK_KEY_SCROLL_END, down); break; + case SDLK_PAGEDOWN: nk_input_key(ctx, NK_KEY_SCROLL_DOWN, down); break; + case SDLK_PAGEUP: nk_input_key(ctx, NK_KEY_SCROLL_UP, down); break; + case SDLK_z: nk_input_key(ctx, NK_KEY_TEXT_UNDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_r: nk_input_key(ctx, NK_KEY_TEXT_REDO, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_c: nk_input_key(ctx, NK_KEY_COPY, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_v: nk_input_key(ctx, NK_KEY_PASTE, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_x: nk_input_key(ctx, NK_KEY_CUT, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_b: nk_input_key(ctx, NK_KEY_TEXT_LINE_START, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_e: nk_input_key(ctx, NK_KEY_TEXT_LINE_END, down && state[SDL_SCANCODE_LCTRL]); break; + case SDLK_UP: nk_input_key(ctx, NK_KEY_UP, down); break; + case SDLK_DOWN: nk_input_key(ctx, NK_KEY_DOWN, down); break; + case SDLK_LEFT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_LEFT, down); + else nk_input_key(ctx, NK_KEY_LEFT, down); + break; + case SDLK_RIGHT: + if (state[SDL_SCANCODE_LCTRL]) + nk_input_key(ctx, NK_KEY_TEXT_WORD_RIGHT, down); + else nk_input_key(ctx, NK_KEY_RIGHT, down); + break; + } + } + return 1; + + case SDL_MOUSEBUTTONUP: /* MOUSEBUTTONUP & MOUSEBUTTONDOWN share same routine */ + case SDL_MOUSEBUTTONDOWN: + { + int down = evt->type == SDL_MOUSEBUTTONDOWN; + const int x = evt->button.x, y = evt->button.y; + switch(evt->button.button) + { + case SDL_BUTTON_LEFT: + if (evt->button.clicks > 1) + nk_input_button(ctx, NK_BUTTON_DOUBLE, x, y, down); + nk_input_button(ctx, NK_BUTTON_LEFT, x, y, down); break; + case SDL_BUTTON_MIDDLE: nk_input_button(ctx, NK_BUTTON_MIDDLE, x, y, down); break; + case SDL_BUTTON_RIGHT: nk_input_button(ctx, NK_BUTTON_RIGHT, x, y, down); break; + } + } + return 1; + + case SDL_MOUSEMOTION: + if (ctx->input.mouse.grabbed) { + int x = (int)ctx->input.mouse.prev.x, y = (int)ctx->input.mouse.prev.y; + nk_input_motion(ctx, x + evt->motion.xrel, y + evt->motion.yrel); + } + else nk_input_motion(ctx, evt->motion.x, evt->motion.y); + return 1; + + case SDL_TEXTINPUT: + { + nk_glyph glyph; + memcpy(glyph, evt->text.text, NK_UTF_SIZE); + nk_input_glyph(ctx, glyph); + } + return 1; + + case SDL_MOUSEWHEEL: + nk_input_scroll(ctx,nk_vec2((float)evt->wheel.x,(float)evt->wheel.y)); + return 1; + } + return 0; +} + +NK_API +void nk_sdl_shutdown(void) +{ + struct nk_sdl_device *dev = &sdl.ogl; + nk_font_atlas_clear(&sdl.atlas); + nk_free(&sdl.ctx); + SDL_DestroyTexture(dev->font_tex); + /* glDeleteTextures(1, &dev->font_tex); */ + nk_buffer_free(&dev->cmds); + memset(&sdl, 0, sizeof(sdl)); +} + +#endif /* NK_SDL_RENDERER_IMPLEMENTATION */ diff --git a/demo/sfml_opengl2/Makefile b/demo/sfml_opengl2/Makefile index 28848a4..e648706 100644 --- a/demo/sfml_opengl2/Makefile +++ b/demo/sfml_opengl2/Makefile @@ -3,7 +3,7 @@ CC = g++ BIN = demo # Flags -CFLAGS += -s -O2 +CFLAGS += -s -Wall -Wextra -pedantic -O2 SRC = main.cpp OBJ = $(SRC:.cpp=.o) diff --git a/demo/sfml_opengl2/main.cpp b/demo/sfml_opengl2/main.cpp index db0bb29..82f8e0f 100644 --- a/demo/sfml_opengl2/main.cpp +++ b/demo/sfml_opengl2/main.cpp @@ -37,27 +37,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -93,10 +98,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif struct nk_colorf bg; @@ -154,6 +165,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/sfml_opengl2/nuklear_sfml_gl2.h b/demo/sfml_opengl2/nuklear_sfml_gl2.h index cff7278..f168bab 100644 --- a/demo/sfml_opengl2/nuklear_sfml_gl2.h +++ b/demo/sfml_opengl2/nuklear_sfml_gl2.h @@ -34,7 +34,7 @@ NK_API void nk_sfml_shutdown(void); struct nk_sfml_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint font_tex; }; @@ -59,7 +59,7 @@ nk_sfml_device_upload_atlas(const void* image, int width, int height) glBindTexture(GL_TEXTURE_2D, dev->font_tex); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); - glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, (GLsizei)width, (GLsizei)height, 0, + glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, (GLsizei)width, (GLsizei)height, 0, GL_RGBA, GL_UNSIGNED_BYTE, image); } @@ -118,7 +118,7 @@ nk_sfml_render(enum nk_anti_aliasing AA) config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_sfml_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_sfml_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -189,6 +189,9 @@ nk_sfml_clipboard_paste(nk_handle usr, struct nk_text_edit* edit) if(text) nk_textedit_paste(edit, text, nk_strlen(text)); (void)usr; +#else + NK_UNUSED(usr); + NK_UNUSED(edit); #endif } @@ -208,6 +211,10 @@ nk_sfml_clipboard_copy(nk_handle usr, const char* text, int len) sf::Clipboard clipboard(sfml.window); clipboard.setText(str); free(str); +#else + NK_UNUSED(usr); + NK_UNUSED(text); + NK_UNUSED(len); #endif } @@ -238,7 +245,7 @@ nk_sfml_font_stash_end() const void* img; img = nk_font_atlas_bake(&sfml.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_sfml_device_upload_atlas(img, w, h); - nk_font_atlas_end(&sfml.atlas, nk_handle_id((int)sfml.ogl.font_tex), &sfml.ogl.null); + nk_font_atlas_end(&sfml.atlas, nk_handle_id((int)sfml.ogl.font_tex), &sfml.ogl.tex_null); if(sfml.atlas.default_font) nk_style_set_font(&sfml.ctx, &sfml.atlas.default_font->handle); } diff --git a/demo/sfml_opengl3/Makefile b/demo/sfml_opengl3/Makefile index b30bf28..7bb9712 100644 --- a/demo/sfml_opengl3/Makefile +++ b/demo/sfml_opengl3/Makefile @@ -3,7 +3,7 @@ CC = g++ BIN = demo # Flags -CFLAGS += -s -O2 +CFLAGS += -s -Wall -Wextra -pedantic -O2 SRC = main.cpp OBJ = $(SRC:.cpp=.o) diff --git a/demo/sfml_opengl3/main.cpp b/demo/sfml_opengl3/main.cpp index 8bd669a..22aafcc 100644 --- a/demo/sfml_opengl3/main.cpp +++ b/demo/sfml_opengl3/main.cpp @@ -39,27 +39,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -99,10 +104,16 @@ int main(void) /* style.c */ #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif struct nk_colorf bg; @@ -161,6 +172,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/sfml_opengl3/nuklear_sfml_gl3.h b/demo/sfml_opengl3/nuklear_sfml_gl3.h index a074ef0..286cfc1 100644 --- a/demo/sfml_opengl3/nuklear_sfml_gl3.h +++ b/demo/sfml_opengl3/nuklear_sfml_gl3.h @@ -43,7 +43,7 @@ NK_API void nk_sfml_device_destroy(void); struct nk_sfml_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -248,7 +248,7 @@ nk_sfml_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_ config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_sfml_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_sfml_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -298,6 +298,9 @@ nk_sfml_clipboard_paste(nk_handle usr, struct nk_text_edit* edit) sf::Clipboard clipboard(sfml.window); const char* text = clipboard.getText(); if(text) nk_textedit_paste(edit, text, nk_strlen(text)); +#else + NK_UNUSED(usr); + NK_UNUSED(edit); #endif } static void @@ -316,6 +319,10 @@ nk_sfml_clipboard_copy(nk_handle usr, const char* text, int len) sf::Clipboard clipboard(sfml.window); clipboard.setText(str); free(str); +#else + NK_UNUSED(usr); + NK_UNUSED(text); + NK_UNUSED(len); #endif } @@ -346,7 +353,7 @@ nk_sfml_font_stash_end() int w, h; image = nk_font_atlas_bake(&sfml.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_sfml_device_upload_atlas(image, w, h); - nk_font_atlas_end(&sfml.atlas, nk_handle_id((int)sfml.ogl.font_tex), &sfml.ogl.null); + nk_font_atlas_end(&sfml.atlas, nk_handle_id((int)sfml.ogl.font_tex), &sfml.ogl.tex_null); if(sfml.atlas.default_font) nk_style_set_font(&sfml.ctx, &sfml.atlas.default_font->handle); } @@ -444,7 +451,7 @@ nk_sfml_handle_event(sf::Event* evt) return 1; } else if(evt->type == sf::Event::TextEntered) { /* 8 ~ backspace */ - if (evt->text.unicode != 8) { + if (evt->text.unicode != 8) { nk_input_unicode(ctx, evt->text.unicode); } return 1; diff --git a/demo/wayland_rawfb/Makefile b/demo/wayland_rawfb/Makefile index 7359784..7832d68 100644 --- a/demo/wayland_rawfb/Makefile +++ b/demo/wayland_rawfb/Makefile @@ -2,12 +2,12 @@ WAYLAND=`pkg-config wayland-client --cflags --libs` WAYLAND_SCANNER=wayland-scanner WAYLAND_PROTOCOLS_DIR=/usr/share/wayland-protocols -CFLAGS?=-std=c11 -Wall -Werror -O3 -fvisibility=hidden +CFLAGS?=-std=c99 -Wall -Wextra -pedantic -Wno-unused-function -O3 -fvisibility=hidden .PHONY: clean demo: main.c xdg-shell.c xdg-shell.h - $(CC) -o demo *.c $(WAYLAND) -lrt -lm + $(CC) $(CFLAGS) -o demo *.c $(WAYLAND) -lrt -lm xdg-shell.c: $(WAYLAND_SCANNER) code $(WAYLAND_PROTOCOLS_DIR)/stable/xdg-shell/xdg-shell.xml xdg-shell.c diff --git a/demo/wayland_rawfb/main.c b/demo/wayland_rawfb/main.c index fee2945..cf60eed 100644 --- a/demo/wayland_rawfb/main.c +++ b/demo/wayland_rawfb/main.c @@ -28,25 +28,79 @@ #define DTIME 20 +/* =============================================================== + * + * EXAMPLE + * + * ===============================================================*/ +/* This are some code examples to provide a small overview of what can be + * done with this library. To try out an example uncomment the defines */ +/*#define INCLUDE_ALL */ +/*#define INCLUDE_STYLE */ +/*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ +/*#define INCLUDE_OVERVIEW */ +/*#define INCLUDE_NODE_EDITOR */ + +#ifdef INCLUDE_ALL + #define INCLUDE_STYLE + #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS + #define INCLUDE_OVERVIEW + #define INCLUDE_NODE_EDITOR +#endif + +#ifdef INCLUDE_STYLE + #include "../../demo/common/style.c" +#endif +#ifdef INCLUDE_CALCULATOR + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" +#endif +#ifdef INCLUDE_OVERVIEW + #include "../../demo/common/overview.c" +#endif +#ifdef INCLUDE_NODE_EDITOR + #include "../../demo/common/node_editor.c" +#endif + //WAYLAND OUTPUT INTERFACE static void nk_wayland_output_cb_geometry(void *data, struct wl_output *wl_output, int x, int y, int w, int h, int subpixel, const char *make, const char *model, int transform) { + NK_UNUSED(data); + NK_UNUSED(wl_output); + NK_UNUSED(subpixel); + NK_UNUSED(make); + NK_UNUSED(model); + NK_UNUSED(transform); + printf("wl_output geometry x=%d, y=%d, w=%d, h=%d make=%s, model=%s \n", x,y,w,h, make, model); } static void nk_wayland_output_cb_mode(void *data, struct wl_output *wl_output, unsigned int flags, int w, int h, int refresh) { + NK_UNUSED(data); + NK_UNUSED(wl_output); + NK_UNUSED(flags); + NK_UNUSED(w); + NK_UNUSED(h); + NK_UNUSED(refresh); } static void nk_wayland_output_cb_done(void *data, struct wl_output *output) { - + NK_UNUSED(data); + NK_UNUSED(output); } static void nk_wayland_output_cb_scale(void *data, struct wl_output *output, int scale) { - + NK_UNUSED(data); + NK_UNUSED(output); + NK_UNUSED(scale); } static const struct wl_output_listener nk_wayland_output_listener = @@ -61,15 +115,29 @@ static const struct wl_output_listener nk_wayland_output_listener = //WAYLAND POINTER INTERFACE (mouse/touchpad) static void nk_wayland_pointer_enter (void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface, wl_fixed_t surface_x, wl_fixed_t surface_y) { + NK_UNUSED(data); + NK_UNUSED(pointer); + NK_UNUSED(serial); + NK_UNUSED(surface); + NK_UNUSED(surface_x); + NK_UNUSED(surface_y); } static void nk_wayland_pointer_leave (void *data, struct wl_pointer *pointer, uint32_t serial, struct wl_surface *surface) { + NK_UNUSED(data); + NK_UNUSED(pointer); + NK_UNUSED(serial); + NK_UNUSED(surface); } static void nk_wayland_pointer_motion (void *data, struct wl_pointer *pointer, uint32_t time, wl_fixed_t x, wl_fixed_t y) { struct nk_wayland* win = (struct nk_wayland*)data; + + NK_UNUSED(pointer); + NK_UNUSED(time); + win->mouse_pointer_x = wl_fixed_to_int(x); win->mouse_pointer_y = wl_fixed_to_int(y); @@ -79,7 +147,11 @@ static void nk_wayland_pointer_motion (void *data, struct wl_pointer *pointer, u static void nk_wayland_pointer_button (void *data, struct wl_pointer *pointer, uint32_t serial, uint32_t time, uint32_t button, uint32_t state) { struct nk_wayland* win = (struct nk_wayland*)data; - + + NK_UNUSED(pointer); + NK_UNUSED(serial); + NK_UNUSED(time); + if (button == 272){ //left mouse button if (state == WL_POINTER_BUTTON_STATE_PRESSED) { // printf("nk_input_button x=%d, y=%d press: 1 \n", win->mouse_pointer_x, win->mouse_pointer_y); @@ -93,6 +165,11 @@ static void nk_wayland_pointer_button (void *data, struct wl_pointer *pointer, u static void nk_wayland_pointer_axis (void *data, struct wl_pointer *pointer, uint32_t time, uint32_t axis, wl_fixed_t value) { + NK_UNUSED(data); + NK_UNUSED(pointer); + NK_UNUSED(time); + NK_UNUSED(axis); + NK_UNUSED(value); } static struct wl_pointer_listener nk_wayland_pointer_listener = @@ -101,30 +178,60 @@ static struct wl_pointer_listener nk_wayland_pointer_listener = &nk_wayland_pointer_leave, &nk_wayland_pointer_motion, &nk_wayland_pointer_button, - &nk_wayland_pointer_axis + &nk_wayland_pointer_axis, + NULL, + NULL, + NULL, + NULL }; //-------------------------------------------------------------------- endof WAYLAND POINTER INTERFACE //WAYLAND KEYBOARD INTERFACE static void nk_wayland_keyboard_keymap (void *data, struct wl_keyboard *keyboard, uint32_t format, int32_t fd, uint32_t size) { + NK_UNUSED(data); + NK_UNUSED(keyboard); + NK_UNUSED(format); + NK_UNUSED(fd); + NK_UNUSED(size); } static void nk_wayland_keyboard_enter (void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface, struct wl_array *keys) -{ +{ + NK_UNUSED(data); + NK_UNUSED(keyboard); + NK_UNUSED(serial); + NK_UNUSED(surface); + NK_UNUSED(keys); } static void nk_wayland_keyboard_leave (void *data, struct wl_keyboard *keyboard, uint32_t serial, struct wl_surface *surface) { + NK_UNUSED(data); + NK_UNUSED(keyboard); + NK_UNUSED(serial); + NK_UNUSED(surface); } static void nk_wayland_keyboard_key (void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t time, uint32_t key, uint32_t state) { + NK_UNUSED(data); + NK_UNUSED(keyboard); + NK_UNUSED(serial); + NK_UNUSED(time); + NK_UNUSED(state); printf("key: %d \n", key); } -static void nk_wayland_keyboard_modifiers (void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed, uint32_t mods_latched, uint32_t mods_locked, uint32_t group) +static void nk_wayland_keyboard_modifiers (void *data, struct wl_keyboard *keyboard, uint32_t serial, uint32_t mods_depressed, uint32_t mods_latched, uint32_t mods_locked, uint32_t group) { + NK_UNUSED(data); + NK_UNUSED(keyboard); + NK_UNUSED(serial); + NK_UNUSED(mods_depressed); + NK_UNUSED(mods_latched); + NK_UNUSED(mods_locked); + NK_UNUSED(group); } static struct wl_keyboard_listener nk_wayland_keyboard_listener = @@ -133,7 +240,8 @@ static struct wl_keyboard_listener nk_wayland_keyboard_listener = &nk_wayland_keyboard_enter, &nk_wayland_keyboard_leave, &nk_wayland_keyboard_key, - &nk_wayland_keyboard_modifiers + &nk_wayland_keyboard_modifiers, + NULL }; //-------------------------------------------------------------------- endof WAYLAND KEYBOARD INTERFACE @@ -154,14 +262,16 @@ static void seat_capabilities (void *data, struct wl_seat *seat, uint32_t capabi static struct wl_seat_listener seat_listener = { - &seat_capabilities + &seat_capabilities, + NULL }; //-------------------------------------------------------------------- endof WAYLAND SEAT INTERFACE // WAYLAND SHELL INTERFACE static void nk_wayland_xdg_wm_base_ping (void *data, struct xdg_wm_base *xdg_wm_base, uint32_t serial) { - xdg_wm_base_pong (xdg_wm_base, serial); + NK_UNUSED(data); + xdg_wm_base_pong (xdg_wm_base, serial); } static struct xdg_wm_base_listener nk_wayland_xdg_wm_base_listener = @@ -171,6 +281,7 @@ static struct xdg_wm_base_listener nk_wayland_xdg_wm_base_listener = static void nk_wayland_xdg_surface_configure (void *data, struct xdg_surface *xdg_surface, uint32_t serial) { + NK_UNUSED(data); xdg_surface_ack_configure(xdg_surface, serial); } @@ -181,10 +292,17 @@ static struct xdg_surface_listener nk_wayland_xdg_surface_listener = static void nk_wayland_xdg_toplevel_configure (void *data, struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height, struct wl_array *states) { + NK_UNUSED(data); + NK_UNUSED(xdg_toplevel); + NK_UNUSED(width); + NK_UNUSED(height); + NK_UNUSED(states); } static void nk_wayland_xdg_toplevel_close (void *data, struct xdg_toplevel *xdg_toplevel) { + NK_UNUSED(data); + NK_UNUSED(xdg_toplevel); } static struct xdg_toplevel_listener nk_wayland_xdg_toplevel_listener = @@ -199,7 +317,9 @@ static struct xdg_toplevel_listener nk_wayland_xdg_toplevel_listener = static void nk_wayland_registry_add_object (void *data, struct wl_registry *registry, uint32_t name, const char *interface, uint32_t version) { struct nk_wayland* win = (struct nk_wayland*)data; - + + NK_UNUSED(version); + //printf("looking for %s interface \n", interface); if (!strcmp(interface,"wl_compositor")) { win->compositor = wl_registry_bind (registry, name, &wl_compositor_interface, 1); @@ -222,6 +342,9 @@ static void nk_wayland_registry_add_object (void *data, struct wl_registry *regi static void nk_wayland_registry_remove_object (void *data, struct wl_registry *registry, uint32_t name) { + NK_UNUSED(data); + NK_UNUSED(registry); + NK_UNUSED(name); } static struct wl_registry_listener nk_wayland_registry_listener = @@ -314,8 +437,10 @@ static void redraw(void *data, struct wl_callback *callback, uint32_t time) { // printf("redrawing.. 1\n"); struct nk_wayland* win = (struct nk_wayland*)data; - struct nk_color col_red = {0xFF,0x00,0x00,0xA0}; //r,g,b,a - struct nk_color col_green = {0x00,0xFF,0x00,0xA0}; //r,g,b,a + + NK_UNUSED(callback); + NK_UNUSED(time); + wl_callback_destroy(win->frame_callback); wl_surface_damage(win->surface, 0, 0, WIDTH, HEIGHT); @@ -338,7 +463,6 @@ int main () long dt; long started; struct nk_wayland nk_wayland_ctx; - struct wl_backend *backend; struct wl_registry *registry; int running = 1; @@ -418,17 +542,20 @@ int main () if (nk_window_is_closed(&(nk_wayland_ctx.ctx), "Demo")) break; - // -------------- EXAMPLES ---------------- - //#ifdef INCLUDE_CALCULATOR - // calculator(&rawfb->ctx); - //#endif - // #ifdef INCLUDE_OVERVIEW - // overview(&rawfb->ctx); - // #endif - // #ifdef INCLUDE_NODE_EDITOR - // node_editor(&rawfb->ctx); - //#endif - // ----------------------------------------- + /* -------------- EXAMPLES ---------------- */ + #ifdef INCLUDE_CALCULATOR + calculator(&(nk_wayland_ctx.ctx)); + #endif + #ifdef INCLUDE_CANVAS + canvas(&(nk_wayland_ctx.ctx)); + #endif + #ifdef INCLUDE_OVERVIEW + overview(&(nk_wayland_ctx.ctx)); + #endif + #ifdef INCLUDE_NODE_EDITOR + node_editor(&(nk_wayland_ctx.ctx)); + #endif + /* ----------------------------------------- */ // Draw framebuffer nk_wayland_render(&nk_wayland_ctx, nk_rgb(30,30,30), 1); diff --git a/demo/wayland_rawfb/nuklear_raw_wayland.h b/demo/wayland_rawfb/nuklear_raw_wayland.h index 6e18a78..49082c5 100644 --- a/demo/wayland_rawfb/nuklear_raw_wayland.h +++ b/demo/wayland_rawfb/nuklear_raw_wayland.h @@ -110,7 +110,7 @@ static void nk_wayland_ctx_setpixel(const struct nk_wayland* win, const short x0, const short y0, const struct nk_color col) { uint32_t c = nk_color_to_xrgb8888(col); - uint32_t *pixels = win->data; + uint32_t *pixels = (uint32_t *)win->data; unsigned int *ptr; pixels += (y0 * win->width); @@ -252,7 +252,7 @@ static void nk_wayland_img_setpixel(const struct wayland_img *img, const int x0, unsigned int *pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); + ptr = (unsigned char *)img->pixels + (img->pitch * y0); pixel = (unsigned int *)ptr; if (img->format == NK_FONT_ATLAS_ALPHA8) { @@ -267,10 +267,9 @@ static struct nk_color nk_wayland_getpixel(const struct nk_wayland* win, const i { struct nk_color col = {0, 0, 0, 0}; uint32_t *ptr; - unsigned int pixel; if (y0 < win->height && y0 >= 0 && x0 >= 0 && x0 < win->width) { - ptr = win->data + (y0 * win->width); + ptr = (uint32_t *)win->data + (y0 * win->width); col = nk_wayland_int2color(*ptr, PIXEL_LAYOUT_XRGB_8888); } @@ -285,7 +284,7 @@ static struct nk_color nk_wayland_img_getpixel(const struct wayland_img *img, co unsigned int pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); + ptr = (unsigned char *)img->pixels + (img->pitch * y0); if (img->format == NK_FONT_ATLAS_ALPHA8) { col.a = ptr[x0]; @@ -365,6 +364,8 @@ static void nk_wayland_stroke_line(const struct nk_wayland* win, short x0, short short tmp; int dy, dx, stepx, stepy; + NK_UNUSED(line_thickness); + dy = y1 - y0; dx = x1 - x0; @@ -494,6 +495,8 @@ static void nk_wayland_stroke_arc(const struct nk_wayland* win, const int fa2 = 4 * a2, fb2 = 4 * b2; int x, y, sigma; + NK_UNUSED(line_thickness); + if (s != 0 && s != 90 && s != 180 && s != 270) return; if (w < 1 || h < 1) return; diff --git a/demo/x11/Makefile b/demo/x11/Makefile index 9057c7b..1234eaf 100644 --- a/demo/x11/Makefile +++ b/demo/x11/Makefile @@ -2,7 +2,7 @@ BIN = zahnrad # Flags -CFLAGS += -std=c89 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -Wno-unused-function -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/x11/main.c b/demo/x11/main.c index 791653d..0d02ad7 100644 --- a/demo/x11/main.c +++ b/demo/x11/main.c @@ -79,27 +79,32 @@ sleep_for(long t) /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -148,10 +153,16 @@ main(void) ctx = nk_xlib_init(xw.font, xw.dpy, xw.screen, xw.win, xw.width, xw.height); #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif while (running) @@ -193,6 +204,9 @@ main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/x11/nuklear_xlib.h b/demo/x11/nuklear_xlib.h index 6701ad9..9b3a861 100644 --- a/demo/x11/nuklear_xlib.h +++ b/demo/x11/nuklear_xlib.h @@ -357,6 +357,29 @@ nk_xsurf_stroke_circle(XSurface *surf, short x, short y, unsigned short w, XSetLineAttributes(surf->dpy, surf->gc, 1, LineSolid, CapButt, JoinMiter); } +NK_INTERN void +nk_xsurf_stroke_arc(XSurface *surf, short cx, short cy, unsigned short radius, + float a_min, float a_max, unsigned short line_thickness, struct nk_color col) +{ + unsigned long c = nk_color_from_byte(&col.r); + XSetLineAttributes(surf->dpy, surf->gc, line_thickness, LineSolid, CapButt, JoinMiter); + XSetForeground(surf->dpy, surf->gc, c); + XDrawArc(surf->dpy, surf->drawable, surf->gc, (int)(cx - radius), (int)(cy - radius), + (unsigned)(radius * 2), (unsigned)(radius * 2), + (int)(a_min * 180 * 64 / NK_PI), (int)(a_max * 180 * 64 / NK_PI)); +} + +NK_INTERN void +nk_xsurf_fill_arc(XSurface *surf, short cx, short cy, unsigned short radius, + float a_min, float a_max, struct nk_color col) +{ + unsigned long c = nk_color_from_byte(&col.r); + XSetForeground(surf->dpy, surf->gc, c); + XFillArc(surf->dpy, surf->drawable, surf->gc, (int)(cx - radius), (int)(cy - radius), + (unsigned)(radius * 2), (unsigned)(radius * 2), + (int)(a_min * 180 * 64 / NK_PI), (int)(a_max * 180 * 64 / NK_PI)); +} + NK_INTERN void nk_xsurf_stroke_curve(XSurface *surf, struct nk_vec2i p1, struct nk_vec2i p2, struct nk_vec2i p3, struct nk_vec2i p4, @@ -385,15 +408,12 @@ nk_xsurf_stroke_curve(XSurface *surf, struct nk_vec2i p1, } NK_INTERN void -nk_xsurf_draw_text(XSurface *surf, short x, short y, unsigned short w, unsigned short h, - const char *text, int len, XFont *font, struct nk_color cbg, struct nk_color cfg) +nk_xsurf_draw_text(XSurface *surf, short x, short y, const char *text, int len, + XFont *font, struct nk_color cfg) { int tx, ty; - unsigned long bg = nk_color_from_byte(&cbg.r); unsigned long fg = nk_color_from_byte(&cfg.r); - XSetForeground(surf->dpy, surf->gc, bg); - XFillRectangle(surf->dpy, surf->drawable, surf->gc, (int)x, (int)y, (unsigned)w, (unsigned)h); if(!text || !font || !len) return; tx = (int)x; @@ -413,10 +433,10 @@ nk_stbi_image_to_xsurf(unsigned char *data, int width, int height, int channels) int bpl = channels; long i, isize = width*height*channels; XImageWithAlpha *aimage = (XImageWithAlpha*)calloc( 1, sizeof(XImageWithAlpha) ); - int depth = DefaultDepth(surf->dpy, surf->screen); + int depth = DefaultDepth(surf->dpy, surf->screen); if (data == NULL) return nk_image_id(0); if (aimage == NULL) return nk_image_id(0); - + switch (depth){ case 24: bpl = 4; @@ -429,7 +449,7 @@ nk_stbi_image_to_xsurf(unsigned char *data, int width, int height, int channels) bpl = 1; break; } - + /* rgba to bgra */ if (channels >= 3){ for (i=0; i < isize; i += channels) { @@ -441,9 +461,9 @@ nk_stbi_image_to_xsurf(unsigned char *data, int width, int height, int channels) } if (channels == 4){ - const unsigned alpha_treshold = 127; + const unsigned alpha_treshold = 127; aimage->clipMask = XCreatePixmap(surf->dpy, surf->drawable, width, height, 1); - + if( aimage->clipMask ){ aimage->clipMaskGC = XCreateGC(surf->dpy, aimage->clipMask, 0, 0); XSetForeground(surf->dpy, aimage->clipMaskGC, BlackPixel(surf->dpy, surf->screen)); @@ -460,13 +480,13 @@ nk_stbi_image_to_xsurf(unsigned char *data, int width, int height, int channels) } } } - - aimage->ximage = XCreateImage(surf->dpy, - CopyFromParent, depth, - ZPixmap, 0, - (char*)data, - width, height, - bpl*8, bpl * width); + + aimage->ximage = XCreateImage(surf->dpy, + CopyFromParent, depth, + ZPixmap, 0, + (char*)data, + width, height, + bpl*8, bpl * width); img = nk_image_ptr( (void*)aimage); img.h = height; img.w = width; @@ -497,10 +517,13 @@ nk_xsurf_draw_image(XSurface *surf, short x, short y, unsigned short w, unsigned struct nk_image img, struct nk_color col) { XImageWithAlpha *aimage = img.handle.ptr; + + NK_UNUSED(col); + if (aimage){ if (aimage->clipMask){ XSetClipMask(surf->dpy, surf->gc, aimage->clipMask); - XSetClipOrigin(surf->dpy, surf->gc, x, y); + XSetClipOrigin(surf->dpy, surf->gc, x, y); } XPutImage(surf->dpy, surf->drawable, surf->gc, aimage->ximage, 0, 0, x, y, w, h); XSetClipMask(surf->dpy, surf->gc, None); @@ -581,6 +604,9 @@ nk_xfont_get_text_width(nk_handle handle, float height, const char *text, int le { XFont *font = (XFont*)handle.ptr; XRectangle r; + + NK_UNUSED(height); + if(!font || !text) return 0; @@ -687,6 +713,8 @@ nk_xlib_handle_event(Display *dpy, int screen, Window win, XEvent *evt) { struct nk_context *ctx = &xlib.ctx; + NK_UNUSED(screen); + /* optional grabbing behavior */ if (ctx->input.mouse.grab) { XDefineCursor(xlib.dpy, xlib.root, xlib.cursor); @@ -907,6 +935,14 @@ nk_xlib_render(Drawable screen, struct nk_color clear) const struct nk_command_circle_filled *c = (const struct nk_command_circle_filled *)cmd; nk_xsurf_fill_circle(surf, c->x, c->y, c->w, c->h, c->color); } break; + case NK_COMMAND_ARC: { + const struct nk_command_arc *a = (const struct nk_command_arc *)cmd; + nk_xsurf_stroke_arc(surf, a->cx, a->cy, a->r, a->a[0], a->a[1], a->line_thickness, a->color); + } break; + case NK_COMMAND_ARC_FILLED: { + const struct nk_command_arc_filled *a = (const struct nk_command_arc_filled *)cmd; + nk_xsurf_fill_arc(surf, a->cx, a->cy, a->r, a->a[0], a->a[1], a->color); + } break; case NK_COMMAND_TRIANGLE: { const struct nk_command_triangle*t = (const struct nk_command_triangle*)cmd; nk_xsurf_stroke_triangle(surf, t->a.x, t->a.y, t->b.x, t->b.y, @@ -931,10 +967,8 @@ nk_xlib_render(Drawable screen, struct nk_color clear) } break; case NK_COMMAND_TEXT: { const struct nk_command_text *t = (const struct nk_command_text*)cmd; - nk_xsurf_draw_text(surf, t->x, t->y, t->w, t->h, - (const char*)t->string, t->length, - (XFont*)t->font->userdata.ptr, - t->background, t->foreground); + nk_xsurf_draw_text(surf, t->x, t->y, (const char*)t->string, t->length, + (XFont*)t->font->userdata.ptr, t->foreground); } break; case NK_COMMAND_CURVE: { const struct nk_command_curve *q = (const struct nk_command_curve *)cmd; @@ -946,8 +980,6 @@ nk_xlib_render(Drawable screen, struct nk_color clear) nk_xsurf_draw_image(surf, i->x, i->y, i->w, i->h, i->img, i->col); } break; case NK_COMMAND_RECT_MULTI_COLOR: - case NK_COMMAND_ARC: - case NK_COMMAND_ARC_FILLED: case NK_COMMAND_CUSTOM: default: break; } diff --git a/demo/x11_opengl2/Makefile b/demo/x11_opengl2/Makefile index a3d6d32..e92437f 100644 --- a/demo/x11_opengl2/Makefile +++ b/demo/x11_opengl2/Makefile @@ -6,7 +6,7 @@ CC = clang DCC = gcc # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/x11_opengl2/main.c b/demo/x11_opengl2/main.c index d906929..2dc845e 100644 --- a/demo/x11_opengl2/main.c +++ b/demo/x11_opengl2/main.c @@ -40,27 +40,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -167,6 +172,7 @@ int main(void) glXGetFBConfigAttrib(win.dpy, fbc[i], GLX_SAMPLES, &samples); if ((fb_best < 0) || (sample_buffer && samples > best_num_samples)) fb_best = i, best_num_samples = samples; + XFree(vi); } } win.fbc = fbc[fb_best]; @@ -251,10 +257,16 @@ int main(void) /*nk_style_set_font(ctx, &droid->handle);*/} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -309,6 +321,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/x11_opengl2/nuklear_xlib_gl2.h b/demo/x11_opengl2/nuklear_xlib_gl2.h index c8483fe..2ad2648 100644 --- a/demo/x11_opengl2/nuklear_xlib_gl2.h +++ b/demo/x11_opengl2/nuklear_xlib_gl2.h @@ -60,7 +60,7 @@ struct nk_x11_vertex { struct nk_x11_device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint font_tex; }; @@ -100,8 +100,11 @@ nk_x11_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b /* setup global state */ struct nk_x11_device *dev = &x11.ogl; int width, height; - XWindowAttributes attr; + + NK_UNUSED(max_vertex_buffer); + NK_UNUSED(max_element_buffer); + XGetWindowAttributes(x11.dpy, x11.win, &attr); width = attr.width; height = attr.height; @@ -150,7 +153,7 @@ nk_x11_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_x11_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_x11_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -223,7 +226,7 @@ nk_x11_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&x11.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_x11_device_upload_atlas(image, w, h); - nk_font_atlas_end(&x11.atlas, nk_handle_id((int)x11.ogl.font_tex), &x11.ogl.null); + nk_font_atlas_end(&x11.atlas, nk_handle_id((int)x11.ogl.font_tex), &x11.ogl.tex_null); if (x11.atlas.default_font) nk_style_set_font(&x11.ctx, &x11.atlas.default_font->handle); } diff --git a/demo/x11_opengl3/Makefile b/demo/x11_opengl3/Makefile index a3d6d32..e92437f 100644 --- a/demo/x11_opengl3/Makefile +++ b/demo/x11_opengl3/Makefile @@ -6,7 +6,7 @@ CC = clang DCC = gcc # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/x11_opengl3/main.c b/demo/x11_opengl3/main.c index 5eab66f..a4a3008 100644 --- a/demo/x11_opengl3/main.c +++ b/demo/x11_opengl3/main.c @@ -38,27 +38,32 @@ /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -165,6 +170,7 @@ int main(void) glXGetFBConfigAttrib(win.dpy, fbc[i], GLX_SAMPLES, &samples); if ((fb_best < 0) || (sample_buffer && samples > best_num_samples)) fb_best = i, best_num_samples = samples; + XFree(vi); } } win.fbc = fbc[fb_best]; @@ -248,10 +254,16 @@ int main(void) /*nk_style_set_font(ctx, &droid->handle);*/} #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif bg.r = 0.10f, bg.g = 0.18f, bg.b = 0.24f, bg.a = 1.0f; @@ -306,6 +318,9 @@ int main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/x11_opengl3/nuklear_xlib_gl3.h b/demo/x11_opengl3/nuklear_xlib_gl3.h index 44d9335..9dd0181 100644 --- a/demo/x11_opengl3/nuklear_xlib_gl3.h +++ b/demo/x11_opengl3/nuklear_xlib_gl3.h @@ -173,7 +173,7 @@ struct nk_x11_device { struct opengl_info info; #endif struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -265,7 +265,7 @@ nk_load_opengl(struct opengl_info *gl) glGetIntegerv(GL_MAJOR_VERSION, &gl->major_version); glGetIntegerv(GL_MINOR_VERSION, &gl->minor_version); if (gl->major_version < 2) { - fprintf(stderr, "[GL]: Graphics card does not fullfill minimum OpenGL 2.0 support\n"); + fprintf(stderr, "[GL]: Graphics card does not fulfill minimum OpenGL 2.0 support\n"); return 0; } gl->version = (float)gl->major_version + (float)gl->minor_version * 0.1f; @@ -536,7 +536,7 @@ nk_x11_render(enum nk_anti_aliasing AA, int max_vertex_buffer, int max_element_b config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_x11_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_x11_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -592,7 +592,7 @@ nk_x11_font_stash_end(void) const void *image; int w, h; image = nk_font_atlas_bake(&x11.atlas, &w, &h, NK_FONT_ATLAS_RGBA32); nk_x11_device_upload_atlas(image, w, h); - nk_font_atlas_end(&x11.atlas, nk_handle_id((int)x11.ogl.font_tex), &x11.ogl.null); + nk_font_atlas_end(&x11.atlas, nk_handle_id((int)x11.ogl.font_tex), &x11.ogl.tex_null); if (x11.atlas.default_font) nk_style_set_font(&x11.ctx, &x11.atlas.default_font->handle); } diff --git a/demo/x11_rawfb/Makefile b/demo/x11_rawfb/Makefile index 0cae0b7..10bb4a7 100644 --- a/demo/x11_rawfb/Makefile +++ b/demo/x11_rawfb/Makefile @@ -2,7 +2,7 @@ BIN = zahnrad # Flags -CFLAGS += -std=c89 -pedantic -O2 -Wunused +CFLAGS += -std=c89 -Wall -Wextra -pedantic -Wno-unused-function -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/x11_rawfb/main.c b/demo/x11_rawfb/main.c index d722864..52a1c93 100644 --- a/demo/x11_rawfb/main.c +++ b/demo/x11_rawfb/main.c @@ -113,27 +113,32 @@ sleep_for(long t) /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -189,10 +194,16 @@ main(void) if (!rawfb) running = 0; #ifdef INCLUDE_STYLE - /*set_style(&rawfb->ctx, THEME_WHITE);*/ - /*set_style(&rawfb->ctx, THEME_RED);*/ - /*set_style(&rawfb->ctx, THEME_BLUE);*/ - /*set_style(&rawfb->ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(&rawfb->ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(&rawfb->ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(&rawfb->ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(&rawfb->ctx, THEME_DARK); + #endif #endif while (running) { @@ -230,6 +241,9 @@ main(void) #ifdef INCLUDE_CALCULATOR calculator(&rawfb->ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(&rawfb->ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(&rawfb->ctx); #endif diff --git a/demo/x11_rawfb/nuklear_rawfb.h b/demo/x11_rawfb/nuklear_rawfb.h index 710065e..ce84222 100644 --- a/demo/x11_rawfb/nuklear_rawfb.h +++ b/demo/x11_rawfb/nuklear_rawfb.h @@ -35,7 +35,7 @@ struct rawfb_context; typedef enum rawfb_pixel_layout { PIXEL_LAYOUT_XRGB_8888, - PIXEL_LAYOUT_RGBX_8888, + PIXEL_LAYOUT_RGBX_8888 } rawfb_pl; @@ -179,7 +179,7 @@ nk_rawfb_img_setpixel(const struct rawfb_image *img, unsigned int *pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); + ptr = (unsigned char *)img->pixels + (img->pitch * y0); pixel = (unsigned int *)ptr; if (img->format == NK_FONT_ATLAS_ALPHA8) { @@ -198,7 +198,7 @@ nk_rawfb_img_getpixel(const struct rawfb_image *img, const int x0, const int y0) unsigned int pixel; NK_ASSERT(img); if (y0 < img->h && y0 >= 0 && x0 >= 0 && x0 < img->w) { - ptr = img->pixels + (img->pitch * y0); + ptr = (unsigned char *)img->pixels + (img->pitch * y0); if (img->format == NK_FONT_ATLAS_ALPHA8) { col.a = ptr[x0]; @@ -247,6 +247,8 @@ nk_rawfb_stroke_line(const struct rawfb_context *rawfb, short tmp; int dy, dx, stepx, stepy; + NK_UNUSED(line_thickness); + dy = y1 - y0; dx = x1 - x0; @@ -381,6 +383,8 @@ nk_rawfb_stroke_arc(const struct rawfb_context *rawfb, const int fa2 = 4 * a2, fb2 = 4 * b2; int x, y, sigma; + NK_UNUSED(line_thickness); + if (s != 0 && s != 90 && s != 180 && s != 270) return; if (w < 1 || h < 1) return; @@ -747,6 +751,8 @@ nk_rawfb_stroke_circle(const struct rawfb_context *rawfb, const int fa2 = 4 * a2, fb2 = 4 * b2; int x, y, sigma; + NK_UNUSED(line_thickness); + /* Convert upper left to center */ h = (h + 1) / 2; w = (w + 1) / 2; diff --git a/demo/x11_rawfb/nuklear_xlib.h b/demo/x11_rawfb/nuklear_xlib.h index 3a13931..0d23135 100644 --- a/demo/x11_rawfb/nuklear_xlib.h +++ b/demo/x11_rawfb/nuklear_xlib.h @@ -109,7 +109,7 @@ nk_xlib_init(Display *dpy, Visual *vis, int screen, Window root, break; } xlib.xsi.shmaddr = xlib.ximg->data = shmat(xlib.xsi.shmid, NULL, 0); - if ((size_t)xlib.xsi.shmaddr < 0) { + if ((intptr_t)xlib.xsi.shmaddr < 0) { XDestroyImage(xlib.ximg); xlib.fallback = True; break; @@ -254,10 +254,10 @@ nk_xlib_handle_event(Display *dpy, int screen, Window win, XEvent *evt, struct r } else if (evt->type == Expose || evt->type == ConfigureNotify) { /* Window resize handler */ void *fb; + rawfb_pl pl; unsigned int width, height; XWindowAttributes attr; XGetWindowAttributes(dpy, win, &attr); - rawfb_pl pl; width = (unsigned int)attr.width; height = (unsigned int)attr.height; diff --git a/demo/x11_xft/Makefile b/demo/x11_xft/Makefile index 12d3cba..1ea53e6 100644 --- a/demo/x11_xft/Makefile +++ b/demo/x11_xft/Makefile @@ -2,7 +2,7 @@ BIN = zahnrad # Flags -CFLAGS += -std=c89 -pedantic -O2 +CFLAGS += -std=c89 -Wall -Wextra -pedantic -Wno-unused-function -O2 SRC = main.c OBJ = $(SRC:.c=.o) diff --git a/demo/x11_xft/main.c b/demo/x11_xft/main.c index 3a7917e..263f43b 100644 --- a/demo/x11_xft/main.c +++ b/demo/x11_xft/main.c @@ -79,27 +79,32 @@ sleep_for(long t) /*#define INCLUDE_ALL */ /*#define INCLUDE_STYLE */ /*#define INCLUDE_CALCULATOR */ +/*#define INCLUDE_CANVAS */ /*#define INCLUDE_OVERVIEW */ /*#define INCLUDE_NODE_EDITOR */ #ifdef INCLUDE_ALL #define INCLUDE_STYLE #define INCLUDE_CALCULATOR + #define INCLUDE_CANVAS #define INCLUDE_OVERVIEW #define INCLUDE_NODE_EDITOR #endif #ifdef INCLUDE_STYLE - #include "../style.c" + #include "../../demo/common/style.c" #endif #ifdef INCLUDE_CALCULATOR - #include "../calculator.c" + #include "../../demo/common/calculator.c" +#endif +#ifdef INCLUDE_CANVAS + #include "../../demo/common/canvas.c" #endif #ifdef INCLUDE_OVERVIEW - #include "../overview.c" + #include "../../demo/common/overview.c" #endif #ifdef INCLUDE_NODE_EDITOR - #include "../node_editor.c" + #include "../../demo/common/node_editor.c" #endif /* =============================================================== @@ -152,10 +157,16 @@ main(void) xw.width, xw.height); #ifdef INCLUDE_STYLE - /*set_style(ctx, THEME_WHITE);*/ - /*set_style(ctx, THEME_RED);*/ - /*set_style(ctx, THEME_BLUE);*/ - /*set_style(ctx, THEME_DARK);*/ + /* ease regression testing during Nuklear release process; not needed for anything else */ + #ifdef STYLE_WHITE + set_style(ctx, THEME_WHITE); + #elif defined(STYLE_RED) + set_style(ctx, THEME_RED); + #elif defined(STYLE_BLUE) + set_style(ctx, THEME_BLUE); + #elif defined(STYLE_DARK) + set_style(ctx, THEME_DARK); + #endif #endif while (running) @@ -197,6 +208,9 @@ main(void) #ifdef INCLUDE_CALCULATOR calculator(ctx); #endif + #ifdef INCLUDE_CANVAS + canvas(ctx); + #endif #ifdef INCLUDE_OVERVIEW overview(ctx); #endif diff --git a/demo/x11_xft/nuklear_xlib.h b/demo/x11_xft/nuklear_xlib.h index cb14e68..9526e3e 100644 --- a/demo/x11_xft/nuklear_xlib.h +++ b/demo/x11_xft/nuklear_xlib.h @@ -389,6 +389,29 @@ nk_xsurf_stroke_circle(XSurface *surf, short x, short y, unsigned short w, XSetLineAttributes(surf->dpy, surf->gc, 1, LineSolid, CapButt, JoinMiter); } +NK_INTERN void +nk_xsurf_stroke_arc(XSurface *surf, short cx, short cy, unsigned short radius, + float a_min, float a_max, unsigned short line_thickness, struct nk_color col) +{ + unsigned long c = nk_color_from_byte(&col.r); + XSetLineAttributes(surf->dpy, surf->gc, line_thickness, LineSolid, CapButt, JoinMiter); + XSetForeground(surf->dpy, surf->gc, c); + XDrawArc(surf->dpy, surf->drawable, surf->gc, (int)(cx - radius), (int)(cy - radius), + (unsigned)(radius * 2), (unsigned)(radius * 2), + (int)(a_min * 180 * 64 / NK_PI), (int)(a_max * 180 * 64 / NK_PI)); +} + +NK_INTERN void +nk_xsurf_fill_arc(XSurface *surf, short cx, short cy, unsigned short radius, + float a_min, float a_max, struct nk_color col) +{ + unsigned long c = nk_color_from_byte(&col.r); + XSetForeground(surf->dpy, surf->gc, c); + XFillArc(surf->dpy, surf->drawable, surf->gc, (int)(cx - radius), (int)(cy - radius), + (unsigned)(radius * 2), (unsigned)(radius * 2), + (int)(a_min * 180 * 64 / NK_PI), (int)(a_max * 180 * 64 / NK_PI)); +} + NK_INTERN void nk_xsurf_stroke_curve(XSurface *surf, struct nk_vec2i p1, struct nk_vec2i p2, struct nk_vec2i p3, struct nk_vec2i p4, @@ -417,22 +440,22 @@ nk_xsurf_stroke_curve(XSurface *surf, struct nk_vec2i p1, } NK_INTERN void -nk_xsurf_draw_text(XSurface *surf, short x, short y, unsigned short w, unsigned short h, - const char *text, int len, XFont *font, struct nk_color cbg, struct nk_color cfg) +nk_xsurf_draw_text(XSurface *surf, short x, short y, const char *text, int len, + XFont *font, struct nk_color cfg) { - int tx, ty; - unsigned long bg = nk_color_from_byte(&cbg.r); +#ifdef NK_XLIB_USE_XFT + XRenderColor xrc; + XftColor color; +#else unsigned long fg = nk_color_from_byte(&cfg.r); +#endif + int tx, ty; - XSetForeground(surf->dpy, surf->gc, bg); - XFillRectangle(surf->dpy, surf->drawable, surf->gc, (int)x, (int)y, (unsigned)w, (unsigned)h); if(!text || !font || !len) return; tx = (int)x; ty = (int)y + font->ascent; #ifdef NK_XLIB_USE_XFT - XRenderColor xrc; - XftColor color; xrc.red = cfg.r * 257; xrc.green = cfg.g * 257; xrc.blue = cfg.b * 257; @@ -541,6 +564,9 @@ nk_xsurf_draw_image(XSurface *surf, short x, short y, unsigned short w, unsigned struct nk_image img, struct nk_color col) { XImageWithAlpha *aimage = img.handle.ptr; + + NK_UNUSED(col); + if (aimage){ if (aimage->clipMask){ XSetClipMask(surf->dpy, surf->gc, aimage->clipMask); @@ -640,17 +666,24 @@ nk_xfont_get_text_width(nk_handle handle, float height, const char *text, int le { XFont *font = (XFont*)handle.ptr; - if(!font || !text) - return 0; - #ifdef NK_XLIB_USE_XFT XGlyphInfo g; + NK_UNUSED(height); + + if(!font || !text) + return 0; + XftTextExtentsUtf8(xlib.dpy, font->ft, (FcChar8*)text, len, &g); return g.xOff; #else XRectangle r; + NK_UNUSED(height); + + if(!font || !text) + return 0; + if(font->set) { XmbTextExtents(font->set, (const char*)text, len, NULL, &r); return (float)r.width; @@ -765,6 +798,8 @@ nk_xlib_handle_event(Display *dpy, int screen, Window win, XEvent *evt) { struct nk_context *ctx = &xlib.ctx; + NK_UNUSED(screen); + /* optional grabbing behavior */ if (ctx->input.mouse.grab) { XDefineCursor(xlib.dpy, xlib.root, xlib.cursor); @@ -985,6 +1020,14 @@ nk_xlib_render(Drawable screen, struct nk_color clear) const struct nk_command_circle_filled *c = (const struct nk_command_circle_filled *)cmd; nk_xsurf_fill_circle(surf, c->x, c->y, c->w, c->h, c->color); } break; + case NK_COMMAND_ARC: { + const struct nk_command_arc *a = (const struct nk_command_arc *)cmd; + nk_xsurf_stroke_arc(surf, a->cx, a->cy, a->r, a->a[0], a->a[1], a->line_thickness, a->color); + } break; + case NK_COMMAND_ARC_FILLED: { + const struct nk_command_arc_filled *a = (const struct nk_command_arc_filled *)cmd; + nk_xsurf_fill_arc(surf, a->cx, a->cy, a->r, a->a[0], a->a[1], a->color); + } break; case NK_COMMAND_TRIANGLE: { const struct nk_command_triangle*t = (const struct nk_command_triangle*)cmd; nk_xsurf_stroke_triangle(surf, t->a.x, t->a.y, t->b.x, t->b.y, @@ -1009,10 +1052,8 @@ nk_xlib_render(Drawable screen, struct nk_color clear) } break; case NK_COMMAND_TEXT: { const struct nk_command_text *t = (const struct nk_command_text*)cmd; - nk_xsurf_draw_text(surf, t->x, t->y, t->w, t->h, - (const char*)t->string, t->length, - (XFont*)t->font->userdata.ptr, - t->background, t->foreground); + nk_xsurf_draw_text(surf, t->x, t->y, (const char*)t->string, t->length, + (XFont*)t->font->userdata.ptr, t->foreground); } break; case NK_COMMAND_CURVE: { const struct nk_command_curve *q = (const struct nk_command_curve *)cmd; @@ -1024,8 +1065,6 @@ nk_xlib_render(Drawable screen, struct nk_color clear) nk_xsurf_draw_image(surf, i->x, i->y, i->w, i->h, i->img, i->col); } break; case NK_COMMAND_RECT_MULTI_COLOR: - case NK_COMMAND_ARC: - case NK_COMMAND_ARC_FILLED: case NK_COMMAND_CUSTOM: default: break; } diff --git a/doc/build.sh b/doc/build.sh index 560dd59..0ac149a 100755 --- a/doc/build.sh +++ b/doc/build.sh @@ -1,4 +1,2 @@ #!/bin/sh -cat ../nuklear.h|./doc > nuklear.html - - +cat ../nuklear.h|./doc > index.html diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..0312be3 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,2626 @@ + + +Nuklear +# Nuklear +![](https://cloud.githubusercontent.com/assets/8057201/11761525/ae06f0ca-a0c6-11e5-819d-5610b25f6ef4.gif) +## Contents +1. About section +2. Highlights section +3. Features section +4. Usage section + 1. Flags section + 2. Constants section + 3. Dependencies section +5. Example section +6. API section + 1. Context section + 2. Input section + 3. Drawing section + 4. Window section + 5. Layouting section + 6. Groups section + 7. Tree section + 8. Properties section +7. License section +8. Changelog section +9. Gallery section +10. Credits section +## About +This is a minimal state immediate mode graphical user interface toolkit +written in ANSI C and licensed under public domain. It was designed as a simple +embeddable user interface for application and does not have any dependencies, +a default renderbackend or OS window and input handling but instead provides a very modular +library approach by using simple input state for input and draw +commands describing primitive shapes as output. So instead of providing a +layered library that tries to abstract over a number of platform and +render backends it only focuses on the actual UI. +## Highlights +- Graphical user interface toolkit +- Single header library +- Written in C89 (a.k.a. ANSI C or ISO C90) +- Small codebase (~18kLOC) +- Focus on portability, efficiency and simplicity +- No dependencies (not even the standard library if not wanted) +- Fully skinnable and customizable +- Low memory footprint with total memory control if needed or wanted +- UTF-8 support +- No global or hidden state +- Customizable library modules (you can compile and use only what you need) +- Optional font baker and vertex buffer output +## Features +- Absolutely no platform dependent code +- Memory management control ranging from/to + - Ease of use by allocating everything from standard library + - Control every byte of memory inside the library +- Font handling control ranging from/to + - Use your own font implementation for everything + - Use this libraries internal font baking and handling API +- Drawing output control ranging from/to + - Simple shapes for more high level APIs which already have drawing capabilities + - Hardware accessible anti-aliased vertex buffer output +- Customizable colors and properties ranging from/to + - Simple changes to color by filling a simple color table + - Complete control with ability to use skinning to decorate widgets +- Bendable UI library with widget ranging from/to + - Basic widgets like buttons, checkboxes, slider, ... + - Advanced widget like abstract comboboxes, contextual menus,... +- Compile time configuration to only compile what you need + - Subset which can be used if you do not want to link or use the standard library +- Can be easily modified to only update on user input instead of frame updates +## Usage +This library is self contained in one single header file and can be used either +in header only mode or in implementation mode. The header only mode is used +by default when included and allows including this header in other headers +and does not contain the actual implementation.

+The implementation mode requires to define the preprocessor macro +NK_IMPLEMENTATION in *one* .c/.cpp file before #including this file, e.g.: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~C + #define NK_IMPLEMENTATION + #include "nuklear.h" +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Also optionally define the symbols listed in the section "OPTIONAL DEFINES" +below in header and implementation mode if you want to use additional functionality +or need more control over the library. +!!! WARNING + Every time nuklear is included define the same compiler flags. This very important not doing so could lead to compiler errors or even worse stack corruptions. +### Flags +Flag | Description +--------------------------------|------------------------------------------ +NK_PRIVATE | If defined declares all functions as static, so they can only be accessed inside the file that contains the implementation +NK_INCLUDE_FIXED_TYPES | If defined it will include header `` for fixed sized types otherwise nuklear tries to select the correct type. If that fails it will throw a compiler error and you have to select the correct types yourself. +NK_INCLUDE_DEFAULT_ALLOCATOR | If defined it will include header `` and provide additional functions to use this library without caring for memory allocation control and therefore ease memory management. +NK_INCLUDE_STANDARD_IO | If defined it will include header `` and provide additional functions depending on file loading. +NK_INCLUDE_STANDARD_VARARGS | If defined it will include header and provide additional functions depending on file loading. +NK_INCLUDE_VERTEX_BUFFER_OUTPUT | Defining this adds a vertex draw command list backend to this library, which allows you to convert queue commands into vertex draw commands. This is mainly if you need a hardware accessible format for OpenGL, DirectX, Vulkan, Metal,... +NK_INCLUDE_FONT_BAKING | Defining this adds `stb_truetype` and `stb_rect_pack` implementation to this library and provides font baking and rendering. If you already have font handling or do not want to use this font handler you don't have to define it. +NK_INCLUDE_DEFAULT_FONT | Defining this adds the default font: ProggyClean.ttf into this library which can be loaded into a font atlas and allows using this library without having a truetype font +NK_INCLUDE_COMMAND_USERDATA | Defining this adds a userdata pointer into each command. Can be useful for example if you want to provide custom shaders depending on the used widget. Can be combined with the style structures. +NK_BUTTON_TRIGGER_ON_RELEASE | Different platforms require button clicks occurring either on buttons being pressed (up to down) or released (down to up). By default this library will react on buttons being pressed, but if you define this it will only trigger if a button is released. +NK_ZERO_COMMAND_MEMORY | Defining this will zero out memory for each drawing command added to a drawing queue (inside nk_command_buffer_push). Zeroing command memory is very useful for fast checking (using memcmp) if command buffers are equal and avoid drawing frames when nothing on screen has changed since previous frame. +NK_UINT_DRAW_INDEX | Defining this will set the size of vertex index elements when using NK_VERTEX_BUFFER_OUTPUT to 32bit instead of the default of 16bit +NK_KEYSTATE_BASED_INPUT | Define this if your backend uses key state for each frame rather than key press/release events +!!! WARNING + The following flags will pull in the standard C library: + - NK_INCLUDE_DEFAULT_ALLOCATOR + - NK_INCLUDE_STANDARD_IO + - NK_INCLUDE_STANDARD_VARARGS +!!! WARNING + The following flags if defined need to be defined for both header and implementation: + - NK_INCLUDE_FIXED_TYPES + - NK_INCLUDE_DEFAULT_ALLOCATOR + - NK_INCLUDE_STANDARD_VARARGS + - NK_INCLUDE_VERTEX_BUFFER_OUTPUT + - NK_INCLUDE_FONT_BAKING + - NK_INCLUDE_DEFAULT_FONT + - NK_INCLUDE_STANDARD_VARARGS + - NK_INCLUDE_COMMAND_USERDATA + - NK_UINT_DRAW_INDEX +### Constants +Define | Description +--------------------------------|--------------------------------------- +NK_BUFFER_DEFAULT_INITIAL_SIZE | Initial buffer size allocated by all buffers while using the default allocator functions included by defining NK_INCLUDE_DEFAULT_ALLOCATOR. If you don't want to allocate the default 4k memory then redefine it. +NK_MAX_NUMBER_BUFFER | Maximum buffer size for the conversion buffer between float and string Under normal circumstances this should be more than sufficient. +NK_INPUT_MAX | Defines the max number of bytes which can be added as text input in one frame. Under normal circumstances this should be more than sufficient. +!!! WARNING + The following constants if defined need to be defined for both header and implementation: + - NK_MAX_NUMBER_BUFFER + - NK_BUFFER_DEFAULT_INITIAL_SIZE + - NK_INPUT_MAX +### Dependencies +Function | Description +------------|--------------------------------------------------------------- +NK_ASSERT | If you don't define this, nuklear will use with assert(). +NK_MEMSET | You can define this to 'memset' or your own memset implementation replacement. If not nuklear will use its own version. +NK_MEMCPY | You can define this to 'memcpy' or your own memcpy implementation replacement. If not nuklear will use its own version. +NK_SQRT | You can define this to 'sqrt' or your own sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. +NK_SIN | You can define this to 'sinf' or your own sine implementation replacement. If not nuklear will use its own approximation implementation. +NK_COS | You can define this to 'cosf' or your own cosine implementation replacement. If not nuklear will use its own approximation implementation. +NK_STRTOD | You can define this to `strtod` or your own string to double conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). +NK_DTOA | You can define this to `dtoa` or your own double to string conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). +NK_VSNPRINTF| If you define `NK_INCLUDE_STANDARD_VARARGS` as well as `NK_INCLUDE_STANDARD_IO` and want to be safe define this to `vsnprintf` on compilers supporting later versions of C or C++. By default nuklear will check for your stdlib version in C as well as compiler version in C++. if `vsnprintf` is available it will define it to `vsnprintf` directly. If not defined and if you have older versions of C or C++ it will be defined to `vsprintf` which is unsafe. +!!! WARNING + The following dependencies will pull in the standard C library if not redefined: + - NK_ASSERT +!!! WARNING + The following dependencies if defined need to be defined for both header and implementation: + - NK_ASSERT +!!! WARNING + The following dependencies if defined need to be defined only for the implementation part: + - NK_MEMSET + - NK_MEMCPY + - NK_SQRT + - NK_SIN + - NK_COS + - NK_STRTOD + - NK_DTOA + - NK_VSNPRINTF +## Example +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +// init gui state +enum {EASY, HARD}; +static int op = EASY; +static float value = 0.6f; +static int i = 20; +struct nk_context ctx; +nk_init_fixed(&ctx, calloc(1, MAX_MEMORY), MAX_MEMORY, &font); +if (nk_begin(&ctx, "Show", nk_rect(50, 50, 220, 220), + NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_CLOSABLE)) { + // fixed widget pixel width + nk_layout_row_static(&ctx, 30, 80, 1); + if (nk_button_label(&ctx, "button")) { + // event handling + } + // fixed widget window ratio width + nk_layout_row_dynamic(&ctx, 30, 2); + if (nk_option_label(&ctx, "easy", op == EASY)) op = EASY; + if (nk_option_label(&ctx, "hard", op == HARD)) op = HARD; + // custom widget pixel width + nk_layout_row_begin(&ctx, NK_STATIC, 30, 2); + { + nk_layout_row_push(&ctx, 50); + nk_label(&ctx, "Volume:", NK_TEXT_LEFT); + nk_layout_row_push(&ctx, 110); + nk_slider_float(&ctx, 0, &value, 1.0f, 0.1f); + } + nk_layout_row_end(&ctx); +} +nk_end(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +![](https://cloud.githubusercontent.com/assets/8057201/10187981/584ecd68-675c-11e5-897c-822ef534a876.png) +## API +### Context +Contexts are the main entry point and the majestro of nuklear and contain all required state. +They are used for window, memory, input, style, stack, commands and time management and need +to be passed into all nuklear GUI specific functions. +#### Usage +To use a context it first has to be initialized which can be achieved by calling +one of either `nk_init_default`, `nk_init_fixed`, `nk_init`, `nk_init_custom`. +Each takes in a font handle and a specific way of handling memory. Memory control +hereby ranges from standard library to just specifying a fixed sized block of memory +which nuklear has to manage itself from. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + // [...] + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +--------------------|------------------------------------------------------- +__nk_init_default__ | Initializes context with standard library memory allocation (malloc,free) +__nk_init_fixed__ | Initializes context from single fixed size memory block +__nk_init__ | Initializes context with memory allocator callbacks for alloc and free +__nk_init_custom__ | Initializes context from two buffers. One for draw commands the other for window/panel/table allocations +__nk_clear__ | Called at the end of the frame to reset and prepare the context for the next frame +__nk_free__ | Shutdown and free all memory allocated inside the context +__nk_set_user_data__| Utility function to pass user data to draw command +#### nk_init_default +Initializes a `nk_context` struct with a default standard library allocator. +Should be used if you don't want to be bothered with memory management in nuklear. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_init_default(struct nk_context *ctx, const struct nk_user_font *font); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|--------------------------------------------------------------- +__ctx__ | Must point to an either stack or heap allocated `nk_context` struct +__font__ | Must point to a previously initialized font handle for more info look at font documentation +Returns either `false(0)` on failure or `true(1)` on success. +#### nk_init_fixed +Initializes a `nk_context` struct from single fixed size memory block +Should be used if you want complete control over nuklear's memory management. +Especially recommended for system with little memory or systems with virtual memory. +For the later case you can just allocate for example 16MB of virtual memory +and only the required amount of memory will actually be committed. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_init_fixed(struct nk_context *ctx, void *memory, nk_size size, const struct nk_user_font *font); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +!!! Warning + make sure the passed memory block is aligned correctly for `nk_draw_commands`. +Parameter | Description +------------|-------------------------------------------------------------- +__ctx__ | Must point to an either stack or heap allocated `nk_context` struct +__memory__ | Must point to a previously allocated memory block +__size__ | Must contain the total size of __memory__ +__font__ | Must point to a previously initialized font handle for more info look at font documentation +Returns either `false(0)` on failure or `true(1)` on success. +#### nk_init +Initializes a `nk_context` struct with memory allocation callbacks for nuklear to allocate +memory from. Used internally for `nk_init_default` and provides a kitchen sink allocation +interface to nuklear. Can be useful for cases like monitoring memory consumption. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_init(struct nk_context *ctx, struct nk_allocator *alloc, const struct nk_user_font *font); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|--------------------------------------------------------------- +__ctx__ | Must point to an either stack or heap allocated `nk_context` struct +__alloc__ | Must point to a previously allocated memory allocator +__font__ | Must point to a previously initialized font handle for more info look at font documentation +Returns either `false(0)` on failure or `true(1)` on success. +#### nk_init_custom +Initializes a `nk_context` struct from two different either fixed or growing +buffers. The first buffer is for allocating draw commands while the second buffer is +used for allocating windows, panels and state tables. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_init_custom(struct nk_context *ctx, struct nk_buffer *cmds, struct nk_buffer *pool, const struct nk_user_font *font); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|--------------------------------------------------------------- +__ctx__ | Must point to an either stack or heap allocated `nk_context` struct +__cmds__ | Must point to a previously initialized memory buffer either fixed or dynamic to store draw commands into +__pool__ | Must point to a previously initialized memory buffer either fixed or dynamic to store windows, panels and tables +__font__ | Must point to a previously initialized font handle for more info look at font documentation +Returns either `false(0)` on failure or `true(1)` on success. +#### nk_clear +Resets the context state at the end of the frame. This includes mostly +garbage collector tasks like removing windows or table not called and therefore +used anymore. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_clear(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +#### nk_free +Frees all memory allocated by nuklear. Not needed if context was +initialized with `nk_init_fixed`. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_free(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +#### nk_set_user_data +Sets the currently passed userdata passed down into each draw command. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_set_user_data(struct nk_context *ctx, nk_handle data); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|-------------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__data__ | Handle with either pointer or index to be passed into every draw commands +### Input +The input API is responsible for holding the current input state composed of +mouse, key and text input states. +It is worth noting that no direct OS or window handling is done in nuklear. +Instead all input state has to be provided by platform specific code. This on one hand +expects more work from the user and complicates usage but on the other hand +provides simple abstraction over a big number of platforms, libraries and other +already provided functionality. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +nk_input_begin(&ctx); +while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + // [...] + } +} nk_input_end(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Usage +Input state needs to be provided to nuklear by first calling `nk_input_begin` +which resets internal state like delta mouse position and button transitions. +After `nk_input_begin` all current input state needs to be provided. This includes +mouse motion, button and key pressed and released, text input and scrolling. +Both event- or state-based input handling are supported by this API +and should work without problems. Finally after all input state has been +mirrored `nk_input_end` needs to be called to finish input process. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + Event evt; + nk_input_begin(&ctx); + while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + // [...] + } + } + nk_input_end(&ctx); + // [...] + nk_clear(&ctx); +} nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +--------------------|------------------------------------------------------- +__nk_input_begin__ | Begins the input mirroring process. Needs to be called before all other `nk_input_xxx` calls +__nk_input_motion__ | Mirrors mouse cursor position +__nk_input_key__ | Mirrors key state with either pressed or released +__nk_input_button__ | Mirrors mouse button state with either pressed or released +__nk_input_scroll__ | Mirrors mouse scroll values +__nk_input_char__ | Adds a single ASCII text character into an internal text buffer +__nk_input_glyph__ | Adds a single multi-byte UTF-8 character into an internal text buffer +__nk_input_unicode__| Adds a single unicode rune into an internal text buffer +__nk_input_end__ | Ends the input mirroring process by calculating state changes. Don't call any `nk_input_xxx` function referenced above after this call +#### nk_input_begin +Begins the input mirroring process by resetting text, scroll +mouse, previous mouse position and movement as well as key state transitions, +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_begin(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +#### nk_input_motion +Mirrors current mouse position to nuklear +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_motion(struct nk_context *ctx, int x, int y); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__x__ | Must hold an integer describing the current mouse cursor x-position +__y__ | Must hold an integer describing the current mouse cursor y-position +#### nk_input_key +Mirrors the state of a specific key to nuklear +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_key(struct nk_context*, enum nk_keys key, int down); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__key__ | Must be any value specified in enum `nk_keys` that needs to be mirrored +__down__ | Must be 0 for key is up and 1 for key is down +#### nk_input_button +Mirrors the state of a specific mouse button to nuklear +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_button(struct nk_context *ctx, enum nk_buttons btn, int x, int y, int down); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__btn__ | Must be any value specified in enum `nk_buttons` that needs to be mirrored +__x__ | Must contain an integer describing mouse cursor x-position on click up/down +__y__ | Must contain an integer describing mouse cursor y-position on click up/down +__down__ | Must be 0 for key is up and 1 for key is down +#### nk_input_scroll +Copies the last mouse scroll value to nuklear. Is generally +a scroll value. So does not have to come from mouse and could also originate +TODO finish this sentence +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__val__ | vector with both X- as well as Y-scroll value +#### nk_input_char +Copies a single ASCII character into an internal text buffer +This is basically a helper function to quickly push ASCII characters into +nuklear. +!!! Note + Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_char(struct nk_context *ctx, char c); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__c__ | Must be a single ASCII character preferable one that can be printed +#### nk_input_glyph +Converts an encoded unicode rune into UTF-8 and copies the result into an +internal text buffer. +!!! Note + Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_glyph(struct nk_context *ctx, const nk_glyph g); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__g__ | UTF-32 unicode codepoint +#### nk_input_unicode +Converts a unicode rune into UTF-8 and copies the result +into an internal text buffer. +!!! Note + Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_unicode(struct nk_context*, nk_rune rune); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +__rune__ | UTF-32 unicode codepoint +#### nk_input_end +End the input mirroring process by resetting mouse grabbing +state to ensure the mouse cursor is not grabbed indefinitely. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_input_end(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to a previously initialized `nk_context` struct +### Drawing +This library was designed to be render backend agnostic so it does +not draw anything to screen directly. Instead all drawn shapes, widgets +are made of, are buffered into memory and make up a command queue. +Each frame therefore fills the command buffer with draw commands +that then need to be executed by the user and his own render backend. +After that the command buffer needs to be cleared and a new frame can be +started. It is probably important to note that the command buffer is the main +drawing API and the optional vertex buffer API only takes this format and +converts it into a hardware accessible format. +#### Usage +To draw all draw commands accumulated over a frame you need your own render +backend able to draw a number of 2D primitives. This includes at least +filled and stroked rectangles, circles, text, lines, triangles and scissors. +As soon as this criterion is met you can iterate over each draw command +and execute each draw command in a interpreter like fashion: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_command *cmd = 0; +nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case //...: + //[...] + } +} +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +In program flow context draw commands need to be executed after input has been +gathered and the complete UI with windows and their contained widgets have +been executed and before calling `nk_clear` which frees all previously +allocated draw commands. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + Event evt; + nk_input_begin(&ctx); + while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + [...] + } + } + nk_input_end(&ctx); + // + // [...] + // + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case ...: + // [...] + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +You probably noticed that you have to draw all of the UI each frame which is +quite wasteful. While the actual UI updating loop is quite fast rendering +without actually needing it is not. So there are multiple things you could do. +First is only update on input. This of course is only an option if your +application only depends on the UI and does not require any outside calculations. +If you actually only update on input make sure to update the UI two times each +frame and call `nk_clear` directly after the first pass and only draw in +the second pass. In addition it is recommended to also add additional timers +to make sure the UI is not drawn more than a fixed number of frames per second. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + // [...wait for input ] + // [...do two UI passes ...] + do_ui(...) + nk_clear(&ctx); + do_ui(...) + // + // draw + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case ...: + //[...] + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The second probably more applicable trick is to only draw if anything changed. +It is not really useful for applications with continuous draw loop but +quite useful for desktop applications. To actually get nuklear to only +draw on changes you first have to define `NK_ZERO_COMMAND_MEMORY` and +allocate a memory buffer that will store each unique drawing output. +After each frame you compare the draw command memory inside the library +with your allocated buffer by memcmp. If memcmp detects differences +you have to copy the command buffer into the allocated buffer +and then draw like usual (this example uses fixed memory but you could +use dynamically allocated memory). +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +//[... other defines ...] +#define NK_ZERO_COMMAND_MEMORY +#include "nuklear.h" +// +// setup context +struct nk_context ctx; +void *last = calloc(1,64*1024); +void *buf = calloc(1,64*1024); +nk_init_fixed(&ctx, buf, 64*1024); +// +// loop +while (1) { + // [...input...] + // [...ui...] + void *cmds = nk_buffer_memory(&ctx.memory); + if (memcmp(cmds, last, ctx.memory.allocated)) { + memcpy(last,cmds,ctx.memory.allocated); + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case ...: + // [...] + } + } + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Finally while using draw commands makes sense for higher abstracted platforms like +X11 and Win32 or drawing libraries it is often desirable to use graphics +hardware directly. Therefore it is possible to just define +`NK_INCLUDE_VERTEX_BUFFER_OUTPUT` which includes optional vertex output. +To access the vertex output you first have to convert all draw commands into +vertexes by calling `nk_convert` which takes in your preferred vertex format. +After successfully converting all draw commands just iterate over and execute all +vertex draw commands: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +// fill configuration +struct your_vertex +{ + float pos[2]; // important to keep it to 2 floats + float uv[2]; + unsigned char col[4]; +}; +struct nk_convert_config cfg = {}; +static const struct nk_draw_vertex_layout_element vertex_layout[] = { + {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, pos)}, + {NK_VERTEX_TEXCOORD, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, uv)}, + {NK_VERTEX_COLOR, NK_FORMAT_R8G8B8A8, NK_OFFSETOF(struct your_vertex, col)}, + {NK_VERTEX_LAYOUT_END} +}; +cfg.shape_AA = NK_ANTI_ALIASING_ON; +cfg.line_AA = NK_ANTI_ALIASING_ON; +cfg.vertex_layout = vertex_layout; +cfg.vertex_size = sizeof(struct your_vertex); +cfg.vertex_alignment = NK_ALIGNOF(struct your_vertex); +cfg.circle_segment_count = 22; +cfg.curve_segment_count = 22; +cfg.arc_segment_count = 22; +cfg.global_alpha = 1.0f; +cfg.tex_null = dev->tex_null; +// +// setup buffers and convert +struct nk_buffer cmds, verts, idx; +nk_buffer_init_default(&cmds); +nk_buffer_init_default(&verts); +nk_buffer_init_default(&idx); +nk_convert(&ctx, &cmds, &verts, &idx, &cfg); +// +// draw +nk_draw_foreach(cmd, &ctx, &cmds) { +if (!cmd->elem_count) continue; + //[...] +} +nk_buffer_free(&cms); +nk_buffer_free(&verts); +nk_buffer_free(&idx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +--------------------|------------------------------------------------------- +__nk__begin__ | Returns the first draw command in the context draw command list to be drawn +__nk__next__ | Increments the draw command iterator to the next command inside the context draw command list +__nk_foreach__ | Iterates over each draw command inside the context draw command list +__nk_convert__ | Converts from the abstract draw commands list into a hardware accessible vertex format +__nk_draw_begin__ | Returns the first vertex command in the context vertex draw list to be executed +__nk__draw_next__ | Increments the vertex command iterator to the next command inside the context vertex command list +__nk__draw_end__ | Returns the end of the vertex draw list +__nk_draw_foreach__ | Iterates over each vertex draw command inside the vertex draw list +#### nk__begin +Returns a draw command list iterator to iterate all draw +commands accumulated over one frame. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_command* nk__begin(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | must point to an previously initialized `nk_context` struct at the end of a frame +Returns draw command pointer pointing to the first command inside the draw command list +#### nk__next +Returns draw command pointer pointing to the next command inside the draw command list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_command* nk__next(struct nk_context*, const struct nk_command*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +__cmd__ | Must point to an previously a draw command either returned by `nk__begin` or `nk__next` +Returns draw command pointer pointing to the next command inside the draw command list +#### nk_foreach +Iterates over each draw command inside the context draw command list +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_foreach(c, ctx) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +__cmd__ | Command pointer initialized to NULL +Iterates over each draw command inside the context draw command list +#### nk_convert +Converts all internal draw commands into vertex draw commands and fills +three buffers with vertexes, vertex draw commands and vertex indices. The vertex format +as well as some other configuration values have to be configured by filling out a +`nk_convert_config` struct. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +nk_flags nk_convert(struct nk_context *ctx, struct nk_buffer *cmds, + struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +__cmds__ | Must point to a previously initialized buffer to hold converted vertex draw commands +__vertices__| Must point to a previously initialized buffer to hold all produced vertices +__elements__| Must point to a previously initialized buffer to hold all produced vertex indices +__config__ | Must point to a filled out `nk_config` struct to configure the conversion process +Returns one of enum nk_convert_result error codes +Parameter | Description +--------------------------------|----------------------------------------------------------- +NK_CONVERT_SUCCESS | Signals a successful draw command to vertex buffer conversion +NK_CONVERT_INVALID_PARAM | An invalid argument was passed in the function call +NK_CONVERT_COMMAND_BUFFER_FULL | The provided buffer for storing draw commands is full or failed to allocate more memory +NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory +NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indices is full or failed to allocate more memory +#### nk__draw_begin +Returns a draw vertex command buffer iterator to iterate over the vertex draw command buffer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_draw_command* nk__draw_begin(const struct nk_context*, const struct nk_buffer*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer +Returns vertex draw command pointer pointing to the first command inside the vertex draw command buffer +#### nk__draw_end +Returns the vertex draw command at the end of the vertex draw command buffer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_draw_command* nk__draw_end(const struct nk_context *ctx, const struct nk_buffer *buf); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer +Returns vertex draw command pointer pointing to the end of the last vertex draw command inside the vertex draw command buffer +#### nk__draw_next +Increments the vertex draw command buffer iterator +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*, const struct nk_buffer*, const struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__cmd__ | Must point to an previously either by `nk__draw_begin` or `nk__draw_next` returned vertex draw command +__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +Returns vertex draw command pointer pointing to the end of the last vertex draw command inside the vertex draw command buffer +#### nk_draw_foreach +Iterates over each vertex draw command inside a vertex draw command buffer +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_draw_foreach(cmd,ctx, b) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__cmd__ | `nk_draw_command`iterator set to NULL +__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer +__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame +### Window +Windows are the main persistent state used inside nuklear and are life time +controlled by simply "retouching" (i.e. calling) each window each frame. +All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx` +and `nk_end`. Calling any widgets outside these two functions will result in an +assert in debug or no state change in release mode.

+Each window holds frame persistent state like position, size, flags, state tables, +and some garbage collected internal persistent widget state. Each window +is linked into a window stack list which determines the drawing and overlapping +order. The topmost window thereby is the currently active window.

+To change window position inside the stack occurs either automatically by +user input by being clicked on or programmatically by calling `nk_window_focus`. +Windows by default are visible unless explicitly being defined with flag +`NK_WINDOW_HIDDEN`, the user clicked the close button on windows with flag +`NK_WINDOW_CLOSABLE` or if a window was explicitly hidden by calling +`nk_window_show`. To explicitly close and destroy a window call `nk_window_close`.

+#### Usage +To create and keep a window you have to call one of the two `nk_begin_xxx` +functions to start window declarations and `nk_end` at the end. Furthermore it +is recommended to check the return value of `nk_begin_xxx` and only process +widgets inside the window if the value is not 0. Either way you have to call +`nk_end` at the end of window declarations. Furthermore, do not attempt to +nest `nk_begin_xxx` calls which will hopefully result in an assert or if not +in a segmentation fault. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +if (nk_begin_xxx(...) { + // [... widgets ...] +} +nk_end(ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +In the grand concept window and widget declarations need to occur after input +handling and before drawing to screen. Not doing so can result in higher +latency or at worst invalid behavior. Furthermore make sure that `nk_clear` +is called at the end of the frame. While nuklear's default platform backends +already call `nk_clear` for you if you write your own backend not calling +`nk_clear` can cause asserts or even worse undefined behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + Event evt; + nk_input_begin(&ctx); + while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + nk_input_xxx(...); + } + } + nk_input_end(&ctx); + if (nk_begin_xxx(...) { + //[...] + } + nk_end(ctx); + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case //...: + //[...] + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +------------------------------------|---------------------------------------- +nk_begin | Starts a new window; needs to be called every frame for every window (unless hidden) or otherwise the window gets removed +nk_begin_titled | Extended window start with separated title and identifier to allow multiple windows with same name but not title +nk_end | Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup +nk_window_find | Finds and returns the window with give name +nk_window_get_bounds | Returns a rectangle with screen position and size of the currently processed window. +nk_window_get_position | Returns the position of the currently processed window +nk_window_get_size | Returns the size with width and height of the currently processed window +nk_window_get_width | Returns the width of the currently processed window +nk_window_get_height | Returns the height of the currently processed window +nk_window_get_panel | Returns the underlying panel which contains all processing state of the current window +nk_window_get_content_region | Returns the position and size of the currently visible and non-clipped space inside the currently processed window +nk_window_get_content_region_min | Returns the upper rectangle position of the currently visible and non-clipped space inside the currently processed window +nk_window_get_content_region_max | Returns the upper rectangle position of the currently visible and non-clipped space inside the currently processed window +nk_window_get_content_region_size | Returns the size of the currently visible and non-clipped space inside the currently processed window +nk_window_get_canvas | Returns the draw command buffer. Can be used to draw custom widgets +nk_window_get_scroll | Gets the scroll offset of the current window +nk_window_has_focus | Returns if the currently processed window is currently active +nk_window_is_collapsed | Returns if the window with given name is currently minimized/collapsed +nk_window_is_closed | Returns if the currently processed window was closed +nk_window_is_hidden | Returns if the currently processed window was hidden +nk_window_is_active | Same as nk_window_has_focus for some reason +nk_window_is_hovered | Returns if the currently processed window is currently being hovered by mouse +nk_window_is_any_hovered | Return if any window currently hovered +nk_item_is_any_active | Returns if any window or widgets is currently hovered or active +nk_window_set_bounds | Updates position and size of the currently processed window +nk_window_set_position | Updates position of the currently process window +nk_window_set_size | Updates the size of the currently processed window +nk_window_set_focus | Set the currently processed window as active window +nk_window_set_scroll | Sets the scroll offset of the current window +nk_window_close | Closes the window with given window name which deletes the window at the end of the frame +nk_window_collapse | Collapses the window with given window name +nk_window_collapse_if | Collapses the window with given window name if the given condition was met +nk_window_show | Hides a visible or reshows a hidden window +nk_window_show_if | Hides/shows a window depending on condition +#### nk_panel_flags +Flag | Description +----------------------------|---------------------------------------- +NK_WINDOW_BORDER | Draws a border around the window to visually separate window from the background +NK_WINDOW_MOVABLE | The movable flag indicates that a window can be moved by user input or by dragging the window header +NK_WINDOW_SCALABLE | The scalable flag indicates that a window can be scaled by user input by dragging a scaler icon at the button of the window +NK_WINDOW_CLOSABLE | Adds a closable icon into the header +NK_WINDOW_MINIMIZABLE | Adds a minimize icon into the header +NK_WINDOW_NO_SCROLLBAR | Removes the scrollbar from the window +NK_WINDOW_TITLE | Forces a header at the top at the window showing the title +NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame +NK_WINDOW_BACKGROUND | Always keep window in the background +NK_WINDOW_SCALE_LEFT | Puts window scaler in the left-bottom corner instead right-bottom +NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus +#### nk_collapse_states +State | Description +----------------|----------------------------------------------------------- +__NK_MINIMIZED__| UI section is collased and not visible until maximized +__NK_MAXIMIZED__| UI section is extended and visible until minimized +

+#### nk_begin +Starts a new window; needs to be called every frame for every +window (unless hidden) or otherwise the window gets removed +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__title__ | Window title and identifier. Needs to be persistent over frames to identify the window +__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame +__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors +Returns `true(1)` if the window can be filled up with widgets from this point +until `nk_end` or `false(0)` otherwise for example if minimized +#### nk_begin_titled +Extended window start with separated title and identifier to allow multiple +windows with same title but not name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_begin_titled(struct nk_context *ctx, const char *name, const char *title, struct nk_rect bounds, nk_flags flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Window identifier. Needs to be persistent over frames to identify the window +__title__ | Window title displayed inside header if flag `NK_WINDOW_TITLE` or either `NK_WINDOW_CLOSABLE` or `NK_WINDOW_MINIMIZED` was set +__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame +__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors +Returns `true(1)` if the window can be filled up with widgets from this point +until `nk_end` or `false(0)` otherwise for example if minimized +#### nk_end +Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup. +All widget calls after this functions will result in asserts or no state changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_end(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +#### nk_window_find +Finds and returns a window from passed name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_window *nk_window_find(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Window identifier +Returns a `nk_window` struct pointing to the identified window or NULL if +no window with the given name was found +#### nk_window_get_bounds +Returns a rectangle with screen position and size of the currently processed window +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_window_get_bounds(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns a `nk_rect` struct with window upper left window position and size +#### nk_window_get_position +Returns the position of the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_window_get_position(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns a `nk_vec2` struct with window upper left position +#### nk_window_get_size +Returns the size with width and height of the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_window_get_size(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns a `nk_vec2` struct with window width and height +#### nk_window_get_width +Returns the width of the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +float nk_window_get_width(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns the current window width +#### nk_window_get_height +Returns the height of the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +float nk_window_get_height(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns the current window height +#### nk_window_get_panel +Returns the underlying panel which contains all processing state of the current window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +!!! WARNING + Do not keep the returned panel pointer around, it is only valid until `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_panel* nk_window_get_panel(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns a pointer to window internal `nk_panel` state. +#### nk_window_get_content_region +Returns the position and size of the currently visible and non-clipped space +inside the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_window_get_content_region(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `nk_rect` struct with screen position and size (no scrollbar offset) +of the visible space inside the current window +#### nk_window_get_content_region_min +Returns the upper left position of the currently visible and non-clipped +space inside the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_window_get_content_region_min(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +returns `nk_vec2` struct with upper left screen position (no scrollbar offset) +of the visible space inside the current window +#### nk_window_get_content_region_max +Returns the lower right screen position of the currently visible and +non-clipped space inside the currently processed window. +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_window_get_content_region_max(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `nk_vec2` struct with lower right screen position (no scrollbar offset) +of the visible space inside the current window +#### nk_window_get_content_region_size +Returns the size of the currently visible and non-clipped space inside the +currently processed window +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_window_get_content_region_size(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `nk_vec2` struct with size the visible space inside the current window +#### nk_window_get_canvas +Returns the draw command buffer. Can be used to draw custom widgets +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +!!! WARNING + Do not keep the returned command buffer pointer around it is only valid until `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_command_buffer* nk_window_get_canvas(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns a pointer to window internal `nk_command_buffer` struct used as +drawing canvas. Can be used to do custom drawing. +#### nk_window_get_scroll +Gets the scroll offset for the current window +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_get_scroll(struct nk_context *ctx, nk_uint *offset_x, nk_uint *offset_y); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +-------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__offset_x__ | A pointer to the x offset output (or NULL to ignore) +__offset_y__ | A pointer to the y offset output (or NULL to ignore) +#### nk_window_has_focus +Returns if the currently processed window is currently active +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_has_focus(const struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `false(0)` if current window is not active or `true(1)` if it is +#### nk_window_is_hovered +Return if the current window is being hovered +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_hovered(struct nk_context *ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `true(1)` if current window is hovered or `false(0)` otherwise +#### nk_window_is_collapsed +Returns if the window with given name is currently minimized/collapsed +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_collapsed(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of window you want to check if it is collapsed +Returns `true(1)` if current window is minimized and `false(0)` if window not +found or is not minimized +#### nk_window_is_closed +Returns if the window with given name was closed by calling `nk_close` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_closed(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of window you want to check if it is closed +Returns `true(1)` if current window was closed or `false(0)` window not found or not closed +#### nk_window_is_hidden +Returns if the window with given name is hidden +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_hidden(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of window you want to check if it is hidden +Returns `true(1)` if current window is hidden or `false(0)` window not found or visible +#### nk_window_is_active +Same as nk_window_has_focus for some reason +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_active(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of window you want to check if it is active +Returns `true(1)` if current window is active or `false(0)` window not found or not active +#### nk_window_is_any_hovered +Returns if the any window is being hovered +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_window_is_any_hovered(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `true(1)` if any window is hovered or `false(0)` otherwise +#### nk_item_is_any_active +Returns if the any window is being hovered or any widget is currently active. +Can be used to decide if input should be processed by UI or your specific input handling. +Example could be UI and 3D camera to move inside a 3D space. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_item_is_any_active(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +Returns `true(1)` if any window is hovered or any item is active or `false(0)` otherwise +#### nk_window_set_bounds +Updates position and size of window with passed in name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_set_bounds(struct nk_context*, const char *name, struct nk_rect bounds); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to modify both position and size +__bounds__ | Must point to a `nk_rect` struct with the new position and size +#### nk_window_set_position +Updates position of window with passed name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_set_position(struct nk_context*, const char *name, struct nk_vec2 pos); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to modify both position +__pos__ | Must point to a `nk_vec2` struct with the new position +#### nk_window_set_size +Updates size of window with passed in name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_set_size(struct nk_context*, const char *name, struct nk_vec2); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to modify both window size +__size__ | Must point to a `nk_vec2` struct with new window size +#### nk_window_set_focus +Sets the window with given name as active +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_set_focus(struct nk_context*, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to set focus on +#### nk_window_set_scroll +Sets the scroll offset for the current window +!!! WARNING + Only call this function between calls `nk_begin_xxx` and `nk_end` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_set_scroll(struct nk_context *ctx, nk_uint offset_x, nk_uint offset_y); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +-------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__offset_x__ | The x offset to scroll to +__offset_y__ | The y offset to scroll to +#### nk_window_close +Closes a window and marks it for being freed at the end of the frame +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_close(struct nk_context *ctx, const char *name); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to close +#### nk_window_collapse +Updates collapse state of a window with given name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_collapse(struct nk_context*, const char *name, enum nk_collapse_states state); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to close +__state__ | value out of nk_collapse_states section +#### nk_window_collapse_if +Updates collapse state of a window with given name if given condition is met +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_collapse_if(struct nk_context*, const char *name, enum nk_collapse_states, int cond); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to either collapse or maximize +__state__ | value out of nk_collapse_states section the window should be put into +__cond__ | condition that has to be met to actually commit the collapse state change +#### nk_window_show +updates visibility state of a window with given name +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_show(struct nk_context*, const char *name, enum nk_show_states); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to either collapse or maximize +__state__ | state with either visible or hidden to modify the window with +#### nk_window_show_if +Updates visibility state of a window with given name if a given condition is met +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_window_show_if(struct nk_context*, const char *name, enum nk_show_states, int cond); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__name__ | Identifier of the window to either hide or show +__state__ | state with either visible or hidden to modify the window with +__cond__ | condition that has to be met to actually commit the visbility state change +### Layouting +Layouting in general describes placing widget inside a window with position and size. +While in this particular implementation there are five different APIs for layouting +each with different trade offs between control and ease of use.

+All layouting methods in this library are based around the concept of a row. +A row has a height the window content grows by and a number of columns and each +layouting method specifies how each widget is placed inside the row. +After a row has been allocated by calling a layouting functions and then +filled with widgets will advance an internal pointer over the allocated row.

+To actually define a layout you just call the appropriate layouting function +and each subsequent widget call will place the widget as specified. Important +here is that if you define more widgets then columns defined inside the layout +functions it will allocate the next row without you having to make another layouting

+call. +Biggest limitation with using all these APIs outside the `nk_layout_space_xxx` API +is that you have to define the row height for each. However the row height +often depends on the height of the font.

+To fix that internally nuklear uses a minimum row height that is set to the +height plus padding of currently active font and overwrites the row height +value if zero.

+If you manually want to change the minimum row height then +use nk_layout_set_min_row_height, and use nk_layout_reset_min_row_height to +reset it back to be derived from font height.

+Also if you change the font in nuklear it will automatically change the minimum +row height for you and. This means if you change the font but still want +a minimum row height smaller than the font you have to repush your value.

+For actually more advanced UI I would even recommend using the `nk_layout_space_xxx` +layouting method in combination with a cassowary constraint solver (there are +some versions on github with permissive license model) to take over all control over widget +layouting yourself. However for quick and dirty layouting using all the other layouting +functions should be fine. +#### Usage +1. __nk_layout_row_dynamic__

+ The easiest layouting function is `nk_layout_row_dynamic`. It provides each + widgets with same horizontal space inside the row and dynamically grows + if the owning window grows in width. So the number of columns dictates + the size of each widget dynamically by formula: + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + widget_width = (window_width - padding - spacing) * (1/colum_count) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Just like all other layouting APIs if you define more widget than columns this + library will allocate a new row and keep all layouting parameters previously + defined. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // first row with height: 30 composed of two widgets + nk_layout_row_dynamic(&ctx, 30, 2); + nk_widget(...); + nk_widget(...); + // + // second row with same parameter as defined above + nk_widget(...); + nk_widget(...); + // + // third row uses 0 for height which will use auto layouting + nk_layout_row_dynamic(&ctx, 0, 2); + nk_widget(...); + nk_widget(...); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +2. __nk_layout_row_static__

+ Another easy layouting function is `nk_layout_row_static`. It provides each + widget with same horizontal pixel width inside the row and does not grow + if the owning window scales smaller or bigger. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // first row with height: 30 composed of two widgets with width: 80 + nk_layout_row_static(&ctx, 30, 80, 2); + nk_widget(...); + nk_widget(...); + // + // second row with same parameter as defined above + nk_widget(...); + nk_widget(...); + // + // third row uses 0 for height which will use auto layouting + nk_layout_row_static(&ctx, 0, 80, 2); + nk_widget(...); + nk_widget(...); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +3. __nk_layout_row_xxx__

+ A little bit more advanced layouting API are functions `nk_layout_row_begin`, + `nk_layout_row_push` and `nk_layout_row_end`. They allow to directly + specify each column pixel or window ratio in a row. It supports either + directly setting per column pixel width or widget window ratio but not + both. Furthermore it is a immediate mode API so each value is directly + pushed before calling a widget. Therefore the layout is not automatically + repeating like the last two layouting functions. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // first row with height: 25 composed of two widgets with width 60 and 40 + nk_layout_row_begin(ctx, NK_STATIC, 25, 2); + nk_layout_row_push(ctx, 60); + nk_widget(...); + nk_layout_row_push(ctx, 40); + nk_widget(...); + nk_layout_row_end(ctx); + // + // second row with height: 25 composed of two widgets with window ratio 0.25 and 0.75 + nk_layout_row_begin(ctx, NK_DYNAMIC, 25, 2); + nk_layout_row_push(ctx, 0.25f); + nk_widget(...); + nk_layout_row_push(ctx, 0.75f); + nk_widget(...); + nk_layout_row_end(ctx); + // + // third row with auto generated height: composed of two widgets with window ratio 0.25 and 0.75 + nk_layout_row_begin(ctx, NK_DYNAMIC, 0, 2); + nk_layout_row_push(ctx, 0.25f); + nk_widget(...); + nk_layout_row_push(ctx, 0.75f); + nk_widget(...); + nk_layout_row_end(ctx); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +4. __nk_layout_row__

+ The array counterpart to API nk_layout_row_xxx is the single nk_layout_row + functions. Instead of pushing either pixel or window ratio for every widget + it allows to define it by array. The trade of for less control is that + `nk_layout_row` is automatically repeating. Otherwise the behavior is the + same. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // two rows with height: 30 composed of two widgets with width 60 and 40 + const float size[] = {60,40}; + nk_layout_row(ctx, NK_STATIC, 30, 2, ratio); + nk_widget(...); + nk_widget(...); + nk_widget(...); + nk_widget(...); + // + // two rows with height: 30 composed of two widgets with window ratio 0.25 and 0.75 + const float ratio[] = {0.25, 0.75}; + nk_layout_row(ctx, NK_DYNAMIC, 30, 2, ratio); + nk_widget(...); + nk_widget(...); + nk_widget(...); + nk_widget(...); + // + // two rows with auto generated height composed of two widgets with window ratio 0.25 and 0.75 + const float ratio[] = {0.25, 0.75}; + nk_layout_row(ctx, NK_DYNAMIC, 30, 2, ratio); + nk_widget(...); + nk_widget(...); + nk_widget(...); + nk_widget(...); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +5. __nk_layout_row_template_xxx__

+ The most complex and second most flexible API is a simplified flexbox version without + line wrapping and weights for dynamic widgets. It is an immediate mode API but + unlike `nk_layout_row_xxx` it has auto repeat behavior and needs to be called + before calling the templated widgets. + The row template layout has three different per widget size specifier. The first + one is the `nk_layout_row_template_push_static` with fixed widget pixel width. + They do not grow if the row grows and will always stay the same. + The second size specifier is `nk_layout_row_template_push_variable` + which defines a minimum widget size but it also can grow if more space is available + not taken by other widgets. + Finally there are dynamic widgets with `nk_layout_row_template_push_dynamic` + which are completely flexible and unlike variable widgets can even shrink + to zero if not enough space is provided. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // two rows with height: 30 composed of three widgets + nk_layout_row_template_begin(ctx, 30); + nk_layout_row_template_push_dynamic(ctx); + nk_layout_row_template_push_variable(ctx, 80); + nk_layout_row_template_push_static(ctx, 80); + nk_layout_row_template_end(ctx); + // + // first row + nk_widget(...); // dynamic widget can go to zero if not enough space + nk_widget(...); // variable widget with min 80 pixel but can grow bigger if enough space + nk_widget(...); // static widget with fixed 80 pixel width + // + // second row same layout + nk_widget(...); + nk_widget(...); + nk_widget(...); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +6. __nk_layout_space_xxx__

+ Finally the most flexible API directly allows you to place widgets inside the + window. The space layout API is an immediate mode API which does not support + row auto repeat and directly sets position and size of a widget. Position + and size hereby can be either specified as ratio of allocated space or + allocated space local position and pixel size. Since this API is quite + powerful there are a number of utility functions to get the available space + and convert between local allocated space and screen space. + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c + if (nk_begin_xxx(...) { + // static row with height: 500 (you can set column count to INT_MAX if you don't want to be bothered) + nk_layout_space_begin(ctx, NK_STATIC, 500, INT_MAX); + nk_layout_space_push(ctx, nk_rect(0,0,150,200)); + nk_widget(...); + nk_layout_space_push(ctx, nk_rect(200,200,100,200)); + nk_widget(...); + nk_layout_space_end(ctx); + // + // dynamic row with height: 500 (you can set column count to INT_MAX if you don't want to be bothered) + nk_layout_space_begin(ctx, NK_DYNAMIC, 500, INT_MAX); + nk_layout_space_push(ctx, nk_rect(0.5,0.5,0.1,0.1)); + nk_widget(...); + nk_layout_space_push(ctx, nk_rect(0.7,0.6,0.1,0.1)); + nk_widget(...); + } + nk_end(...); + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +----------------------------------------|------------------------------------ +nk_layout_set_min_row_height | Set the currently used minimum row height to a specified value +nk_layout_reset_min_row_height | Resets the currently used minimum row height to font height +nk_layout_widget_bounds | Calculates current width a static layout row can fit inside a window +nk_layout_ratio_from_pixel | Utility functions to calculate window ratio from pixel size +nk_layout_row_dynamic | Current layout is divided into n same sized growing columns +nk_layout_row_static | Current layout is divided into n same fixed sized columns +nk_layout_row_begin | Starts a new row with given height and number of columns +nk_layout_row_push | Pushes another column with given size or window ratio +nk_layout_row_end | Finished previously started row +nk_layout_row | Specifies row columns in array as either window ratio or size +nk_layout_row_template_begin | Begins the row template declaration +nk_layout_row_template_push_dynamic | Adds a dynamic column that dynamically grows and can go to zero if not enough space +nk_layout_row_template_push_variable | Adds a variable column that dynamically grows but does not shrink below specified pixel width +nk_layout_row_template_push_static | Adds a static column that does not grow and will always have the same size +nk_layout_row_template_end | Marks the end of the row template +nk_layout_space_begin | Begins a new layouting space that allows to specify each widgets position and size +nk_layout_space_push | Pushes position and size of the next widget in own coordinate space either as pixel or ratio +nk_layout_space_end | Marks the end of the layouting space +nk_layout_space_bounds | Callable after nk_layout_space_begin and returns total space allocated +nk_layout_space_to_screen | Converts vector from nk_layout_space coordinate space into screen space +nk_layout_space_to_local | Converts vector from screen space into nk_layout_space coordinates +nk_layout_space_rect_to_screen | Converts rectangle from nk_layout_space coordinate space into screen space +nk_layout_space_rect_to_local | Converts rectangle from screen space into nk_layout_space coordinates +#### nk_layout_set_min_row_height +Sets the currently used minimum row height. +!!! WARNING + The passed height needs to include both your preferred row height + as well as padding. No internal padding is added. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_set_min_row_height(struct nk_context*, float height); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__height__ | New minimum row height to be used for auto generating the row height +#### nk_layout_reset_min_row_height +Reset the currently used minimum row height back to `font_height + text_padding + padding` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_reset_min_row_height(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +#### nk_layout_widget_bounds +Returns the width of the next row allocate by one of the layouting functions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_layout_widget_bounds(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +Return `nk_rect` with both position and size of the next row +#### nk_layout_ratio_from_pixel +Utility functions to calculate window ratio from pixel size +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +float nk_layout_ratio_from_pixel(struct nk_context*, float pixel_width); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__pixel__ | Pixel_width to convert to window ratio +Returns `nk_rect` with both position and size of the next row +#### nk_layout_row_dynamic +Sets current row layout to share horizontal space +between @cols number of widgets evenly. Once called all subsequent widget +calls greater than @cols will allocate a new row with same layout. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__height__ | Holds height of each widget in row or zero for auto layouting +__columns__ | Number of widget inside row +#### nk_layout_row_static +Sets current row layout to fill @cols number of widgets +in row with same @item_width horizontal size. Once called all subsequent widget +calls greater than @cols will allocate a new row with same layout. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_static(struct nk_context *ctx, float height, int item_width, int cols); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__height__ | Holds height of each widget in row or zero for auto layouting +__width__ | Holds pixel width of each widget in the row +__columns__ | Number of widget inside row +#### nk_layout_row_begin +Starts a new dynamic or fixed row with given height and columns. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_begin(struct nk_context *ctx, enum nk_layout_format fmt, float row_height, int cols); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__fmt__ | either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns +__height__ | holds height of each widget in row or zero for auto layouting +__columns__ | Number of widget inside row +#### nk_layout_row_push +Specifies either window ratio or width of a single column +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_push(struct nk_context*, float value); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__value__ | either a window ratio or fixed width depending on @fmt in previous `nk_layout_row_begin` call +#### nk_layout_row_end +Finished previously started row +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_end(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +#### nk_layout_row +Specifies row columns in array as either window ratio or size +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row(struct nk_context*, enum nk_layout_format, float height, int cols, const float *ratio); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__fmt__ | Either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns +__height__ | Holds height of each widget in row or zero for auto layouting +__columns__ | Number of widget inside row +#### nk_layout_row_template_begin +Begins the row template declaration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_template_begin(struct nk_context*, float row_height); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__height__ | Holds height of each widget in row or zero for auto layouting +#### nk_layout_row_template_push_dynamic +Adds a dynamic column that dynamically grows and can go to zero if not enough space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_template_push_dynamic(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__height__ | Holds height of each widget in row or zero for auto layouting +#### nk_layout_row_template_push_variable +Adds a variable column that dynamically grows but does not shrink below specified pixel width +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_template_push_variable(struct nk_context*, float min_width); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__width__ | Holds the minimum pixel width the next column must always be +#### nk_layout_row_template_push_static +Adds a static column that does not grow and will always have the same size +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_template_push_static(struct nk_context*, float width); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__width__ | Holds the absolute pixel width value the next column must be +#### nk_layout_row_template_end +Marks the end of the row template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_row_template_end(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +#### nk_layout_space_begin +Begins a new layouting space that allows to specify each widgets position and size. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_space_begin(struct nk_context*, enum nk_layout_format, float height, int widget_count); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` +__fmt__ | Either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns +__height__ | Holds height of each widget in row or zero for auto layouting +__columns__ | Number of widgets inside row +#### nk_layout_space_push +Pushes position and size of the next widget in own coordinate space either as pixel or ratio +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_space_push(struct nk_context *ctx, struct nk_rect bounds); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +__bounds__ | Position and size in laoyut space local coordinates +#### nk_layout_space_end +Marks the end of the layout space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_layout_space_end(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +#### nk_layout_space_bounds +Utility function to calculate total space allocated for `nk_layout_space` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_layout_space_bounds(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +Returns `nk_rect` holding the total space allocated +#### nk_layout_space_to_screen +Converts vector from nk_layout_space coordinate space into screen space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +__vec__ | Position to convert from layout space into screen coordinate space +Returns transformed `nk_vec2` in screen space coordinates +#### nk_layout_space_to_local +Converts vector from layout space into screen space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_vec2 nk_layout_space_to_local(struct nk_context*, struct nk_vec2); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +__vec__ | Position to convert from screen space into layout coordinate space +Returns transformed `nk_vec2` in layout space coordinates +#### nk_layout_space_rect_to_screen +Converts rectangle from screen space into layout space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_layout_space_rect_to_screen(struct nk_context*, struct nk_rect); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +__bounds__ | Rectangle to convert from layout space into screen space +Returns transformed `nk_rect` in screen space coordinates +#### nk_layout_space_rect_to_local +Converts rectangle from layout space into screen space +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_rect nk_layout_space_rect_to_local(struct nk_context*, struct nk_rect); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` +__bounds__ | Rectangle to convert from layout space into screen space +Returns transformed `nk_rect` in layout space coordinates +### Groups +Groups are basically windows inside windows. They allow to subdivide space +in a window to layout widgets as a group. Almost all more complex widget +layouting requirements can be solved using groups and basic layouting +fuctionality. Groups just like windows are identified by an unique name and +internally keep track of scrollbar offsets by default. However additional +versions are provided to directly manage the scrollbar. +#### Usage +To create a group you have to call one of the three `nk_group_begin_xxx` +functions to start group declarations and `nk_group_end` at the end. Furthermore it +is required to check the return value of `nk_group_begin_xxx` and only process +widgets inside the window if the value is not 0. +Nesting groups is possible and even encouraged since many layouting schemes +can only be achieved by nesting. Groups, unlike windows, need `nk_group_end` +to be only called if the corresponding `nk_group_begin_xxx` call does not return 0: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +if (nk_group_begin_xxx(ctx, ...) { + // [... widgets ...] + nk_group_end(ctx); +} +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +In the grand concept groups can be called after starting a window +with `nk_begin_xxx` and before calling `nk_end`: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + // Input + Event evt; + nk_input_begin(&ctx); + while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + nk_input_xxx(...); + } + } + nk_input_end(&ctx); + // + // Window + if (nk_begin_xxx(...) { + // [...widgets...] + nk_layout_row_dynamic(...); + if (nk_group_begin_xxx(ctx, ...) { + //[... widgets ...] + nk_group_end(ctx); + } + } + nk_end(ctx); + // + // Draw + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case ...: + // [...] + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +--------------------------------|------------------------------------------- +nk_group_begin | Start a new group with internal scrollbar handling +nk_group_begin_titled | Start a new group with separated name and title and internal scrollbar handling +nk_group_end | Ends a group. Should only be called if nk_group_begin returned non-zero +nk_group_scrolled_offset_begin | Start a new group with manual separated handling of scrollbar x- and y-offset +nk_group_scrolled_begin | Start a new group with manual scrollbar handling +nk_group_scrolled_end | Ends a group with manual scrollbar handling. Should only be called if nk_group_begin returned non-zero +nk_group_get_scroll | Gets the scroll offset for the given group +nk_group_set_scroll | Sets the scroll offset for the given group +#### nk_group_begin +Starts a new widget group. Requires a previous layouting function to specify a pos/size. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_group_begin(struct nk_context*, const char *title, nk_flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__title__ | Must be an unique identifier for this group that is also used for the group header +__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_group_begin_titled +Starts a new widget group. Requires a previous layouting function to specify a pos/size. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_group_begin_titled(struct nk_context*, const char *name, const char *title, nk_flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__id__ | Must be an unique identifier for this group +__title__ | Group header title +__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_group_end +Ends a widget group +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_group_end(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +#### nk_group_scrolled_offset_begin +starts a new widget group. requires a previous layouting function to specify +a size. Does not keep track of scrollbar. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_group_scrolled_offset_begin(struct nk_context*, nk_uint *x_offset, nk_uint *y_offset, const char *title, nk_flags flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__x_offset__| Scrollbar x-offset to offset all widgets inside the group horizontally. +__y_offset__| Scrollbar y-offset to offset all widgets inside the group vertically +__title__ | Window unique group title used to both identify and display in the group header +__flags__ | Window flags from the nk_panel_flags section +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_group_scrolled_begin +Starts a new widget group. requires a previous +layouting function to specify a size. Does not keep track of scrollbar. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_group_scrolled_begin(struct nk_context*, struct nk_scroll *off, const char *title, nk_flags); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__off__ | Both x- and y- scroll offset. Allows for manual scrollbar control +__title__ | Window unique group title used to both identify and display in the group header +__flags__ | Window flags from nk_panel_flags section +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_group_scrolled_end +Ends a widget group after calling nk_group_scrolled_offset_begin or nk_group_scrolled_begin. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_group_scrolled_end(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +#### nk_group_get_scroll +Gets the scroll position of the given group. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_group_get_scroll(struct nk_context*, const char *id, nk_uint *x_offset, nk_uint *y_offset); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +-------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__id__ | The id of the group to get the scroll position of +__x_offset__ | A pointer to the x offset output (or NULL to ignore) +__y_offset__ | A pointer to the y offset output (or NULL to ignore) +#### nk_group_set_scroll +Sets the scroll position of the given group. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_offset, nk_uint y_offset); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +-------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__id__ | The id of the group to scroll +__x_offset__ | The x offset to scroll to +__y_offset__ | The y offset to scroll to +### Tree +Trees represent two different concept. First the concept of a collapsible +UI section that can be either in a hidden or visible state. They allow the UI +user to selectively minimize the current set of visible UI to comprehend. +The second concept are tree widgets for visual UI representation of trees.

+Trees thereby can be nested for tree representations and multiple nested +collapsible UI sections. All trees are started by calling of the +`nk_tree_xxx_push_tree` functions and ended by calling one of the +`nk_tree_xxx_pop_xxx()` functions. Each starting functions takes a title label +and optionally an image to be displayed and the initial collapse state from +the nk_collapse_states section.

+The runtime state of the tree is either stored outside the library by the caller +or inside which requires a unique ID. The unique ID can either be generated +automatically from `__FILE__` and `__LINE__` with function `nk_tree_push`, +by `__FILE__` and a user provided ID generated for example by loop index with +function `nk_tree_push_id` or completely provided from outside by user with +function `nk_tree_push_hashed`. +#### Usage +To create a tree you have to call one of the seven `nk_tree_xxx_push_xxx` +functions to start a collapsible UI section and `nk_tree_xxx_pop` to mark the +end. +Each starting function will either return `false(0)` if the tree is collapsed +or hidden and therefore does not need to be filled with content or `true(1)` +if visible and required to be filled. +!!! Note + The tree header does not require and layouting function and instead + calculates a auto height based on the currently used font size +The tree ending functions only need to be called if the tree content is +actually visible. So make sure the tree push function is guarded by `if` +and the pop call is only taken if the tree is visible. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +if (nk_tree_push(ctx, NK_TREE_TAB, "Tree", NK_MINIMIZED)) { + nk_layout_row_dynamic(...); + nk_widget(...); + nk_tree_pop(ctx); +} +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +----------------------------|------------------------------------------- +nk_tree_push | Start a collapsible UI section with internal state management +nk_tree_push_id | Start a collapsible UI section with internal state management callable in a look +nk_tree_push_hashed | Start a collapsible UI section with internal state management with full control over internal unique ID use to store state +nk_tree_image_push | Start a collapsible UI section with image and label header +nk_tree_image_push_id | Start a collapsible UI section with image and label header and internal state management callable in a look +nk_tree_image_push_hashed | Start a collapsible UI section with image and label header and internal state management with full control over internal unique ID use to store state +nk_tree_pop | Ends a collapsible UI section +nk_tree_state_push | Start a collapsible UI section with external state management +nk_tree_state_image_push | Start a collapsible UI section with image and label header and external state management +nk_tree_state_pop | Ends a collapsabale UI section +#### nk_tree_type +Flag | Description +----------------|---------------------------------------- +NK_TREE_NODE | Highlighted tree header to mark a collapsible UI section +NK_TREE_TAB | Non-highlighted tree header closer to tree representations +#### nk_tree_push +Starts a collapsible UI section with internal state management +!!! WARNING + To keep track of the runtime tree collapsible state this function uses + defines `__FILE__` and `__LINE__` to generate a unique ID. If you want + to call this function in a loop please use `nk_tree_push_id` or + `nk_tree_push_hashed` instead. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_tree_push(ctx, type, title, state) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_push_id +Starts a collapsible UI section with internal state management callable in a look +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_tree_push_id(ctx, type, title, state, id) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +__id__ | Loop counter index if this function is called in a loop +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_push_hashed +Start a collapsible UI section with internal state management with full +control over internal unique ID used to store state +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +__hash__ | Memory block or string to generate the ID from +__len__ | Size of passed memory block or string in __hash__ +__seed__ | Seeding value if this function is called in a loop or default to `0` +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_image_push +Start a collapsible UI section with image and label header +!!! WARNING + To keep track of the runtime tree collapsible state this function uses + defines `__FILE__` and `__LINE__` to generate a unique ID. If you want + to call this function in a loop please use `nk_tree_image_push_id` or + `nk_tree_image_push_hashed` instead. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_tree_image_push(ctx, type, img, title, state) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__img__ | Image to display inside the header on the left of the label +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_image_push_id +Start a collapsible UI section with image and label header and internal state +management callable in a look +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +#define nk_tree_image_push_id(ctx, type, img, title, state, id) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__img__ | Image to display inside the header on the left of the label +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +__id__ | Loop counter index if this function is called in a loop +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_image_push_hashed +Start a collapsible UI section with internal state management with full +control over internal unique ID used to store state +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__img__ | Image to display inside the header on the left of the label +__title__ | Label printed in the tree header +__state__ | Initial tree state value out of nk_collapse_states +__hash__ | Memory block or string to generate the ID from +__len__ | Size of passed memory block or string in __hash__ +__seed__ | Seeding value if this function is called in a loop or default to `0` +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_pop +Ends a collapsabale UI section +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_tree_pop(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` +#### nk_tree_state_push +Start a collapsible UI section with external state management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__title__ | Label printed in the tree header +__state__ | Persistent state to update +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_state_image_push +Start a collapsible UI section with image and label header and external state management +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_tree_state_image_push(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states *state); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` +__img__ | Image to display inside the header on the left of the label +__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node +__title__ | Label printed in the tree header +__state__ | Persistent state to update +Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise +#### nk_tree_state_pop +Ends a collapsabale UI section +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_tree_state_pop(struct nk_context*); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` +### Properties +Properties are the main value modification widgets in Nuklear. Changing a value +can be achieved by dragging, adding/removing incremental steps on button click +or by directly typing a number. +#### Usage +Each property requires a unique name for identification that is also used for +displaying a label. If you want to use the same name multiple times make sure +add a '#' before your name. The '#' will not be shown but will generate a +unique ID. Each property also takes in a minimum and maximum value. If you want +to make use of the complete number range of a type just use the provided +type limits from `limits.h`. For example `INT_MIN` and `INT_MAX` for +`nk_property_int` and `nk_propertyi`. In additional each property takes in +a increment value that will be added or subtracted if either the increment +decrement button is clicked. Finally there is a value for increment per pixel +dragged that is added or subtracted from the value. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int value = 0; +struct nk_context ctx; +nk_init_xxx(&ctx, ...); +while (1) { + // Input + Event evt; + nk_input_begin(&ctx); + while (GetEvent(&evt)) { + if (evt.type == MOUSE_MOVE) + nk_input_motion(&ctx, evt.motion.x, evt.motion.y); + else if (evt.type == [...]) { + nk_input_xxx(...); + } + } + nk_input_end(&ctx); + // + // Window + if (nk_begin_xxx(...) { + // Property + nk_layout_row_dynamic(...); + nk_property_int(ctx, "ID", INT_MIN, &value, INT_MAX, 1, 1); + } + nk_end(ctx); + // + // Draw + const struct nk_command *cmd = 0; + nk_foreach(cmd, &ctx) { + switch (cmd->type) { + case NK_COMMAND_LINE: + your_draw_line_function(...) + break; + case NK_COMMAND_RECT + your_draw_rect_function(...) + break; + case ...: + // [...] + } + nk_clear(&ctx); +} +nk_free(&ctx); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#### Reference +Function | Description +--------------------|------------------------------------------- +nk_property_int | Integer property directly modifying a passed in value +nk_property_float | Float property directly modifying a passed in value +nk_property_double | Double property directly modifying a passed in value +nk_propertyi | Integer property returning the modified int value +nk_propertyf | Float property returning the modified float value +nk_propertyd | Double property returning the modified double value +#### nk_property_int +Integer property directly modifying a passed in value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_property_int(struct nk_context *ctx, const char *name, int min, int *val, int max, int step, float inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Integer pointer to be modified +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +#### nk_property_float +Float property directly modifying a passed in value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_property_float(struct nk_context *ctx, const char *name, float min, float *val, float max, float step, float inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Float pointer to be modified +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +#### nk_property_double +Double property directly modifying a passed in value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +void nk_property_double(struct nk_context *ctx, const char *name, double min, double *val, double max, double step, double inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Double pointer to be modified +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +#### nk_propertyi +Integer property modifying a passed in value and returning the new value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +int nk_propertyi(struct nk_context *ctx, const char *name, int min, int val, int max, int step, float inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Current integer value to be modified and returned +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +Returns the new modified integer value +#### nk_propertyf +Float property modifying a passed in value and returning the new value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +float nk_propertyf(struct nk_context *ctx, const char *name, float min, float val, float max, float step, float inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Current float value to be modified and returned +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +Returns the new modified float value +#### nk_propertyd +Float property modifying a passed in value and returning the new value +!!! WARNING + To generate a unique property ID using the same label make sure to insert + a `#` at the beginning. It will not be shown but guarantees correct behavior. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c +float nk_propertyd(struct nk_context *ctx, const char *name, double min, double val, double max, double step, double inc_per_pixel); +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Parameter | Description +--------------------|----------------------------------------------------------- +__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function +__name__ | String used both as a label as well as a unique identifier +__min__ | Minimum value not allowed to be underflown +__val__ | Current double value to be modified and returned +__max__ | Maximum value not allowed to be overflown +__step__ | Increment added and subtracted on increment and decrement button +__inc_per_pixel__ | Value per pixel added or subtracted on dragging +Returns the new modified double value + -XXX.XXX- X...X - X...X -X....X - X....X" +X...XXXXXXXXXXXXX...X - " +## License +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none + ------------------------------------------------------------------------------ + This software is available under 2 licenses -- choose whichever you prefer. + ------------------------------------------------------------------------------ + ALTERNATIVE A - MIT License + Copyright (c) 2016-2018 Micha Mettke + Permission is hereby granted, free of charge, to any person obtaining a copy of + this software and associated documentation files (the "Software"), to deal in + the Software without restriction, including without limitation the rights to + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies + of the Software, and to permit persons to whom the Software is furnished to do + so, subject to the following conditions: + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + ------------------------------------------------------------------------------ + ALTERNATIVE B - Public Domain (www.unlicense.org) + This is free and unencumbered software released into the public domain. + Anyone is free to copy, modify, publish, use, compile, sell, or distribute this + software, either in source code form or as a compiled binary, for any purpose, + commercial or non-commercial, and by any means. + In jurisdictions that recognize copyright laws, the author or authors of this + software dedicate any and all copyright interest in the software to the public + domain. We make this dedication for the benefit of the public at large and to + the detriment of our heirs and successors. We intend this dedication to be an + overt act of relinquishment in perpetuity of all present and future rights to + this software under copyright law. + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION + WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + ------------------------------------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +## Changelog +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none +[date][x.yy.zz]-[description] +-[date]: date on which the change has been pushed +-[x.yy.zz]: Numerical version string representation. Each version number on the right + resets back to zero if version on the left is incremented. + - [x]: Major version with API and library breaking changes + - [yy]: Minor version with non-breaking API and library changes + - [zz]: Bug fix version with no direct changes to API +- 2020/04/09 (4.02.1) - Removed unused nk_sqrt function to fix compiler warnings + - Fixed compiler warnings if you bring your own methods for + nk_cos/nk_sin/nk_strtod/nk_memset/nk_memcopy/nk_dtoa +- 2020/04/06 (4.01.10) - Fix bug: Do not use pool before checking for NULL +- 2020/03/22 (4.01.9) - Fix bug where layout state wasn't restored correctly after + popping a tree. +- 2020/03/11 (4.01.8) - Fix bug where padding is subtracted from widget +- 2020/03/06 (4.01.7) - Fix bug where width padding was applied twice +- 2020/02/06 (4.01.6) - Update stb_truetype.h and stb_rect_pack.h and separate them +- 2019/12/10 (4.01.5) - Fix off-by-one error in NK_INTERSECT +- 2019/10/09 (4.01.4) - Fix bug for autoscrolling in nk_do_edit +- 2019/09/20 (4.01.3) - Fixed a bug wherein combobox cannot be closed by clicking the header + when NK_BUTTON_TRIGGER_ON_RELEASE is defined. +- 2019/09/10 (4.01.2) - Fixed the nk_cos function, which deviated significantly. +- 2019/09/08 (4.01.1) - Fixed a bug wherein re-baking of fonts caused a segmentation + fault due to dst_font->glyph_count not being zeroed on subsequent + bakes of the same set of fonts. +- 2019/06/23 (4.01.0) - Added nk_***_get_scroll and nk_***_set_scroll for groups, windows, and popups. +- 2019/06/12 (4.00.3) - Fix panel background drawing bug. +- 2018/10/31 (4.00.2) - Added NK_KEYSTATE_BASED_INPUT to "fix" state based backends + like GLFW without breaking key repeat behavior on event based. +- 2018/04/01 (4.00.1) - Fixed calling `nk_convert` multiple time per single frame. +- 2018/04/01 (4.00.0) - BREAKING CHANGE: nk_draw_list_clear no longer tries to + clear provided buffers. So make sure to either free + or clear each passed buffer after calling nk_convert. +- 2018/02/23 (3.00.6) - Fixed slider dragging behavior. +- 2018/01/31 (3.00.5) - Fixed overcalculation of cursor data in font baking process. +- 2018/01/31 (3.00.4) - Removed name collision with stb_truetype. +- 2018/01/28 (3.00.3) - Fixed panel window border drawing bug. +- 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separated group identifier and title. +- 2018/01/07 (3.00.1) - Started to change documentation style. +- 2018/01/05 (3.00.0) - BREAKING CHANGE: The previous color picker API was broken + because of conversions between float and byte color representation. + Color pickers now use floating point values to represent + HSV values. To get back the old behavior I added some additional + color conversion functions to cast between nk_color and + nk_colorf. +- 2017/12/23 (2.00.7) - Fixed small warning. +- 2017/12/23 (2.00.7) - Fixed `nk_edit_buffer` behavior if activated to allow input. +- 2017/12/23 (2.00.7) - Fixed modifyable progressbar dragging visuals and input behavior. +- 2017/12/04 (2.00.6) - Added formatted string tooltip widget. +- 2017/11/18 (2.00.5) - Fixed window becoming hidden with flag `NK_WINDOW_NO_INPUT`. +- 2017/11/15 (2.00.4) - Fixed font merging. +- 2017/11/07 (2.00.3) - Fixed window size and position modifier functions. +- 2017/09/14 (2.00.2) - Fixed `nk_edit_buffer` and `nk_edit_focus` behavior. +- 2017/09/14 (2.00.1) - Fixed window closing behavior. +- 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifying window position and size functions now + require the name of the window and must happen outside the window + building process (between function call nk_begin and nk_end). +- 2017/09/11 (1.40.9) - Fixed window background flag if background window is declared last. +- 2017/08/27 (1.40.8) - Fixed `nk_item_is_any_active` for hidden windows. +- 2017/08/27 (1.40.7) - Fixed window background flag. +- 2017/07/07 (1.40.6) - Fixed missing clipping rect check for hovering/clicked + query for widgets. +- 2017/07/07 (1.40.5) - Fixed drawing bug for vertex output for lines and stroked + and filled rectangles. +- 2017/07/07 (1.40.4) - Fixed bug in nk_convert trying to add windows that are in + process of being destroyed. +- 2017/07/07 (1.40.3) - Fixed table internal bug caused by storing table size in + window instead of directly in table. +- 2017/06/30 (1.40.2) - Removed unneeded semicolon in C++ NK_ALIGNOF macro. +- 2017/06/30 (1.40.1) - Fixed drawing lines smaller or equal zero. +- 2017/06/08 (1.40.0) - Removed the breaking part of last commit. Auto layout now only + comes in effect if you pass in zero was row height argument. +- 2017/06/08 (1.40.0) - BREAKING CHANGE: while not directly API breaking it will change + how layouting works. From now there will be an internal minimum + row height derived from font height. If you need a row smaller than + that you can directly set it by `nk_layout_set_min_row_height` and + reset the value back by calling `nk_layout_reset_min_row_height. +- 2017/06/08 (1.39.1) - Fixed property text edit handling bug caused by past `nk_widget` fix. +- 2017/06/08 (1.39.0) - Added function to retrieve window space without calling a `nk_layout_xxx` function. +- 2017/06/06 (1.38.5) - Fixed `nk_convert` return flag for command buffer. +- 2017/05/23 (1.38.4) - Fixed activation behavior for widgets partially clipped. +- 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundaries. +- 2017/05/09 (1.38.2) - Fixed vertical scrollbar drawing with not enough space. +- 2017/05/09 (1.38.1) - Fixed scaler dragging behavior if window size hits minimum size. +- 2017/05/06 (1.38.0) - Added platform double-click support. +- 2017/04/20 (1.37.1) - Fixed key repeat found inside glfw demo backends. +- 2017/04/20 (1.37.0) - Extended properties with selection and clipboard support. +- 2017/04/20 (1.36.2) - Fixed #405 overlapping rows with zero padding and spacing. +- 2017/04/09 (1.36.1) - Fixed #403 with another widget float error. +- 2017/04/09 (1.36.0) - Added window `NK_WINDOW_NO_INPUT` and `NK_WINDOW_NOT_INTERACTIVE` flags. +- 2017/04/09 (1.35.3) - Fixed buffer heap corruption. +- 2017/03/25 (1.35.2) - Fixed popup overlapping for `NK_WINDOW_BACKGROUND` windows. +- 2017/03/25 (1.35.1) - Fixed windows closing behavior. +- 2017/03/18 (1.35.0) - Added horizontal scroll requested in #377. +- 2017/03/18 (1.34.3) - Fixed long window header titles. +- 2017/03/04 (1.34.2) - Fixed text edit filtering. +- 2017/03/04 (1.34.1) - Fixed group closable flag. +- 2017/02/25 (1.34.0) - Added custom draw command for better language binding support. +- 2017/01/24 (1.33.0) - Added programmatic way to remove edit focus. +- 2017/01/24 (1.32.3) - Fixed wrong define for basic type definitions for windows. +- 2017/01/21 (1.32.2) - Fixed input capture from hidden or closed windows. +- 2017/01/21 (1.32.1) - Fixed slider behavior and drawing. +- 2017/01/13 (1.32.0) - Added flag to put scaler into the bottom left corner. +- 2017/01/13 (1.31.0) - Added additional row layouting method to combine both + dynamic and static widgets. +- 2016/12/31 (1.30.0) - Extended scrollbar offset from 16-bit to 32-bit. +- 2016/12/31 (1.29.2) - Fixed closing window bug of minimized windows. +- 2016/12/03 (1.29.1) - Fixed wrapped text with no seperator and C89 error. +- 2016/12/03 (1.29.0) - Changed text wrapping to process words not characters. +- 2016/11/22 (1.28.6) - Fixed window minimized closing bug. +- 2016/11/19 (1.28.5) - Fixed abstract combo box closing behavior. +- 2016/11/19 (1.28.4) - Fixed tooltip flickering. +- 2016/11/19 (1.28.3) - Fixed memory leak caused by popup repeated closing. +- 2016/11/18 (1.28.2) - Fixed memory leak caused by popup panel allocation. +- 2016/11/10 (1.28.1) - Fixed some warnings and C++ error. +- 2016/11/10 (1.28.0) - Added additional `nk_button` versions which allows to directly + pass in a style struct to change buttons visual. +- 2016/11/10 (1.27.0) - Added additional `nk_tree` versions to support external state + storage. Just like last the `nk_group` commit the main + advantage is that you optionally can minimize nuklears runtime + memory consumption or handle hash collisions. +- 2016/11/09 (1.26.0) - Added additional `nk_group` version to support external scrollbar + offset storage. Main advantage is that you can externalize + the memory management for the offset. It could also be helpful + if you have a hash collision in `nk_group_begin` but really + want the name. In addition I added `nk_list_view` which allows + to draw big lists inside a group without actually having to + commit the whole list to nuklear (issue #269). +- 2016/10/30 (1.25.1) - Fixed clipping rectangle bug inside `nk_draw_list`. +- 2016/10/29 (1.25.0) - Pulled `nk_panel` memory management into nuklear and out of + the hands of the user. From now on users don't have to care + about panels unless they care about some information. If you + still need the panel just call `nk_window_get_panel`. +- 2016/10/21 (1.24.0) - Changed widget border drawing to stroked rectangle from filled + rectangle for less overdraw and widget background transparency. +- 2016/10/18 (1.23.0) - Added `nk_edit_focus` for manually edit widget focus control. +- 2016/09/29 (1.22.7) - Fixed deduction of basic type in non `` compilation. +- 2016/09/29 (1.22.6) - Fixed edit widget UTF-8 text cursor drawing bug. +- 2016/09/28 (1.22.5) - Fixed edit widget UTF-8 text appending/inserting/removing. +- 2016/09/28 (1.22.4) - Fixed drawing bug inside edit widgets which offset all text + text in every edit widget if one of them is scrolled. +- 2016/09/28 (1.22.3) - Fixed small bug in edit widgets if not active. The wrong + text length is passed. It should have been in bytes but + was passed as glyphs. +- 2016/09/20 (1.22.2) - Fixed color button size calculation. +- 2016/09/20 (1.22.1) - Fixed some `nk_vsnprintf` behavior bugs and removed `` + again from `NK_INCLUDE_STANDARD_VARARGS`. +- 2016/09/18 (1.22.0) - C89 does not support vsnprintf only C99 and newer as well + as C++11 and newer. In addition to use vsnprintf you have + to include . So just defining `NK_INCLUDE_STD_VAR_ARGS` + is not enough. That behavior is now fixed. By default if + both varargs as well as stdio is selected I try to use + vsnprintf if not possible I will revert to vsprintf. If + varargs but not stdio was defined I will use my own function. +- 2016/09/15 (1.21.2) - Fixed panel `close` behavior for deeper panel levels. +- 2016/09/15 (1.21.1) - Fixed C++ errors and wrong argument to `nk_panel_get_xxxx`. +- 2016/09/13 (1.21.0) - !BREAKING! Fixed nonblocking popup behavior in menu, combo, + and contextual which prevented closing in y-direction if + popup did not reach max height. + In addition the height parameter was changed into vec2 + for width and height to have more control over the popup size. +- 2016/09/13 (1.20.3) - Cleaned up and extended type selection. +- 2016/09/13 (1.20.2) - Fixed slider behavior hopefully for the last time. This time + all calculation are correct so no more hackery. +- 2016/09/13 (1.20.1) - Internal change to divide window/panel flags into panel flags and types. + Suprisinly spend years in C and still happened to confuse types + with flags. Probably something to take note. +- 2016/09/08 (1.20.0) - Added additional helper function to make it easier to just + take the produced buffers from `nk_convert` and unplug the + iteration process from `nk_context`. So now you can + just use the vertex,element and command buffer + two pointer + inside the command buffer retrieved by calls `nk__draw_begin` + and `nk__draw_end` and macro `nk_draw_foreach_bounded`. +- 2016/09/08 (1.19.0) - Added additional asserts to make sure every `nk_xxx_begin` call + for windows, popups, combobox, menu and contextual is guarded by + `if` condition and does not produce false drawing output. +- 2016/09/08 (1.18.0) - Changed confusing name for `NK_SYMBOL_RECT_FILLED`, `NK_SYMBOL_RECT` + to hopefully easier to understand `NK_SYMBOL_RECT_FILLED` and + `NK_SYMBOL_RECT_OUTLINE`. +- 2016/09/08 (1.17.0) - Changed confusing name for `NK_SYMBOL_CIRLCE_FILLED`, `NK_SYMBOL_CIRCLE` + to hopefully easier to understand `NK_SYMBOL_CIRCLE_FILLED` and + `NK_SYMBOL_CIRCLE_OUTLINE`. +- 2016/09/08 (1.16.0) - Added additional checks to select correct types if `NK_INCLUDE_FIXED_TYPES` + is not defined by supporting the biggest compiler GCC, clang and MSVC. +- 2016/09/07 (1.15.3) - Fixed `NK_INCLUDE_COMMAND_USERDATA` define to not cause an error. +- 2016/09/04 (1.15.2) - Fixed wrong combobox height calculation. +- 2016/09/03 (1.15.1) - Fixed gaps inside combo boxes in OpenGL. +- 2016/09/02 (1.15.0) - Changed nuklear to not have any default vertex layout and + instead made it user provided. The range of types to convert + to is quite limited at the moment, but I would be more than + happy to accept PRs to add additional. +- 2016/08/30 (1.14.2) - Removed unused variables. +- 2016/08/30 (1.14.1) - Fixed C++ build errors. +- 2016/08/30 (1.14.0) - Removed mouse dragging from SDL demo since it does not work correctly. +- 2016/08/30 (1.13.4) - Tweaked some default styling variables. +- 2016/08/30 (1.13.3) - Hopefully fixed drawing bug in slider, in general I would + refrain from using slider with a big number of steps. +- 2016/08/30 (1.13.2) - Fixed close and minimize button which would fire even if the + window was in Read Only Mode. +- 2016/08/30 (1.13.1) - Fixed popup panel padding handling which was previously just + a hack for combo box and menu. +- 2016/08/30 (1.13.0) - Removed `NK_WINDOW_DYNAMIC` flag from public API since + it is bugged and causes issues in window selection. +- 2016/08/30 (1.12.0) - Removed scaler size. The size of the scaler is now + determined by the scrollbar size. +- 2016/08/30 (1.11.2) - Fixed some drawing bugs caused by changes from 1.11.0. +- 2016/08/30 (1.11.1) - Fixed overlapping minimized window selection. +- 2016/08/30 (1.11.0) - Removed some internal complexity and overly complex code + handling panel padding and panel border. +- 2016/08/29 (1.10.0) - Added additional height parameter to `nk_combobox_xxx`. +- 2016/08/29 (1.10.0) - Fixed drawing bug in dynamic popups. +- 2016/08/29 (1.10.0) - Added experimental mouse scrolling to popups, menus and comboboxes. +- 2016/08/26 (1.10.0) - Added window name string prepresentation to account for + hash collisions. Currently limited to `NK_WINDOW_MAX_NAME` + which in term can be redefined if not big enough. +- 2016/08/26 (1.10.0) - Added stacks for temporary style/UI changes in code. +- 2016/08/25 (1.10.0) - Changed `nk_input_is_key_pressed` and 'nk_input_is_key_released' + to account for key press and release happening in one frame. +- 2016/08/25 (1.10.0) - Added additional nk_edit flag to directly jump to the end on activate. +- 2016/08/17 (1.09.6) - Removed invalid check for value zero in `nk_propertyx`. +- 2016/08/16 (1.09.5) - Fixed ROM mode for deeper levels of popup windows parents. +- 2016/08/15 (1.09.4) - Editbox are now still active if enter was pressed with flag + `NK_EDIT_SIG_ENTER`. Main reasoning is to be able to keep + typing after committing. +- 2016/08/15 (1.09.4) - Removed redundant code. +- 2016/08/15 (1.09.4) - Fixed negative numbers in `nk_strtoi` and remove unused variable. +- 2016/08/15 (1.09.3) - Fixed `NK_WINDOW_BACKGROUND` flag behavior to select a background + window only as selected by hovering and not by clicking. +- 2016/08/14 (1.09.2) - Fixed a bug in font atlas which caused wrong loading + of glyphs for font with multiple ranges. +- 2016/08/12 (1.09.1) - Added additional function to check if window is currently + hidden and therefore not visible. +- 2016/08/12 (1.09.1) - nk_window_is_closed now queries the correct flag `NK_WINDOW_CLOSED` + instead of the old flag `NK_WINDOW_HIDDEN`. +- 2016/08/09 (1.09.0) - Added additional double version to nk_property and changed + the underlying implementation to not cast to float and instead + work directly on the given values. +- 2016/08/09 (1.08.0) - Added additional define to overwrite library internal + floating pointer number to string conversion for additional + precision. +- 2016/08/09 (1.08.0) - Added additional define to overwrite library internal + string to floating point number conversion for additional + precision. +- 2016/08/08 (1.07.2) - Fixed compiling error without define `NK_INCLUDE_FIXED_TYPE`. +- 2016/08/08 (1.07.1) - Fixed possible floating point error inside `nk_widget` leading + to wrong wiget width calculation which results in widgets falsely + becoming tagged as not inside window and cannot be accessed. +- 2016/08/08 (1.07.0) - Nuklear now differentiates between hiding a window (NK_WINDOW_HIDDEN) and + closing a window (NK_WINDOW_CLOSED). A window can be hidden/shown + by using `nk_window_show` and closed by either clicking the close + icon in a window or by calling `nk_window_close`. Only closed + windows get removed at the end of the frame while hidden windows + remain. +- 2016/08/08 (1.06.0) - Added `nk_edit_string_zero_terminated` as a second option to + `nk_edit_string` which takes, edits and outputs a '\0' terminated string. +- 2016/08/08 (1.05.4) - Fixed scrollbar auto hiding behavior. +- 2016/08/08 (1.05.3) - Fixed wrong panel padding selection in `nk_layout_widget_space`. +- 2016/08/07 (1.05.2) - Fixed old bug in dynamic immediate mode layout API, calculating + wrong item spacing and panel width. +- 2016/08/07 (1.05.1) - Hopefully finally fixed combobox popup drawing bug. +- 2016/08/07 (1.05.0) - Split varargs away from `NK_INCLUDE_STANDARD_IO` into own + define `NK_INCLUDE_STANDARD_VARARGS` to allow more fine + grained controlled over library includes. +- 2016/08/06 (1.04.5) - Changed memset calls to `NK_MEMSET`. +- 2016/08/04 (1.04.4) - Fixed fast window scaling behavior. +- 2016/08/04 (1.04.3) - Fixed window scaling, movement bug which appears if you + move/scale a window and another window is behind it. + If you are fast enough then the window behind gets activated + and the operation is blocked. I now require activating + by hovering only if mouse is not pressed. +- 2016/08/04 (1.04.2) - Fixed changing fonts. +- 2016/08/03 (1.04.1) - Fixed `NK_WINDOW_BACKGROUND` behavior. +- 2016/08/03 (1.04.0) - Added color parameter to `nk_draw_image`. +- 2016/08/03 (1.04.0) - Added additional window padding style attributes for + sub windows (combo, menu, ...). +- 2016/08/03 (1.04.0) - Added functions to show/hide software cursor. +- 2016/08/03 (1.04.0) - Added `NK_WINDOW_BACKGROUND` flag to force a window + to be always in the background of the screen. +- 2016/08/03 (1.03.2) - Removed invalid assert macro for NK_RGB color picker. +- 2016/08/01 (1.03.1) - Added helper macros into header include guard. +- 2016/07/29 (1.03.0) - Moved the window/table pool into the header part to + simplify memory management by removing the need to + allocate the pool. +- 2016/07/29 (1.02.0) - Added auto scrollbar hiding window flag which if enabled + will hide the window scrollbar after NK_SCROLLBAR_HIDING_TIMEOUT + seconds without window interaction. To make it work + you have to also set a delta time inside the `nk_context`. +- 2016/07/25 (1.01.1) - Fixed small panel and panel border drawing bugs. +- 2016/07/15 (1.01.0) - Added software cursor to `nk_style` and `nk_context`. +- 2016/07/15 (1.01.0) - Added const correctness to `nk_buffer_push' data argument. +- 2016/07/15 (1.01.0) - Removed internal font baking API and simplified + font atlas memory management by converting pointer + arrays for fonts and font configurations to lists. +- 2016/07/15 (1.00.0) - Changed button API to use context dependent button + behavior instead of passing it for every function call. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +## Gallery +![Figure [blue]: Feature overview with blue color styling](https://cloud.githubusercontent.com/assets/8057201/13538240/acd96876-e249-11e5-9547-5ac0b19667a0.png) +![Figure [red]: Feature overview with red color styling](https://cloud.githubusercontent.com/assets/8057201/13538243/b04acd4c-e249-11e5-8fd2-ad7744a5b446.png) +![Figure [widgets]: Widget overview](https://cloud.githubusercontent.com/assets/8057201/11282359/3325e3c6-8eff-11e5-86cb-cf02b0596087.png) +![Figure [blackwhite]: Black and white](https://cloud.githubusercontent.com/assets/8057201/11033668/59ab5d04-86e5-11e5-8091-c56f16411565.png) +![Figure [filexp]: File explorer](https://cloud.githubusercontent.com/assets/8057201/10718115/02a9ba08-7b6b-11e5-950f-adacdd637739.png) +![Figure [opengl]: OpenGL Editor](https://cloud.githubusercontent.com/assets/8057201/12779619/2a20d72c-ca69-11e5-95fe-4edecf820d5c.png) +![Figure [nodedit]: Node Editor](https://cloud.githubusercontent.com/assets/8057201/9976995/e81ac04a-5ef7-11e5-872b-acd54fbeee03.gif) +![Figure [skinning]: Using skinning in Nuklear](https://cloud.githubusercontent.com/assets/8057201/15991632/76494854-30b8-11e6-9555-a69840d0d50b.png) +![Figure [bf]: Heavy modified version](https://cloud.githubusercontent.com/assets/8057201/14902576/339926a8-0d9c-11e6-9fee-a8b73af04473.png) +## Credits +Developed by Micha Mettke and every direct or indirect github contributor.

+Embeds [stb_texedit](https://github.com/nothings/stb/blob/master/stb_textedit.h), [stb_truetype](https://github.com/nothings/stb/blob/master/stb_truetype.h) and [stb_rectpack](https://github.com/nothings/stb/blob/master/stb_rect_pack.h) by Sean Barret (public domain)
+Uses [stddoc.c](https://github.com/r-lyeh/stddoc.c) from r-lyeh@github.com for documentation generation

+Embeds ProggyClean.ttf font by Tristan Grimmer (MIT license).
+Big thank you to Omar Cornut (ocornut@github) for his [imgui library](https://github.com/ocornut/imgui) and +giving me the inspiration for this library, Casey Muratori for handmade hero +and his original immediate mode graphical user interface idea and Sean +Barret for his amazing single header libraries which restored my faith +in libraries and brought me to create some of my own. Finally Apoorva Joshi +for his single header file packer. + + diff --git a/doc/nuklear.html b/doc/nuklear.html index fd94595..c3acf91 100644 --- a/doc/nuklear.html +++ b/doc/nuklear.html @@ -1,2625 +1,11 @@ - - -# Nuklear -![](https://cloud.githubusercontent.com/assets/8057201/11761525/ae06f0ca-a0c6-11e5-819d-5610b25f6ef4.gif) -## Contents -1. About section -2. Highlights section -3. Features section -4. Usage section - 1. Flags section - 2. Constants section - 3. Dependencies section -5. Example section -6. API section - 1. Context section - 2. Input section - 3. Drawing section - 4. Window section - 5. Layouting section - 6. Groups section - 7. Tree section - 8. Properties section -7. License section -8. Changelog section -9. Gallery section -10. Credits section -## About -This is a minimal state immediate mode graphical user interface toolkit -written in ANSI C and licensed under public domain. It was designed as a simple -embeddable user interface for application and does not have any dependencies, -a default renderbackend or OS window and input handling but instead provides a very modular -library approach by using simple input state for input and draw -commands describing primitive shapes as output. So instead of providing a -layered library that tries to abstract over a number of platform and -render backends it only focuses on the actual UI. -## Highlights -- Graphical user interface toolkit -- Single header library -- Written in C89 (a.k.a. ANSI C or ISO C90) -- Small codebase (~18kLOC) -- Focus on portability, efficiency and simplicity -- No dependencies (not even the standard library if not wanted) -- Fully skinnable and customizable -- Low memory footprint with total memory control if needed or wanted -- UTF-8 support -- No global or hidden state -- Customizable library modules (you can compile and use only what you need) -- Optional font baker and vertex buffer output -## Features -- Absolutely no platform dependent code -- Memory management control ranging from/to - - Ease of use by allocating everything from standard library - - Control every byte of memory inside the library -- Font handling control ranging from/to - - Use your own font implementation for everything - - Use this libraries internal font baking and handling API -- Drawing output control ranging from/to - - Simple shapes for more high level APIs which already have drawing capabilities - - Hardware accessible anti-aliased vertex buffer output -- Customizable colors and properties ranging from/to - - Simple changes to color by filling a simple color table - - Complete control with ability to use skinning to decorate widgets -- Bendable UI library with widget ranging from/to - - Basic widgets like buttons, checkboxes, slider, ... - - Advanced widget like abstract comboboxes, contextual menus,... -- Compile time configuration to only compile what you need - - Subset which can be used if you do not want to link or use the standard library -- Can be easily modified to only update on user input instead of frame updates -## Usage -This library is self contained in one single header file and can be used either -in header only mode or in implementation mode. The header only mode is used -by default when included and allows including this header in other headers -and does not contain the actual implementation.

-The implementation mode requires to define the preprocessor macro -NK_IMPLEMENTATION in *one* .c/.cpp file before #includeing this file, e.g.: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~C - #define NK_IMPLEMENTATION - #include "nuklear.h" -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Also optionally define the symbols listed in the section "OPTIONAL DEFINES" -below in header and implementation mode if you want to use additional functionality -or need more control over the library. -!!! WARNING - Every time nuklear is included define the same compiler flags. This very important not doing so could lead to compiler errors or even worse stack corruptions. -### Flags -Flag | Description ---------------------------------|------------------------------------------ -NK_PRIVATE | If defined declares all functions as static, so they can only be accessed inside the file that contains the implementation -NK_INCLUDE_FIXED_TYPES | If defined it will include header `` for fixed sized types otherwise nuklear tries to select the correct type. If that fails it will throw a compiler error and you have to select the correct types yourself. -NK_INCLUDE_DEFAULT_ALLOCATOR | If defined it will include header `` and provide additional functions to use this library without caring for memory allocation control and therefore ease memory management. -NK_INCLUDE_STANDARD_IO | If defined it will include header `` and provide additional functions depending on file loading. -NK_INCLUDE_STANDARD_VARARGS | If defined it will include header and provide additional functions depending on file loading. -NK_INCLUDE_VERTEX_BUFFER_OUTPUT | Defining this adds a vertex draw command list backend to this library, which allows you to convert queue commands into vertex draw commands. This is mainly if you need a hardware accessible format for OpenGL, DirectX, Vulkan, Metal,... -NK_INCLUDE_FONT_BAKING | Defining this adds `stb_truetype` and `stb_rect_pack` implementation to this library and provides font baking and rendering. If you already have font handling or do not want to use this font handler you don't have to define it. -NK_INCLUDE_DEFAULT_FONT | Defining this adds the default font: ProggyClean.ttf into this library which can be loaded into a font atlas and allows using this library without having a truetype font -NK_INCLUDE_COMMAND_USERDATA | Defining this adds a userdata pointer into each command. Can be useful for example if you want to provide custom shaders depending on the used widget. Can be combined with the style structures. -NK_BUTTON_TRIGGER_ON_RELEASE | Different platforms require button clicks occurring either on buttons being pressed (up to down) or released (down to up). By default this library will react on buttons being pressed, but if you define this it will only trigger if a button is released. -NK_ZERO_COMMAND_MEMORY | Defining this will zero out memory for each drawing command added to a drawing queue (inside nk_command_buffer_push). Zeroing command memory is very useful for fast checking (using memcmp) if command buffers are equal and avoid drawing frames when nothing on screen has changed since previous frame. -NK_UINT_DRAW_INDEX | Defining this will set the size of vertex index elements when using NK_VERTEX_BUFFER_OUTPUT to 32bit instead of the default of 16bit -NK_KEYSTATE_BASED_INPUT | Define this if your backend uses key state for each frame rather than key press/release events -!!! WARNING - The following flags will pull in the standard C library: - - NK_INCLUDE_DEFAULT_ALLOCATOR - - NK_INCLUDE_STANDARD_IO - - NK_INCLUDE_STANDARD_VARARGS -!!! WARNING - The following flags if defined need to be defined for both header and implementation: - - NK_INCLUDE_FIXED_TYPES - - NK_INCLUDE_DEFAULT_ALLOCATOR - - NK_INCLUDE_STANDARD_VARARGS - - NK_INCLUDE_VERTEX_BUFFER_OUTPUT - - NK_INCLUDE_FONT_BAKING - - NK_INCLUDE_DEFAULT_FONT - - NK_INCLUDE_STANDARD_VARARGS - - NK_INCLUDE_COMMAND_USERDATA - - NK_UINT_DRAW_INDEX -### Constants -Define | Description ---------------------------------|--------------------------------------- -NK_BUFFER_DEFAULT_INITIAL_SIZE | Initial buffer size allocated by all buffers while using the default allocator functions included by defining NK_INCLUDE_DEFAULT_ALLOCATOR. If you don't want to allocate the default 4k memory then redefine it. -NK_MAX_NUMBER_BUFFER | Maximum buffer size for the conversion buffer between float and string Under normal circumstances this should be more than sufficient. -NK_INPUT_MAX | Defines the max number of bytes which can be added as text input in one frame. Under normal circumstances this should be more than sufficient. -!!! WARNING - The following constants if defined need to be defined for both header and implementation: - - NK_MAX_NUMBER_BUFFER - - NK_BUFFER_DEFAULT_INITIAL_SIZE - - NK_INPUT_MAX -### Dependencies -Function | Description -------------|--------------------------------------------------------------- -NK_ASSERT | If you don't define this, nuklear will use with assert(). -NK_MEMSET | You can define this to 'memset' or your own memset implementation replacement. If not nuklear will use its own version. -NK_MEMCPY | You can define this to 'memcpy' or your own memcpy implementation replacement. If not nuklear will use its own version. -NK_SQRT | You can define this to 'sqrt' or your own sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. -NK_SIN | You can define this to 'sinf' or your own sine implementation replacement. If not nuklear will use its own approximation implementation. -NK_COS | You can define this to 'cosf' or your own cosine implementation replacement. If not nuklear will use its own approximation implementation. -NK_STRTOD | You can define this to `strtod` or your own string to double conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). -NK_DTOA | You can define this to `dtoa` or your own double to string conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). -NK_VSNPRINTF| If you define `NK_INCLUDE_STANDARD_VARARGS` as well as `NK_INCLUDE_STANDARD_IO` and want to be safe define this to `vsnprintf` on compilers supporting later versions of C or C++. By default nuklear will check for your stdlib version in C as well as compiler version in C++. if `vsnprintf` is available it will define it to `vsnprintf` directly. If not defined and if you have older versions of C or C++ it will be defined to `vsprintf` which is unsafe. -!!! WARNING - The following dependencies will pull in the standard C library if not redefined: - - NK_ASSERT -!!! WARNING - The following dependencies if defined need to be defined for both header and implementation: - - NK_ASSERT -!!! WARNING - The following dependencies if defined need to be defined only for the implementation part: - - NK_MEMSET - - NK_MEMCPY - - NK_SQRT - - NK_SIN - - NK_COS - - NK_STRTOD - - NK_DTOA - - NK_VSNPRINTF -## Example -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -// init gui state -enum {EASY, HARD}; -static int op = EASY; -static float value = 0.6f; -static int i = 20; -struct nk_context ctx; -nk_init_fixed(&ctx, calloc(1, MAX_MEMORY), MAX_MEMORY, &font); -if (nk_begin(&ctx, "Show", nk_rect(50, 50, 220, 220), - NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_CLOSABLE)) { - // fixed widget pixel width - nk_layout_row_static(&ctx, 30, 80, 1); - if (nk_button_label(&ctx, "button")) { - // event handling - } - // fixed widget window ratio width - nk_layout_row_dynamic(&ctx, 30, 2); - if (nk_option_label(&ctx, "easy", op == EASY)) op = EASY; - if (nk_option_label(&ctx, "hard", op == HARD)) op = HARD; - // custom widget pixel width - nk_layout_row_begin(&ctx, NK_STATIC, 30, 2); - { - nk_layout_row_push(&ctx, 50); - nk_label(&ctx, "Volume:", NK_TEXT_LEFT); - nk_layout_row_push(&ctx, 110); - nk_slider_float(&ctx, 0, &value, 1.0f, 0.1f); - } - nk_layout_row_end(&ctx); -} -nk_end(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -![](https://cloud.githubusercontent.com/assets/8057201/10187981/584ecd68-675c-11e5-897c-822ef534a876.png) -## API -### Context -Contexts are the main entry point and the majestro of nuklear and contain all required state. -They are used for window, memory, input, style, stack, commands and time management and need -to be passed into all nuklear GUI specific functions. -#### Usage -To use a context it first has to be initialized which can be achieved by calling -one of either `nk_init_default`, `nk_init_fixed`, `nk_init`, `nk_init_custom`. -Each takes in a font handle and a specific way of handling memory. Memory control -hereby ranges from standard library to just specifying a fixed sized block of memory -which nuklear has to manage itself from. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - // [...] - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description ---------------------|------------------------------------------------------- -__nk_init_default__ | Initializes context with standard library memory allocation (malloc,free) -__nk_init_fixed__ | Initializes context from single fixed size memory block -__nk_init__ | Initializes context with memory allocator callbacks for alloc and free -__nk_init_custom__ | Initializes context from two buffers. One for draw commands the other for window/panel/table allocations -__nk_clear__ | Called at the end of the frame to reset and prepare the context for the next frame -__nk_free__ | Shutdown and free all memory allocated inside the context -__nk_set_user_data__| Utility function to pass user data to draw command -#### nk_init_default -Initializes a `nk_context` struct with a default standard library allocator. -Should be used if you don't want to be bothered with memory management in nuklear. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_init_default(struct nk_context *ctx, const struct nk_user_font *font); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|--------------------------------------------------------------- -__ctx__ | Must point to an either stack or heap allocated `nk_context` struct -__font__ | Must point to a previously initialized font handle for more info look at font documentation -Returns either `false(0)` on failure or `true(1)` on success. -#### nk_init_fixed -Initializes a `nk_context` struct from single fixed size memory block -Should be used if you want complete control over nuklear's memory management. -Especially recommended for system with little memory or systems with virtual memory. -For the later case you can just allocate for example 16MB of virtual memory -and only the required amount of memory will actually be committed. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_init_fixed(struct nk_context *ctx, void *memory, nk_size size, const struct nk_user_font *font); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -!!! Warning - make sure the passed memory block is aligned correctly for `nk_draw_commands`. -Parameter | Description -------------|-------------------------------------------------------------- -__ctx__ | Must point to an either stack or heap allocated `nk_context` struct -__memory__ | Must point to a previously allocated memory block -__size__ | Must contain the total size of __memory__ -__font__ | Must point to a previously initialized font handle for more info look at font documentation -Returns either `false(0)` on failure or `true(1)` on success. -#### nk_init -Initializes a `nk_context` struct with memory allocation callbacks for nuklear to allocate -memory from. Used internally for `nk_init_default` and provides a kitchen sink allocation -interface to nuklear. Can be useful for cases like monitoring memory consumption. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_init(struct nk_context *ctx, struct nk_allocator *alloc, const struct nk_user_font *font); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|--------------------------------------------------------------- -__ctx__ | Must point to an either stack or heap allocated `nk_context` struct -__alloc__ | Must point to a previously allocated memory allocator -__font__ | Must point to a previously initialized font handle for more info look at font documentation -Returns either `false(0)` on failure or `true(1)` on success. -#### nk_init_custom -Initializes a `nk_context` struct from two different either fixed or growing -buffers. The first buffer is for allocating draw commands while the second buffer is -used for allocating windows, panels and state tables. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_init_custom(struct nk_context *ctx, struct nk_buffer *cmds, struct nk_buffer *pool, const struct nk_user_font *font); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|--------------------------------------------------------------- -__ctx__ | Must point to an either stack or heap allocated `nk_context` struct -__cmds__ | Must point to a previously initialized memory buffer either fixed or dynamic to store draw commands into -__pool__ | Must point to a previously initialized memory buffer either fixed or dynamic to store windows, panels and tables -__font__ | Must point to a previously initialized font handle for more info look at font documentation -Returns either `false(0)` on failure or `true(1)` on success. -#### nk_clear -Resets the context state at the end of the frame. This includes mostly -garbage collector tasks like removing windows or table not called and therefore -used anymore. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_clear(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -#### nk_free -Frees all memory allocated by nuklear. Not needed if context was -initialized with `nk_init_fixed`. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_free(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -#### nk_set_user_data -Sets the currently passed userdata passed down into each draw command. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_set_user_data(struct nk_context *ctx, nk_handle data); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|-------------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__data__ | Handle with either pointer or index to be passed into every draw commands -### Input -The input API is responsible for holding the current input state composed of -mouse, key and text input states. -It is worth noting that no direct OS or window handling is done in nuklear. -Instead all input state has to be provided by platform specific code. This on one hand -expects more work from the user and complicates usage but on the other hand -provides simple abstraction over a big number of platforms, libraries and other -already provided functionality. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -nk_input_begin(&ctx); -while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - // [...] - } -} nk_input_end(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Usage -Input state needs to be provided to nuklear by first calling `nk_input_begin` -which resets internal state like delta mouse position and button transistions. -After `nk_input_begin` all current input state needs to be provided. This includes -mouse motion, button and key pressed and released, text input and scrolling. -Both event- or state-based input handling are supported by this API -and should work without problems. Finally after all input state has been -mirrored `nk_input_end` needs to be called to finish input process. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - Event evt; - nk_input_begin(&ctx); - while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - // [...] - } - } - nk_input_end(&ctx); - // [...] - nk_clear(&ctx); -} nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description ---------------------|------------------------------------------------------- -__nk_input_begin__ | Begins the input mirroring process. Needs to be called before all other `nk_input_xxx` calls -__nk_input_motion__ | Mirrors mouse cursor position -__nk_input_key__ | Mirrors key state with either pressed or released -__nk_input_button__ | Mirrors mouse button state with either pressed or released -__nk_input_scroll__ | Mirrors mouse scroll values -__nk_input_char__ | Adds a single ASCII text character into an internal text buffer -__nk_input_glyph__ | Adds a single multi-byte UTF-8 character into an internal text buffer -__nk_input_unicode__| Adds a single unicode rune into an internal text buffer -__nk_input_end__ | Ends the input mirroring process by calculating state changes. Don't call any `nk_input_xxx` function referenced above after this call -#### nk_input_begin -Begins the input mirroring process by resetting text, scroll -mouse, previous mouse position and movement as well as key state transitions, -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_begin(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -#### nk_input_motion -Mirrors current mouse position to nuklear -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_motion(struct nk_context *ctx, int x, int y); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__x__ | Must hold an integer describing the current mouse cursor x-position -__y__ | Must hold an integer describing the current mouse cursor y-position -#### nk_input_key -Mirrors the state of a specific key to nuklear -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_key(struct nk_context*, enum nk_keys key, int down); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__key__ | Must be any value specified in enum `nk_keys` that needs to be mirrored -__down__ | Must be 0 for key is up and 1 for key is down -#### nk_input_button -Mirrors the state of a specific mouse button to nuklear -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_button(struct nk_context *ctx, enum nk_buttons btn, int x, int y, int down); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__btn__ | Must be any value specified in enum `nk_buttons` that needs to be mirrored -__x__ | Must contain an integer describing mouse cursor x-position on click up/down -__y__ | Must contain an integer describing mouse cursor y-position on click up/down -__down__ | Must be 0 for key is up and 1 for key is down -#### nk_input_scroll -Copies the last mouse scroll value to nuklear. Is generally -a scroll value. So does not have to come from mouse and could also originate -TODO finish this sentence -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__val__ | vector with both X- as well as Y-scroll value -#### nk_input_char -Copies a single ASCII character into an internal text buffer -This is basically a helper function to quickly push ASCII characters into -nuklear. -!!! Note - Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_char(struct nk_context *ctx, char c); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__c__ | Must be a single ASCII character preferable one that can be printed -#### nk_input_glyph -Converts an encoded unicode rune into UTF-8 and copies the result into an -internal text buffer. -!!! Note - Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_glyph(struct nk_context *ctx, const nk_glyph g); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__g__ | UTF-32 unicode codepoint -#### nk_input_unicode -Converts a unicode rune into UTF-8 and copies the result -into an internal text buffer. -!!! Note - Stores up to NK_INPUT_MAX bytes between `nk_input_begin` and `nk_input_end`. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_unicode(struct nk_context*, nk_rune rune); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -__rune__ | UTF-32 unicode codepoint -#### nk_input_end -End the input mirroring process by resetting mouse grabbing -state to ensure the mouse cursor is not grabbed indefinitely. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_input_end(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to a previously initialized `nk_context` struct -### Drawing -This library was designed to be render backend agnostic so it does -not draw anything to screen directly. Instead all drawn shapes, widgets -are made of, are buffered into memory and make up a command queue. -Each frame therefore fills the command buffer with draw commands -that then need to be executed by the user and his own render backend. -After that the command buffer needs to be cleared and a new frame can be -started. It is probably important to note that the command buffer is the main -drawing API and the optional vertex buffer API only takes this format and -converts it into a hardware accessible format. -#### Usage -To draw all draw commands accumulated over a frame you need your own render -backend able to draw a number of 2D primitives. This includes at least -filled and stroked rectangles, circles, text, lines, triangles and scissors. -As soon as this criterion is met you can iterate over each draw command -and execute each draw command in a interpreter like fashion: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_command *cmd = 0; -nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case //...: - //[...] - } -} -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In program flow context draw commands need to be executed after input has been -gathered and the complete UI with windows and their contained widgets have -been executed and before calling `nk_clear` which frees all previously -allocated draw commands. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - Event evt; - nk_input_begin(&ctx); - while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - [...] - } - } - nk_input_end(&ctx); - // - // [...] - // - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case ...: - // [...] - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You probably noticed that you have to draw all of the UI each frame which is -quite wasteful. While the actual UI updating loop is quite fast rendering -without actually needing it is not. So there are multiple things you could do. -First is only update on input. This of course is only an option if your -application only depends on the UI and does not require any outside calculations. -If you actually only update on input make sure to update the UI two times each -frame and call `nk_clear` directly after the first pass and only draw in -the second pass. In addition it is recommended to also add additional timers -to make sure the UI is not drawn more than a fixed number of frames per second. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - // [...wait for input ] - // [...do two UI passes ...] - do_ui(...) - nk_clear(&ctx); - do_ui(...) - // - // draw - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case ...: - //[...] - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The second probably more applicable trick is to only draw if anything changed. -It is not really useful for applications with continuous draw loop but -quite useful for desktop applications. To actually get nuklear to only -draw on changes you first have to define `NK_ZERO_COMMAND_MEMORY` and -allocate a memory buffer that will store each unique drawing output. -After each frame you compare the draw command memory inside the library -with your allocated buffer by memcmp. If memcmp detects differences -you have to copy the command buffer into the allocated buffer -and then draw like usual (this example uses fixed memory but you could -use dynamically allocated memory). -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -//[... other defines ...] -#define NK_ZERO_COMMAND_MEMORY -#include "nuklear.h" -// -// setup context -struct nk_context ctx; -void *last = calloc(1,64*1024); -void *buf = calloc(1,64*1024); -nk_init_fixed(&ctx, buf, 64*1024); -// -// loop -while (1) { - // [...input...] - // [...ui...] - void *cmds = nk_buffer_memory(&ctx.memory); - if (memcmp(cmds, last, ctx.memory.allocated)) { - memcpy(last,cmds,ctx.memory.allocated); - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case ...: - // [...] - } - } - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Finally while using draw commands makes sense for higher abstracted platforms like -X11 and Win32 or drawing libraries it is often desirable to use graphics -hardware directly. Therefore it is possible to just define -`NK_INCLUDE_VERTEX_BUFFER_OUTPUT` which includes optional vertex output. -To access the vertex output you first have to convert all draw commands into -vertexes by calling `nk_convert` which takes in your preferred vertex format. -After successfully converting all draw commands just iterate over and execute all -vertex draw commands: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -// fill configuration -struct your_vertex -{ - float pos[2]; // important to keep it to 2 floats - float uv[2]; - unsigned char col[4]; -}; -struct nk_convert_config cfg = {}; -static const struct nk_draw_vertex_layout_element vertex_layout[] = { - {NK_VERTEX_POSITION, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, pos)}, - {NK_VERTEX_TEXCOORD, NK_FORMAT_FLOAT, NK_OFFSETOF(struct your_vertex, uv)}, - {NK_VERTEX_COLOR, NK_FORMAT_R8G8B8A8, NK_OFFSETOF(struct your_vertex, col)}, - {NK_VERTEX_LAYOUT_END} -}; -cfg.shape_AA = NK_ANTI_ALIASING_ON; -cfg.line_AA = NK_ANTI_ALIASING_ON; -cfg.vertex_layout = vertex_layout; -cfg.vertex_size = sizeof(struct your_vertex); -cfg.vertex_alignment = NK_ALIGNOF(struct your_vertex); -cfg.circle_segment_count = 22; -cfg.curve_segment_count = 22; -cfg.arc_segment_count = 22; -cfg.global_alpha = 1.0f; -cfg.null = dev->null; -// -// setup buffers and convert -struct nk_buffer cmds, verts, idx; -nk_buffer_init_default(&cmds); -nk_buffer_init_default(&verts); -nk_buffer_init_default(&idx); -nk_convert(&ctx, &cmds, &verts, &idx, &cfg); -// -// draw -nk_draw_foreach(cmd, &ctx, &cmds) { -if (!cmd->elem_count) continue; - //[...] -} -nk_buffer_free(&cms); -nk_buffer_free(&verts); -nk_buffer_free(&idx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description ---------------------|------------------------------------------------------- -__nk__begin__ | Returns the first draw command in the context draw command list to be drawn -__nk__next__ | Increments the draw command iterator to the next command inside the context draw command list -__nk_foreach__ | Iterates over each draw command inside the context draw command list -__nk_convert__ | Converts from the abstract draw commands list into a hardware accessible vertex format -__nk_draw_begin__ | Returns the first vertex command in the context vertex draw list to be executed -__nk__draw_next__ | Increments the vertex command iterator to the next command inside the context vertex command list -__nk__draw_end__ | Returns the end of the vertex draw list -__nk_draw_foreach__ | Iterates over each vertex draw command inside the vertex draw list -#### nk__begin -Returns a draw command list iterator to iterate all draw -commands accumulated over one frame. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_command* nk__begin(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | must point to an previously initialized `nk_context` struct at the end of a frame -Returns draw command pointer pointing to the first command inside the draw command list -#### nk__next -Returns draw command pointer pointing to the next command inside the draw command list -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_command* nk__next(struct nk_context*, const struct nk_command*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -__cmd__ | Must point to an previously a draw command either returned by `nk__begin` or `nk__next` -Returns draw command pointer pointing to the next command inside the draw command list -#### nk_foreach -Iterates over each draw command inside the context draw command list -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_foreach(c, ctx) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -__cmd__ | Command pointer initialized to NULL -Iterates over each draw command inside the context draw command list -#### nk_convert -Converts all internal draw commands into vertex draw commands and fills -three buffers with vertexes, vertex draw commands and vertex indices. The vertex format -as well as some other configuration values have to be configured by filling out a -`nk_convert_config` struct. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -nk_flags nk_convert(struct nk_context *ctx, struct nk_buffer *cmds, - struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -__cmds__ | Must point to a previously initialized buffer to hold converted vertex draw commands -__vertices__| Must point to a previously initialized buffer to hold all produced vertices -__elements__| Must point to a previously initialized buffer to hold all produced vertex indices -__config__ | Must point to a filled out `nk_config` struct to configure the conversion process -Returns one of enum nk_convert_result error codes -Parameter | Description ---------------------------------|----------------------------------------------------------- -NK_CONVERT_SUCCESS | Signals a successful draw command to vertex buffer conversion -NK_CONVERT_INVALID_PARAM | An invalid argument was passed in the function call -NK_CONVERT_COMMAND_BUFFER_FULL | The provided buffer for storing draw commands is full or failed to allocate more memory -NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory -NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is full or failed to allocate more memory -#### nk__draw_begin -Returns a draw vertex command buffer iterator to iterate over the vertex draw command buffer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_draw_command* nk__draw_begin(const struct nk_context*, const struct nk_buffer*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer -Returns vertex draw command pointer pointing to the first command inside the vertex draw command buffer -#### nk__draw_end -Returns the vertex draw command at the end of the vertex draw command buffer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_draw_command* nk__draw_end(const struct nk_context *ctx, const struct nk_buffer *buf); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer -Returns vertex draw command pointer pointing to the end of the last vertex draw command inside the vertex draw command buffer -#### nk__draw_next -Increments the vertex draw command buffer iterator -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -const struct nk_draw_command* nk__draw_next(const struct nk_draw_command*, const struct nk_buffer*, const struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__cmd__ | Must point to an previously either by `nk__draw_begin` or `nk__draw_next` returned vertex draw command -__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -Returns vertex draw command pointer pointing to the end of the last vertex draw command inside the vertex draw command buffer -#### nk_draw_foreach -Iterates over each vertex draw command inside a vertex draw command buffer -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_draw_foreach(cmd,ctx, b) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__cmd__ | `nk_draw_command`iterator set to NULL -__buf__ | Must point to an previously by `nk_convert` filled out vertex draw command buffer -__ctx__ | Must point to an previously initialized `nk_context` struct at the end of a frame -### Window -Windows are the main persistent state used inside nuklear and are life time -controlled by simply "retouching" (i.e. calling) each window each frame. -All widgets inside nuklear can only be added inside the function pair `nk_begin_xxx` -and `nk_end`. Calling any widgets outside these two functions will result in an -assert in debug or no state change in release mode.

-Each window holds frame persistent state like position, size, flags, state tables, -and some garbage collected internal persistent widget state. Each window -is linked into a window stack list which determines the drawing and overlapping -order. The topmost window thereby is the currently active window.

-To change window position inside the stack occurs either automatically by -user input by being clicked on or programmatically by calling `nk_window_focus`. -Windows by default are visible unless explicitly being defined with flag -`NK_WINDOW_HIDDEN`, the user clicked the close button on windows with flag -`NK_WINDOW_CLOSABLE` or if a window was explicitly hidden by calling -`nk_window_show`. To explicitly close and destroy a window call `nk_window_close`.

-#### Usage -To create and keep a window you have to call one of the two `nk_begin_xxx` -functions to start window declarations and `nk_end` at the end. Furthermore it -is recommended to check the return value of `nk_begin_xxx` and only process -widgets inside the window if the value is not 0. Either way you have to call -`nk_end` at the end of window declarations. Furthermore, do not attempt to -nest `nk_begin_xxx` calls which will hopefully result in an assert or if not -in a segmentation fault. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -if (nk_begin_xxx(...) { - // [... widgets ...] -} -nk_end(ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the grand concept window and widget declarations need to occur after input -handling and before drawing to screen. Not doing so can result in higher -latency or at worst invalid behavior. Furthermore make sure that `nk_clear` -is called at the end of the frame. While nuklear's default platform backends -already call `nk_clear` for you if you write your own backend not calling -`nk_clear` can cause asserts or even worse undefined behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - Event evt; - nk_input_begin(&ctx); - while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - nk_input_xxx(...); - } - } - nk_input_end(&ctx); - if (nk_begin_xxx(...) { - //[...] - } - nk_end(ctx); - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case //...: - //[...] - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description -------------------------------------|---------------------------------------- -nk_begin | Starts a new window; needs to be called every frame for every window (unless hidden) or otherwise the window gets removed -nk_begin_titled | Extended window start with separated title and identifier to allow multiple windows with same name but not title -nk_end | Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup -nk_window_find | Finds and returns the window with give name -nk_window_get_bounds | Returns a rectangle with screen position and size of the currently processed window. -nk_window_get_position | Returns the position of the currently processed window -nk_window_get_size | Returns the size with width and height of the currently processed window -nk_window_get_width | Returns the width of the currently processed window -nk_window_get_height | Returns the height of the currently processed window -nk_window_get_panel | Returns the underlying panel which contains all processing state of the current window -nk_window_get_content_region | Returns the position and size of the currently visible and non-clipped space inside the currently processed window -nk_window_get_content_region_min | Returns the upper rectangle position of the currently visible and non-clipped space inside the currently processed window -nk_window_get_content_region_max | Returns the upper rectangle position of the currently visible and non-clipped space inside the currently processed window -nk_window_get_content_region_size | Returns the size of the currently visible and non-clipped space inside the currently processed window -nk_window_get_canvas | Returns the draw command buffer. Can be used to draw custom widgets -nk_window_get_scroll | Gets the scroll offset of the current window -nk_window_has_focus | Returns if the currently processed window is currently active -nk_window_is_collapsed | Returns if the window with given name is currently minimized/collapsed -nk_window_is_closed | Returns if the currently processed window was closed -nk_window_is_hidden | Returns if the currently processed window was hidden -nk_window_is_active | Same as nk_window_has_focus for some reason -nk_window_is_hovered | Returns if the currently processed window is currently being hovered by mouse -nk_window_is_any_hovered | Return if any window currently hovered -nk_item_is_any_active | Returns if any window or widgets is currently hovered or active -nk_window_set_bounds | Updates position and size of the currently processed window -nk_window_set_position | Updates position of the currently process window -nk_window_set_size | Updates the size of the currently processed window -nk_window_set_focus | Set the currently processed window as active window -nk_window_set_scroll | Sets the scroll offset of the current window -nk_window_close | Closes the window with given window name which deletes the window at the end of the frame -nk_window_collapse | Collapses the window with given window name -nk_window_collapse_if | Collapses the window with given window name if the given condition was met -nk_window_show | Hides a visible or reshows a hidden window -nk_window_show_if | Hides/shows a window depending on condition -#### nk_panel_flags -Flag | Description -----------------------------|---------------------------------------- -NK_WINDOW_BORDER | Draws a border around the window to visually separate window from the background -NK_WINDOW_MOVABLE | The movable flag indicates that a window can be moved by user input or by dragging the window header -NK_WINDOW_SCALABLE | The scalable flag indicates that a window can be scaled by user input by dragging a scaler icon at the button of the window -NK_WINDOW_CLOSABLE | Adds a closable icon into the header -NK_WINDOW_MINIMIZABLE | Adds a minimize icon into the header -NK_WINDOW_NO_SCROLLBAR | Removes the scrollbar from the window -NK_WINDOW_TITLE | Forces a header at the top at the window showing the title -NK_WINDOW_SCROLL_AUTO_HIDE | Automatically hides the window scrollbar if no user interaction: also requires delta time in `nk_context` to be set each frame -NK_WINDOW_BACKGROUND | Always keep window in the background -NK_WINDOW_SCALE_LEFT | Puts window scaler in the left-bottom corner instead right-bottom -NK_WINDOW_NO_INPUT | Prevents window of scaling, moving or getting focus -#### nk_collapse_states -State | Description -----------------|----------------------------------------------------------- -__NK_MINIMIZED__| UI section is collased and not visibile until maximized -__NK_MAXIMIZED__| UI section is extended and visibile until minimized -

-#### nk_begin -Starts a new window; needs to be called every frame for every -window (unless hidden) or otherwise the window gets removed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_begin(struct nk_context *ctx, const char *title, struct nk_rect bounds, nk_flags flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__title__ | Window title and identifier. Needs to be persistent over frames to identify the window -__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame -__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors -Returns `true(1)` if the window can be filled up with widgets from this point -until `nk_end` or `false(0)` otherwise for example if minimized -#### nk_begin_titled -Extended window start with separated title and identifier to allow multiple -windows with same title but not name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_begin_titled(struct nk_context *ctx, const char *name, const char *title, struct nk_rect bounds, nk_flags flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Window identifier. Needs to be persistent over frames to identify the window -__title__ | Window title displayed inside header if flag `NK_WINDOW_TITLE` or either `NK_WINDOW_CLOSABLE` or `NK_WINDOW_MINIMIZED` was set -__bounds__ | Initial position and window size. However if you do not define `NK_WINDOW_SCALABLE` or `NK_WINDOW_MOVABLE` you can set window position and size every frame -__flags__ | Window flags defined in the nk_panel_flags section with a number of different window behaviors -Returns `true(1)` if the window can be filled up with widgets from this point -until `nk_end` or `false(0)` otherwise for example if minimized -#### nk_end -Needs to be called at the end of the window building process to process scaling, scrollbars and general cleanup. -All widget calls after this functions will result in asserts or no state changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_end(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -#### nk_window_find -Finds and returns a window from passed name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_window *nk_window_find(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Window identifier -Returns a `nk_window` struct pointing to the identified window or NULL if -no window with the given name was found -#### nk_window_get_bounds -Returns a rectangle with screen position and size of the currently processed window -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_window_get_bounds(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns a `nk_rect` struct with window upper left window position and size -#### nk_window_get_position -Returns the position of the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_window_get_position(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns a `nk_vec2` struct with window upper left position -#### nk_window_get_size -Returns the size with width and height of the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_window_get_size(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns a `nk_vec2` struct with window width and height -#### nk_window_get_width -Returns the width of the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -float nk_window_get_width(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns the current window width -#### nk_window_get_height -Returns the height of the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -float nk_window_get_height(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns the current window height -#### nk_window_get_panel -Returns the underlying panel which contains all processing state of the current window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -!!! WARNING - Do not keep the returned panel pointer around, it is only valid until `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_panel* nk_window_get_panel(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns a pointer to window internal `nk_panel` state. -#### nk_window_get_content_region -Returns the position and size of the currently visible and non-clipped space -inside the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_window_get_content_region(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `nk_rect` struct with screen position and size (no scrollbar offset) -of the visible space inside the current window -#### nk_window_get_content_region_min -Returns the upper left position of the currently visible and non-clipped -space inside the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_window_get_content_region_min(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -returns `nk_vec2` struct with upper left screen position (no scrollbar offset) -of the visible space inside the current window -#### nk_window_get_content_region_max -Returns the lower right screen position of the currently visible and -non-clipped space inside the currently processed window. -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_window_get_content_region_max(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `nk_vec2` struct with lower right screen position (no scrollbar offset) -of the visible space inside the current window -#### nk_window_get_content_region_size -Returns the size of the currently visible and non-clipped space inside the -currently processed window -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_window_get_content_region_size(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `nk_vec2` struct with size the visible space inside the current window -#### nk_window_get_canvas -Returns the draw command buffer. Can be used to draw custom widgets -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -!!! WARNING - Do not keep the returned command buffer pointer around it is only valid until `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_command_buffer* nk_window_get_canvas(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns a pointer to window internal `nk_command_buffer` struct used as -drawing canvas. Can be used to do custom drawing. -#### nk_window_get_scroll -Gets the scroll offset for the current window -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_get_scroll(struct nk_context *ctx, nk_uint *offset_x, nk_uint *offset_y); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description --------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__offset_x__ | A pointer to the x offset output (or NULL to ignore) -__offset_y__ | A pointer to the y offset output (or NULL to ignore) -#### nk_window_has_focus -Returns if the currently processed window is currently active -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_has_focus(const struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `false(0)` if current window is not active or `true(1)` if it is -#### nk_window_is_hovered -Return if the current window is being hovered -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_hovered(struct nk_context *ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `true(1)` if current window is hovered or `false(0)` otherwise -#### nk_window_is_collapsed -Returns if the window with given name is currently minimized/collapsed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_collapsed(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of window you want to check if it is collapsed -Returns `true(1)` if current window is minimized and `false(0)` if window not -found or is not minimized -#### nk_window_is_closed -Returns if the window with given name was closed by calling `nk_close` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_closed(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of window you want to check if it is closed -Returns `true(1)` if current window was closed or `false(0)` window not found or not closed -#### nk_window_is_hidden -Returns if the window with given name is hidden -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_hidden(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of window you want to check if it is hidden -Returns `true(1)` if current window is hidden or `false(0)` window not found or visible -#### nk_window_is_active -Same as nk_window_has_focus for some reason -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_active(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of window you want to check if it is active -Returns `true(1)` if current window is active or `false(0)` window not found or not active -#### nk_window_is_any_hovered -Returns if the any window is being hovered -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_window_is_any_hovered(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `true(1)` if any window is hovered or `false(0)` otherwise -#### nk_item_is_any_active -Returns if the any window is being hovered or any widget is currently active. -Can be used to decide if input should be processed by UI or your specific input handling. -Example could be UI and 3D camera to move inside a 3D space. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_item_is_any_active(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -Returns `true(1)` if any window is hovered or any item is active or `false(0)` otherwise -#### nk_window_set_bounds -Updates position and size of window with passed in name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_set_bounds(struct nk_context*, const char *name, struct nk_rect bounds); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to modify both position and size -__bounds__ | Must point to a `nk_rect` struct with the new position and size -#### nk_window_set_position -Updates position of window with passed name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_set_position(struct nk_context*, const char *name, struct nk_vec2 pos); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to modify both position -__pos__ | Must point to a `nk_vec2` struct with the new position -#### nk_window_set_size -Updates size of window with passed in name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_set_size(struct nk_context*, const char *name, struct nk_vec2); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to modify both window size -__size__ | Must point to a `nk_vec2` struct with new window size -#### nk_window_set_focus -Sets the window with given name as active -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_set_focus(struct nk_context*, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to set focus on -#### nk_window_set_scroll -Sets the scroll offset for the current window -!!! WARNING - Only call this function between calls `nk_begin_xxx` and `nk_end` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_set_scroll(struct nk_context *ctx, nk_uint offset_x, nk_uint offset_y); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description --------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__offset_x__ | The x offset to scroll to -__offset_y__ | The y offset to scroll to -#### nk_window_close -Closes a window and marks it for being freed at the end of the frame -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_close(struct nk_context *ctx, const char *name); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to close -#### nk_window_collapse -Updates collapse state of a window with given name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_collapse(struct nk_context*, const char *name, enum nk_collapse_states state); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to close -__state__ | value out of nk_collapse_states section -#### nk_window_collapse_if -Updates collapse state of a window with given name if given condition is met -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_collapse_if(struct nk_context*, const char *name, enum nk_collapse_states, int cond); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to either collapse or maximize -__state__ | value out of nk_collapse_states section the window should be put into -__cond__ | condition that has to be met to actually commit the collapse state change -#### nk_window_show -updates visibility state of a window with given name -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_show(struct nk_context*, const char *name, enum nk_show_states); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to either collapse or maximize -__state__ | state with either visible or hidden to modify the window with -#### nk_window_show_if -Updates visibility state of a window with given name if a given condition is met -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_window_show_if(struct nk_context*, const char *name, enum nk_show_states, int cond); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__name__ | Identifier of the window to either hide or show -__state__ | state with either visible or hidden to modify the window with -__cond__ | condition that has to be met to actually commit the visbility state change -### Layouting -Layouting in general describes placing widget inside a window with position and size. -While in this particular implementation there are five different APIs for layouting -each with different trade offs between control and ease of use.

-All layouting methods in this library are based around the concept of a row. -A row has a height the window content grows by and a number of columns and each -layouting method specifies how each widget is placed inside the row. -After a row has been allocated by calling a layouting functions and then -filled with widgets will advance an internal pointer over the allocated row.

-To actually define a layout you just call the appropriate layouting function -and each subsequent widget call will place the widget as specified. Important -here is that if you define more widgets then columns defined inside the layout -functions it will allocate the next row without you having to make another layouting

-call. -Biggest limitation with using all these APIs outside the `nk_layout_space_xxx` API -is that you have to define the row height for each. However the row height -often depends on the height of the font.

-To fix that internally nuklear uses a minimum row height that is set to the -height plus padding of currently active font and overwrites the row height -value if zero.

-If you manually want to change the minimum row height then -use nk_layout_set_min_row_height, and use nk_layout_reset_min_row_height to -reset it back to be derived from font height.

-Also if you change the font in nuklear it will automatically change the minimum -row height for you and. This means if you change the font but still want -a minimum row height smaller than the font you have to repush your value.

-For actually more advanced UI I would even recommend using the `nk_layout_space_xxx` -layouting method in combination with a cassowary constraint solver (there are -some versions on github with permissive license model) to take over all control over widget -layouting yourself. However for quick and dirty layouting using all the other layouting -functions should be fine. -#### Usage -1. __nk_layout_row_dynamic__

- The easiest layouting function is `nk_layout_row_dynamic`. It provides each - widgets with same horizontal space inside the row and dynamically grows - if the owning window grows in width. So the number of columns dictates - the size of each widget dynamically by formula: - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - widget_width = (window_width - padding - spacing) * (1/colum_count) - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Just like all other layouting APIs if you define more widget than columns this - library will allocate a new row and keep all layouting parameters previously - defined. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // first row with height: 30 composed of two widgets - nk_layout_row_dynamic(&ctx, 30, 2); - nk_widget(...); - nk_widget(...); - // - // second row with same parameter as defined above - nk_widget(...); - nk_widget(...); - // - // third row uses 0 for height which will use auto layouting - nk_layout_row_dynamic(&ctx, 0, 2); - nk_widget(...); - nk_widget(...); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -2. __nk_layout_row_static__

- Another easy layouting function is `nk_layout_row_static`. It provides each - widget with same horizontal pixel width inside the row and does not grow - if the owning window scales smaller or bigger. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // first row with height: 30 composed of two widgets with width: 80 - nk_layout_row_static(&ctx, 30, 80, 2); - nk_widget(...); - nk_widget(...); - // - // second row with same parameter as defined above - nk_widget(...); - nk_widget(...); - // - // third row uses 0 for height which will use auto layouting - nk_layout_row_static(&ctx, 0, 80, 2); - nk_widget(...); - nk_widget(...); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -3. __nk_layout_row_xxx__

- A little bit more advanced layouting API are functions `nk_layout_row_begin`, - `nk_layout_row_push` and `nk_layout_row_end`. They allow to directly - specify each column pixel or window ratio in a row. It supports either - directly setting per column pixel width or widget window ratio but not - both. Furthermore it is a immediate mode API so each value is directly - pushed before calling a widget. Therefore the layout is not automatically - repeating like the last two layouting functions. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // first row with height: 25 composed of two widgets with width 60 and 40 - nk_layout_row_begin(ctx, NK_STATIC, 25, 2); - nk_layout_row_push(ctx, 60); - nk_widget(...); - nk_layout_row_push(ctx, 40); - nk_widget(...); - nk_layout_row_end(ctx); - // - // second row with height: 25 composed of two widgets with window ratio 0.25 and 0.75 - nk_layout_row_begin(ctx, NK_DYNAMIC, 25, 2); - nk_layout_row_push(ctx, 0.25f); - nk_widget(...); - nk_layout_row_push(ctx, 0.75f); - nk_widget(...); - nk_layout_row_end(ctx); - // - // third row with auto generated height: composed of two widgets with window ratio 0.25 and 0.75 - nk_layout_row_begin(ctx, NK_DYNAMIC, 0, 2); - nk_layout_row_push(ctx, 0.25f); - nk_widget(...); - nk_layout_row_push(ctx, 0.75f); - nk_widget(...); - nk_layout_row_end(ctx); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -4. __nk_layout_row__

- The array counterpart to API nk_layout_row_xxx is the single nk_layout_row - functions. Instead of pushing either pixel or window ratio for every widget - it allows to define it by array. The trade of for less control is that - `nk_layout_row` is automatically repeating. Otherwise the behavior is the - same. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // two rows with height: 30 composed of two widgets with width 60 and 40 - const float size[] = {60,40}; - nk_layout_row(ctx, NK_STATIC, 30, 2, ratio); - nk_widget(...); - nk_widget(...); - nk_widget(...); - nk_widget(...); - // - // two rows with height: 30 composed of two widgets with window ratio 0.25 and 0.75 - const float ratio[] = {0.25, 0.75}; - nk_layout_row(ctx, NK_DYNAMIC, 30, 2, ratio); - nk_widget(...); - nk_widget(...); - nk_widget(...); - nk_widget(...); - // - // two rows with auto generated height composed of two widgets with window ratio 0.25 and 0.75 - const float ratio[] = {0.25, 0.75}; - nk_layout_row(ctx, NK_DYNAMIC, 30, 2, ratio); - nk_widget(...); - nk_widget(...); - nk_widget(...); - nk_widget(...); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -5. __nk_layout_row_template_xxx__

- The most complex and second most flexible API is a simplified flexbox version without - line wrapping and weights for dynamic widgets. It is an immediate mode API but - unlike `nk_layout_row_xxx` it has auto repeat behavior and needs to be called - before calling the templated widgets. - The row template layout has three different per widget size specifier. The first - one is the `nk_layout_row_template_push_static` with fixed widget pixel width. - They do not grow if the row grows and will always stay the same. - The second size specifier is `nk_layout_row_template_push_variable` - which defines a minimum widget size but it also can grow if more space is available - not taken by other widgets. - Finally there are dynamic widgets with `nk_layout_row_template_push_dynamic` - which are completely flexible and unlike variable widgets can even shrink - to zero if not enough space is provided. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // two rows with height: 30 composed of three widgets - nk_layout_row_template_begin(ctx, 30); - nk_layout_row_template_push_dynamic(ctx); - nk_layout_row_template_push_variable(ctx, 80); - nk_layout_row_template_push_static(ctx, 80); - nk_layout_row_template_end(ctx); - // - // first row - nk_widget(...); // dynamic widget can go to zero if not enough space - nk_widget(...); // variable widget with min 80 pixel but can grow bigger if enough space - nk_widget(...); // static widget with fixed 80 pixel width - // - // second row same layout - nk_widget(...); - nk_widget(...); - nk_widget(...); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -6. __nk_layout_space_xxx__

- Finally the most flexible API directly allows you to place widgets inside the - window. The space layout API is an immediate mode API which does not support - row auto repeat and directly sets position and size of a widget. Position - and size hereby can be either specified as ratio of allocated space or - allocated space local position and pixel size. Since this API is quite - powerful there are a number of utility functions to get the available space - and convert between local allocated space and screen space. - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c - if (nk_begin_xxx(...) { - // static row with height: 500 (you can set column count to INT_MAX if you don't want to be bothered) - nk_layout_space_begin(ctx, NK_STATIC, 500, INT_MAX); - nk_layout_space_push(ctx, nk_rect(0,0,150,200)); - nk_widget(...); - nk_layout_space_push(ctx, nk_rect(200,200,100,200)); - nk_widget(...); - nk_layout_space_end(ctx); - // - // dynamic row with height: 500 (you can set column count to INT_MAX if you don't want to be bothered) - nk_layout_space_begin(ctx, NK_DYNAMIC, 500, INT_MAX); - nk_layout_space_push(ctx, nk_rect(0.5,0.5,0.1,0.1)); - nk_widget(...); - nk_layout_space_push(ctx, nk_rect(0.7,0.6,0.1,0.1)); - nk_widget(...); - } - nk_end(...); - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description -----------------------------------------|------------------------------------ -nk_layout_set_min_row_height | Set the currently used minimum row height to a specified value -nk_layout_reset_min_row_height | Resets the currently used minimum row height to font height -nk_layout_widget_bounds | Calculates current width a static layout row can fit inside a window -nk_layout_ratio_from_pixel | Utility functions to calculate window ratio from pixel size -nk_layout_row_dynamic | Current layout is divided into n same sized growing columns -nk_layout_row_static | Current layout is divided into n same fixed sized columns -nk_layout_row_begin | Starts a new row with given height and number of columns -nk_layout_row_push | Pushes another column with given size or window ratio -nk_layout_row_end | Finished previously started row -nk_layout_row | Specifies row columns in array as either window ratio or size -nk_layout_row_template_begin | Begins the row template declaration -nk_layout_row_template_push_dynamic | Adds a dynamic column that dynamically grows and can go to zero if not enough space -nk_layout_row_template_push_variable | Adds a variable column that dynamically grows but does not shrink below specified pixel width -nk_layout_row_template_push_static | Adds a static column that does not grow and will always have the same size -nk_layout_row_template_end | Marks the end of the row template -nk_layout_space_begin | Begins a new layouting space that allows to specify each widgets position and size -nk_layout_space_push | Pushes position and size of the next widget in own coordinate space either as pixel or ratio -nk_layout_space_end | Marks the end of the layouting space -nk_layout_space_bounds | Callable after nk_layout_space_begin and returns total space allocated -nk_layout_space_to_screen | Converts vector from nk_layout_space coordinate space into screen space -nk_layout_space_to_local | Converts vector from screen space into nk_layout_space coordinates -nk_layout_space_rect_to_screen | Converts rectangle from nk_layout_space coordinate space into screen space -nk_layout_space_rect_to_local | Converts rectangle from screen space into nk_layout_space coordinates -#### nk_layout_set_min_row_height -Sets the currently used minimum row height. -!!! WARNING - The passed height needs to include both your preferred row height - as well as padding. No internal padding is added. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_set_min_row_height(struct nk_context*, float height); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__height__ | New minimum row height to be used for auto generating the row height -#### nk_layout_reset_min_row_height -Reset the currently used minimum row height back to `font_height + text_padding + padding` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_reset_min_row_height(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -#### nk_layout_widget_bounds -Returns the width of the next row allocate by one of the layouting functions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_layout_widget_bounds(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -Return `nk_rect` with both position and size of the next row -#### nk_layout_ratio_from_pixel -Utility functions to calculate window ratio from pixel size -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -float nk_layout_ratio_from_pixel(struct nk_context*, float pixel_width); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__pixel__ | Pixel_width to convert to window ratio -Returns `nk_rect` with both position and size of the next row -#### nk_layout_row_dynamic -Sets current row layout to share horizontal space -between @cols number of widgets evenly. Once called all subsequent widget -calls greater than @cols will allocate a new row with same layout. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_dynamic(struct nk_context *ctx, float height, int cols); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__height__ | Holds height of each widget in row or zero for auto layouting -__columns__ | Number of widget inside row -#### nk_layout_row_static -Sets current row layout to fill @cols number of widgets -in row with same @item_width horizontal size. Once called all subsequent widget -calls greater than @cols will allocate a new row with same layout. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_static(struct nk_context *ctx, float height, int item_width, int cols); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__height__ | Holds height of each widget in row or zero for auto layouting -__width__ | Holds pixel width of each widget in the row -__columns__ | Number of widget inside row -#### nk_layout_row_begin -Starts a new dynamic or fixed row with given height and columns. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_begin(struct nk_context *ctx, enum nk_layout_format fmt, float row_height, int cols); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__fmt__ | either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns -__height__ | holds height of each widget in row or zero for auto layouting -__columns__ | Number of widget inside row -#### nk_layout_row_push -Specifies either window ratio or width of a single column -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_push(struct nk_context*, float value); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__value__ | either a window ratio or fixed width depending on @fmt in previous `nk_layout_row_begin` call -#### nk_layout_row_end -Finished previously started row -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_end(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -#### nk_layout_row -Specifies row columns in array as either window ratio or size -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row(struct nk_context*, enum nk_layout_format, float height, int cols, const float *ratio); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__fmt__ | Either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns -__height__ | Holds height of each widget in row or zero for auto layouting -__columns__ | Number of widget inside row -#### nk_layout_row_template_begin -Begins the row template declaration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_template_begin(struct nk_context*, float row_height); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__height__ | Holds height of each widget in row or zero for auto layouting -#### nk_layout_row_template_push_dynamic -Adds a dynamic column that dynamically grows and can go to zero if not enough space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_template_push_dynamic(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__height__ | Holds height of each widget in row or zero for auto layouting -#### nk_layout_row_template_push_variable -Adds a variable column that dynamically grows but does not shrink below specified pixel width -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_template_push_variable(struct nk_context*, float min_width); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__width__ | Holds the minimum pixel width the next column must always be -#### nk_layout_row_template_push_static -Adds a static column that does not grow and will always have the same size -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_template_push_static(struct nk_context*, float width); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__width__ | Holds the absolute pixel width value the next column must be -#### nk_layout_row_template_end -Marks the end of the row template -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_row_template_end(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -#### nk_layout_space_begin -Begins a new layouting space that allows to specify each widgets position and size. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_space_begin(struct nk_context*, enum nk_layout_format, float height, int widget_count); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_begin_xxx` -__fmt__ | Either `NK_DYNAMIC` for window ratio or `NK_STATIC` for fixed size columns -__height__ | Holds height of each widget in row or zero for auto layouting -__columns__ | Number of widgets inside row -#### nk_layout_space_push -Pushes position and size of the next widget in own coordinate space either as pixel or ratio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_space_push(struct nk_context *ctx, struct nk_rect bounds); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -__bounds__ | Position and size in laoyut space local coordinates -#### nk_layout_space_end -Marks the end of the layout space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_layout_space_end(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -#### nk_layout_space_bounds -Utility function to calculate total space allocated for `nk_layout_space` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_layout_space_bounds(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -Returns `nk_rect` holding the total space allocated -#### nk_layout_space_to_screen -Converts vector from nk_layout_space coordinate space into screen space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_layout_space_to_screen(struct nk_context*, struct nk_vec2); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -__vec__ | Position to convert from layout space into screen coordinate space -Returns transformed `nk_vec2` in screen space coordinates -#### nk_layout_space_to_local -Converts vector from layout space into screen space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_vec2 nk_layout_space_to_local(struct nk_context*, struct nk_vec2); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -__vec__ | Position to convert from screen space into layout coordinate space -Returns transformed `nk_vec2` in layout space coordinates -#### nk_layout_space_rect_to_screen -Converts rectangle from screen space into layout space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_layout_space_rect_to_screen(struct nk_context*, struct nk_rect); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -__bounds__ | Rectangle to convert from layout space into screen space -Returns transformed `nk_rect` in screen space coordinates -#### nk_layout_space_rect_to_local -Converts rectangle from layout space into screen space -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_rect nk_layout_space_rect_to_local(struct nk_context*, struct nk_rect); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after call `nk_layout_space_begin` -__bounds__ | Rectangle to convert from layout space into screen space -Returns transformed `nk_rect` in layout space coordinates -### Groups -Groups are basically windows inside windows. They allow to subdivide space -in a window to layout widgets as a group. Almost all more complex widget -layouting requirements can be solved using groups and basic layouting -fuctionality. Groups just like windows are identified by an unique name and -internally keep track of scrollbar offsets by default. However additional -versions are provided to directly manage the scrollbar. -#### Usage -To create a group you have to call one of the three `nk_group_begin_xxx` -functions to start group declarations and `nk_group_end` at the end. Furthermore it -is required to check the return value of `nk_group_begin_xxx` and only process -widgets inside the window if the value is not 0. -Nesting groups is possible and even encouraged since many layouting schemes -can only be achieved by nesting. Groups, unlike windows, need `nk_group_end` -to be only called if the corosponding `nk_group_begin_xxx` call does not return 0: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -if (nk_group_begin_xxx(ctx, ...) { - // [... widgets ...] - nk_group_end(ctx); -} -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the grand concept groups can be called after starting a window -with `nk_begin_xxx` and before calling `nk_end`: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - // Input - Event evt; - nk_input_begin(&ctx); - while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - nk_input_xxx(...); - } - } - nk_input_end(&ctx); - // - // Window - if (nk_begin_xxx(...) { - // [...widgets...] - nk_layout_row_dynamic(...); - if (nk_group_begin_xxx(ctx, ...) { - //[... widgets ...] - nk_group_end(ctx); - } - } - nk_end(ctx); - // - // Draw - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case ...: - // [...] - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description ---------------------------------|------------------------------------------- -nk_group_begin | Start a new group with internal scrollbar handling -nk_group_begin_titled | Start a new group with separeted name and title and internal scrollbar handling -nk_group_end | Ends a group. Should only be called if nk_group_begin returned non-zero -nk_group_scrolled_offset_begin | Start a new group with manual separated handling of scrollbar x- and y-offset -nk_group_scrolled_begin | Start a new group with manual scrollbar handling -nk_group_scrolled_end | Ends a group with manual scrollbar handling. Should only be called if nk_group_begin returned non-zero -nk_group_get_scroll | Gets the scroll offset for the given group -nk_group_set_scroll | Sets the scroll offset for the given group -#### nk_group_begin -Starts a new widget group. Requires a previous layouting function to specify a pos/size. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_group_begin(struct nk_context*, const char *title, nk_flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__title__ | Must be an unique identifier for this group that is also used for the group header -__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_group_begin_titled -Starts a new widget group. Requires a previous layouting function to specify a pos/size. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_group_begin_titled(struct nk_context*, const char *name, const char *title, nk_flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__id__ | Must be an unique identifier for this group -__title__ | Group header title -__flags__ | Window flags defined in the nk_panel_flags section with a number of different group behaviors -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_group_end -Ends a widget group -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_group_end(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -#### nk_group_scrolled_offset_begin -starts a new widget group. requires a previous layouting function to specify -a size. Does not keep track of scrollbar. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_group_scrolled_offset_begin(struct nk_context*, nk_uint *x_offset, nk_uint *y_offset, const char *title, nk_flags flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__x_offset__| Scrollbar x-offset to offset all widgets inside the group horizontally. -__y_offset__| Scrollbar y-offset to offset all widgets inside the group vertically -__title__ | Window unique group title used to both identify and display in the group header -__flags__ | Window flags from the nk_panel_flags section -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_group_scrolled_begin -Starts a new widget group. requires a previous -layouting function to specify a size. Does not keep track of scrollbar. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_group_scrolled_begin(struct nk_context*, struct nk_scroll *off, const char *title, nk_flags); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__off__ | Both x- and y- scroll offset. Allows for manual scrollbar control -__title__ | Window unique group title used to both identify and display in the group header -__flags__ | Window flags from nk_panel_flags section -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_group_scrolled_end -Ends a widget group after calling nk_group_scrolled_offset_begin or nk_group_scrolled_begin. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_group_scrolled_end(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -#### nk_group_get_scroll -Gets the scroll position of the given group. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_group_get_scroll(struct nk_context*, const char *id, nk_uint *x_offset, nk_uint *y_offset); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description --------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__id__ | The id of the group to get the scroll position of -__x_offset__ | A pointer to the x offset output (or NULL to ignore) -__y_offset__ | A pointer to the y offset output (or NULL to ignore) -#### nk_group_set_scroll -Sets the scroll position of the given group. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_offset, nk_uint y_offset); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description --------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__id__ | The id of the group to scroll -__x_offset__ | The x offset to scroll to -__y_offset__ | The y offset to scroll to -### Tree -Trees represent two different concept. First the concept of a collapsable -UI section that can be either in a hidden or visibile state. They allow the UI -user to selectively minimize the current set of visible UI to comprehend. -The second concept are tree widgets for visual UI representation of trees.

-Trees thereby can be nested for tree representations and multiple nested -collapsable UI sections. All trees are started by calling of the -`nk_tree_xxx_push_tree` functions and ended by calling one of the -`nk_tree_xxx_pop_xxx()` functions. Each starting functions takes a title label -and optionally an image to be displayed and the initial collapse state from -the nk_collapse_states section.

-The runtime state of the tree is either stored outside the library by the caller -or inside which requires a unique ID. The unique ID can either be generated -automatically from `__FILE__` and `__LINE__` with function `nk_tree_push`, -by `__FILE__` and a user provided ID generated for example by loop index with -function `nk_tree_push_id` or completely provided from outside by user with -function `nk_tree_push_hashed`. -#### Usage -To create a tree you have to call one of the seven `nk_tree_xxx_push_xxx` -functions to start a collapsable UI section and `nk_tree_xxx_pop` to mark the -end. -Each starting function will either return `false(0)` if the tree is collapsed -or hidden and therefore does not need to be filled with content or `true(1)` -if visible and required to be filled. -!!! Note - The tree header does not require and layouting function and instead - calculates a auto height based on the currently used font size -The tree ending functions only need to be called if the tree content is -actually visible. So make sure the tree push function is guarded by `if` -and the pop call is only taken if the tree is visible. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -if (nk_tree_push(ctx, NK_TREE_TAB, "Tree", NK_MINIMIZED)) { - nk_layout_row_dynamic(...); - nk_widget(...); - nk_tree_pop(ctx); -} -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description -----------------------------|------------------------------------------- -nk_tree_push | Start a collapsable UI section with internal state management -nk_tree_push_id | Start a collapsable UI section with internal state management callable in a look -nk_tree_push_hashed | Start a collapsable UI section with internal state management with full control over internal unique ID use to store state -nk_tree_image_push | Start a collapsable UI section with image and label header -nk_tree_image_push_id | Start a collapsable UI section with image and label header and internal state management callable in a look -nk_tree_image_push_hashed | Start a collapsable UI section with image and label header and internal state management with full control over internal unique ID use to store state -nk_tree_pop | Ends a collapsable UI section -nk_tree_state_push | Start a collapsable UI section with external state management -nk_tree_state_image_push | Start a collapsable UI section with image and label header and external state management -nk_tree_state_pop | Ends a collapsabale UI section -#### nk_tree_type -Flag | Description -----------------|---------------------------------------- -NK_TREE_NODE | Highlighted tree header to mark a collapsable UI section -NK_TREE_TAB | Non-highighted tree header closer to tree representations -#### nk_tree_push -Starts a collapsable UI section with internal state management -!!! WARNING - To keep track of the runtime tree collapsable state this function uses - defines `__FILE__` and `__LINE__` to generate a unique ID. If you want - to call this function in a loop please use `nk_tree_push_id` or - `nk_tree_push_hashed` instead. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_tree_push(ctx, type, title, state) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_push_id -Starts a collapsable UI section with internal state management callable in a look -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_tree_push_id(ctx, type, title, state, id) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -__id__ | Loop counter index if this function is called in a loop -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_push_hashed -Start a collapsable UI section with internal state management with full -control over internal unique ID used to store state -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -__hash__ | Memory block or string to generate the ID from -__len__ | Size of passed memory block or string in __hash__ -__seed__ | Seeding value if this function is called in a loop or default to `0` -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_image_push -Start a collapsable UI section with image and label header -!!! WARNING - To keep track of the runtime tree collapsable state this function uses - defines `__FILE__` and `__LINE__` to generate a unique ID. If you want - to call this function in a loop please use `nk_tree_image_push_id` or - `nk_tree_image_push_hashed` instead. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_tree_image_push(ctx, type, img, title, state) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__img__ | Image to display inside the header on the left of the label -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_image_push_id -Start a collapsable UI section with image and label header and internal state -management callable in a look -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -#define nk_tree_image_push_id(ctx, type, img, title, state, id) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__img__ | Image to display inside the header on the left of the label -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -__id__ | Loop counter index if this function is called in a loop -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_image_push_hashed -Start a collapsable UI section with internal state management with full -control over internal unique ID used to store state -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__img__ | Image to display inside the header on the left of the label -__title__ | Label printed in the tree header -__state__ | Initial tree state value out of nk_collapse_states -__hash__ | Memory block or string to generate the ID from -__len__ | Size of passed memory block or string in __hash__ -__seed__ | Seeding value if this function is called in a loop or default to `0` -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_pop -Ends a collapsabale UI section -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_tree_pop(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` -#### nk_tree_state_push -Start a collapsable UI section with external state management -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__title__ | Label printed in the tree header -__state__ | Persistent state to update -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_state_image_push -Start a collapsable UI section with image and label header and external state management -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_tree_state_image_push(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states *state); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` -__img__ | Image to display inside the header on the left of the label -__type__ | Value from the nk_tree_type section to visually mark a tree node header as either a collapseable UI section or tree node -__title__ | Label printed in the tree header -__state__ | Persistent state to update -Returns `true(1)` if visible and fillable with widgets or `false(0)` otherwise -#### nk_tree_state_pop -Ends a collapsabale UI section -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_tree_state_pop(struct nk_context*); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description -------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling `nk_tree_xxx_push_xxx` -### Properties -Properties are the main value modification widgets in Nuklear. Changing a value -can be achieved by dragging, adding/removing incremental steps on button click -or by directly typing a number. -#### Usage -Each property requires a unique name for identifaction that is also used for -displaying a label. If you want to use the same name multiple times make sure -add a '#' before your name. The '#' will not be shown but will generate a -unique ID. Each propery also takes in a minimum and maximum value. If you want -to make use of the complete number range of a type just use the provided -type limits from `limits.h`. For example `INT_MIN` and `INT_MAX` for -`nk_property_int` and `nk_propertyi`. In additional each property takes in -a increment value that will be added or subtracted if either the increment -decrement button is clicked. Finally there is a value for increment per pixel -dragged that is added or subtracted from the value. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int value = 0; -struct nk_context ctx; -nk_init_xxx(&ctx, ...); -while (1) { - // Input - Event evt; - nk_input_begin(&ctx); - while (GetEvent(&evt)) { - if (evt.type == MOUSE_MOVE) - nk_input_motion(&ctx, evt.motion.x, evt.motion.y); - else if (evt.type == [...]) { - nk_input_xxx(...); - } - } - nk_input_end(&ctx); - // - // Window - if (nk_begin_xxx(...) { - // Property - nk_layout_row_dynamic(...); - nk_property_int(ctx, "ID", INT_MIN, &value, INT_MAX, 1, 1); - } - nk_end(ctx); - // - // Draw - const struct nk_command *cmd = 0; - nk_foreach(cmd, &ctx) { - switch (cmd->type) { - case NK_COMMAND_LINE: - your_draw_line_function(...) - break; - case NK_COMMAND_RECT - your_draw_rect_function(...) - break; - case ...: - // [...] - } - nk_clear(&ctx); -} -nk_free(&ctx); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#### Reference -Function | Description ---------------------|------------------------------------------- -nk_property_int | Integer property directly modifing a passed in value -nk_property_float | Float property directly modifing a passed in value -nk_property_double | Double property directly modifing a passed in value -nk_propertyi | Integer property returning the modified int value -nk_propertyf | Float property returning the modified float value -nk_propertyd | Double property returning the modified double value -#### nk_property_int -Integer property directly modifing a passed in value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_property_int(struct nk_context *ctx, const char *name, int min, int *val, int max, int step, float inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Integer pointer to be modified -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -#### nk_property_float -Float property directly modifing a passed in value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_property_float(struct nk_context *ctx, const char *name, float min, float *val, float max, float step, float inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Float pointer to be modified -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -#### nk_property_double -Double property directly modifing a passed in value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -void nk_property_double(struct nk_context *ctx, const char *name, double min, double *val, double max, double step, double inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Double pointer to be modified -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -#### nk_propertyi -Integer property modifing a passed in value and returning the new value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -int nk_propertyi(struct nk_context *ctx, const char *name, int min, int val, int max, int step, float inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Current integer value to be modified and returned -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -Returns the new modified integer value -#### nk_propertyf -Float property modifing a passed in value and returning the new value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -float nk_propertyf(struct nk_context *ctx, const char *name, float min, float val, float max, float step, float inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Current float value to be modified and returned -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -Returns the new modified float value -#### nk_propertyd -Float property modifing a passed in value and returning the new value -!!! WARNING - To generate a unique property ID using the same label make sure to insert - a `#` at the beginning. It will not be shown but guarantees correct behavior. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c -float nk_propertyd(struct nk_context *ctx, const char *name, double min, double val, double max, double step, double inc_per_pixel); -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Parameter | Description ---------------------|----------------------------------------------------------- -__ctx__ | Must point to an previously initialized `nk_context` struct after calling a layouting function -__name__ | String used both as a label as well as a unique identifier -__min__ | Minimum value not allowed to be underflown -__val__ | Current double value to be modified and returned -__max__ | Maximum value not allowed to be overflown -__step__ | Increment added and subtracted on increment and decrement button -__inc_per_pixel__ | Value per pixel added or subtracted on dragging -Returns the new modified double value - -XXX.XXX- X...X - X...X -X....X - X....X" -X...XXXXXXXXXXXXX...X - " -## License -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none - ------------------------------------------------------------------------------ - This software is available under 2 licenses -- choose whichever you prefer. - ------------------------------------------------------------------------------ - ALTERNATIVE A - MIT License - Copyright (c) 2016-2018 Micha Mettke - Permission is hereby granted, free of charge, to any person obtaining a copy of - this software and associated documentation files (the "Software"), to deal in - the Software without restriction, including without limitation the rights to - use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies - of the Software, and to permit persons to whom the Software is furnished to do - so, subject to the following conditions: - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. - ------------------------------------------------------------------------------ - ALTERNATIVE B - Public Domain (www.unlicense.org) - This is free and unencumbered software released into the public domain. - Anyone is free to copy, modify, publish, use, compile, sell, or distribute this - software, either in source code form or as a compiled binary, for any purpose, - commercial or non-commercial, and by any means. - In jurisdictions that recognize copyright laws, the author or authors of this - software dedicate any and all copyright interest in the software to the public - domain. We make this dedication for the benefit of the public at large and to - the detriment of our heirs and successors. We intend this dedication to be an - overt act of relinquishment in perpetuity of all present and future rights to - this software under copyright law. - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN - ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION - WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ------------------------------------------------------------------------------ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -## Changelog -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none -[date][x.yy.zz]-[description] --[date]: date on which the change has been pushed --[x.yy.zz]: Numerical version string representation. Each version number on the right - resets back to zero if version on the left is incremented. - - [x]: Major version with API and library breaking changes - - [yy]: Minor version with non-breaking API and library changes - - [zz]: Bug fix version with no direct changes to API -- 2020/04/09 (4.02.1) - Removed unused nk_sqrt function to fix compiler warnings - - Fixed compiler warnings if you bring your own methods for - nk_cos/nk_sin/nk_strtod/nk_memset/nk_memcopy/nk_dtoa -- 2020/04/06 (4.01.10) - Fix bug: Do not use pool before checking for NULL -- 2020/03/22 (4.01.9) - Fix bug where layout state wasn't restored correctly after - popping a tree. -- 2020/03/11 (4.01.8) - Fix bug where padding is subtracted from widget -- 2020/03/06 (4.01.7) - Fix bug where width padding was applied twice -- 2020/02/06 (4.01.6) - Update stb_truetype.h and stb_rect_pack.h and separate them -- 2019/12/10 (4.01.5) - Fix off-by-one error in NK_INTERSECT -- 2019/10/09 (4.01.4) - Fix bug for autoscrolling in nk_do_edit -- 2019/09/20 (4.01.3) - Fixed a bug wherein combobox cannot be closed by clicking the header - when NK_BUTTON_TRIGGER_ON_RELEASE is defined. -- 2019/09/10 (4.01.2) - Fixed the nk_cos function, which deviated significantly. -- 2019/09/08 (4.01.1) - Fixed a bug wherein re-baking of fonts caused a segmentation - fault due to dst_font->glyph_count not being zeroed on subsequent - bakes of the same set of fonts. -- 2019/06/23 (4.01.0) - Added nk_***_get_scroll and nk_***_set_scroll for groups, windows, and popups. -- 2019/06/12 (4.00.3) - Fix panel background drawing bug. -- 2018/10/31 (4.00.2) - Added NK_KEYSTATE_BASED_INPUT to "fix" state based backends - like GLFW without breaking key repeat behavior on event based. -- 2018/04/01 (4.00.1) - Fixed calling `nk_convert` multiple time per single frame. -- 2018/04/01 (4.00.0) - BREAKING CHANGE: nk_draw_list_clear no longer tries to - clear provided buffers. So make sure to either free - or clear each passed buffer after calling nk_convert. -- 2018/02/23 (3.00.6) - Fixed slider dragging behavior. -- 2018/01/31 (3.00.5) - Fixed overcalculation of cursor data in font baking process. -- 2018/01/31 (3.00.4) - Removed name collision with stb_truetype. -- 2018/01/28 (3.00.3) - Fixed panel window border drawing bug. -- 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separed group identifier and title. -- 2018/01/07 (3.00.1) - Started to change documentation style. -- 2018/01/05 (3.00.0) - BREAKING CHANGE: The previous color picker API was broken - because of conversions between float and byte color representation. - Color pickers now use floating point values to represent - HSV values. To get back the old behavior I added some additional - color conversion functions to cast between nk_color and - nk_colorf. -- 2017/12/23 (2.00.7) - Fixed small warning. -- 2017/12/23 (2.00.7) - Fixed `nk_edit_buffer` behavior if activated to allow input. -- 2017/12/23 (2.00.7) - Fixed modifyable progressbar dragging visuals and input behavior. -- 2017/12/04 (2.00.6) - Added formated string tooltip widget. -- 2017/11/18 (2.00.5) - Fixed window becoming hidden with flag `NK_WINDOW_NO_INPUT`. -- 2017/11/15 (2.00.4) - Fixed font merging. -- 2017/11/07 (2.00.3) - Fixed window size and position modifier functions. -- 2017/09/14 (2.00.2) - Fixed `nk_edit_buffer` and `nk_edit_focus` behavior. -- 2017/09/14 (2.00.1) - Fixed window closing behavior. -- 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifing window position and size funtions now - require the name of the window and must happen outside the window - building process (between function call nk_begin and nk_end). -- 2017/09/11 (1.40.9) - Fixed window background flag if background window is declared last. -- 2017/08/27 (1.40.8) - Fixed `nk_item_is_any_active` for hidden windows. -- 2017/08/27 (1.40.7) - Fixed window background flag. -- 2017/07/07 (1.40.6) - Fixed missing clipping rect check for hovering/clicked - query for widgets. -- 2017/07/07 (1.40.5) - Fixed drawing bug for vertex output for lines and stroked - and filled rectangles. -- 2017/07/07 (1.40.4) - Fixed bug in nk_convert trying to add windows that are in - process of being destroyed. -- 2017/07/07 (1.40.3) - Fixed table internal bug caused by storing table size in - window instead of directly in table. -- 2017/06/30 (1.40.2) - Removed unneeded semicolon in C++ NK_ALIGNOF macro. -- 2017/06/30 (1.40.1) - Fixed drawing lines smaller or equal zero. -- 2017/06/08 (1.40.0) - Removed the breaking part of last commit. Auto layout now only - comes in effect if you pass in zero was row height argument. -- 2017/06/08 (1.40.0) - BREAKING CHANGE: while not directly API breaking it will change - how layouting works. From now there will be an internal minimum - row height derived from font height. If you need a row smaller than - that you can directly set it by `nk_layout_set_min_row_height` and - reset the value back by calling `nk_layout_reset_min_row_height. -- 2017/06/08 (1.39.1) - Fixed property text edit handling bug caused by past `nk_widget` fix. -- 2017/06/08 (1.39.0) - Added function to retrieve window space without calling a `nk_layout_xxx` function. -- 2017/06/06 (1.38.5) - Fixed `nk_convert` return flag for command buffer. -- 2017/05/23 (1.38.4) - Fixed activation behavior for widgets partially clipped. -- 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundries. -- 2017/05/09 (1.38.2) - Fixed vertical scrollbar drawing with not enough space. -- 2017/05/09 (1.38.1) - Fixed scaler dragging behavior if window size hits minimum size. -- 2017/05/06 (1.38.0) - Added platform double-click support. -- 2017/04/20 (1.37.1) - Fixed key repeat found inside glfw demo backends. -- 2017/04/20 (1.37.0) - Extended properties with selection and clipboard support. -- 2017/04/20 (1.36.2) - Fixed #405 overlapping rows with zero padding and spacing. -- 2017/04/09 (1.36.1) - Fixed #403 with another widget float error. -- 2017/04/09 (1.36.0) - Added window `NK_WINDOW_NO_INPUT` and `NK_WINDOW_NOT_INTERACTIVE` flags. -- 2017/04/09 (1.35.3) - Fixed buffer heap corruption. -- 2017/03/25 (1.35.2) - Fixed popup overlapping for `NK_WINDOW_BACKGROUND` windows. -- 2017/03/25 (1.35.1) - Fixed windows closing behavior. -- 2017/03/18 (1.35.0) - Added horizontal scroll requested in #377. -- 2017/03/18 (1.34.3) - Fixed long window header titles. -- 2017/03/04 (1.34.2) - Fixed text edit filtering. -- 2017/03/04 (1.34.1) - Fixed group closable flag. -- 2017/02/25 (1.34.0) - Added custom draw command for better language binding support. -- 2017/01/24 (1.33.0) - Added programatic way of remove edit focus. -- 2017/01/24 (1.32.3) - Fixed wrong define for basic type definitions for windows. -- 2017/01/21 (1.32.2) - Fixed input capture from hidden or closed windows. -- 2017/01/21 (1.32.1) - Fixed slider behavior and drawing. -- 2017/01/13 (1.32.0) - Added flag to put scaler into the bottom left corner. -- 2017/01/13 (1.31.0) - Added additional row layouting method to combine both - dynamic and static widgets. -- 2016/12/31 (1.30.0) - Extended scrollbar offset from 16-bit to 32-bit. -- 2016/12/31 (1.29.2) - Fixed closing window bug of minimized windows. -- 2016/12/03 (1.29.1) - Fixed wrapped text with no seperator and C89 error. -- 2016/12/03 (1.29.0) - Changed text wrapping to process words not characters. -- 2016/11/22 (1.28.6) - Fixed window minimized closing bug. -- 2016/11/19 (1.28.5) - Fixed abstract combo box closing behavior. -- 2016/11/19 (1.28.4) - Fixed tooltip flickering. -- 2016/11/19 (1.28.3) - Fixed memory leak caused by popup repeated closing. -- 2016/11/18 (1.28.2) - Fixed memory leak caused by popup panel allocation. -- 2016/11/10 (1.28.1) - Fixed some warnings and C++ error. -- 2016/11/10 (1.28.0) - Added additional `nk_button` versions which allows to directly - pass in a style struct to change buttons visual. -- 2016/11/10 (1.27.0) - Added additional `nk_tree` versions to support external state - storage. Just like last the `nk_group` commit the main - advantage is that you optionally can minimize nuklears runtime - memory consumption or handle hash collisions. -- 2016/11/09 (1.26.0) - Added additional `nk_group` version to support external scrollbar - offset storage. Main advantage is that you can externalize - the memory management for the offset. It could also be helpful - if you have a hash collision in `nk_group_begin` but really - want the name. In addition I added `nk_list_view` which allows - to draw big lists inside a group without actually having to - commit the whole list to nuklear (issue #269). -- 2016/10/30 (1.25.1) - Fixed clipping rectangle bug inside `nk_draw_list`. -- 2016/10/29 (1.25.0) - Pulled `nk_panel` memory management into nuklear and out of - the hands of the user. From now on users don't have to care - about panels unless they care about some information. If you - still need the panel just call `nk_window_get_panel`. -- 2016/10/21 (1.24.0) - Changed widget border drawing to stroked rectangle from filled - rectangle for less overdraw and widget background transparency. -- 2016/10/18 (1.23.0) - Added `nk_edit_focus` for manually edit widget focus control. -- 2016/09/29 (1.22.7) - Fixed deduction of basic type in non `` compilation. -- 2016/09/29 (1.22.6) - Fixed edit widget UTF-8 text cursor drawing bug. -- 2016/09/28 (1.22.5) - Fixed edit widget UTF-8 text appending/inserting/removing. -- 2016/09/28 (1.22.4) - Fixed drawing bug inside edit widgets which offset all text - text in every edit widget if one of them is scrolled. -- 2016/09/28 (1.22.3) - Fixed small bug in edit widgets if not active. The wrong - text length is passed. It should have been in bytes but - was passed as glyphes. -- 2016/09/20 (1.22.2) - Fixed color button size calculation. -- 2016/09/20 (1.22.1) - Fixed some `nk_vsnprintf` behavior bugs and removed `` - again from `NK_INCLUDE_STANDARD_VARARGS`. -- 2016/09/18 (1.22.0) - C89 does not support vsnprintf only C99 and newer as well - as C++11 and newer. In addition to use vsnprintf you have - to include . So just defining `NK_INCLUDE_STD_VAR_ARGS` - is not enough. That behavior is now fixed. By default if - both varargs as well as stdio is selected I try to use - vsnprintf if not possible I will revert to vsprintf. If - varargs but not stdio was defined I will use my own function. -- 2016/09/15 (1.21.2) - Fixed panel `close` behavior for deeper panel levels. -- 2016/09/15 (1.21.1) - Fixed C++ errors and wrong argument to `nk_panel_get_xxxx`. -- 2016/09/13 (1.21.0) - !BREAKING! Fixed nonblocking popup behavior in menu, combo, - and contextual which prevented closing in y-direction if - popup did not reach max height. - In addition the height parameter was changed into vec2 - for width and height to have more control over the popup size. -- 2016/09/13 (1.20.3) - Cleaned up and extended type selection. -- 2016/09/13 (1.20.2) - Fixed slider behavior hopefully for the last time. This time - all calculation are correct so no more hackery. -- 2016/09/13 (1.20.1) - Internal change to divide window/panel flags into panel flags and types. - Suprisinly spend years in C and still happened to confuse types - with flags. Probably something to take note. -- 2016/09/08 (1.20.0) - Added additional helper function to make it easier to just - take the produced buffers from `nk_convert` and unplug the - iteration process from `nk_context`. So now you can - just use the vertex,element and command buffer + two pointer - inside the command buffer retrieved by calls `nk__draw_begin` - and `nk__draw_end` and macro `nk_draw_foreach_bounded`. -- 2016/09/08 (1.19.0) - Added additional asserts to make sure every `nk_xxx_begin` call - for windows, popups, combobox, menu and contextual is guarded by - `if` condition and does not produce false drawing output. -- 2016/09/08 (1.18.0) - Changed confusing name for `NK_SYMBOL_RECT_FILLED`, `NK_SYMBOL_RECT` - to hopefully easier to understand `NK_SYMBOL_RECT_FILLED` and - `NK_SYMBOL_RECT_OUTLINE`. -- 2016/09/08 (1.17.0) - Changed confusing name for `NK_SYMBOL_CIRLCE_FILLED`, `NK_SYMBOL_CIRCLE` - to hopefully easier to understand `NK_SYMBOL_CIRCLE_FILLED` and - `NK_SYMBOL_CIRCLE_OUTLINE`. -- 2016/09/08 (1.16.0) - Added additional checks to select correct types if `NK_INCLUDE_FIXED_TYPES` - is not defined by supporting the biggest compiler GCC, clang and MSVC. -- 2016/09/07 (1.15.3) - Fixed `NK_INCLUDE_COMMAND_USERDATA` define to not cause an error. -- 2016/09/04 (1.15.2) - Fixed wrong combobox height calculation. -- 2016/09/03 (1.15.1) - Fixed gaps inside combo boxes in OpenGL. -- 2016/09/02 (1.15.0) - Changed nuklear to not have any default vertex layout and - instead made it user provided. The range of types to convert - to is quite limited at the moment, but I would be more than - happy to accept PRs to add additional. -- 2016/08/30 (1.14.2) - Removed unused variables. -- 2016/08/30 (1.14.1) - Fixed C++ build errors. -- 2016/08/30 (1.14.0) - Removed mouse dragging from SDL demo since it does not work correctly. -- 2016/08/30 (1.13.4) - Tweaked some default styling variables. -- 2016/08/30 (1.13.3) - Hopefully fixed drawing bug in slider, in general I would - refrain from using slider with a big number of steps. -- 2016/08/30 (1.13.2) - Fixed close and minimize button which would fire even if the - window was in Read Only Mode. -- 2016/08/30 (1.13.1) - Fixed popup panel padding handling which was previously just - a hack for combo box and menu. -- 2016/08/30 (1.13.0) - Removed `NK_WINDOW_DYNAMIC` flag from public API since - it is bugged and causes issues in window selection. -- 2016/08/30 (1.12.0) - Removed scaler size. The size of the scaler is now - determined by the scrollbar size. -- 2016/08/30 (1.11.2) - Fixed some drawing bugs caused by changes from 1.11.0. -- 2016/08/30 (1.11.1) - Fixed overlapping minimized window selection. -- 2016/08/30 (1.11.0) - Removed some internal complexity and overly complex code - handling panel padding and panel border. -- 2016/08/29 (1.10.0) - Added additional height parameter to `nk_combobox_xxx`. -- 2016/08/29 (1.10.0) - Fixed drawing bug in dynamic popups. -- 2016/08/29 (1.10.0) - Added experimental mouse scrolling to popups, menus and comboboxes. -- 2016/08/26 (1.10.0) - Added window name string prepresentation to account for - hash collisions. Currently limited to `NK_WINDOW_MAX_NAME` - which in term can be redefined if not big enough. -- 2016/08/26 (1.10.0) - Added stacks for temporary style/UI changes in code. -- 2016/08/25 (1.10.0) - Changed `nk_input_is_key_pressed` and 'nk_input_is_key_released' - to account for key press and release happening in one frame. -- 2016/08/25 (1.10.0) - Added additional nk_edit flag to directly jump to the end on activate. -- 2016/08/17 (1.09.6) - Removed invalid check for value zero in `nk_propertyx`. -- 2016/08/16 (1.09.5) - Fixed ROM mode for deeper levels of popup windows parents. -- 2016/08/15 (1.09.4) - Editbox are now still active if enter was pressed with flag - `NK_EDIT_SIG_ENTER`. Main reasoning is to be able to keep - typing after commiting. -- 2016/08/15 (1.09.4) - Removed redundant code. -- 2016/08/15 (1.09.4) - Fixed negative numbers in `nk_strtoi` and remove unused variable. -- 2016/08/15 (1.09.3) - Fixed `NK_WINDOW_BACKGROUND` flag behavior to select a background - window only as selected by hovering and not by clicking. -- 2016/08/14 (1.09.2) - Fixed a bug in font atlas which caused wrong loading - of glyphes for font with multiple ranges. -- 2016/08/12 (1.09.1) - Added additional function to check if window is currently - hidden and therefore not visible. -- 2016/08/12 (1.09.1) - nk_window_is_closed now queries the correct flag `NK_WINDOW_CLOSED` - instead of the old flag `NK_WINDOW_HIDDEN`. -- 2016/08/09 (1.09.0) - Added additional double version to nk_property and changed - the underlying implementation to not cast to float and instead - work directly on the given values. -- 2016/08/09 (1.08.0) - Added additional define to overwrite library internal - floating pointer number to string conversion for additional - precision. -- 2016/08/09 (1.08.0) - Added additional define to overwrite library internal - string to floating point number conversion for additional - precision. -- 2016/08/08 (1.07.2) - Fixed compiling error without define `NK_INCLUDE_FIXED_TYPE`. -- 2016/08/08 (1.07.1) - Fixed possible floating point error inside `nk_widget` leading - to wrong wiget width calculation which results in widgets falsly - becomming tagged as not inside window and cannot be accessed. -- 2016/08/08 (1.07.0) - Nuklear now differentiates between hiding a window (NK_WINDOW_HIDDEN) and - closing a window (NK_WINDOW_CLOSED). A window can be hidden/shown - by using `nk_window_show` and closed by either clicking the close - icon in a window or by calling `nk_window_close`. Only closed - windows get removed at the end of the frame while hidden windows - remain. -- 2016/08/08 (1.06.0) - Added `nk_edit_string_zero_terminated` as a second option to - `nk_edit_string` which takes, edits and outputs a '\0' terminated string. -- 2016/08/08 (1.05.4) - Fixed scrollbar auto hiding behavior. -- 2016/08/08 (1.05.3) - Fixed wrong panel padding selection in `nk_layout_widget_space`. -- 2016/08/07 (1.05.2) - Fixed old bug in dynamic immediate mode layout API, calculating - wrong item spacing and panel width. -- 2016/08/07 (1.05.1) - Hopefully finally fixed combobox popup drawing bug. -- 2016/08/07 (1.05.0) - Split varargs away from `NK_INCLUDE_STANDARD_IO` into own - define `NK_INCLUDE_STANDARD_VARARGS` to allow more fine - grained controlled over library includes. -- 2016/08/06 (1.04.5) - Changed memset calls to `NK_MEMSET`. -- 2016/08/04 (1.04.4) - Fixed fast window scaling behavior. -- 2016/08/04 (1.04.3) - Fixed window scaling, movement bug which appears if you - move/scale a window and another window is behind it. - If you are fast enough then the window behind gets activated - and the operation is blocked. I now require activating - by hovering only if mouse is not pressed. -- 2016/08/04 (1.04.2) - Fixed changing fonts. -- 2016/08/03 (1.04.1) - Fixed `NK_WINDOW_BACKGROUND` behavior. -- 2016/08/03 (1.04.0) - Added color parameter to `nk_draw_image`. -- 2016/08/03 (1.04.0) - Added additional window padding style attributes for - sub windows (combo, menu, ...). -- 2016/08/03 (1.04.0) - Added functions to show/hide software cursor. -- 2016/08/03 (1.04.0) - Added `NK_WINDOW_BACKGROUND` flag to force a window - to be always in the background of the screen. -- 2016/08/03 (1.03.2) - Removed invalid assert macro for NK_RGB color picker. -- 2016/08/01 (1.03.1) - Added helper macros into header include guard. -- 2016/07/29 (1.03.0) - Moved the window/table pool into the header part to - simplify memory management by removing the need to - allocate the pool. -- 2016/07/29 (1.02.0) - Added auto scrollbar hiding window flag which if enabled - will hide the window scrollbar after NK_SCROLLBAR_HIDING_TIMEOUT - seconds without window interaction. To make it work - you have to also set a delta time inside the `nk_context`. -- 2016/07/25 (1.01.1) - Fixed small panel and panel border drawing bugs. -- 2016/07/15 (1.01.0) - Added software cursor to `nk_style` and `nk_context`. -- 2016/07/15 (1.01.0) - Added const correctness to `nk_buffer_push' data argument. -- 2016/07/15 (1.01.0) - Removed internal font baking API and simplified - font atlas memory management by converting pointer - arrays for fonts and font configurations to lists. -- 2016/07/15 (1.00.0) - Changed button API to use context dependend button - behavior instead of passing it for every function call. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -## Gallery -![Figure [blue]: Feature overview with blue color styling](https://cloud.githubusercontent.com/assets/8057201/13538240/acd96876-e249-11e5-9547-5ac0b19667a0.png) -![Figure [red]: Feature overview with red color styling](https://cloud.githubusercontent.com/assets/8057201/13538243/b04acd4c-e249-11e5-8fd2-ad7744a5b446.png) -![Figure [widgets]: Widget overview](https://cloud.githubusercontent.com/assets/8057201/11282359/3325e3c6-8eff-11e5-86cb-cf02b0596087.png) -![Figure [blackwhite]: Black and white](https://cloud.githubusercontent.com/assets/8057201/11033668/59ab5d04-86e5-11e5-8091-c56f16411565.png) -![Figure [filexp]: File explorer](https://cloud.githubusercontent.com/assets/8057201/10718115/02a9ba08-7b6b-11e5-950f-adacdd637739.png) -![Figure [opengl]: OpenGL Editor](https://cloud.githubusercontent.com/assets/8057201/12779619/2a20d72c-ca69-11e5-95fe-4edecf820d5c.png) -![Figure [nodedit]: Node Editor](https://cloud.githubusercontent.com/assets/8057201/9976995/e81ac04a-5ef7-11e5-872b-acd54fbeee03.gif) -![Figure [skinning]: Using skinning in Nuklear](https://cloud.githubusercontent.com/assets/8057201/15991632/76494854-30b8-11e6-9555-a69840d0d50b.png) -![Figure [bf]: Heavy modified version](https://cloud.githubusercontent.com/assets/8057201/14902576/339926a8-0d9c-11e6-9fee-a8b73af04473.png) -## Credits -Developed by Micha Mettke and every direct or indirect github contributor.

-Embeds [stb_texedit](https://github.com/nothings/stb/blob/master/stb_textedit.h), [stb_truetype](https://github.com/nothings/stb/blob/master/stb_truetype.h) and [stb_rectpack](https://github.com/nothings/stb/blob/master/stb_rect_pack.h) by Sean Barret (public domain)
-Uses [stddoc.c](https://github.com/r-lyeh/stddoc.c) from r-lyeh@github.com for documentation generation

-Embeds ProggyClean.ttf font by Tristan Grimmer (MIT license).
-Big thank you to Omar Cornut (ocornut@github) for his [imgui library](https://github.com/ocornut/imgui) and -giving me the inspiration for this library, Casey Muratori for handmade hero -and his original immediate mode graphical user interface idea and Sean -Barret for his amazing single header libraries which restored my faith -in libraries and brought me to create some of my own. Finally Apoorva Joshi -for his single header file packer. - - + + + + + + +

If you are not redirected in five seconds, click here.

+ + diff --git a/doc/stddoc.c b/doc/stddoc.c index 461ddc1..2f7661a 100644 --- a/doc/stddoc.c +++ b/doc/stddoc.c @@ -71,7 +71,7 @@ int main() { /// 1. Numbered /// 1. List! /// -/// Symbol substitutions: a 45-degree turn; som x -> y arrows; some whoa ==> fancy <==> arrows. +/// Symbol substitutions: a 45-degree turn; some x -> y arrows; some whoa ==> fancy <==> arrows. /// /// Is this a definition list? /// : Looks like one to me diff --git a/example/Makefile b/example/Makefile index 7d99d77..1f24aea 100644 --- a/example/Makefile +++ b/example/Makefile @@ -1,5 +1,5 @@ # Flags -CFLAGS += -std=c99 -pedantic -O2 +CFLAGS += -std=c99 -Wall -Wextra -pedantic -Wno-misleading-indentation -Wno-shift-negative-value -O2 LIBS := ifeq ($(OS),Windows_NT) diff --git a/example/canvas.c b/example/canvas.c index ed7d833..2456927 100644 --- a/example/canvas.c +++ b/example/canvas.c @@ -52,7 +52,7 @@ struct nk_glfw_vertex { struct device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -65,6 +65,8 @@ struct device { GLuint font_tex; }; +/* function icon_load () is not used to build this file but might still be useful :) */ +/* static void die(const char *fmt, ...) { @@ -76,26 +78,24 @@ die(const char *fmt, ...) exit(EXIT_FAILURE); } -/* function icon_load () is not used to build this file but might still be useful :) */ -/* -static struct nk_image -icon_load(const char *filename) -{ - int x,y,n; - GLuint tex; - unsigned char *data = stbi_load(filename, &x, &y, &n, 0); - if (!data) die("[SDL]: failed to load image: %s", filename); +static struct nk_image +icon_load(const char *filename) +{ + int x,y,n; + GLuint tex; + unsigned char *data = stbi_load(filename, &x, &y, &n, 0); + if (!data) die("[SDL]: failed to load image: %s", filename); - glGenTextures(1, &tex); - glBindTexture(GL_TEXTURE_2D, tex); - glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_NEAREST); - glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR_MIPMAP_NEAREST); - glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); - glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); - glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, x, y, 0, GL_RGBA, GL_UNSIGNED_BYTE, data); - glGenerateMipmap(GL_TEXTURE_2D); - stbi_image_free(data); - return nk_image_id((int)tex); + glGenTextures(1, &tex); + glBindTexture(GL_TEXTURE_2D, tex); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR_MIPMAP_NEAREST); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR_MIPMAP_NEAREST); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE); + glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE); + glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, x, y, 0, GL_RGBA, GL_UNSIGNED_BYTE, data); + glGenerateMipmap(GL_TEXTURE_2D); + stbi_image_free(data); + return nk_image_id((int)tex); } */ @@ -262,7 +262,7 @@ device_draw(struct device *dev, struct nk_context *ctx, int width, int height, config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -404,6 +404,9 @@ int main(int argc, char *argv[]) struct nk_font_atlas atlas; struct nk_context ctx; + NK_UNUSED(argc); + NK_UNUSED(argv); + /* GLFW */ glfwSetErrorCallback(error_callback); if (!glfwInit()) { @@ -438,7 +441,7 @@ int main(int argc, char *argv[]) font = nk_font_atlas_add_default(&atlas, 13, 0); image = nk_font_atlas_bake(&atlas, &w, &h, NK_FONT_ATLAS_RGBA32); device_upload_atlas(&device, image, w, h); - nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.null); + nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.tex_null); nk_init_default(&ctx, &font->handle); glEnable(GL_TEXTURE_2D); diff --git a/example/extended.c b/example/extended.c index 38be5f6..4e1211b 100644 --- a/example/extended.c +++ b/example/extended.c @@ -478,7 +478,7 @@ struct nk_glfw_vertex { struct device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -685,7 +685,7 @@ device_draw(struct device *dev, struct nk_context *ctx, int width, int height, config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -748,6 +748,9 @@ int main(int argc, char *argv[]) struct media media; struct nk_context ctx; + NK_UNUSED(argc); + NK_UNUSED(argv); + /* GLFW */ glfwSetErrorCallback(error_callback); if (!glfwInit()) { @@ -792,7 +795,7 @@ int main(int argc, char *argv[]) media.font_22 = nk_font_atlas_add_from_file(&atlas, "../../extra_font/Roboto-Regular.ttf", 22.0f, &cfg); image = nk_font_atlas_bake(&atlas, &w, &h, NK_FONT_ATLAS_RGBA32); device_upload_atlas(&device, image, w, h); - nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.null);} + nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.tex_null);} nk_init_default(&ctx, &media.font_14->handle);} /* icons */ diff --git a/example/file_browser.c b/example/file_browser.c index d77615d..6bf23c2 100644 --- a/example/file_browser.c +++ b/example/file_browser.c @@ -149,6 +149,7 @@ die(const char *fmt, ...) exit(EXIT_FAILURE); } +#if 0 static char* file_load(const char* path, size_t* siz) { @@ -163,6 +164,7 @@ file_load(const char* path, size_t* siz) fclose(fd); return buf; } +#endif static char* str_duplicate(const char *src) @@ -200,6 +202,7 @@ dir_list(const char *dir, int return_subdirs, size_t *count) assert(dir); assert(count); strncpy(buffer, dir, MAX_PATH_LEN); + buffer[MAX_PATH_LEN - 1] = 0; n = strlen(buffer); if (n > 0 && (buffer[n-1] != '/')) @@ -343,6 +346,7 @@ static void file_browser_reload_directory_content(struct file_browser *browser, const char *path) { strncpy(browser->directory, path, MAX_PATH_LEN); + browser->directory[MAX_PATH_LEN - 1] = 0; dir_free_list(browser->files, browser->file_count); dir_free_list(browser->directories, browser->dir_count); browser->files = dir_list(path, 0, &browser->file_count); @@ -364,6 +368,7 @@ file_browser_init(struct file_browser *browser, struct media *media) { size_t l; strncpy(browser->home, home, MAX_PATH_LEN); + browser->home[MAX_PATH_LEN - 1] = 0; l = strlen(browser->home); strcpy(browser->home + l, "/"); strcpy(browser->directory, browser->home); @@ -522,7 +527,7 @@ struct nk_glfw_vertex { struct device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -717,7 +722,7 @@ device_draw(struct device *dev, struct nk_context *ctx, int width, int height, config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -818,7 +823,7 @@ int main(int argc, char *argv[]) else font = nk_font_atlas_add_default(&atlas, 13.0f, NULL); image = nk_font_atlas_bake(&atlas, &w, &h, NK_FONT_ATLAS_RGBA32); device_upload_atlas(&device, image, w, h); - nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.null);} + nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.tex_null);} nk_init_default(&ctx, &font->handle);} /* icons */ diff --git a/example/skinning.c b/example/skinning.c index 84c4bf6..fab9ce3 100644 --- a/example/skinning.c +++ b/example/skinning.c @@ -79,7 +79,7 @@ struct nk_glfw_vertex { struct device { struct nk_buffer cmds; - struct nk_draw_null_texture null; + struct nk_draw_null_texture tex_null; GLuint vbo, vao, ebo; GLuint prog; GLuint vert_shdr; @@ -286,7 +286,7 @@ device_draw(struct device *dev, struct nk_context *ctx, int width, int height, config.vertex_layout = vertex_layout; config.vertex_size = sizeof(struct nk_glfw_vertex); config.vertex_alignment = NK_ALIGNOF(struct nk_glfw_vertex); - config.null = dev->null; + config.tex_null = dev->tex_null; config.circle_segment_count = 22; config.curve_segment_count = 22; config.arc_segment_count = 22; @@ -388,7 +388,7 @@ int main(int argc, char *argv[]) else font = nk_font_atlas_add_default(&atlas, 13.0f, NULL); image = nk_font_atlas_bake(&atlas, &w, &h, NK_FONT_ATLAS_RGBA32); device_upload_atlas(&device, image, w, h); - nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.null);} + nk_font_atlas_end(&atlas, nk_handle_id((int)device.font_tex), &device.tex_null);} nk_init_default(&ctx, &font->handle);} { /* skin */ @@ -733,7 +733,6 @@ int main(int argc, char *argv[]) nk_input_end(&ctx);} /* GUI */ - {struct nk_panel layout, tab; if (nk_begin(&ctx, "Demo", nk_rect(50, 50, 300, 400), NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_TITLE)) { @@ -805,7 +804,7 @@ int main(int argc, char *argv[]) nk_group_end(&ctx); } } - nk_end(&ctx);} + nk_end(&ctx); /* Draw */ glViewport(0, 0, display_width, display_height); diff --git a/example/stb_image.h b/example/stb_image.h index 0a9de39..1f4d468 100644 --- a/example/stb_image.h +++ b/example/stb_image.h @@ -4081,13 +4081,13 @@ static int stbi__create_png_image_raw(stbi__png *a, stbi_uc *raw, stbi__uint32 r // we make a separate pass to expand bits to pixels; for performance, // this could run two scanlines behind the above code, so it won't - // intefere with filtering but will still be in the cache. + // interfere with filtering but will still be in the cache. if (depth < 8) { for (j=0; j < y; ++j) { stbi_uc *cur = a->out + stride*j; stbi_uc *in = a->out + stride*j + x*out_n - img_width_bytes; // unpack 1/2/4-bit into a 8-bit buffer. allows us to keep the common 8-bit path optimal at minimal cost for 1/2/4-bit - // png guarante byte alignment, if width is not multiple of 8/4/2 we'll decode dummy trailing data that will be skipped in the later loop + // png guarantee byte alignment, if width is not multiple of 8/4/2 we'll decode dummy trailing data that will be skipped in the later loop stbi_uc scale = (color == 0) ? stbi__depth_scale_table[depth] : 1; // scale grayscale values to 0..255 range // note that the final byte might overshoot and write more data than desired. @@ -4231,7 +4231,7 @@ static int stbi__expand_png_palette(stbi__png *a, stbi_uc *palette, int len, int p = (stbi_uc *) stbi__malloc(pixel_count * pal_img_n); if (p == NULL) return stbi__err("outofmem", "Out of memory"); - // between here and free(out) below, exitting would leak + // between here and free(out) below, exiting would leak temp_out = p; if (pal_img_n == 3) { @@ -4899,7 +4899,7 @@ static stbi_uc *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int int RLE_repeating = 0; int read_next_pixel = 1; - // do a tiny bit of precessing + // do a tiny bit of processing if ( tga_image_type >= 8 ) { tga_image_type -= 8; @@ -5161,7 +5161,7 @@ static stbi_uc *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int // Else if n is 128, noop. // Endloop - // The RLE-compressed data is preceeded by a 2-byte data count for each row in the data, + // The RLE-compressed data is preceded by a 2-byte data count for each row in the data, // which we're going to just skip. stbi__skip(s, h * channelCount * 2 ); @@ -6429,7 +6429,7 @@ STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *c, void *user, int 1.31 (2011-06-20) a few more leak fixes, bug in PNG handling (SpartanJ) 1.30 (2011-06-11) - added ability to load files via callbacks to accomidate custom input streams (Ben Wenger) + added ability to load files via callbacks to accommodate custom input streams (Ben Wenger) removed deprecated format-specific test/load functions removed support for installable file formats (stbi_loader) -- would have been broken for IO callbacks anyway error cases in bmp and tga give messages and don't leak (Raymond Barbiero, grisha) diff --git a/nuklear.h b/nuklear.h index e125865..5e645db 100644 --- a/nuklear.h +++ b/nuklear.h @@ -77,7 +77,7 @@ /// and does not contain the actual implementation.

/// /// The implementation mode requires to define the preprocessor macro -/// NK_IMPLEMENTATION in *one* .c/.cpp file before #includeing this file, e.g.: +/// NK_IMPLEMENTATION in *one* .c/.cpp file before #including this file, e.g.: /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~C /// #define NK_IMPLEMENTATION @@ -147,7 +147,7 @@ /// NK_ASSERT | If you don't define this, nuklear will use with assert(). /// NK_MEMSET | You can define this to 'memset' or your own memset implementation replacement. If not nuklear will use its own version. /// NK_MEMCPY | You can define this to 'memcpy' or your own memcpy implementation replacement. If not nuklear will use its own version. -/// NK_SQRT | You can define this to 'sqrt' or your own sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. +/// NK_INV_SQRT | You can define this to your own inverse sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. /// NK_SIN | You can define this to 'sinf' or your own sine implementation replacement. If not nuklear will use its own approximation implementation. /// NK_COS | You can define this to 'cosf' or your own cosine implementation replacement. If not nuklear will use its own approximation implementation. /// NK_STRTOD | You can define this to `strtod` or your own string to double conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). @@ -372,7 +372,7 @@ extern "C" { #elif (defined(_WIN32) || defined(WIN32)) && defined(_MSC_VER) #define NK_SIZE_TYPE unsigned __int32 #elif defined(__GNUC__) || defined(__clang__) - #if defined(__x86_64__) || defined(__ppc64__) + #if defined(__x86_64__) || defined(__ppc64__) || defined(__aarch64__) #define NK_SIZE_TYPE unsigned long #else #define NK_SIZE_TYPE unsigned int @@ -387,7 +387,7 @@ extern "C" { #elif (defined(_WIN32) || defined(WIN32)) && defined(_MSC_VER) #define NK_POINTER_TYPE unsigned __int32 #elif defined(__GNUC__) || defined(__clang__) - #if defined(__x86_64__) || defined(__ppc64__) + #if defined(__x86_64__) || defined(__ppc64__) || defined(__aarch64__) #define NK_POINTER_TYPE unsigned long #else #define NK_POINTER_TYPE unsigned int @@ -712,7 +712,7 @@ NK_API void nk_set_user_data(struct nk_context*, nk_handle handle); /// /// #### Usage /// Input state needs to be provided to nuklear by first calling `nk_input_begin` -/// which resets internal state like delta mouse position and button transistions. +/// which resets internal state like delta mouse position and button transitions. /// After `nk_input_begin` all current input state needs to be provided. This includes /// mouse motion, button and key pressed and released, text input and scrolling. /// Both event- or state-based input handling are supported by this API @@ -1127,7 +1127,7 @@ NK_API void nk_input_end(struct nk_context*); /// cfg.curve_segment_count = 22; /// cfg.arc_segment_count = 22; /// cfg.global_alpha = 1.0f; -/// cfg.null = dev->null; +/// cfg.tex_null = dev->tex_null; /// // /// // setup buffers and convert /// struct nk_buffer cmds, verts, idx; @@ -1177,7 +1177,7 @@ struct nk_convert_config { unsigned circle_segment_count; /* number of segments used for circles: default to 22 */ unsigned arc_segment_count; /* number of segments used for arcs: default to 22 */ unsigned curve_segment_count; /* number of segments used for curves: default to 22 */ - struct nk_draw_null_texture null; /* handle to texture with a white pixel for shape drawing */ + struct nk_draw_null_texture tex_null; /* handle to texture with a white pixel for shape drawing */ const struct nk_draw_vertex_layout_element *vertex_layout; /* describes the vertex output format and packing */ nk_size vertex_size; /* sizeof one vertex for vertex packing */ nk_size vertex_alignment; /* vertex alignment: Can be obtained by NK_ALIGNOF */ @@ -1255,7 +1255,7 @@ NK_API const struct nk_command* nk__next(struct nk_context*, const struct nk_com /// NK_CONVERT_INVALID_PARAM | An invalid argument was passed in the function call /// NK_CONVERT_COMMAND_BUFFER_FULL | The provided buffer for storing draw commands is full or failed to allocate more memory /// NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory -/// NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is full or failed to allocate more memory +/// NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indices is full or failed to allocate more memory */ NK_API nk_flags nk_convert(struct nk_context*, struct nk_buffer *cmds, struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*); /*/// #### nk__draw_begin @@ -1462,8 +1462,8 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* /// #### nk_collapse_states /// State | Description /// ----------------|----------------------------------------------------------- -/// __NK_MINIMIZED__| UI section is collased and not visibile until maximized -/// __NK_MAXIMIZED__| UI section is extended and visibile until minimized +/// __NK_MINIMIZED__| UI section is collased and not visible until maximized +/// __NK_MAXIMIZED__| UI section is extended and visible until minimized ///

*/ enum nk_panel_flags { @@ -2612,7 +2612,7 @@ NK_API void nk_spacer(struct nk_context* ); /// widgets inside the window if the value is not 0. /// Nesting groups is possible and even encouraged since many layouting schemes /// can only be achieved by nesting. Groups, unlike windows, need `nk_group_end` -/// to be only called if the corosponding `nk_group_begin_xxx` call does not return 0: +/// to be only called if the corresponding `nk_group_begin_xxx` call does not return 0: /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// if (nk_group_begin_xxx(ctx, ...) { @@ -2672,7 +2672,7 @@ NK_API void nk_spacer(struct nk_context* ); /// Function | Description /// --------------------------------|------------------------------------------- /// nk_group_begin | Start a new group with internal scrollbar handling -/// nk_group_begin_titled | Start a new group with separeted name and title and internal scrollbar handling +/// nk_group_begin_titled | Start a new group with separated name and title and internal scrollbar handling /// nk_group_end | Ends a group. Should only be called if nk_group_begin returned non-zero /// nk_group_scrolled_offset_begin | Start a new group with manual separated handling of scrollbar x- and y-offset /// nk_group_scrolled_begin | Start a new group with manual scrollbar handling @@ -2802,13 +2802,13 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of * * ============================================================================= /// ### Tree -/// Trees represent two different concept. First the concept of a collapsable -/// UI section that can be either in a hidden or visibile state. They allow the UI +/// Trees represent two different concept. First the concept of a collapsible +/// UI section that can be either in a hidden or visible state. They allow the UI /// user to selectively minimize the current set of visible UI to comprehend. /// The second concept are tree widgets for visual UI representation of trees.

/// /// Trees thereby can be nested for tree representations and multiple nested -/// collapsable UI sections. All trees are started by calling of the +/// collapsible UI sections. All trees are started by calling of the /// `nk_tree_xxx_push_tree` functions and ended by calling one of the /// `nk_tree_xxx_pop_xxx()` functions. Each starting functions takes a title label /// and optionally an image to be displayed and the initial collapse state from @@ -2823,7 +2823,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of /// /// #### Usage /// To create a tree you have to call one of the seven `nk_tree_xxx_push_xxx` -/// functions to start a collapsable UI section and `nk_tree_xxx_pop` to mark the +/// functions to start a collapsible UI section and `nk_tree_xxx_pop` to mark the /// end. /// Each starting function will either return `false(0)` if the tree is collapsed /// or hidden and therefore does not need to be filled with content or `true(1)` @@ -2848,28 +2848,28 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of /// #### Reference /// Function | Description /// ----------------------------|------------------------------------------- -/// nk_tree_push | Start a collapsable UI section with internal state management -/// nk_tree_push_id | Start a collapsable UI section with internal state management callable in a look -/// nk_tree_push_hashed | Start a collapsable UI section with internal state management with full control over internal unique ID use to store state -/// nk_tree_image_push | Start a collapsable UI section with image and label header -/// nk_tree_image_push_id | Start a collapsable UI section with image and label header and internal state management callable in a look -/// nk_tree_image_push_hashed | Start a collapsable UI section with image and label header and internal state management with full control over internal unique ID use to store state -/// nk_tree_pop | Ends a collapsable UI section +/// nk_tree_push | Start a collapsible UI section with internal state management +/// nk_tree_push_id | Start a collapsible UI section with internal state management callable in a look +/// nk_tree_push_hashed | Start a collapsible UI section with internal state management with full control over internal unique ID use to store state +/// nk_tree_image_push | Start a collapsible UI section with image and label header +/// nk_tree_image_push_id | Start a collapsible UI section with image and label header and internal state management callable in a look +/// nk_tree_image_push_hashed | Start a collapsible UI section with image and label header and internal state management with full control over internal unique ID use to store state +/// nk_tree_pop | Ends a collapsible UI section // -/// nk_tree_state_push | Start a collapsable UI section with external state management -/// nk_tree_state_image_push | Start a collapsable UI section with image and label header and external state management +/// nk_tree_state_push | Start a collapsible UI section with external state management +/// nk_tree_state_image_push | Start a collapsible UI section with image and label header and external state management /// nk_tree_state_pop | Ends a collapsabale UI section /// /// #### nk_tree_type /// Flag | Description /// ----------------|---------------------------------------- -/// NK_TREE_NODE | Highlighted tree header to mark a collapsable UI section -/// NK_TREE_TAB | Non-highighted tree header closer to tree representations +/// NK_TREE_NODE | Highlighted tree header to mark a collapsible UI section +/// NK_TREE_TAB | Non-highlighted tree header closer to tree representations */ /*/// #### nk_tree_push -/// Starts a collapsable UI section with internal state management +/// Starts a collapsible UI section with internal state management /// !!! WARNING -/// To keep track of the runtime tree collapsable state this function uses +/// To keep track of the runtime tree collapsible state this function uses /// defines `__FILE__` and `__LINE__` to generate a unique ID. If you want /// to call this function in a loop please use `nk_tree_push_id` or /// `nk_tree_push_hashed` instead. @@ -2889,7 +2889,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ #define nk_tree_push(ctx, type, title, state) nk_tree_push_hashed(ctx, type, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),__LINE__) /*/// #### nk_tree_push_id -/// Starts a collapsable UI section with internal state management callable in a look +/// Starts a collapsible UI section with internal state management callable in a look /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// #define nk_tree_push_id(ctx, type, title, state, id) /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2906,7 +2906,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ #define nk_tree_push_id(ctx, type, title, state, id) nk_tree_push_hashed(ctx, type, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),id) /*/// #### nk_tree_push_hashed -/// Start a collapsable UI section with internal state management with full +/// Start a collapsible UI section with internal state management with full /// control over internal unique ID used to store state /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); @@ -2926,9 +2926,9 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); /*/// #### nk_tree_image_push -/// Start a collapsable UI section with image and label header +/// Start a collapsible UI section with image and label header /// !!! WARNING -/// To keep track of the runtime tree collapsable state this function uses +/// To keep track of the runtime tree collapsible state this function uses /// defines `__FILE__` and `__LINE__` to generate a unique ID. If you want /// to call this function in a loop please use `nk_tree_image_push_id` or /// `nk_tree_image_push_hashed` instead. @@ -2949,7 +2949,7 @@ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const */ #define nk_tree_image_push(ctx, type, img, title, state) nk_tree_image_push_hashed(ctx, type, img, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),__LINE__) /*/// #### nk_tree_image_push_id -/// Start a collapsable UI section with image and label header and internal state +/// Start a collapsible UI section with image and label header and internal state /// management callable in a look /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c @@ -2969,7 +2969,7 @@ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const */ #define nk_tree_image_push_id(ctx, type, img, title, state, id) nk_tree_image_push_hashed(ctx, type, img, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),id) /*/// #### nk_tree_image_push_hashed -/// Start a collapsable UI section with internal state management with full +/// Start a collapsible UI section with internal state management with full /// control over internal unique ID used to store state /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); @@ -3001,7 +3001,7 @@ NK_API nk_bool nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, */ NK_API void nk_tree_pop(struct nk_context*); /*/// #### nk_tree_state_push -/// Start a collapsable UI section with external state management +/// Start a collapsible UI section with external state management /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3017,7 +3017,7 @@ NK_API void nk_tree_pop(struct nk_context*); */ NK_API nk_bool nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); /*/// #### nk_tree_state_image_push -/// Start a collapsable UI section with image and label header and external state management +/// Start a collapsible UI section with image and label header and external state management /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_state_image_push(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states *state); /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3244,10 +3244,10 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo /// or by directly typing a number. /// /// #### Usage -/// Each property requires a unique name for identifaction that is also used for +/// Each property requires a unique name for identification that is also used for /// displaying a label. If you want to use the same name multiple times make sure /// add a '#' before your name. The '#' will not be shown but will generate a -/// unique ID. Each propery also takes in a minimum and maximum value. If you want +/// unique ID. Each property also takes in a minimum and maximum value. If you want /// to make use of the complete number range of a type just use the provided /// type limits from `limits.h`. For example `INT_MIN` and `INT_MAX` for /// `nk_property_int` and `nk_propertyi`. In additional each property takes in @@ -3301,16 +3301,16 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo /// #### Reference /// Function | Description /// --------------------|------------------------------------------- -/// nk_property_int | Integer property directly modifing a passed in value -/// nk_property_float | Float property directly modifing a passed in value -/// nk_property_double | Double property directly modifing a passed in value +/// nk_property_int | Integer property directly modifying a passed in value +/// nk_property_float | Float property directly modifying a passed in value +/// nk_property_double | Double property directly modifying a passed in value /// nk_propertyi | Integer property returning the modified int value /// nk_propertyf | Float property returning the modified float value /// nk_propertyd | Double property returning the modified double value /// */ /*/// #### nk_property_int -/// Integer property directly modifing a passed in value +/// Integer property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3331,7 +3331,7 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo */ NK_API void nk_property_int(struct nk_context*, const char *name, int min, int *val, int max, int step, float inc_per_pixel); /*/// #### nk_property_float -/// Float property directly modifing a passed in value +/// Float property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3352,7 +3352,7 @@ NK_API void nk_property_int(struct nk_context*, const char *name, int min, int * */ NK_API void nk_property_float(struct nk_context*, const char *name, float min, float *val, float max, float step, float inc_per_pixel); /*/// #### nk_property_double -/// Double property directly modifing a passed in value +/// Double property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3373,7 +3373,7 @@ NK_API void nk_property_float(struct nk_context*, const char *name, float min, f */ NK_API void nk_property_double(struct nk_context*, const char *name, double min, double *val, double max, double step, float inc_per_pixel); /*/// #### nk_propertyi -/// Integer property modifing a passed in value and returning the new value +/// Integer property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3396,7 +3396,7 @@ NK_API void nk_property_double(struct nk_context*, const char *name, double min, */ NK_API int nk_propertyi(struct nk_context*, const char *name, int min, int val, int max, int step, float inc_per_pixel); /*/// #### nk_propertyf -/// Float property modifing a passed in value and returning the new value +/// Float property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3419,7 +3419,7 @@ NK_API int nk_propertyi(struct nk_context*, const char *name, int min, int val, */ NK_API float nk_propertyf(struct nk_context*, const char *name, float min, float val, float max, float step, float inc_per_pixel); /*/// #### nk_propertyd -/// Float property modifing a passed in value and returning the new value +/// Float property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -4012,7 +4012,7 @@ struct nk_font_config { unsigned char pixel_snap; /* align every character to pixel boundary (if true set oversample (1,1)) */ unsigned char oversample_v, oversample_h; - /* rasterize at hight quality for sub-pixel position */ + /* rasterize at high quality for sub-pixel position */ unsigned char padding[3]; float size; @@ -4654,6 +4654,9 @@ struct nk_mouse_button { struct nk_mouse { struct nk_mouse_button buttons[NK_BUTTON_MAX]; struct nk_vec2 pos; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + struct nk_vec2 down_pos; +#endif struct nk_vec2 prev; struct nk_vec2 delta; struct nk_vec2 scroll_delta; @@ -4679,6 +4682,7 @@ struct nk_input { NK_API nk_bool nk_input_has_mouse_click(const struct nk_input*, enum nk_buttons); NK_API nk_bool nk_input_has_mouse_click_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); +NK_API nk_bool nk_input_has_mouse_click_in_button_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); NK_API nk_bool nk_input_has_mouse_click_down_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect, nk_bool down); NK_API nk_bool nk_input_is_mouse_click_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); NK_API nk_bool nk_input_is_mouse_click_down_in_rect(const struct nk_input *i, enum nk_buttons id, struct nk_rect b, nk_bool down); @@ -5838,7 +5842,9 @@ NK_GLOBAL const struct nk_color nk_yellow = {255,255,0,255}; else (*(s)) = NK_WIDGET_STATE_INACTIVE; /* math */ +#ifndef NK_INV_SQRT NK_LIB float nk_inv_sqrt(float n); +#endif #ifndef NK_SIN NK_LIB float nk_sin(float x); #endif @@ -6132,6 +6138,8 @@ nk_stbtt_free(void *ptr, void *user_data) { (it can actually approximate a lot more functions) can be found here: www.lolengine.net/wiki/oss/lolremez */ +#ifndef NK_INV_SQRT +#define NK_INV_SQRT nk_inv_sqrt NK_LIB float nk_inv_sqrt(float n) { @@ -6144,6 +6152,7 @@ nk_inv_sqrt(float n) conv.f = conv.f * (threehalfs - (x2 * conv.f * conv.f)); return conv.f; } +#endif #ifndef NK_SIN #define NK_SIN nk_sin NK_LIB float @@ -9554,7 +9563,7 @@ nk_draw_list_add_clip(struct nk_draw_list *list, struct nk_rect rect) NK_ASSERT(list); if (!list) return; if (!list->cmd_count) { - nk_draw_list_push_command(list, rect, list->config.null.texture); + nk_draw_list_push_command(list, rect, list->config.tex_null.texture); } else { struct nk_draw_command *prev = nk_draw_list_command_last(list); if (prev->elem_count == 0) @@ -9604,14 +9613,14 @@ nk_draw_list_alloc_vertices(struct nk_draw_list *list, nk_size count) /* This assert triggers because your are drawing a lot of stuff and nuklear * defined `nk_draw_index` as `nk_ushort` to safe space be default. * - * So you reached the maximum number of indicies or rather vertexes. - * To solve this issue please change typdef `nk_draw_index` to `nk_uint` + * So you reached the maximum number of indices or rather vertexes. + * To solve this issue please change typedef `nk_draw_index` to `nk_uint` * and don't forget to specify the new element size in your drawing * backend (OpenGL, DirectX, ...). For example in OpenGL for `glDrawElements` - * instead of specifing `GL_UNSIGNED_SHORT` you have to define `GL_UNSIGNED_INT`. + * instead of specifying `GL_UNSIGNED_SHORT` you have to define `GL_UNSIGNED_INT`. * Sorry for the inconvenience. */ if(sizeof(nk_draw_index)==2) NK_ASSERT((list->vertex_count < NK_USHORT_MAX && - "To many verticies for 16-bit vertex indicies. Please read comment above on how to solve this problem")); + "To many vertices for 16-bit vertex indices. Please read comment above on how to solve this problem")); return vtx; } NK_INTERN nk_draw_index* @@ -9854,7 +9863,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* vec2 inverted length */ len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -9909,7 +9918,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* fill vertices */ for (i = 0; i < points_count; ++i) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; vtx = nk_draw_vertex(vtx, &list->config, points[i], uv, col); vtx = nk_draw_vertex(vtx, &list->config, temp[i*2+0], uv, col_trans); vtx = nk_draw_vertex(vtx, &list->config, temp[i*2+1], uv, col_trans); @@ -9974,7 +9983,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* add vertices */ for (i = 0; i < points_count; ++i) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+0], uv, col_trans); vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+1], uv, col); vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+2], uv, col); @@ -9995,7 +10004,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p for (i1 = 0; i1 < count; ++i1) { float dx, dy; - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; const nk_size i2 = ((i1+1) == points_count) ? 0 : i1 + 1; const struct nk_vec2 p1 = points[i1]; const struct nk_vec2 p2 = points[i2]; @@ -10005,7 +10014,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* vec2 inverted length */ len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -10095,7 +10104,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, /* vec2 inverted length */ float len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -10105,7 +10114,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, /* add vertices + indexes */ for (i0 = points_count-1, i1 = 0; i1 < points_count; i0 = i1++) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; struct nk_vec2 n0 = normals[i0]; struct nk_vec2 n1 = normals[i1]; struct nk_vec2 dm = nk_vec2_muls(nk_vec2_add(n0, n1), 0.5f); @@ -10142,7 +10151,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, if (!vtx || !ids) return; for (i = 0; i < vtx_count; ++i) - vtx = nk_draw_vertex(vtx, &list->config, points[i], list->config.null.uv, col); + vtx = nk_draw_vertex(vtx, &list->config, points[i], list->config.tex_null.uv, col); for (i = 2; i < points_count; ++i) { ids[0] = (nk_draw_index)index; ids[1] = (nk_draw_index)(index+ i - 1); @@ -10171,8 +10180,8 @@ nk_draw_list_path_line_to(struct nk_draw_list *list, struct nk_vec2 pos) nk_draw_list_add_clip(list, nk_null_rect); cmd = nk_draw_list_command_last(list); - if (cmd && cmd->texture.ptr != list->config.null.texture.ptr) - nk_draw_list_push_image(list, list->config.null.texture); + if (cmd && cmd->texture.ptr != list->config.tex_null.texture.ptr) + nk_draw_list_push_image(list, list->config.tex_null.texture); points = nk_draw_list_alloc_path(list, 1); if (!points) return; @@ -10374,7 +10383,7 @@ nk_draw_list_fill_rect_multi_color(struct nk_draw_list *list, struct nk_rect rec NK_ASSERT(list); if (!list) return; - nk_draw_list_push_image(list, list->config.null.texture); + nk_draw_list_push_image(list, list->config.tex_null.texture); index = (nk_draw_index)list->vertex_count; vtx = nk_draw_list_alloc_vertices(list, 4); idx = nk_draw_list_alloc_elements(list, 6); @@ -10384,10 +10393,10 @@ nk_draw_list_fill_rect_multi_color(struct nk_draw_list *list, struct nk_rect rec idx[2] = (nk_draw_index)(index+2); idx[3] = (nk_draw_index)(index+0); idx[4] = (nk_draw_index)(index+2); idx[5] = (nk_draw_index)(index+3); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y), list->config.null.uv, col_left); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y), list->config.null.uv, col_top); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y + rect.h), list->config.null.uv, col_right); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y + rect.h), list->config.null.uv, col_bottom); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y), list->config.tex_null.uv, col_left); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y), list->config.tex_null.uv, col_top); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y + rect.h), list->config.tex_null.uv, col_right); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y + rect.h), list->config.tex_null.uv, col_bottom); } NK_API void nk_draw_list_fill_triangle(struct nk_draw_list *list, struct nk_vec2 a, @@ -10714,12 +10723,18 @@ nk__draw_next(const struct nk_draw_command *cmd, #endif -/* stb_rect_pack.h - v1.00 - public domain - rectangle packing */ +/* stb_rect_pack.h - v1.01 - public domain - rectangle packing */ /* Sean Barrett 2014 */ /* */ /* Useful for e.g. packing rectangular textures into an atlas. */ /* Does not do rotation. */ /* */ +/* Before #including, */ +/* */ +/* #define STB_RECT_PACK_IMPLEMENTATION */ +/* */ +/* in the file that you want to have the implementation. */ +/* */ /* Not necessarily the awesomest packing method, but better than */ /* the totally naive one in stb_truetype (which is primarily what */ /* this is meant to replace). */ @@ -10751,6 +10766,7 @@ nk__draw_next(const struct nk_draw_command *cmd, /* */ /* Version history: */ /* */ +/* 1.01 (2021-07-11) always use large rect mode, expose STBRP__MAXVAL in public section */ /* 1.00 (2019-02-25) avoid small space waste; gracefully fail too-wide rectangles */ /* 0.99 (2019-02-07) warning fixes */ /* 0.11 (2017-03-03) return packing success/fail result */ @@ -10791,11 +10807,10 @@ typedef struct stbrp_context stbrp_context; typedef struct stbrp_node stbrp_node; typedef struct stbrp_rect stbrp_rect; -#ifdef STBRP_LARGE_RECTS typedef int stbrp_coord; -#else -typedef unsigned short stbrp_coord; -#endif + +#define STBRP__MAXVAL 0x7fffffff +/* Mostly for internal use, but this is the maximum supported coordinate value. */ STBRP_DEF int stbrp_pack_rects (stbrp_context *context, stbrp_rect *rects, int num_rects); /* Assign packed locations to rectangles. The rectangles are of type */ @@ -10925,8 +10940,10 @@ struct stbrp_context #ifdef _MSC_VER #define STBRP__NOTUSED(v) (void)(v) +#define STBRP__CDECL __cdecl #else #define STBRP__NOTUSED(v) (void)sizeof(v) +#define STBRP__CDECL #endif enum @@ -10969,9 +10986,6 @@ STBRP_DEF void stbrp_setup_allow_out_of_mem(stbrp_context *context, int allow_ou STBRP_DEF void stbrp_init_target(stbrp_context *context, int width, int height, stbrp_node *nodes, int num_nodes) { int i; -#ifndef STBRP_LARGE_RECTS - STBRP_ASSERT(width <= 0xffff && height <= 0xffff); -#endif for (i=0; i < num_nodes-1; ++i) nodes[i].next = &nodes[i+1]; @@ -10990,11 +11004,7 @@ STBRP_DEF void stbrp_init_target(stbrp_context *context, int width, int height, context->extra[0].y = 0; context->extra[0].next = &context->extra[1]; context->extra[1].x = (stbrp_coord) width; -#ifdef STBRP_LARGE_RECTS context->extra[1].y = (1<<30); -#else - context->extra[1].y = 65535; -#endif context->extra[1].next = NULL; } @@ -11236,7 +11246,7 @@ static stbrp__findresult stbrp__skyline_pack_rectangle(stbrp_context *context, i return res; } -static int rect_height_compare(const void *a, const void *b) +static int STBRP__CDECL rect_height_compare(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; @@ -11247,19 +11257,13 @@ static int rect_height_compare(const void *a, const void *b) return (p->w > q->w) ? -1 : (p->w < q->w); } -static int rect_original_order(const void *a, const void *b) +static int STBRP__CDECL rect_original_order(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; return (p->was_packed < q->was_packed) ? -1 : (p->was_packed > q->was_packed); } -#ifdef STBRP_LARGE_RECTS -#define STBRP__MAXVAL 0xffffffff -#else -#define STBRP__MAXVAL 0xffff -#endif - STBRP_DEF int stbrp_pack_rects(stbrp_context *context, stbrp_rect *rects, int num_rects) { int i, all_rects_packed = 1; @@ -11343,8 +11347,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ------------------------------------------------------------------------------ */ -/* stb_truetype.h - v1.24 - public domain */ -/* authored from 2009-2020 by Sean Barrett / RAD Game Tools */ +/* stb_truetype.h - v1.26 - public domain */ +/* authored from 2009-2021 by Sean Barrett / RAD Game Tools */ /* */ /* ======================================================================= */ /* */ @@ -11398,11 +11402,13 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. /* Johan Duparc Thomas Fields */ /* Hou Qiming Derek Vinyard */ /* Rob Loach Cort Stratton */ -/* Kenney Phillis Jr. Brian Costabile */ -/* Ken Voskuil (kaesve) */ +/* Kenney Phillis Jr. Brian Costabile */ +/* Ken Voskuil (kaesve) */ /* */ /* VERSION HISTORY */ /* */ +/* 1.26 (2021-08-28) fix broken rasterizer */ +/* 1.25 (2021-07-11) many fixes */ /* 1.24 (2020-02-05) fix warning */ /* 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) */ /* 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined */ @@ -11615,8 +11621,8 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. /* // SAMPLE PROGRAMS */ /* // */ /* */ -/* Incomplete text-in-3d-api example, which draws quads properly aligned to be lossless */ -/* */ +/* Incomplete text-in-3d-api example, which draws quads properly aligned to be lossless. */ +/* See "tests/truetype_demo_win32.c" for a complete version. */ #if 0 #define STB_TRUETYPE_IMPLEMENTATION /* force following include to generate implementation */ #include "stb_truetype.h" @@ -11642,6 +11648,8 @@ void my_stbtt_initfont(void) void my_stbtt_print(float x, float y, char *text) { /* assume orthographic projection with units = screen pixels, origin at top left */ + glEnable(GL_BLEND); + glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); glEnable(GL_TEXTURE_2D); glBindTexture(GL_TEXTURE_2D, ftex); glBegin(GL_QUADS); @@ -11649,10 +11657,10 @@ void my_stbtt_print(float x, float y, char *text) if (*text >= 32 && *text < 128) { stbtt_aligned_quad q; stbtt_GetBakedQuad(cdata, 512,512, *text-32, &x,&y,&q,1);/* 1=opengl & d3d10+,0=d3d9 */ - glTexCoord2f(q.s0,q.t1); glVertex2f(q.x0,q.y0); - glTexCoord2f(q.s1,q.t1); glVertex2f(q.x1,q.y0); - glTexCoord2f(q.s1,q.t0); glVertex2f(q.x1,q.y1); - glTexCoord2f(q.s0,q.t0); glVertex2f(q.x0,q.y1); + glTexCoord2f(q.s0,q.t0); glVertex2f(q.x0,q.y0); + glTexCoord2f(q.s1,q.t0); glVertex2f(q.x1,q.y0); + glTexCoord2f(q.s1,q.t1); glVertex2f(q.x1,q.y1); + glTexCoord2f(q.s0,q.t1); glVertex2f(q.x0,q.y1); } ++text; } @@ -12198,6 +12206,7 @@ STBTT_DEF int stbtt_GetGlyphShape(const stbtt_fontinfo *info, int glyph_index, s STBTT_DEF void stbtt_FreeShape(const stbtt_fontinfo *info, stbtt_vertex *vertices); /* frees the data allocated above */ +STBTT_DEF unsigned char *stbtt_FindSVGDoc(const stbtt_fontinfo *info, int gl); STBTT_DEF int stbtt_GetCodepointSVG(const stbtt_fontinfo *info, int unicode_codepoint, const char **svg); STBTT_DEF int stbtt_GetGlyphSVG(const stbtt_fontinfo *info, int gl, const char **svg); /* fills svg with the character's SVG data. */ @@ -12884,12 +12893,12 @@ STBTT_DEF int stbtt_FindGlyphIndex(const stbtt_fontinfo *info, int unicode_codep search += 2; { - stbtt_uint16 offset, start; + stbtt_uint16 offset, start, last; stbtt_uint16 item = (stbtt_uint16) ((search - endCount) >> 1); - STBTT_assert(unicode_codepoint <= ttUSHORT(data + endCount + 2*item)); start = ttUSHORT(data + index_map + 14 + segcount*2 + 2 + 2*item); - if (unicode_codepoint < start) + last = ttUSHORT(data + endCount + 2*item); + if (unicode_codepoint < start || unicode_codepoint > last) return 0; offset = ttUSHORT(data + index_map + 14 + segcount*6 + 2 + 2*item); @@ -13216,7 +13225,7 @@ static int stbtt__GetGlyphShapeTT(const stbtt_fontinfo *info, int glyph_index, s if (comp_verts) STBTT_free(comp_verts, info->userdata); return 0; } - if (num_vertices > 0) STBTT_memcpy(tmp, vertices, num_vertices*sizeof(stbtt_vertex)); + if (num_vertices > 0 && vertices) STBTT_memcpy(tmp, vertices, num_vertices*sizeof(stbtt_vertex)); STBTT_memcpy(tmp+num_vertices, comp_verts, comp_num_verts*sizeof(stbtt_vertex)); if (vertices) STBTT_free(vertices, info->userdata); vertices = tmp; @@ -13479,7 +13488,7 @@ static int stbtt__run_charstring(const stbtt_fontinfo *info, int glyph_index, st subrs = stbtt__cid_get_glyph_subrs(info, glyph_index); has_subrs = 1; } - /* fallthrough */ + /* FALLTHROUGH */ case 0x1D: /* callgsubr */ if (sp < 1) return STBTT__CSERR("call(g|)subr stack"); v = (int) s[--sp]; @@ -13584,7 +13593,7 @@ static int stbtt__run_charstring(const stbtt_fontinfo *info, int glyph_index, st } break; default: - if (b0 != 255 && b0 != 28 && (b0 < 32 || b0 > 254)) + if (b0 != 255 && b0 != 28 && b0 < 32) return STBTT__CSERR("reserved operator"); /* push immediate */ @@ -13696,7 +13705,7 @@ STBTT_DEF int stbtt_GetKerningTable(const stbtt_fontinfo *info, stbtt_kerningent return length; } -static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) +static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { stbtt_uint8 *data = info->data + info->kern; stbtt_uint32 needle, straw; @@ -13726,243 +13735,225 @@ static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph return 0; } -static stbtt_int32 stbtt__GetCoverageIndex(stbtt_uint8 *coverageTable, int glyph) +static stbtt_int32 stbtt__GetCoverageIndex(stbtt_uint8 *coverageTable, int glyph) { - stbtt_uint16 coverageFormat = ttUSHORT(coverageTable); - switch(coverageFormat) { - case 1: { - stbtt_uint16 glyphCount = ttUSHORT(coverageTable + 2); + stbtt_uint16 coverageFormat = ttUSHORT(coverageTable); + switch (coverageFormat) { + case 1: { + stbtt_uint16 glyphCount = ttUSHORT(coverageTable + 2); - /* Binary search. */ - stbtt_int32 l=0, r=glyphCount-1, m; - int straw, needle=glyph; - while (l <= r) { - stbtt_uint8 *glyphArray = coverageTable + 4; - stbtt_uint16 glyphID; - m = (l + r) >> 1; - glyphID = ttUSHORT(glyphArray + 2 * m); - straw = glyphID; - if (needle < straw) - r = m - 1; - else if (needle > straw) - l = m + 1; - else { - return m; - } + /* Binary search. */ + stbtt_int32 l=0, r=glyphCount-1, m; + int straw, needle=glyph; + while (l <= r) { + stbtt_uint8 *glyphArray = coverageTable + 4; + stbtt_uint16 glyphID; + m = (l + r) >> 1; + glyphID = ttUSHORT(glyphArray + 2 * m); + straw = glyphID; + if (needle < straw) + r = m - 1; + else if (needle > straw) + l = m + 1; + else { + return m; } - } break; + } + break; + } - case 2: { - stbtt_uint16 rangeCount = ttUSHORT(coverageTable + 2); - stbtt_uint8 *rangeArray = coverageTable + 4; + case 2: { + stbtt_uint16 rangeCount = ttUSHORT(coverageTable + 2); + stbtt_uint8 *rangeArray = coverageTable + 4; - /* Binary search. */ - stbtt_int32 l=0, r=rangeCount-1, m; - int strawStart, strawEnd, needle=glyph; - while (l <= r) { - stbtt_uint8 *rangeRecord; - m = (l + r) >> 1; - rangeRecord = rangeArray + 6 * m; - strawStart = ttUSHORT(rangeRecord); - strawEnd = ttUSHORT(rangeRecord + 2); - if (needle < strawStart) - r = m - 1; - else if (needle > strawEnd) - l = m + 1; - else { - stbtt_uint16 startCoverageIndex = ttUSHORT(rangeRecord + 4); - return startCoverageIndex + glyph - strawStart; - } + /* Binary search. */ + stbtt_int32 l=0, r=rangeCount-1, m; + int strawStart, strawEnd, needle=glyph; + while (l <= r) { + stbtt_uint8 *rangeRecord; + m = (l + r) >> 1; + rangeRecord = rangeArray + 6 * m; + strawStart = ttUSHORT(rangeRecord); + strawEnd = ttUSHORT(rangeRecord + 2); + if (needle < strawStart) + r = m - 1; + else if (needle > strawEnd) + l = m + 1; + else { + stbtt_uint16 startCoverageIndex = ttUSHORT(rangeRecord + 4); + return startCoverageIndex + glyph - strawStart; } - } break; + } + break; + } - default: { - /* There are no other cases. */ - STBTT_assert(0); - } break; - } + default: return -1; /* unsupported */ + } - return -1; + return -1; } static stbtt_int32 stbtt__GetGlyphClass(stbtt_uint8 *classDefTable, int glyph) { - stbtt_uint16 classDefFormat = ttUSHORT(classDefTable); - switch(classDefFormat) - { - case 1: { - stbtt_uint16 startGlyphID = ttUSHORT(classDefTable + 2); - stbtt_uint16 glyphCount = ttUSHORT(classDefTable + 4); - stbtt_uint8 *classDef1ValueArray = classDefTable + 6; + stbtt_uint16 classDefFormat = ttUSHORT(classDefTable); + switch (classDefFormat) + { + case 1: { + stbtt_uint16 startGlyphID = ttUSHORT(classDefTable + 2); + stbtt_uint16 glyphCount = ttUSHORT(classDefTable + 4); + stbtt_uint8 *classDef1ValueArray = classDefTable + 6; - if (glyph >= startGlyphID && glyph < startGlyphID + glyphCount) - return (stbtt_int32)ttUSHORT(classDef1ValueArray + 2 * (glyph - startGlyphID)); + if (glyph >= startGlyphID && glyph < startGlyphID + glyphCount) + return (stbtt_int32)ttUSHORT(classDef1ValueArray + 2 * (glyph - startGlyphID)); + break; + } - classDefTable = classDef1ValueArray + 2 * glyphCount; - } break; + case 2: { + stbtt_uint16 classRangeCount = ttUSHORT(classDefTable + 2); + stbtt_uint8 *classRangeRecords = classDefTable + 4; - case 2: { - stbtt_uint16 classRangeCount = ttUSHORT(classDefTable + 2); - stbtt_uint8 *classRangeRecords = classDefTable + 4; + /* Binary search. */ + stbtt_int32 l=0, r=classRangeCount-1, m; + int strawStart, strawEnd, needle=glyph; + while (l <= r) { + stbtt_uint8 *classRangeRecord; + m = (l + r) >> 1; + classRangeRecord = classRangeRecords + 6 * m; + strawStart = ttUSHORT(classRangeRecord); + strawEnd = ttUSHORT(classRangeRecord + 2); + if (needle < strawStart) + r = m - 1; + else if (needle > strawEnd) + l = m + 1; + else + return (stbtt_int32)ttUSHORT(classRangeRecord + 4); + } + break; + } - /* Binary search. */ - stbtt_int32 l=0, r=classRangeCount-1, m; - int strawStart, strawEnd, needle=glyph; - while (l <= r) { - stbtt_uint8 *classRangeRecord; - m = (l + r) >> 1; - classRangeRecord = classRangeRecords + 6 * m; - strawStart = ttUSHORT(classRangeRecord); - strawEnd = ttUSHORT(classRangeRecord + 2); - if (needle < strawStart) - r = m - 1; - else if (needle > strawEnd) - l = m + 1; - else - return (stbtt_int32)ttUSHORT(classRangeRecord + 4); - } + default: + return -1; /* Unsupported definition type, return an error. */ + } - classDefTable = classRangeRecords + 6 * classRangeCount; - } break; - - default: { - /* There are no other cases. */ - STBTT_assert(0); - } break; - } - - return -1; + /* "All glyphs not assigned to a class fall into class 0". (OpenType spec) */ + return 0; } /* Define to STBTT_assert(x) if you want to break on unimplemented formats. */ #define STBTT_GPOS_TODO_assert(x) -static stbtt_int32 stbtt__GetGlyphGPOSInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) +static stbtt_int32 stbtt__GetGlyphGPOSInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { - stbtt_uint16 lookupListOffset; - stbtt_uint8 *lookupList; - stbtt_uint16 lookupCount; - stbtt_uint8 *data; - stbtt_int32 i; + stbtt_uint16 lookupListOffset; + stbtt_uint8 *lookupList; + stbtt_uint16 lookupCount; + stbtt_uint8 *data; + stbtt_int32 i, sti; - if (!info->gpos) return 0; + if (!info->gpos) return 0; - data = info->data + info->gpos; + data = info->data + info->gpos; - if (ttUSHORT(data+0) != 1) return 0; /* Major version 1 */ - if (ttUSHORT(data+2) != 0) return 0; /* Minor version 0 */ + if (ttUSHORT(data+0) != 1) return 0; /* Major version 1 */ + if (ttUSHORT(data+2) != 0) return 0; /* Minor version 0 */ - lookupListOffset = ttUSHORT(data+8); - lookupList = data + lookupListOffset; - lookupCount = ttUSHORT(lookupList); + lookupListOffset = ttUSHORT(data+8); + lookupList = data + lookupListOffset; + lookupCount = ttUSHORT(lookupList); - for (i=0; i= pairSetCount) return 0; - /* Binary search. */ - while (l <= r) { - stbtt_uint16 secondGlyph; - stbtt_uint8 *pairValue; - m = (l + r) >> 1; - pairValue = pairValueArray + (2 + valueRecordPairSizeInBytes) * m; - secondGlyph = ttUSHORT(pairValue); - straw = secondGlyph; - if (needle < straw) - r = m - 1; - else if (needle > straw) - l = m + 1; - else { - stbtt_int16 xAdvance = ttSHORT(pairValue + 2); - return xAdvance; - } - } - } break; + needle=glyph2; + r=pairValueCount-1; + l=0; - case 2: { - stbtt_uint16 valueFormat1 = ttUSHORT(table + 4); - stbtt_uint16 valueFormat2 = ttUSHORT(table + 6); + /* Binary search. */ + while (l <= r) { + stbtt_uint16 secondGlyph; + stbtt_uint8 *pairValue; + m = (l + r) >> 1; + pairValue = pairValueArray + (2 + valueRecordPairSizeInBytes) * m; + secondGlyph = ttUSHORT(pairValue); + straw = secondGlyph; + if (needle < straw) + r = m - 1; + else if (needle > straw) + l = m + 1; + else { + stbtt_int16 xAdvance = ttSHORT(pairValue + 2); + return xAdvance; + } + } + } else + return 0; + break; + } - stbtt_uint16 classDef1Offset = ttUSHORT(table + 8); - stbtt_uint16 classDef2Offset = ttUSHORT(table + 10); - int glyph1class = stbtt__GetGlyphClass(table + classDef1Offset, glyph1); - int glyph2class = stbtt__GetGlyphClass(table + classDef2Offset, glyph2); + case 2: { + stbtt_uint16 valueFormat1 = ttUSHORT(table + 4); + stbtt_uint16 valueFormat2 = ttUSHORT(table + 6); + if (valueFormat1 == 4 && valueFormat2 == 0) { /* Support more formats? */ + stbtt_uint16 classDef1Offset = ttUSHORT(table + 8); + stbtt_uint16 classDef2Offset = ttUSHORT(table + 10); + int glyph1class = stbtt__GetGlyphClass(table + classDef1Offset, glyph1); + int glyph2class = stbtt__GetGlyphClass(table + classDef2Offset, glyph2); - stbtt_uint16 class1Count = ttUSHORT(table + 12); - stbtt_uint16 class2Count = ttUSHORT(table + 14); - STBTT_assert(glyph1class < class1Count); - STBTT_assert(glyph2class < class2Count); + stbtt_uint16 class1Count = ttUSHORT(table + 12); + stbtt_uint16 class2Count = ttUSHORT(table + 14); + stbtt_uint8 *class1Records, *class2Records; + stbtt_int16 xAdvance; - /* TODO: Support more formats. */ - STBTT_GPOS_TODO_assert(valueFormat1 == 4); - if (valueFormat1 != 4) return 0; - STBTT_GPOS_TODO_assert(valueFormat2 == 0); - if (valueFormat2 != 0) return 0; + if (glyph1class < 0 || glyph1class >= class1Count) return 0; /* malformed */ + if (glyph2class < 0 || glyph2class >= class2Count) return 0; /* malformed */ - if (glyph1class >= 0 && glyph1class < class1Count && glyph2class >= 0 && glyph2class < class2Count) { - stbtt_uint8 *class1Records = table + 16; - stbtt_uint8 *class2Records = class1Records + 2 * (glyph1class * class2Count); - stbtt_int16 xAdvance = ttSHORT(class2Records + 2 * glyph2class); - return xAdvance; - } - } break; - - default: { - /* There are no other cases. */ - STBTT_assert(0); - break; - }; - } - } - break; - }; + class1Records = table + 16; + class2Records = class1Records + 2 * (glyph1class * class2Count); + xAdvance = ttSHORT(class2Records + 2 * glyph2class); + return xAdvance; + } else + return 0; + break; + } default: - /* TODO: Implement other stuff. */ - break; - } - } + return 0; /* Unsupported position format */ + } + } + } - return 0; + return 0; } STBTT_DEF int stbtt_GetGlyphKernAdvance(const stbtt_fontinfo *info, int g1, int g2) @@ -14420,6 +14411,23 @@ static void stbtt__handle_clipped_edge(float *scanline, int x, stbtt__active_edg } } +static float stbtt__sized_trapezoid_area(float height, float top_width, float bottom_width) +{ + STBTT_assert(top_width >= 0); + STBTT_assert(bottom_width >= 0); + return (top_width + bottom_width) / 2.0f * height; +} + +static float stbtt__position_trapezoid_area(float height, float tx0, float tx1, float bx0, float bx1) +{ + return stbtt__sized_trapezoid_area(height, tx1 - tx0, bx1 - bx0); +} + +static float stbtt__sized_triangle_area(float height, float width) +{ + return height * width / 2; +} + static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, int len, stbtt__active_edge *e, float y_top) { float y_bottom = y_top+1; @@ -14474,13 +14482,13 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, float height; /* simple case, only spans one pixel */ int x = (int) x_top; - height = sy1 - sy0; + height = (sy1 - sy0) * e->direction; STBTT_assert(x >= 0 && x < len); - scanline[x] += e->direction * (1-((x_top - x) + (x_bottom-x))/2) * height; - scanline_fill[x] += e->direction * height; /* everything right of this pixel is filled */ + scanline[x] += stbtt__position_trapezoid_area(height, x_top, x+1.0f, x_bottom, x+1.0f); + scanline_fill[x] += height; /* everything right of this pixel is filled */ } else { int x,x1,x2; - float y_crossing, step, sign, area; + float y_crossing, y_final, step, sign, area; /* covers 2+ pixels */ if (x_top > x_bottom) { /* flip scanline vertically; signed area is the same */ @@ -14493,29 +14501,79 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, dy = -dy; t = x0, x0 = xb, xb = t; } + STBTT_assert(dy >= 0); + STBTT_assert(dx >= 0); x1 = (int) x_top; x2 = (int) x_bottom; /* compute intersection with y axis at x1+1 */ - y_crossing = (x1+1 - x0) * dy + y_top; + y_crossing = y_top + dy * (x1+1 - x0); + + /* compute intersection with y axis at x2 */ + y_final = y_top + dy * (x2 - x0); + + /* x1 x_top x2 x_bottom */ + /* y_top +------|-----+------------+------------+--------|---+------------+ */ + /* | | | | | | */ + /* | | | | | | */ + /* sy0 | Txxxxx|............|............|............|............| */ + /* y_crossing | *xxxxx.......|............|............|............| */ + /* | | xxxxx..|............|............|............| */ + /* | | /- xx*xxxx........|............|............| */ + /* | | dy < | xxxxxx..|............|............| */ + /* y_final | | \- | xx*xxx.........|............| */ + /* sy1 | | | | xxxxxB...|............| */ + /* | | | | | | */ + /* | | | | | | */ + /* y_bottom +------------+------------+------------+------------+------------+ */ + /* */ + /* goal is to measure the area covered by '.' in each pixel */ + + /* if x2 is right at the right edge of x1, y_crossing can blow up, github #1057 */ + /* @TODO: maybe test against sy1 rather than y_bottom? */ + if (y_crossing > y_bottom) + y_crossing = y_bottom; sign = e->direction; - /* area of the rectangle covered from y0..y_crossing */ - area = sign * (y_crossing-sy0); - /* area of the triangle (x_top,y0), (x+1,y0), (x+1,y_crossing) */ - scanline[x1] += area * (1-((x_top - x1)+(x1+1-x1))/2); - step = sign * dy; + /* area of the rectangle covered from sy0..y_crossing */ + area = sign * (y_crossing-sy0); + + /* area of the triangle (x_top,sy0), (x1+1,sy0), (x1+1,y_crossing) */ + scanline[x1] += stbtt__sized_triangle_area(area, x1+1 - x_top); + + /* check if final y_crossing is blown up; no test case for this */ + if (y_final > y_bottom) { + y_final = y_bottom; + dy = (y_final - y_crossing ) / (x2 - (x1+1)); /* if denom=0, y_final = y_crossing, so y_final <= y_bottom */ + } + + /* in second pixel, area covered by line segment found in first pixel */ + /* is always a rectangle 1 wide * the height of that line segment; this */ + /* is exactly what the variable 'area' stores. it also gets a contribution */ + /* from the line segment within it. the THIRD pixel will get the first */ + /* pixel's rectangle contribution, the second pixel's rectangle contribution, */ + /* and its own contribution. the 'own contribution' is the same in every pixel except */ + /* the leftmost and rightmost, a trapezoid that slides down in each pixel. */ + /* the second pixel's contribution to the third pixel will be the */ + /* rectangle 1 wide times the height change in the second pixel, which is dy. */ + + step = sign * dy * 1; /* dy is dy/dx, change in y for every 1 change in x, */ + /* which multiplied by 1-pixel-width is how much pixel area changes for each step in x */ + /* so the area advances by 'step' every time */ + for (x = x1+1; x < x2; ++x) { - scanline[x] += area + step/2; + scanline[x] += area + step/2; /* area of trapezoid is 1*step/2 */ area += step; } - y_crossing += dy * (x2 - (x1+1)); + STBTT_assert(STBTT_fabs(area) <= 1.01f); /* accumulated error from area += step unless we round step down */ + STBTT_assert(sy1 > y_final-0.01f); - STBTT_assert(STBTT_fabs(area) <= 1.01f); - - scanline[x2] += area + sign * (1-((x2-x2)+(x_bottom-x2))/2) * (sy1-y_crossing); + /* area covered in the last pixel is the rectangle from all the pixels to the left, */ + /* plus the trapezoid filled by the line segment in this pixel all the way to the right edge */ + scanline[x2] += area + sign * stbtt__position_trapezoid_area(sy1-y_final, (float) x2, x2+1.0f, x_bottom, x2+1.0f); + /* the rest of the line is filled based on the total height of the line segment in this pixel */ scanline_fill[x2] += sign * (sy1-sy0); } } else { @@ -14523,6 +14581,9 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, /* clipping logic. since this does not match the intended use */ /* of this library, we use a different, very slow brute */ /* force implementation */ + /* note though that this does happen some of the time because */ + /* x_top and x_bottom can be extrapolated at the top & bottom of */ + /* the shape and actually lie outside the bounding box */ int x; for (x=0; x < len; ++x) { /* cases: */ @@ -15759,15 +15820,14 @@ static int stbtt__compute_crossings_x(float x, float y, int nverts, stbtt_vertex float y_frac; int winding = 0; - orig[0] = x; - orig[1] = y; - /* make sure y never passes through a vertex of the shape */ y_frac = (float) STBTT_fmod(y, 1.0f); if (y_frac < 0.01f) y += 0.01f; else if (y_frac > 0.99f) y -= 0.01f; + + orig[0] = x; orig[1] = y; /* test a ray from (-infinity,y) to (x,y) */ @@ -15829,35 +15889,35 @@ static float stbtt__cuberoot( float x ) return (float) STBTT_pow( x,1.0f/3.0f); } -/* x^3 + c*x^2 + b*x + a = 0 */ +/* x^3 + a*x^2 + b*x + c = 0 */ static int stbtt__solve_cubic(float a, float b, float c, float* r) { - float s = -a / 3; - float p = b - a*a / 3; - float q = a * (2*a*a - 9*b) / 27 + c; + float s = -a / 3; + float p = b - a*a / 3; + float q = a * (2*a*a - 9*b) / 27 + c; float p3 = p*p*p; - float d = q*q + 4*p3 / 27; - if (d >= 0) { - float z = (float) STBTT_sqrt(d); - float u = (-q + z) / 2; - float v = (-q - z) / 2; - u = stbtt__cuberoot(u); - v = stbtt__cuberoot(v); - r[0] = s + u + v; - return 1; - } else { - float u = (float) STBTT_sqrt(-p/3); - float v = (float) STBTT_acos(-STBTT_sqrt(-27/p3) * q / 2) / 3; /* p3 must be negative, since d is negative */ - float m = (float) STBTT_cos(v); + float d = q*q + 4*p3 / 27; + if (d >= 0) { + float z = (float) STBTT_sqrt(d); + float u = (-q + z) / 2; + float v = (-q - z) / 2; + u = stbtt__cuberoot(u); + v = stbtt__cuberoot(v); + r[0] = s + u + v; + return 1; + } else { + float u = (float) STBTT_sqrt(-p/3); + float v = (float) STBTT_acos(-STBTT_sqrt(-27/p3) * q / 2) / 3; /* p3 must be negative, since d is negative */ + float m = (float) STBTT_cos(v); float n = (float) STBTT_cos(v-3.141592/2)*1.732050808f; - r[0] = s + u * 2 * m; - r[1] = s - u * (m + n); - r[2] = s - u * (m - n); + r[0] = s + u * 2 * m; + r[1] = s - u * (m + n); + r[2] = s - u * (m - n); /* STBTT_assert( STBTT_fabs(((r[0]+a)*r[0]+b)*r[0]+c) < 0.05f); // these asserts may not be safe at all scales, though they're in bezier t parameter units so maybe? */ /* STBTT_assert( STBTT_fabs(((r[1]+a)*r[1]+b)*r[1]+c) < 0.05f); */ /* STBTT_assert( STBTT_fabs(((r[2]+a)*r[2]+b)*r[2]+c) < 0.05f); */ - return 3; + return 3; } } @@ -15934,18 +15994,17 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc for (i=0; i < num_verts; ++i) { float x0 = verts[i].x*scale_x, y0 = verts[i].y*scale_y; - /* check against every point here rather than inside line/curve primitives -- @TODO: wrong if multiple 'moves' in a row produce a garbage point, and given culling, probably more efficient to do within line/curve */ - float dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); - if (dist2 < min_dist*min_dist) - min_dist = (float) STBTT_sqrt(dist2); - - if (verts[i].type == STBTT_vline) { + if (verts[i].type == STBTT_vline && precompute[i] != 0.0f) { float x1 = verts[i-1].x*scale_x, y1 = verts[i-1].y*scale_y; + float dist,dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); + if (dist2 < min_dist*min_dist) + min_dist = (float) STBTT_sqrt(dist2); + /* coarse culling against bbox */ /* if (sx > STBTT_min(x0,x1)-min_dist && sx < STBTT_max(x0,x1)+min_dist && */ /* sy > STBTT_min(y0,y1)-min_dist && sy < STBTT_max(y0,y1)+min_dist) */ - float dist = (float) STBTT_fabs((x1-x0)*(y0-sy) - (y1-y0)*(x0-sx)) * precompute[i]; + dist = (float) STBTT_fabs((x1-x0)*(y0-sy) - (y1-y0)*(x0-sx)) * precompute[i]; STBTT_assert(i != 0); if (dist < min_dist) { /* check position along line */ @@ -15972,7 +16031,8 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc float ax = x1-x0, ay = y1-y0; float bx = x0 - 2*x1 + x2, by = y0 - 2*y1 + y2; float mx = x0 - sx, my = y0 - sy; - float res[3],px,py,t,it; + float res[3] = {0.f,0.f,0.f}; + float px,py,t,it,dist2; float a_inv = precompute[i]; if (a_inv == 0.0) { /* if a_inv is 0, it's 2nd degree so use quadratic formula */ float a = 3*(ax*bx + ay*by); @@ -15999,6 +16059,10 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc float d = (mx*ax+my*ay) * a_inv; num = stbtt__solve_cubic(b, c, d, res); } + dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); + if (dist2 < min_dist*min_dist) + min_dist = (float) STBTT_sqrt(dist2); + if (num >= 1 && res[0] >= 0.0f && res[0] <= 1.0f) { t = res[0], it = 1.0f - t; px = it*it*x0 + 2*t*it*x1 + t*t*x2; @@ -16258,6 +16322,12 @@ STBTT_DEF int stbtt_CompareUTF8toUTF16_bigendian(const char *s1, int len1, const /* FULL VERSION HISTORY */ /* */ +/* 1.25 (2021-07-11) many fixes */ +/* 1.24 (2020-02-05) fix warning */ +/* 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) */ +/* 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined */ +/* 1.21 (2019-02-25) fix warning */ +/* 1.20 (2019-02-07) PackFontRange skips missing codepoints; GetScaleFontVMetrics() */ /* 1.19 (2018-02-11) OpenType GPOS kerning (horizontal only), STBTT_fmod */ /* 1.18 (2018-01-29) add missing function */ /* 1.17 (2017-07-23) make more arguments const; doc fix */ @@ -16442,7 +16512,7 @@ nk_font_chinese_glyph_ranges(void) 0x3000, 0x30FF, 0x31F0, 0x31FF, 0xFF00, 0xFFEF, - 0x4e00, 0x9FAF, + 0x4E00, 0x9FAF, 0 }; return ranges; @@ -17633,20 +17703,20 @@ failed: } NK_API void nk_font_atlas_end(struct nk_font_atlas *atlas, nk_handle texture, - struct nk_draw_null_texture *null) + struct nk_draw_null_texture *tex_null) { int i = 0; struct nk_font *font_iter; NK_ASSERT(atlas); if (!atlas) { - if (!null) return; - null->texture = texture; - null->uv = nk_vec2(0.5f,0.5f); + if (!tex_null) return; + tex_null->texture = texture; + tex_null->uv = nk_vec2(0.5f,0.5f); } - if (null) { - null->texture = texture; - null->uv.x = (atlas->custom.x + 0.5f)/(float)atlas->tex_width; - null->uv.y = (atlas->custom.y + 0.5f)/(float)atlas->tex_height; + if (tex_null) { + tex_null->texture = texture; + tex_null->uv.x = (atlas->custom.x + 0.5f)/(float)atlas->tex_width; + tex_null->uv.y = (atlas->custom.y + 0.5f)/(float)atlas->tex_height; } for (font_iter = atlas->fonts; font_iter; font_iter = font_iter->next) { font_iter->texture = texture; @@ -17815,6 +17885,13 @@ nk_input_button(struct nk_context *ctx, enum nk_buttons id, int x, int y, nk_boo btn->clicked_pos.y = (float)y; btn->down = down; btn->clicked++; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + if (down == 1 && id == NK_BUTTON_LEFT) + { + in->mouse.down_pos.x = btn->clicked_pos.x; + in->mouse.down_pos.y = btn->clicked_pos.y; + } +#endif } NK_API void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val) @@ -17880,6 +17957,22 @@ nk_input_has_mouse_click_in_rect(const struct nk_input *i, enum nk_buttons id, return nk_true; } NK_API nk_bool +nk_input_has_mouse_click_in_button_rect(const struct nk_input *i, enum nk_buttons id, + struct nk_rect b) +{ + const struct nk_mouse_button *btn; + if (!i) return nk_false; + btn = &i->mouse.buttons[id]; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + if (!NK_INBOX(btn->clicked_pos.x,btn->clicked_pos.y,b.x,b.y,b.w,b.h) + || !NK_INBOX(i->mouse.down_pos.x,i->mouse.down_pos.y,b.x,b.y,b.w,b.h)) +#else + if (!NK_INBOX(btn->clicked_pos.x,btn->clicked_pos.y,b.x,b.y,b.w,b.h)) +#endif + return nk_false; + return nk_true; +} +NK_API nk_bool nk_input_has_mouse_click_down_in_rect(const struct nk_input *i, enum nk_buttons id, struct nk_rect b, nk_bool down) { @@ -20383,10 +20476,15 @@ nk_window_is_hovered(struct nk_context *ctx) { NK_ASSERT(ctx); NK_ASSERT(ctx->current); - if (!ctx || !ctx->current) return 0; - if(ctx->current->flags & NK_WINDOW_HIDDEN) + if (!ctx || !ctx->current || (ctx->current->flags & NK_WINDOW_HIDDEN)) return 0; - return nk_input_is_mouse_hovering_rect(&ctx->input, ctx->current->bounds); + else { + struct nk_rect actual_bounds = ctx->current->bounds; + if (ctx->begin->flags & NK_WINDOW_MINIMIZED) { + actual_bounds.h = ctx->current->layout->header_height; + } + return nk_input_is_mouse_hovering_rect(&ctx->input, actual_bounds); + } } NK_API nk_bool nk_window_is_any_hovered(struct nk_context *ctx) @@ -22163,17 +22261,16 @@ nk_layout_peek(struct nk_rect *bounds, struct nk_context *ctx) layout->at_y = y; layout->row.index = index; } -NK_API void +NK_API void nk_spacer(struct nk_context *ctx ) { - struct nk_rect dummy_rect = {0}; + struct nk_rect dummy_rect = { 0, 0, 0, 0 }; nk_panel_alloc_space( &dummy_rect, ctx ); } - /* =============================================================== * * TREE @@ -23685,7 +23782,7 @@ nk_button_behavior(nk_flags *state, struct nk_rect r, *state = NK_WIDGET_STATE_HOVERED; if (nk_input_is_mouse_down(i, NK_BUTTON_LEFT)) *state = NK_WIDGET_STATE_ACTIVE; - if (nk_input_has_mouse_click_in_rect(i, NK_BUTTON_LEFT, r)) { + if (nk_input_has_mouse_click_in_button_rect(i, NK_BUTTON_LEFT, r)) { ret = (behavior != NK_BUTTON_DEFAULT) ? nk_input_is_mouse_down(i, NK_BUTTON_LEFT): #ifdef NK_BUTTON_TRIGGER_ON_RELEASE @@ -26065,7 +26162,7 @@ nk_textedit_text(struct nk_text_edit *state, const char *text, int total_len) text+text_len, 1)) { nk_textedit_makeundo_insert(state, state->cursor, 1); - ++state->cursor; + state->cursor = NK_MIN(state->cursor + 1, state->string.len); state->has_preferred_x = 0; } } @@ -29552,14 +29649,26 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// ## Changelog /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none -/// [date][x.yy.zz]-[description] -/// -[date]: date on which the change has been pushed -/// -[x.yy.zz]: Numerical version string representation. Each version number on the right -/// resets back to zero if version on the left is incremented. -/// - [x]: Major version with API and library breaking changes -/// - [yy]: Minor version with non-breaking API and library changes -/// - [zz]: Bug fix version with no direct changes to API +/// [date] ([x.y.z]) - [description] +/// - [date]: date on which the change has been pushed +/// - [x.y.z]: Version string, represented in Semantic Versioning format +/// - [x]: Major version with API and library breaking changes +/// - [y]: Minor version with non-breaking API and library changes +/// - [z]: Patch version with no direct changes to the API /// +/// - 2022/08/28 (4.10.3) - Renamed the `null` texture variable to `tex_null` +/// - 2022/08/01 (4.10.2) - Fix Apple Silicon with incorrect NK_SITE_TYPE and NK_POINTER_TYPE +/// - 2022/08/01 (4.10.1) - Fix cursor jumping back to beginning of text when typing more than +/// nk_edit_xxx limit +/// - 2022/05/27 (4.10.0) - Add nk_input_has_mouse_click_in_button_rect() to fix window move bug +/// - 2022/04/18 (4.9.7) - Change button behavior when NK_BUTTON_TRIGGER_ON_RELEASE is defined to +/// only trigger when the mouse position was inside the same button on down +/// - 2022/02/03 (4.9.6) - Allow overriding the NK_INV_SQRT function, similar to NK_SIN and NK_COS +/// - 2021/12/22 (4.9.5) - Revert layout bounds not accounting for padding due to regressions +/// - 2021/12/22 (4.9.4) - Fix checking hovering when window is minimized +/// - 2021/12/22 (4.09.3) - Fix layout bounds not accounting for padding +/// - 2021/12/19 (4.09.2) - Update to stb_rect_pack.h v1.01 and stb_truetype.h v1.26 +/// - 2021/12/16 (4.09.1) - Fix the majority of GCC warnings /// - 2021/10/16 (4.09.0) - Added nk_spacer() widget /// - 2021/09/22 (4.08.6) - Fix "may be used uninitialized" warnings in nk_widget /// - 2021/09/22 (4.08.5) - GCC __builtin_offsetof only exists in version 4 and later @@ -29617,7 +29726,7 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2018/01/31 (3.00.5) - Fixed overcalculation of cursor data in font baking process. /// - 2018/01/31 (3.00.4) - Removed name collision with stb_truetype. /// - 2018/01/28 (3.00.3) - Fixed panel window border drawing bug. -/// - 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separed group identifier and title. +/// - 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separated group identifier and title. /// - 2018/01/07 (3.00.1) - Started to change documentation style. /// - 2018/01/05 (3.00.0) - BREAKING CHANGE: The previous color picker API was broken /// because of conversions between float and byte color representation. @@ -29628,13 +29737,13 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2017/12/23 (2.00.7) - Fixed small warning. /// - 2017/12/23 (2.00.7) - Fixed `nk_edit_buffer` behavior if activated to allow input. /// - 2017/12/23 (2.00.7) - Fixed modifyable progressbar dragging visuals and input behavior. -/// - 2017/12/04 (2.00.6) - Added formated string tooltip widget. +/// - 2017/12/04 (2.00.6) - Added formatted string tooltip widget. /// - 2017/11/18 (2.00.5) - Fixed window becoming hidden with flag `NK_WINDOW_NO_INPUT`. /// - 2017/11/15 (2.00.4) - Fixed font merging. /// - 2017/11/07 (2.00.3) - Fixed window size and position modifier functions. /// - 2017/09/14 (2.00.2) - Fixed `nk_edit_buffer` and `nk_edit_focus` behavior. /// - 2017/09/14 (2.00.1) - Fixed window closing behavior. -/// - 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifing window position and size funtions now +/// - 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifying window position and size functions now /// require the name of the window and must happen outside the window /// building process (between function call nk_begin and nk_end). /// - 2017/09/11 (1.40.9) - Fixed window background flag if background window is declared last. @@ -29661,7 +29770,7 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2017/06/08 (1.39.0) - Added function to retrieve window space without calling a `nk_layout_xxx` function. /// - 2017/06/06 (1.38.5) - Fixed `nk_convert` return flag for command buffer. /// - 2017/05/23 (1.38.4) - Fixed activation behavior for widgets partially clipped. -/// - 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundries. +/// - 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundaries. /// - 2017/05/09 (1.38.2) - Fixed vertical scrollbar drawing with not enough space. /// - 2017/05/09 (1.38.1) - Fixed scaler dragging behavior if window size hits minimum size. /// - 2017/05/06 (1.38.0) - Added platform double-click support. @@ -29678,7 +29787,7 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2017/03/04 (1.34.2) - Fixed text edit filtering. /// - 2017/03/04 (1.34.1) - Fixed group closable flag. /// - 2017/02/25 (1.34.0) - Added custom draw command for better language binding support. -/// - 2017/01/24 (1.33.0) - Added programatic way of remove edit focus. +/// - 2017/01/24 (1.33.0) - Added programmatic way to remove edit focus. /// - 2017/01/24 (1.32.3) - Fixed wrong define for basic type definitions for windows. /// - 2017/01/21 (1.32.2) - Fixed input capture from hidden or closed windows. /// - 2017/01/21 (1.32.1) - Fixed slider behavior and drawing. @@ -29723,7 +29832,7 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// text in every edit widget if one of them is scrolled. /// - 2016/09/28 (1.22.3) - Fixed small bug in edit widgets if not active. The wrong /// text length is passed. It should have been in bytes but -/// was passed as glyphes. +/// was passed as glyphs. /// - 2016/09/20 (1.22.2) - Fixed color button size calculation. /// - 2016/09/20 (1.22.1) - Fixed some `nk_vsnprintf` behavior bugs and removed `` /// again from `NK_INCLUDE_STANDARD_VARARGS`. @@ -29803,13 +29912,13 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2016/08/16 (1.09.5) - Fixed ROM mode for deeper levels of popup windows parents. /// - 2016/08/15 (1.09.4) - Editbox are now still active if enter was pressed with flag /// `NK_EDIT_SIG_ENTER`. Main reasoning is to be able to keep -/// typing after commiting. +/// typing after committing. /// - 2016/08/15 (1.09.4) - Removed redundant code. /// - 2016/08/15 (1.09.4) - Fixed negative numbers in `nk_strtoi` and remove unused variable. /// - 2016/08/15 (1.09.3) - Fixed `NK_WINDOW_BACKGROUND` flag behavior to select a background /// window only as selected by hovering and not by clicking. /// - 2016/08/14 (1.09.2) - Fixed a bug in font atlas which caused wrong loading -/// of glyphes for font with multiple ranges. +/// of glyphs for font with multiple ranges. /// - 2016/08/12 (1.09.1) - Added additional function to check if window is currently /// hidden and therefore not visible. /// - 2016/08/12 (1.09.1) - nk_window_is_closed now queries the correct flag `NK_WINDOW_CLOSED` @@ -29825,8 +29934,8 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// precision. /// - 2016/08/08 (1.07.2) - Fixed compiling error without define `NK_INCLUDE_FIXED_TYPE`. /// - 2016/08/08 (1.07.1) - Fixed possible floating point error inside `nk_widget` leading -/// to wrong wiget width calculation which results in widgets falsly -/// becomming tagged as not inside window and cannot be accessed. +/// to wrong wiget width calculation which results in widgets falsely +/// becoming tagged as not inside window and cannot be accessed. /// - 2016/08/08 (1.07.0) - Nuklear now differentiates between hiding a window (NK_WINDOW_HIDDEN) and /// closing a window (NK_WINDOW_CLOSED). A window can be hidden/shown /// by using `nk_window_show` and closed by either clicking the close @@ -29873,7 +29982,7 @@ nk_tooltipfv(struct nk_context *ctx, const char *fmt, va_list args) /// - 2016/07/15 (1.01.0) - Removed internal font baking API and simplified /// font atlas memory management by converting pointer /// arrays for fonts and font configurations to lists. -/// - 2016/07/15 (1.00.0) - Changed button API to use context dependend button +/// - 2016/07/15 (1.00.0) - Changed button API to use context dependent button /// behavior instead of passing it for every function call. /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ /// ## Gallery diff --git a/src/CHANGELOG b/src/CHANGELOG index ce587c8..da6fd2d 100644 --- a/src/CHANGELOG +++ b/src/CHANGELOG @@ -1,13 +1,25 @@ /// ## Changelog /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~none -/// [date][x.yy.zz]-[description] -/// -[date]: date on which the change has been pushed -/// -[x.yy.zz]: Numerical version string representation. Each version number on the right -/// resets back to zero if version on the left is incremented. -/// - [x]: Major version with API and library breaking changes -/// - [yy]: Minor version with non-breaking API and library changes -/// - [zz]: Bug fix version with no direct changes to API +/// [date] ([x.y.z]) - [description] +/// - [date]: date on which the change has been pushed +/// - [x.y.z]: Version string, represented in Semantic Versioning format +/// - [x]: Major version with API and library breaking changes +/// - [y]: Minor version with non-breaking API and library changes +/// - [z]: Patch version with no direct changes to the API /// +/// - 2022/09/03 (4.10.3) - Renamed the `null` texture variable to `tex_null` +/// - 2022/08/01 (4.10.2) - Fix Apple Silicon with incorrect NK_SITE_TYPE and NK_POINTER_TYPE +/// - 2022/08/01 (4.10.1) - Fix cursor jumping back to beginning of text when typing more than +/// nk_edit_xxx limit +/// - 2022/05/27 (4.10.0) - Add nk_input_has_mouse_click_in_button_rect() to fix window move bug +/// - 2022/04/18 (4.9.7) - Change button behavior when NK_BUTTON_TRIGGER_ON_RELEASE is defined to +/// only trigger when the mouse position was inside the same button on down +/// - 2022/02/03 (4.9.6) - Allow overriding the NK_INV_SQRT function, similar to NK_SIN and NK_COS +/// - 2021/12/22 (4.9.5) - Revert layout bounds not accounting for padding due to regressions +/// - 2021/12/22 (4.9.4) - Fix checking hovering when window is minimized +/// - 2021/12/22 (4.09.3) - Fix layout bounds not accounting for padding +/// - 2021/12/19 (4.09.2) - Update to stb_rect_pack.h v1.01 and stb_truetype.h v1.26 +/// - 2021/12/16 (4.09.1) - Fix the majority of GCC warnings /// - 2021/10/16 (4.09.0) - Added nk_spacer() widget /// - 2021/09/22 (4.08.6) - Fix "may be used uninitialized" warnings in nk_widget /// - 2021/09/22 (4.08.5) - GCC __builtin_offsetof only exists in version 4 and later @@ -65,7 +77,7 @@ /// - 2018/01/31 (3.00.5) - Fixed overcalculation of cursor data in font baking process. /// - 2018/01/31 (3.00.4) - Removed name collision with stb_truetype. /// - 2018/01/28 (3.00.3) - Fixed panel window border drawing bug. -/// - 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separed group identifier and title. +/// - 2018/01/12 (3.00.2) - Added `nk_group_begin_titled` for separated group identifier and title. /// - 2018/01/07 (3.00.1) - Started to change documentation style. /// - 2018/01/05 (3.00.0) - BREAKING CHANGE: The previous color picker API was broken /// because of conversions between float and byte color representation. @@ -76,13 +88,13 @@ /// - 2017/12/23 (2.00.7) - Fixed small warning. /// - 2017/12/23 (2.00.7) - Fixed `nk_edit_buffer` behavior if activated to allow input. /// - 2017/12/23 (2.00.7) - Fixed modifyable progressbar dragging visuals and input behavior. -/// - 2017/12/04 (2.00.6) - Added formated string tooltip widget. +/// - 2017/12/04 (2.00.6) - Added formatted string tooltip widget. /// - 2017/11/18 (2.00.5) - Fixed window becoming hidden with flag `NK_WINDOW_NO_INPUT`. /// - 2017/11/15 (2.00.4) - Fixed font merging. /// - 2017/11/07 (2.00.3) - Fixed window size and position modifier functions. /// - 2017/09/14 (2.00.2) - Fixed `nk_edit_buffer` and `nk_edit_focus` behavior. /// - 2017/09/14 (2.00.1) - Fixed window closing behavior. -/// - 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifing window position and size funtions now +/// - 2017/09/14 (2.00.0) - BREAKING CHANGE: Modifying window position and size functions now /// require the name of the window and must happen outside the window /// building process (between function call nk_begin and nk_end). /// - 2017/09/11 (1.40.9) - Fixed window background flag if background window is declared last. @@ -109,7 +121,7 @@ /// - 2017/06/08 (1.39.0) - Added function to retrieve window space without calling a `nk_layout_xxx` function. /// - 2017/06/06 (1.38.5) - Fixed `nk_convert` return flag for command buffer. /// - 2017/05/23 (1.38.4) - Fixed activation behavior for widgets partially clipped. -/// - 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundries. +/// - 2017/05/10 (1.38.3) - Fixed wrong min window size mouse scaling over boundaries. /// - 2017/05/09 (1.38.2) - Fixed vertical scrollbar drawing with not enough space. /// - 2017/05/09 (1.38.1) - Fixed scaler dragging behavior if window size hits minimum size. /// - 2017/05/06 (1.38.0) - Added platform double-click support. @@ -126,7 +138,7 @@ /// - 2017/03/04 (1.34.2) - Fixed text edit filtering. /// - 2017/03/04 (1.34.1) - Fixed group closable flag. /// - 2017/02/25 (1.34.0) - Added custom draw command for better language binding support. -/// - 2017/01/24 (1.33.0) - Added programatic way of remove edit focus. +/// - 2017/01/24 (1.33.0) - Added programmatic way to remove edit focus. /// - 2017/01/24 (1.32.3) - Fixed wrong define for basic type definitions for windows. /// - 2017/01/21 (1.32.2) - Fixed input capture from hidden or closed windows. /// - 2017/01/21 (1.32.1) - Fixed slider behavior and drawing. @@ -171,7 +183,7 @@ /// text in every edit widget if one of them is scrolled. /// - 2016/09/28 (1.22.3) - Fixed small bug in edit widgets if not active. The wrong /// text length is passed. It should have been in bytes but -/// was passed as glyphes. +/// was passed as glyphs. /// - 2016/09/20 (1.22.2) - Fixed color button size calculation. /// - 2016/09/20 (1.22.1) - Fixed some `nk_vsnprintf` behavior bugs and removed `` /// again from `NK_INCLUDE_STANDARD_VARARGS`. @@ -251,13 +263,13 @@ /// - 2016/08/16 (1.09.5) - Fixed ROM mode for deeper levels of popup windows parents. /// - 2016/08/15 (1.09.4) - Editbox are now still active if enter was pressed with flag /// `NK_EDIT_SIG_ENTER`. Main reasoning is to be able to keep -/// typing after commiting. +/// typing after committing. /// - 2016/08/15 (1.09.4) - Removed redundant code. /// - 2016/08/15 (1.09.4) - Fixed negative numbers in `nk_strtoi` and remove unused variable. /// - 2016/08/15 (1.09.3) - Fixed `NK_WINDOW_BACKGROUND` flag behavior to select a background /// window only as selected by hovering and not by clicking. /// - 2016/08/14 (1.09.2) - Fixed a bug in font atlas which caused wrong loading -/// of glyphes for font with multiple ranges. +/// of glyphs for font with multiple ranges. /// - 2016/08/12 (1.09.1) - Added additional function to check if window is currently /// hidden and therefore not visible. /// - 2016/08/12 (1.09.1) - nk_window_is_closed now queries the correct flag `NK_WINDOW_CLOSED` @@ -273,8 +285,8 @@ /// precision. /// - 2016/08/08 (1.07.2) - Fixed compiling error without define `NK_INCLUDE_FIXED_TYPE`. /// - 2016/08/08 (1.07.1) - Fixed possible floating point error inside `nk_widget` leading -/// to wrong wiget width calculation which results in widgets falsly -/// becomming tagged as not inside window and cannot be accessed. +/// to wrong wiget width calculation which results in widgets falsely +/// becoming tagged as not inside window and cannot be accessed. /// - 2016/08/08 (1.07.0) - Nuklear now differentiates between hiding a window (NK_WINDOW_HIDDEN) and /// closing a window (NK_WINDOW_CLOSED). A window can be hidden/shown /// by using `nk_window_show` and closed by either clicking the close @@ -321,6 +333,6 @@ /// - 2016/07/15 (1.01.0) - Removed internal font baking API and simplified /// font atlas memory management by converting pointer /// arrays for fonts and font configurations to lists. -/// - 2016/07/15 (1.00.0) - Changed button API to use context dependend button +/// - 2016/07/15 (1.00.0) - Changed button API to use context dependent button /// behavior instead of passing it for every function call. /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/src/HEADER b/src/HEADER index 0f6b672..3a5bffe 100644 --- a/src/HEADER +++ b/src/HEADER @@ -76,7 +76,7 @@ /// and does not contain the actual implementation.

/// /// The implementation mode requires to define the preprocessor macro -/// NK_IMPLEMENTATION in *one* .c/.cpp file before #includeing this file, e.g.: +/// NK_IMPLEMENTATION in *one* .c/.cpp file before #including this file, e.g.: /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~C /// #define NK_IMPLEMENTATION @@ -146,7 +146,7 @@ /// NK_ASSERT | If you don't define this, nuklear will use with assert(). /// NK_MEMSET | You can define this to 'memset' or your own memset implementation replacement. If not nuklear will use its own version. /// NK_MEMCPY | You can define this to 'memcpy' or your own memcpy implementation replacement. If not nuklear will use its own version. -/// NK_SQRT | You can define this to 'sqrt' or your own sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. +/// NK_INV_SQRT | You can define this to your own inverse sqrt implementation replacement. If not nuklear will use its own slow and not highly accurate version. /// NK_SIN | You can define this to 'sinf' or your own sine implementation replacement. If not nuklear will use its own approximation implementation. /// NK_COS | You can define this to 'cosf' or your own cosine implementation replacement. If not nuklear will use its own approximation implementation. /// NK_STRTOD | You can define this to `strtod` or your own string to double conversion implementation replacement. If not defined nuklear will use its own imprecise and possibly unsafe version (does not handle nan or infinity!). diff --git a/src/nuklear.h b/src/nuklear.h index 89a75b6..2d4af9d 100644 --- a/src/nuklear.h +++ b/src/nuklear.h @@ -151,7 +151,7 @@ extern "C" { #elif (defined(_WIN32) || defined(WIN32)) && defined(_MSC_VER) #define NK_SIZE_TYPE unsigned __int32 #elif defined(__GNUC__) || defined(__clang__) - #if defined(__x86_64__) || defined(__ppc64__) + #if defined(__x86_64__) || defined(__ppc64__) || defined(__aarch64__) #define NK_SIZE_TYPE unsigned long #else #define NK_SIZE_TYPE unsigned int @@ -166,7 +166,7 @@ extern "C" { #elif (defined(_WIN32) || defined(WIN32)) && defined(_MSC_VER) #define NK_POINTER_TYPE unsigned __int32 #elif defined(__GNUC__) || defined(__clang__) - #if defined(__x86_64__) || defined(__ppc64__) + #if defined(__x86_64__) || defined(__ppc64__) || defined(__aarch64__) #define NK_POINTER_TYPE unsigned long #else #define NK_POINTER_TYPE unsigned int @@ -491,7 +491,7 @@ NK_API void nk_set_user_data(struct nk_context*, nk_handle handle); /// /// #### Usage /// Input state needs to be provided to nuklear by first calling `nk_input_begin` -/// which resets internal state like delta mouse position and button transistions. +/// which resets internal state like delta mouse position and button transitions. /// After `nk_input_begin` all current input state needs to be provided. This includes /// mouse motion, button and key pressed and released, text input and scrolling. /// Both event- or state-based input handling are supported by this API @@ -906,7 +906,7 @@ NK_API void nk_input_end(struct nk_context*); /// cfg.curve_segment_count = 22; /// cfg.arc_segment_count = 22; /// cfg.global_alpha = 1.0f; -/// cfg.null = dev->null; +/// cfg.tex_null = dev->tex_null; /// // /// // setup buffers and convert /// struct nk_buffer cmds, verts, idx; @@ -956,7 +956,7 @@ struct nk_convert_config { unsigned circle_segment_count; /* number of segments used for circles: default to 22 */ unsigned arc_segment_count; /* number of segments used for arcs: default to 22 */ unsigned curve_segment_count; /* number of segments used for curves: default to 22 */ - struct nk_draw_null_texture null; /* handle to texture with a white pixel for shape drawing */ + struct nk_draw_null_texture tex_null; /* handle to texture with a white pixel for shape drawing */ const struct nk_draw_vertex_layout_element *vertex_layout; /* describes the vertex output format and packing */ nk_size vertex_size; /* sizeof one vertex for vertex packing */ nk_size vertex_alignment; /* vertex alignment: Can be obtained by NK_ALIGNOF */ @@ -1034,7 +1034,7 @@ NK_API const struct nk_command* nk__next(struct nk_context*, const struct nk_com /// NK_CONVERT_INVALID_PARAM | An invalid argument was passed in the function call /// NK_CONVERT_COMMAND_BUFFER_FULL | The provided buffer for storing draw commands is full or failed to allocate more memory /// NK_CONVERT_VERTEX_BUFFER_FULL | The provided buffer for storing vertices is full or failed to allocate more memory -/// NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indicies is full or failed to allocate more memory +/// NK_CONVERT_ELEMENT_BUFFER_FULL | The provided buffer for storing indices is full or failed to allocate more memory */ NK_API nk_flags nk_convert(struct nk_context*, struct nk_buffer *cmds, struct nk_buffer *vertices, struct nk_buffer *elements, const struct nk_convert_config*); /*/// #### nk__draw_begin @@ -1241,8 +1241,8 @@ NK_API const struct nk_draw_command* nk__draw_next(const struct nk_draw_command* /// #### nk_collapse_states /// State | Description /// ----------------|----------------------------------------------------------- -/// __NK_MINIMIZED__| UI section is collased and not visibile until maximized -/// __NK_MAXIMIZED__| UI section is extended and visibile until minimized +/// __NK_MINIMIZED__| UI section is collased and not visible until maximized +/// __NK_MAXIMIZED__| UI section is extended and visible until minimized ///

*/ enum nk_panel_flags { @@ -2391,7 +2391,7 @@ NK_API void nk_spacer(struct nk_context* ); /// widgets inside the window if the value is not 0. /// Nesting groups is possible and even encouraged since many layouting schemes /// can only be achieved by nesting. Groups, unlike windows, need `nk_group_end` -/// to be only called if the corosponding `nk_group_begin_xxx` call does not return 0: +/// to be only called if the corresponding `nk_group_begin_xxx` call does not return 0: /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// if (nk_group_begin_xxx(ctx, ...) { @@ -2451,7 +2451,7 @@ NK_API void nk_spacer(struct nk_context* ); /// Function | Description /// --------------------------------|------------------------------------------- /// nk_group_begin | Start a new group with internal scrollbar handling -/// nk_group_begin_titled | Start a new group with separeted name and title and internal scrollbar handling +/// nk_group_begin_titled | Start a new group with separated name and title and internal scrollbar handling /// nk_group_end | Ends a group. Should only be called if nk_group_begin returned non-zero /// nk_group_scrolled_offset_begin | Start a new group with manual separated handling of scrollbar x- and y-offset /// nk_group_scrolled_begin | Start a new group with manual scrollbar handling @@ -2581,13 +2581,13 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of * * ============================================================================= /// ### Tree -/// Trees represent two different concept. First the concept of a collapsable -/// UI section that can be either in a hidden or visibile state. They allow the UI +/// Trees represent two different concept. First the concept of a collapsible +/// UI section that can be either in a hidden or visible state. They allow the UI /// user to selectively minimize the current set of visible UI to comprehend. /// The second concept are tree widgets for visual UI representation of trees.

/// /// Trees thereby can be nested for tree representations and multiple nested -/// collapsable UI sections. All trees are started by calling of the +/// collapsible UI sections. All trees are started by calling of the /// `nk_tree_xxx_push_tree` functions and ended by calling one of the /// `nk_tree_xxx_pop_xxx()` functions. Each starting functions takes a title label /// and optionally an image to be displayed and the initial collapse state from @@ -2602,7 +2602,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of /// /// #### Usage /// To create a tree you have to call one of the seven `nk_tree_xxx_push_xxx` -/// functions to start a collapsable UI section and `nk_tree_xxx_pop` to mark the +/// functions to start a collapsible UI section and `nk_tree_xxx_pop` to mark the /// end. /// Each starting function will either return `false(0)` if the tree is collapsed /// or hidden and therefore does not need to be filled with content or `true(1)` @@ -2627,28 +2627,28 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of /// #### Reference /// Function | Description /// ----------------------------|------------------------------------------- -/// nk_tree_push | Start a collapsable UI section with internal state management -/// nk_tree_push_id | Start a collapsable UI section with internal state management callable in a look -/// nk_tree_push_hashed | Start a collapsable UI section with internal state management with full control over internal unique ID use to store state -/// nk_tree_image_push | Start a collapsable UI section with image and label header -/// nk_tree_image_push_id | Start a collapsable UI section with image and label header and internal state management callable in a look -/// nk_tree_image_push_hashed | Start a collapsable UI section with image and label header and internal state management with full control over internal unique ID use to store state -/// nk_tree_pop | Ends a collapsable UI section +/// nk_tree_push | Start a collapsible UI section with internal state management +/// nk_tree_push_id | Start a collapsible UI section with internal state management callable in a look +/// nk_tree_push_hashed | Start a collapsible UI section with internal state management with full control over internal unique ID use to store state +/// nk_tree_image_push | Start a collapsible UI section with image and label header +/// nk_tree_image_push_id | Start a collapsible UI section with image and label header and internal state management callable in a look +/// nk_tree_image_push_hashed | Start a collapsible UI section with image and label header and internal state management with full control over internal unique ID use to store state +/// nk_tree_pop | Ends a collapsible UI section // -/// nk_tree_state_push | Start a collapsable UI section with external state management -/// nk_tree_state_image_push | Start a collapsable UI section with image and label header and external state management +/// nk_tree_state_push | Start a collapsible UI section with external state management +/// nk_tree_state_image_push | Start a collapsible UI section with image and label header and external state management /// nk_tree_state_pop | Ends a collapsabale UI section /// /// #### nk_tree_type /// Flag | Description /// ----------------|---------------------------------------- -/// NK_TREE_NODE | Highlighted tree header to mark a collapsable UI section -/// NK_TREE_TAB | Non-highighted tree header closer to tree representations +/// NK_TREE_NODE | Highlighted tree header to mark a collapsible UI section +/// NK_TREE_TAB | Non-highlighted tree header closer to tree representations */ /*/// #### nk_tree_push -/// Starts a collapsable UI section with internal state management +/// Starts a collapsible UI section with internal state management /// !!! WARNING -/// To keep track of the runtime tree collapsable state this function uses +/// To keep track of the runtime tree collapsible state this function uses /// defines `__FILE__` and `__LINE__` to generate a unique ID. If you want /// to call this function in a loop please use `nk_tree_push_id` or /// `nk_tree_push_hashed` instead. @@ -2668,7 +2668,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ #define nk_tree_push(ctx, type, title, state) nk_tree_push_hashed(ctx, type, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),__LINE__) /*/// #### nk_tree_push_id -/// Starts a collapsable UI section with internal state management callable in a look +/// Starts a collapsible UI section with internal state management callable in a look /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// #define nk_tree_push_id(ctx, type, title, state, id) /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2685,7 +2685,7 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ #define nk_tree_push_id(ctx, type, title, state, id) nk_tree_push_hashed(ctx, type, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),id) /*/// #### nk_tree_push_hashed -/// Start a collapsable UI section with internal state management with full +/// Start a collapsible UI section with internal state management with full /// control over internal unique ID used to store state /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); @@ -2705,9 +2705,9 @@ NK_API void nk_group_set_scroll(struct nk_context*, const char *id, nk_uint x_of */ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); /*/// #### nk_tree_image_push -/// Start a collapsable UI section with image and label header +/// Start a collapsible UI section with image and label header /// !!! WARNING -/// To keep track of the runtime tree collapsable state this function uses +/// To keep track of the runtime tree collapsible state this function uses /// defines `__FILE__` and `__LINE__` to generate a unique ID. If you want /// to call this function in a loop please use `nk_tree_image_push_id` or /// `nk_tree_image_push_hashed` instead. @@ -2728,7 +2728,7 @@ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const */ #define nk_tree_image_push(ctx, type, img, title, state) nk_tree_image_push_hashed(ctx, type, img, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),__LINE__) /*/// #### nk_tree_image_push_id -/// Start a collapsable UI section with image and label header and internal state +/// Start a collapsible UI section with image and label header and internal state /// management callable in a look /// /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c @@ -2748,7 +2748,7 @@ NK_API nk_bool nk_tree_push_hashed(struct nk_context*, enum nk_tree_type, const */ #define nk_tree_image_push_id(ctx, type, img, title, state, id) nk_tree_image_push_hashed(ctx, type, img, title, state, NK_FILE_LINE,nk_strlen(NK_FILE_LINE),id) /*/// #### nk_tree_image_push_hashed -/// Start a collapsable UI section with internal state management with full +/// Start a collapsible UI section with internal state management with full /// control over internal unique ID used to store state /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states initial_state, const char *hash, int len,int seed); @@ -2780,7 +2780,7 @@ NK_API nk_bool nk_tree_image_push_hashed(struct nk_context*, enum nk_tree_type, */ NK_API void nk_tree_pop(struct nk_context*); /*/// #### nk_tree_state_push -/// Start a collapsable UI section with external state management +/// Start a collapsible UI section with external state management /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2796,7 +2796,7 @@ NK_API void nk_tree_pop(struct nk_context*); */ NK_API nk_bool nk_tree_state_push(struct nk_context*, enum nk_tree_type, const char *title, enum nk_collapse_states *state); /*/// #### nk_tree_state_image_push -/// Start a collapsable UI section with image and label header and external state management +/// Start a collapsible UI section with image and label header and external state management /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~c /// nk_bool nk_tree_state_image_push(struct nk_context*, enum nk_tree_type, struct nk_image, const char *title, enum nk_collapse_states *state); /// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3023,10 +3023,10 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo /// or by directly typing a number. /// /// #### Usage -/// Each property requires a unique name for identifaction that is also used for +/// Each property requires a unique name for identification that is also used for /// displaying a label. If you want to use the same name multiple times make sure /// add a '#' before your name. The '#' will not be shown but will generate a -/// unique ID. Each propery also takes in a minimum and maximum value. If you want +/// unique ID. Each property also takes in a minimum and maximum value. If you want /// to make use of the complete number range of a type just use the provided /// type limits from `limits.h`. For example `INT_MIN` and `INT_MAX` for /// `nk_property_int` and `nk_propertyi`. In additional each property takes in @@ -3080,16 +3080,16 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo /// #### Reference /// Function | Description /// --------------------|------------------------------------------- -/// nk_property_int | Integer property directly modifing a passed in value -/// nk_property_float | Float property directly modifing a passed in value -/// nk_property_double | Double property directly modifing a passed in value +/// nk_property_int | Integer property directly modifying a passed in value +/// nk_property_float | Float property directly modifying a passed in value +/// nk_property_double | Double property directly modifying a passed in value /// nk_propertyi | Integer property returning the modified int value /// nk_propertyf | Float property returning the modified float value /// nk_propertyd | Double property returning the modified double value /// */ /*/// #### nk_property_int -/// Integer property directly modifing a passed in value +/// Integer property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3110,7 +3110,7 @@ NK_API nk_bool nk_color_pick(struct nk_context*, struct nk_colorf*, enum nk_colo */ NK_API void nk_property_int(struct nk_context*, const char *name, int min, int *val, int max, int step, float inc_per_pixel); /*/// #### nk_property_float -/// Float property directly modifing a passed in value +/// Float property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3131,7 +3131,7 @@ NK_API void nk_property_int(struct nk_context*, const char *name, int min, int * */ NK_API void nk_property_float(struct nk_context*, const char *name, float min, float *val, float max, float step, float inc_per_pixel); /*/// #### nk_property_double -/// Double property directly modifing a passed in value +/// Double property directly modifying a passed in value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3152,7 +3152,7 @@ NK_API void nk_property_float(struct nk_context*, const char *name, float min, f */ NK_API void nk_property_double(struct nk_context*, const char *name, double min, double *val, double max, double step, float inc_per_pixel); /*/// #### nk_propertyi -/// Integer property modifing a passed in value and returning the new value +/// Integer property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3175,7 +3175,7 @@ NK_API void nk_property_double(struct nk_context*, const char *name, double min, */ NK_API int nk_propertyi(struct nk_context*, const char *name, int min, int val, int max, int step, float inc_per_pixel); /*/// #### nk_propertyf -/// Float property modifing a passed in value and returning the new value +/// Float property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3198,7 +3198,7 @@ NK_API int nk_propertyi(struct nk_context*, const char *name, int min, int val, */ NK_API float nk_propertyf(struct nk_context*, const char *name, float min, float val, float max, float step, float inc_per_pixel); /*/// #### nk_propertyd -/// Float property modifing a passed in value and returning the new value +/// Float property modifying a passed in value and returning the new value /// !!! WARNING /// To generate a unique property ID using the same label make sure to insert /// a `#` at the beginning. It will not be shown but guarantees correct behavior. @@ -3791,7 +3791,7 @@ struct nk_font_config { unsigned char pixel_snap; /* align every character to pixel boundary (if true set oversample (1,1)) */ unsigned char oversample_v, oversample_h; - /* rasterize at hight quality for sub-pixel position */ + /* rasterize at high quality for sub-pixel position */ unsigned char padding[3]; float size; @@ -4433,6 +4433,9 @@ struct nk_mouse_button { struct nk_mouse { struct nk_mouse_button buttons[NK_BUTTON_MAX]; struct nk_vec2 pos; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + struct nk_vec2 down_pos; +#endif struct nk_vec2 prev; struct nk_vec2 delta; struct nk_vec2 scroll_delta; @@ -4458,6 +4461,7 @@ struct nk_input { NK_API nk_bool nk_input_has_mouse_click(const struct nk_input*, enum nk_buttons); NK_API nk_bool nk_input_has_mouse_click_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); +NK_API nk_bool nk_input_has_mouse_click_in_button_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); NK_API nk_bool nk_input_has_mouse_click_down_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect, nk_bool down); NK_API nk_bool nk_input_is_mouse_click_in_rect(const struct nk_input*, enum nk_buttons, struct nk_rect); NK_API nk_bool nk_input_is_mouse_click_down_in_rect(const struct nk_input *i, enum nk_buttons id, struct nk_rect b, nk_bool down); diff --git a/src/nuklear_button.c b/src/nuklear_button.c index 54f02f7..2636b60 100644 --- a/src/nuklear_button.c +++ b/src/nuklear_button.c @@ -70,7 +70,7 @@ nk_button_behavior(nk_flags *state, struct nk_rect r, *state = NK_WIDGET_STATE_HOVERED; if (nk_input_is_mouse_down(i, NK_BUTTON_LEFT)) *state = NK_WIDGET_STATE_ACTIVE; - if (nk_input_has_mouse_click_in_rect(i, NK_BUTTON_LEFT, r)) { + if (nk_input_has_mouse_click_in_button_rect(i, NK_BUTTON_LEFT, r)) { ret = (behavior != NK_BUTTON_DEFAULT) ? nk_input_is_mouse_down(i, NK_BUTTON_LEFT): #ifdef NK_BUTTON_TRIGGER_ON_RELEASE diff --git a/src/nuklear_font.c b/src/nuklear_font.c index 541bf48..49df38e 100644 --- a/src/nuklear_font.c +++ b/src/nuklear_font.c @@ -85,7 +85,7 @@ nk_font_chinese_glyph_ranges(void) 0x3000, 0x30FF, 0x31F0, 0x31FF, 0xFF00, 0xFFEF, - 0x4e00, 0x9FAF, + 0x4E00, 0x9FAF, 0 }; return ranges; @@ -1276,20 +1276,20 @@ failed: } NK_API void nk_font_atlas_end(struct nk_font_atlas *atlas, nk_handle texture, - struct nk_draw_null_texture *null) + struct nk_draw_null_texture *tex_null) { int i = 0; struct nk_font *font_iter; NK_ASSERT(atlas); if (!atlas) { - if (!null) return; - null->texture = texture; - null->uv = nk_vec2(0.5f,0.5f); + if (!tex_null) return; + tex_null->texture = texture; + tex_null->uv = nk_vec2(0.5f,0.5f); } - if (null) { - null->texture = texture; - null->uv.x = (atlas->custom.x + 0.5f)/(float)atlas->tex_width; - null->uv.y = (atlas->custom.y + 0.5f)/(float)atlas->tex_height; + if (tex_null) { + tex_null->texture = texture; + tex_null->uv.x = (atlas->custom.x + 0.5f)/(float)atlas->tex_width; + tex_null->uv.y = (atlas->custom.y + 0.5f)/(float)atlas->tex_height; } for (font_iter = atlas->fonts; font_iter; font_iter = font_iter->next) { font_iter->texture = texture; diff --git a/src/nuklear_input.c b/src/nuklear_input.c index 0c3e14d..e438581 100644 --- a/src/nuklear_input.c +++ b/src/nuklear_input.c @@ -83,6 +83,13 @@ nk_input_button(struct nk_context *ctx, enum nk_buttons id, int x, int y, nk_boo btn->clicked_pos.y = (float)y; btn->down = down; btn->clicked++; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + if (down == 1 && id == NK_BUTTON_LEFT) + { + in->mouse.down_pos.x = btn->clicked_pos.x; + in->mouse.down_pos.y = btn->clicked_pos.y; + } +#endif } NK_API void nk_input_scroll(struct nk_context *ctx, struct nk_vec2 val) @@ -148,6 +155,22 @@ nk_input_has_mouse_click_in_rect(const struct nk_input *i, enum nk_buttons id, return nk_true; } NK_API nk_bool +nk_input_has_mouse_click_in_button_rect(const struct nk_input *i, enum nk_buttons id, + struct nk_rect b) +{ + const struct nk_mouse_button *btn; + if (!i) return nk_false; + btn = &i->mouse.buttons[id]; +#ifdef NK_BUTTON_TRIGGER_ON_RELEASE + if (!NK_INBOX(btn->clicked_pos.x,btn->clicked_pos.y,b.x,b.y,b.w,b.h) + || !NK_INBOX(i->mouse.down_pos.x,i->mouse.down_pos.y,b.x,b.y,b.w,b.h)) +#else + if (!NK_INBOX(btn->clicked_pos.x,btn->clicked_pos.y,b.x,b.y,b.w,b.h)) +#endif + return nk_false; + return nk_true; +} +NK_API nk_bool nk_input_has_mouse_click_down_in_rect(const struct nk_input *i, enum nk_buttons id, struct nk_rect b, nk_bool down) { diff --git a/src/nuklear_internal.h b/src/nuklear_internal.h index ec8081b..8d1b785 100644 --- a/src/nuklear_internal.h +++ b/src/nuklear_internal.h @@ -94,7 +94,9 @@ NK_GLOBAL const struct nk_color nk_yellow = {255,255,0,255}; else (*(s)) = NK_WIDGET_STATE_INACTIVE; /* math */ +#ifndef NK_INV_SQRT NK_LIB float nk_inv_sqrt(float n); +#endif #ifndef NK_SIN NK_LIB float nk_sin(float x); #endif diff --git a/src/nuklear_layout.c b/src/nuklear_layout.c index b737aca..0229bd0 100644 --- a/src/nuklear_layout.c +++ b/src/nuklear_layout.c @@ -760,10 +760,9 @@ nk_layout_peek(struct nk_rect *bounds, struct nk_context *ctx) layout->at_y = y; layout->row.index = index; } -NK_API void +NK_API void nk_spacer(struct nk_context *ctx ) { - struct nk_rect dummy_rect = {0}; + struct nk_rect dummy_rect = { 0, 0, 0, 0 }; nk_panel_alloc_space( &dummy_rect, ctx ); } - diff --git a/src/nuklear_math.c b/src/nuklear_math.c index b70651b..c288a0b 100644 --- a/src/nuklear_math.c +++ b/src/nuklear_math.c @@ -33,6 +33,8 @@ (it can actually approximate a lot more functions) can be found here: www.lolengine.net/wiki/oss/lolremez */ +#ifndef NK_INV_SQRT +#define NK_INV_SQRT nk_inv_sqrt NK_LIB float nk_inv_sqrt(float n) { @@ -45,6 +47,7 @@ nk_inv_sqrt(float n) conv.f = conv.f * (threehalfs - (x2 * conv.f * conv.f)); return conv.f; } +#endif #ifndef NK_SIN #define NK_SIN nk_sin NK_LIB float diff --git a/src/nuklear_text_editor.c b/src/nuklear_text_editor.c index 5b0c03a..e381857 100644 --- a/src/nuklear_text_editor.c +++ b/src/nuklear_text_editor.c @@ -394,7 +394,7 @@ nk_textedit_text(struct nk_text_edit *state, const char *text, int total_len) text+text_len, 1)) { nk_textedit_makeundo_insert(state, state->cursor, 1); - ++state->cursor; + state->cursor = NK_MIN(state->cursor + 1, state->string.len); state->has_preferred_x = 0; } } diff --git a/src/nuklear_vertex.c b/src/nuklear_vertex.c index 8e94f88..ce1f94e 100644 --- a/src/nuklear_vertex.c +++ b/src/nuklear_vertex.c @@ -177,7 +177,7 @@ nk_draw_list_add_clip(struct nk_draw_list *list, struct nk_rect rect) NK_ASSERT(list); if (!list) return; if (!list->cmd_count) { - nk_draw_list_push_command(list, rect, list->config.null.texture); + nk_draw_list_push_command(list, rect, list->config.tex_null.texture); } else { struct nk_draw_command *prev = nk_draw_list_command_last(list); if (prev->elem_count == 0) @@ -227,14 +227,14 @@ nk_draw_list_alloc_vertices(struct nk_draw_list *list, nk_size count) /* This assert triggers because your are drawing a lot of stuff and nuklear * defined `nk_draw_index` as `nk_ushort` to safe space be default. * - * So you reached the maximum number of indicies or rather vertexes. - * To solve this issue please change typdef `nk_draw_index` to `nk_uint` + * So you reached the maximum number of indices or rather vertexes. + * To solve this issue please change typedef `nk_draw_index` to `nk_uint` * and don't forget to specify the new element size in your drawing * backend (OpenGL, DirectX, ...). For example in OpenGL for `glDrawElements` - * instead of specifing `GL_UNSIGNED_SHORT` you have to define `GL_UNSIGNED_INT`. + * instead of specifying `GL_UNSIGNED_SHORT` you have to define `GL_UNSIGNED_INT`. * Sorry for the inconvenience. */ if(sizeof(nk_draw_index)==2) NK_ASSERT((list->vertex_count < NK_USHORT_MAX && - "To many verticies for 16-bit vertex indicies. Please read comment above on how to solve this problem")); + "To many vertices for 16-bit vertex indices. Please read comment above on how to solve this problem")); return vtx; } NK_INTERN nk_draw_index* @@ -477,7 +477,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* vec2 inverted length */ len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -532,7 +532,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* fill vertices */ for (i = 0; i < points_count; ++i) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; vtx = nk_draw_vertex(vtx, &list->config, points[i], uv, col); vtx = nk_draw_vertex(vtx, &list->config, temp[i*2+0], uv, col_trans); vtx = nk_draw_vertex(vtx, &list->config, temp[i*2+1], uv, col_trans); @@ -597,7 +597,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* add vertices */ for (i = 0; i < points_count; ++i) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+0], uv, col_trans); vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+1], uv, col); vtx = nk_draw_vertex(vtx, &list->config, temp[i*4+2], uv, col); @@ -618,7 +618,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p for (i1 = 0; i1 < count; ++i1) { float dx, dy; - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; const nk_size i2 = ((i1+1) == points_count) ? 0 : i1 + 1; const struct nk_vec2 p1 = points[i1]; const struct nk_vec2 p2 = points[i2]; @@ -628,7 +628,7 @@ nk_draw_list_stroke_poly_line(struct nk_draw_list *list, const struct nk_vec2 *p /* vec2 inverted length */ len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -718,7 +718,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, /* vec2 inverted length */ float len = nk_vec2_len_sqr(diff); if (len != 0.0f) - len = nk_inv_sqrt(len); + len = NK_INV_SQRT(len); else len = 1.0f; diff = nk_vec2_muls(diff, len); @@ -728,7 +728,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, /* add vertices + indexes */ for (i0 = points_count-1, i1 = 0; i1 < points_count; i0 = i1++) { - const struct nk_vec2 uv = list->config.null.uv; + const struct nk_vec2 uv = list->config.tex_null.uv; struct nk_vec2 n0 = normals[i0]; struct nk_vec2 n1 = normals[i1]; struct nk_vec2 dm = nk_vec2_muls(nk_vec2_add(n0, n1), 0.5f); @@ -765,7 +765,7 @@ nk_draw_list_fill_poly_convex(struct nk_draw_list *list, if (!vtx || !ids) return; for (i = 0; i < vtx_count; ++i) - vtx = nk_draw_vertex(vtx, &list->config, points[i], list->config.null.uv, col); + vtx = nk_draw_vertex(vtx, &list->config, points[i], list->config.tex_null.uv, col); for (i = 2; i < points_count; ++i) { ids[0] = (nk_draw_index)index; ids[1] = (nk_draw_index)(index+ i - 1); @@ -794,8 +794,8 @@ nk_draw_list_path_line_to(struct nk_draw_list *list, struct nk_vec2 pos) nk_draw_list_add_clip(list, nk_null_rect); cmd = nk_draw_list_command_last(list); - if (cmd && cmd->texture.ptr != list->config.null.texture.ptr) - nk_draw_list_push_image(list, list->config.null.texture); + if (cmd && cmd->texture.ptr != list->config.tex_null.texture.ptr) + nk_draw_list_push_image(list, list->config.tex_null.texture); points = nk_draw_list_alloc_path(list, 1); if (!points) return; @@ -997,7 +997,7 @@ nk_draw_list_fill_rect_multi_color(struct nk_draw_list *list, struct nk_rect rec NK_ASSERT(list); if (!list) return; - nk_draw_list_push_image(list, list->config.null.texture); + nk_draw_list_push_image(list, list->config.tex_null.texture); index = (nk_draw_index)list->vertex_count; vtx = nk_draw_list_alloc_vertices(list, 4); idx = nk_draw_list_alloc_elements(list, 6); @@ -1007,10 +1007,10 @@ nk_draw_list_fill_rect_multi_color(struct nk_draw_list *list, struct nk_rect rec idx[2] = (nk_draw_index)(index+2); idx[3] = (nk_draw_index)(index+0); idx[4] = (nk_draw_index)(index+2); idx[5] = (nk_draw_index)(index+3); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y), list->config.null.uv, col_left); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y), list->config.null.uv, col_top); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y + rect.h), list->config.null.uv, col_right); - vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y + rect.h), list->config.null.uv, col_bottom); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y), list->config.tex_null.uv, col_left); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y), list->config.tex_null.uv, col_top); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x + rect.w, rect.y + rect.h), list->config.tex_null.uv, col_right); + vtx = nk_draw_vertex(vtx, &list->config, nk_vec2(rect.x, rect.y + rect.h), list->config.tex_null.uv, col_bottom); } NK_API void nk_draw_list_fill_triangle(struct nk_draw_list *list, struct nk_vec2 a, diff --git a/src/nuklear_window.c b/src/nuklear_window.c index 558ebce..486b912 100644 --- a/src/nuklear_window.c +++ b/src/nuklear_window.c @@ -431,10 +431,15 @@ nk_window_is_hovered(struct nk_context *ctx) { NK_ASSERT(ctx); NK_ASSERT(ctx->current); - if (!ctx || !ctx->current) return 0; - if(ctx->current->flags & NK_WINDOW_HIDDEN) + if (!ctx || !ctx->current || (ctx->current->flags & NK_WINDOW_HIDDEN)) return 0; - return nk_input_is_mouse_hovering_rect(&ctx->input, ctx->current->bounds); + else { + struct nk_rect actual_bounds = ctx->current->bounds; + if (ctx->begin->flags & NK_WINDOW_MINIMIZED) { + actual_bounds.h = ctx->current->layout->header_height; + } + return nk_input_is_mouse_hovering_rect(&ctx->input, actual_bounds); + } } NK_API nk_bool nk_window_is_any_hovered(struct nk_context *ctx) diff --git a/src/stb_rect_pack.h b/src/stb_rect_pack.h index 5c848de..6a633ce 100644 --- a/src/stb_rect_pack.h +++ b/src/stb_rect_pack.h @@ -1,9 +1,15 @@ -// stb_rect_pack.h - v1.00 - public domain - rectangle packing +// stb_rect_pack.h - v1.01 - public domain - rectangle packing // Sean Barrett 2014 // // Useful for e.g. packing rectangular textures into an atlas. // Does not do rotation. // +// Before #including, +// +// #define STB_RECT_PACK_IMPLEMENTATION +// +// in the file that you want to have the implementation. +// // Not necessarily the awesomest packing method, but better than // the totally naive one in stb_truetype (which is primarily what // this is meant to replace). @@ -35,6 +41,7 @@ // // Version history: // +// 1.01 (2021-07-11) always use large rect mode, expose STBRP__MAXVAL in public section // 1.00 (2019-02-25) avoid small space waste; gracefully fail too-wide rectangles // 0.99 (2019-02-07) warning fixes // 0.11 (2017-03-03) return packing success/fail result @@ -75,11 +82,10 @@ typedef struct stbrp_context stbrp_context; typedef struct stbrp_node stbrp_node; typedef struct stbrp_rect stbrp_rect; -#ifdef STBRP_LARGE_RECTS typedef int stbrp_coord; -#else -typedef unsigned short stbrp_coord; -#endif + +#define STBRP__MAXVAL 0x7fffffff +// Mostly for internal use, but this is the maximum supported coordinate value. STBRP_DEF int stbrp_pack_rects (stbrp_context *context, stbrp_rect *rects, int num_rects); // Assign packed locations to rectangles. The rectangles are of type @@ -209,8 +215,10 @@ struct stbrp_context #ifdef _MSC_VER #define STBRP__NOTUSED(v) (void)(v) +#define STBRP__CDECL __cdecl #else #define STBRP__NOTUSED(v) (void)sizeof(v) +#define STBRP__CDECL #endif enum @@ -253,9 +261,6 @@ STBRP_DEF void stbrp_setup_allow_out_of_mem(stbrp_context *context, int allow_ou STBRP_DEF void stbrp_init_target(stbrp_context *context, int width, int height, stbrp_node *nodes, int num_nodes) { int i; -#ifndef STBRP_LARGE_RECTS - STBRP_ASSERT(width <= 0xffff && height <= 0xffff); -#endif for (i=0; i < num_nodes-1; ++i) nodes[i].next = &nodes[i+1]; @@ -274,11 +279,7 @@ STBRP_DEF void stbrp_init_target(stbrp_context *context, int width, int height, context->extra[0].y = 0; context->extra[0].next = &context->extra[1]; context->extra[1].x = (stbrp_coord) width; -#ifdef STBRP_LARGE_RECTS context->extra[1].y = (1<<30); -#else - context->extra[1].y = 65535; -#endif context->extra[1].next = NULL; } @@ -520,7 +521,7 @@ static stbrp__findresult stbrp__skyline_pack_rectangle(stbrp_context *context, i return res; } -static int rect_height_compare(const void *a, const void *b) +static int STBRP__CDECL rect_height_compare(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; @@ -531,19 +532,13 @@ static int rect_height_compare(const void *a, const void *b) return (p->w > q->w) ? -1 : (p->w < q->w); } -static int rect_original_order(const void *a, const void *b) +static int STBRP__CDECL rect_original_order(const void *a, const void *b) { const stbrp_rect *p = (const stbrp_rect *) a; const stbrp_rect *q = (const stbrp_rect *) b; return (p->was_packed < q->was_packed) ? -1 : (p->was_packed > q->was_packed); } -#ifdef STBRP_LARGE_RECTS -#define STBRP__MAXVAL 0xffffffff -#else -#define STBRP__MAXVAL 0xffff -#endif - STBRP_DEF int stbrp_pack_rects(stbrp_context *context, stbrp_rect *rects, int num_rects) { int i, all_rects_packed = 1; diff --git a/src/stb_truetype.h b/src/stb_truetype.h index 935a6de..bbf2284 100644 --- a/src/stb_truetype.h +++ b/src/stb_truetype.h @@ -1,5 +1,5 @@ -// stb_truetype.h - v1.24 - public domain -// authored from 2009-2020 by Sean Barrett / RAD Game Tools +// stb_truetype.h - v1.26 - public domain +// authored from 2009-2021 by Sean Barrett / RAD Game Tools // // ======================================================================= // @@ -53,11 +53,13 @@ // Johan Duparc Thomas Fields // Hou Qiming Derek Vinyard // Rob Loach Cort Stratton -// Kenney Phillis Jr. Brian Costabile -// Ken Voskuil (kaesve) +// Kenney Phillis Jr. Brian Costabile +// Ken Voskuil (kaesve) // // VERSION HISTORY // +// 1.26 (2021-08-28) fix broken rasterizer +// 1.25 (2021-07-11) many fixes // 1.24 (2020-02-05) fix warning // 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) // 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined @@ -270,8 +272,8 @@ //// SAMPLE PROGRAMS //// // -// Incomplete text-in-3d-api example, which draws quads properly aligned to be lossless -// +// Incomplete text-in-3d-api example, which draws quads properly aligned to be lossless. +// See "tests/truetype_demo_win32.c" for a complete version. #if 0 #define STB_TRUETYPE_IMPLEMENTATION // force following include to generate implementation #include "stb_truetype.h" @@ -297,6 +299,8 @@ void my_stbtt_initfont(void) void my_stbtt_print(float x, float y, char *text) { // assume orthographic projection with units = screen pixels, origin at top left + glEnable(GL_BLEND); + glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA); glEnable(GL_TEXTURE_2D); glBindTexture(GL_TEXTURE_2D, ftex); glBegin(GL_QUADS); @@ -304,10 +308,10 @@ void my_stbtt_print(float x, float y, char *text) if (*text >= 32 && *text < 128) { stbtt_aligned_quad q; stbtt_GetBakedQuad(cdata, 512,512, *text-32, &x,&y,&q,1);//1=opengl & d3d10+,0=d3d9 - glTexCoord2f(q.s0,q.t1); glVertex2f(q.x0,q.y0); - glTexCoord2f(q.s1,q.t1); glVertex2f(q.x1,q.y0); - glTexCoord2f(q.s1,q.t0); glVertex2f(q.x1,q.y1); - glTexCoord2f(q.s0,q.t0); glVertex2f(q.x0,q.y1); + glTexCoord2f(q.s0,q.t0); glVertex2f(q.x0,q.y0); + glTexCoord2f(q.s1,q.t0); glVertex2f(q.x1,q.y0); + glTexCoord2f(q.s1,q.t1); glVertex2f(q.x1,q.y1); + glTexCoord2f(q.s0,q.t1); glVertex2f(q.x0,q.y1); } ++text; } @@ -853,6 +857,7 @@ STBTT_DEF int stbtt_GetGlyphShape(const stbtt_fontinfo *info, int glyph_index, s STBTT_DEF void stbtt_FreeShape(const stbtt_fontinfo *info, stbtt_vertex *vertices); // frees the data allocated above +STBTT_DEF unsigned char *stbtt_FindSVGDoc(const stbtt_fontinfo *info, int gl); STBTT_DEF int stbtt_GetCodepointSVG(const stbtt_fontinfo *info, int unicode_codepoint, const char **svg); STBTT_DEF int stbtt_GetGlyphSVG(const stbtt_fontinfo *info, int gl, const char **svg); // fills svg with the character's SVG data. @@ -1539,12 +1544,12 @@ STBTT_DEF int stbtt_FindGlyphIndex(const stbtt_fontinfo *info, int unicode_codep search += 2; { - stbtt_uint16 offset, start; + stbtt_uint16 offset, start, last; stbtt_uint16 item = (stbtt_uint16) ((search - endCount) >> 1); - STBTT_assert(unicode_codepoint <= ttUSHORT(data + endCount + 2*item)); start = ttUSHORT(data + index_map + 14 + segcount*2 + 2 + 2*item); - if (unicode_codepoint < start) + last = ttUSHORT(data + endCount + 2*item); + if (unicode_codepoint < start || unicode_codepoint > last) return 0; offset = ttUSHORT(data + index_map + 14 + segcount*6 + 2 + 2*item); @@ -1871,7 +1876,7 @@ static int stbtt__GetGlyphShapeTT(const stbtt_fontinfo *info, int glyph_index, s if (comp_verts) STBTT_free(comp_verts, info->userdata); return 0; } - if (num_vertices > 0) STBTT_memcpy(tmp, vertices, num_vertices*sizeof(stbtt_vertex)); + if (num_vertices > 0 && vertices) STBTT_memcpy(tmp, vertices, num_vertices*sizeof(stbtt_vertex)); STBTT_memcpy(tmp+num_vertices, comp_verts, comp_num_verts*sizeof(stbtt_vertex)); if (vertices) STBTT_free(vertices, info->userdata); vertices = tmp; @@ -2134,7 +2139,7 @@ static int stbtt__run_charstring(const stbtt_fontinfo *info, int glyph_index, st subrs = stbtt__cid_get_glyph_subrs(info, glyph_index); has_subrs = 1; } - // fallthrough + // FALLTHROUGH case 0x1D: // callgsubr if (sp < 1) return STBTT__CSERR("call(g|)subr stack"); v = (int) s[--sp]; @@ -2239,7 +2244,7 @@ static int stbtt__run_charstring(const stbtt_fontinfo *info, int glyph_index, st } break; default: - if (b0 != 255 && b0 != 28 && (b0 < 32 || b0 > 254)) + if (b0 != 255 && b0 != 28 && b0 < 32) return STBTT__CSERR("reserved operator"); // push immediate @@ -2351,7 +2356,7 @@ STBTT_DEF int stbtt_GetKerningTable(const stbtt_fontinfo *info, stbtt_kerningent return length; } -static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) +static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { stbtt_uint8 *data = info->data + info->kern; stbtt_uint32 needle, straw; @@ -2381,243 +2386,225 @@ static int stbtt__GetGlyphKernInfoAdvance(const stbtt_fontinfo *info, int glyph return 0; } -static stbtt_int32 stbtt__GetCoverageIndex(stbtt_uint8 *coverageTable, int glyph) +static stbtt_int32 stbtt__GetCoverageIndex(stbtt_uint8 *coverageTable, int glyph) { - stbtt_uint16 coverageFormat = ttUSHORT(coverageTable); - switch(coverageFormat) { - case 1: { - stbtt_uint16 glyphCount = ttUSHORT(coverageTable + 2); + stbtt_uint16 coverageFormat = ttUSHORT(coverageTable); + switch (coverageFormat) { + case 1: { + stbtt_uint16 glyphCount = ttUSHORT(coverageTable + 2); - // Binary search. - stbtt_int32 l=0, r=glyphCount-1, m; - int straw, needle=glyph; - while (l <= r) { - stbtt_uint8 *glyphArray = coverageTable + 4; - stbtt_uint16 glyphID; - m = (l + r) >> 1; - glyphID = ttUSHORT(glyphArray + 2 * m); - straw = glyphID; - if (needle < straw) - r = m - 1; - else if (needle > straw) - l = m + 1; - else { - return m; - } + // Binary search. + stbtt_int32 l=0, r=glyphCount-1, m; + int straw, needle=glyph; + while (l <= r) { + stbtt_uint8 *glyphArray = coverageTable + 4; + stbtt_uint16 glyphID; + m = (l + r) >> 1; + glyphID = ttUSHORT(glyphArray + 2 * m); + straw = glyphID; + if (needle < straw) + r = m - 1; + else if (needle > straw) + l = m + 1; + else { + return m; } - } break; + } + break; + } - case 2: { - stbtt_uint16 rangeCount = ttUSHORT(coverageTable + 2); - stbtt_uint8 *rangeArray = coverageTable + 4; + case 2: { + stbtt_uint16 rangeCount = ttUSHORT(coverageTable + 2); + stbtt_uint8 *rangeArray = coverageTable + 4; - // Binary search. - stbtt_int32 l=0, r=rangeCount-1, m; - int strawStart, strawEnd, needle=glyph; - while (l <= r) { - stbtt_uint8 *rangeRecord; - m = (l + r) >> 1; - rangeRecord = rangeArray + 6 * m; - strawStart = ttUSHORT(rangeRecord); - strawEnd = ttUSHORT(rangeRecord + 2); - if (needle < strawStart) - r = m - 1; - else if (needle > strawEnd) - l = m + 1; - else { - stbtt_uint16 startCoverageIndex = ttUSHORT(rangeRecord + 4); - return startCoverageIndex + glyph - strawStart; - } + // Binary search. + stbtt_int32 l=0, r=rangeCount-1, m; + int strawStart, strawEnd, needle=glyph; + while (l <= r) { + stbtt_uint8 *rangeRecord; + m = (l + r) >> 1; + rangeRecord = rangeArray + 6 * m; + strawStart = ttUSHORT(rangeRecord); + strawEnd = ttUSHORT(rangeRecord + 2); + if (needle < strawStart) + r = m - 1; + else if (needle > strawEnd) + l = m + 1; + else { + stbtt_uint16 startCoverageIndex = ttUSHORT(rangeRecord + 4); + return startCoverageIndex + glyph - strawStart; } - } break; + } + break; + } - default: { - // There are no other cases. - STBTT_assert(0); - } break; - } + default: return -1; // unsupported + } - return -1; + return -1; } static stbtt_int32 stbtt__GetGlyphClass(stbtt_uint8 *classDefTable, int glyph) { - stbtt_uint16 classDefFormat = ttUSHORT(classDefTable); - switch(classDefFormat) - { - case 1: { - stbtt_uint16 startGlyphID = ttUSHORT(classDefTable + 2); - stbtt_uint16 glyphCount = ttUSHORT(classDefTable + 4); - stbtt_uint8 *classDef1ValueArray = classDefTable + 6; + stbtt_uint16 classDefFormat = ttUSHORT(classDefTable); + switch (classDefFormat) + { + case 1: { + stbtt_uint16 startGlyphID = ttUSHORT(classDefTable + 2); + stbtt_uint16 glyphCount = ttUSHORT(classDefTable + 4); + stbtt_uint8 *classDef1ValueArray = classDefTable + 6; - if (glyph >= startGlyphID && glyph < startGlyphID + glyphCount) - return (stbtt_int32)ttUSHORT(classDef1ValueArray + 2 * (glyph - startGlyphID)); + if (glyph >= startGlyphID && glyph < startGlyphID + glyphCount) + return (stbtt_int32)ttUSHORT(classDef1ValueArray + 2 * (glyph - startGlyphID)); + break; + } - classDefTable = classDef1ValueArray + 2 * glyphCount; - } break; + case 2: { + stbtt_uint16 classRangeCount = ttUSHORT(classDefTable + 2); + stbtt_uint8 *classRangeRecords = classDefTable + 4; - case 2: { - stbtt_uint16 classRangeCount = ttUSHORT(classDefTable + 2); - stbtt_uint8 *classRangeRecords = classDefTable + 4; + // Binary search. + stbtt_int32 l=0, r=classRangeCount-1, m; + int strawStart, strawEnd, needle=glyph; + while (l <= r) { + stbtt_uint8 *classRangeRecord; + m = (l + r) >> 1; + classRangeRecord = classRangeRecords + 6 * m; + strawStart = ttUSHORT(classRangeRecord); + strawEnd = ttUSHORT(classRangeRecord + 2); + if (needle < strawStart) + r = m - 1; + else if (needle > strawEnd) + l = m + 1; + else + return (stbtt_int32)ttUSHORT(classRangeRecord + 4); + } + break; + } - // Binary search. - stbtt_int32 l=0, r=classRangeCount-1, m; - int strawStart, strawEnd, needle=glyph; - while (l <= r) { - stbtt_uint8 *classRangeRecord; - m = (l + r) >> 1; - classRangeRecord = classRangeRecords + 6 * m; - strawStart = ttUSHORT(classRangeRecord); - strawEnd = ttUSHORT(classRangeRecord + 2); - if (needle < strawStart) - r = m - 1; - else if (needle > strawEnd) - l = m + 1; - else - return (stbtt_int32)ttUSHORT(classRangeRecord + 4); - } + default: + return -1; // Unsupported definition type, return an error. + } - classDefTable = classRangeRecords + 6 * classRangeCount; - } break; - - default: { - // There are no other cases. - STBTT_assert(0); - } break; - } - - return -1; + // "All glyphs not assigned to a class fall into class 0". (OpenType spec) + return 0; } // Define to STBTT_assert(x) if you want to break on unimplemented formats. #define STBTT_GPOS_TODO_assert(x) -static stbtt_int32 stbtt__GetGlyphGPOSInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) +static stbtt_int32 stbtt__GetGlyphGPOSInfoAdvance(const stbtt_fontinfo *info, int glyph1, int glyph2) { - stbtt_uint16 lookupListOffset; - stbtt_uint8 *lookupList; - stbtt_uint16 lookupCount; - stbtt_uint8 *data; - stbtt_int32 i; + stbtt_uint16 lookupListOffset; + stbtt_uint8 *lookupList; + stbtt_uint16 lookupCount; + stbtt_uint8 *data; + stbtt_int32 i, sti; - if (!info->gpos) return 0; + if (!info->gpos) return 0; - data = info->data + info->gpos; + data = info->data + info->gpos; - if (ttUSHORT(data+0) != 1) return 0; // Major version 1 - if (ttUSHORT(data+2) != 0) return 0; // Minor version 0 + if (ttUSHORT(data+0) != 1) return 0; // Major version 1 + if (ttUSHORT(data+2) != 0) return 0; // Minor version 0 - lookupListOffset = ttUSHORT(data+8); - lookupList = data + lookupListOffset; - lookupCount = ttUSHORT(lookupList); + lookupListOffset = ttUSHORT(data+8); + lookupList = data + lookupListOffset; + lookupCount = ttUSHORT(lookupList); - for (i=0; i= pairSetCount) return 0; - // Binary search. - while (l <= r) { - stbtt_uint16 secondGlyph; - stbtt_uint8 *pairValue; - m = (l + r) >> 1; - pairValue = pairValueArray + (2 + valueRecordPairSizeInBytes) * m; - secondGlyph = ttUSHORT(pairValue); - straw = secondGlyph; - if (needle < straw) - r = m - 1; - else if (needle > straw) - l = m + 1; - else { - stbtt_int16 xAdvance = ttSHORT(pairValue + 2); - return xAdvance; - } - } - } break; + needle=glyph2; + r=pairValueCount-1; + l=0; - case 2: { - stbtt_uint16 valueFormat1 = ttUSHORT(table + 4); - stbtt_uint16 valueFormat2 = ttUSHORT(table + 6); + // Binary search. + while (l <= r) { + stbtt_uint16 secondGlyph; + stbtt_uint8 *pairValue; + m = (l + r) >> 1; + pairValue = pairValueArray + (2 + valueRecordPairSizeInBytes) * m; + secondGlyph = ttUSHORT(pairValue); + straw = secondGlyph; + if (needle < straw) + r = m - 1; + else if (needle > straw) + l = m + 1; + else { + stbtt_int16 xAdvance = ttSHORT(pairValue + 2); + return xAdvance; + } + } + } else + return 0; + break; + } - stbtt_uint16 classDef1Offset = ttUSHORT(table + 8); - stbtt_uint16 classDef2Offset = ttUSHORT(table + 10); - int glyph1class = stbtt__GetGlyphClass(table + classDef1Offset, glyph1); - int glyph2class = stbtt__GetGlyphClass(table + classDef2Offset, glyph2); + case 2: { + stbtt_uint16 valueFormat1 = ttUSHORT(table + 4); + stbtt_uint16 valueFormat2 = ttUSHORT(table + 6); + if (valueFormat1 == 4 && valueFormat2 == 0) { // Support more formats? + stbtt_uint16 classDef1Offset = ttUSHORT(table + 8); + stbtt_uint16 classDef2Offset = ttUSHORT(table + 10); + int glyph1class = stbtt__GetGlyphClass(table + classDef1Offset, glyph1); + int glyph2class = stbtt__GetGlyphClass(table + classDef2Offset, glyph2); - stbtt_uint16 class1Count = ttUSHORT(table + 12); - stbtt_uint16 class2Count = ttUSHORT(table + 14); - STBTT_assert(glyph1class < class1Count); - STBTT_assert(glyph2class < class2Count); + stbtt_uint16 class1Count = ttUSHORT(table + 12); + stbtt_uint16 class2Count = ttUSHORT(table + 14); + stbtt_uint8 *class1Records, *class2Records; + stbtt_int16 xAdvance; - // TODO: Support more formats. - STBTT_GPOS_TODO_assert(valueFormat1 == 4); - if (valueFormat1 != 4) return 0; - STBTT_GPOS_TODO_assert(valueFormat2 == 0); - if (valueFormat2 != 0) return 0; + if (glyph1class < 0 || glyph1class >= class1Count) return 0; // malformed + if (glyph2class < 0 || glyph2class >= class2Count) return 0; // malformed - if (glyph1class >= 0 && glyph1class < class1Count && glyph2class >= 0 && glyph2class < class2Count) { - stbtt_uint8 *class1Records = table + 16; - stbtt_uint8 *class2Records = class1Records + 2 * (glyph1class * class2Count); - stbtt_int16 xAdvance = ttSHORT(class2Records + 2 * glyph2class); - return xAdvance; - } - } break; - - default: { - // There are no other cases. - STBTT_assert(0); - break; - }; - } - } - break; - }; + class1Records = table + 16; + class2Records = class1Records + 2 * (glyph1class * class2Count); + xAdvance = ttSHORT(class2Records + 2 * glyph2class); + return xAdvance; + } else + return 0; + break; + } default: - // TODO: Implement other stuff. - break; - } - } + return 0; // Unsupported position format + } + } + } - return 0; + return 0; } STBTT_DEF int stbtt_GetGlyphKernAdvance(const stbtt_fontinfo *info, int g1, int g2) @@ -3075,6 +3062,23 @@ static void stbtt__handle_clipped_edge(float *scanline, int x, stbtt__active_edg } } +static float stbtt__sized_trapezoid_area(float height, float top_width, float bottom_width) +{ + STBTT_assert(top_width >= 0); + STBTT_assert(bottom_width >= 0); + return (top_width + bottom_width) / 2.0f * height; +} + +static float stbtt__position_trapezoid_area(float height, float tx0, float tx1, float bx0, float bx1) +{ + return stbtt__sized_trapezoid_area(height, tx1 - tx0, bx1 - bx0); +} + +static float stbtt__sized_triangle_area(float height, float width) +{ + return height * width / 2; +} + static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, int len, stbtt__active_edge *e, float y_top) { float y_bottom = y_top+1; @@ -3129,13 +3133,13 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, float height; // simple case, only spans one pixel int x = (int) x_top; - height = sy1 - sy0; + height = (sy1 - sy0) * e->direction; STBTT_assert(x >= 0 && x < len); - scanline[x] += e->direction * (1-((x_top - x) + (x_bottom-x))/2) * height; - scanline_fill[x] += e->direction * height; // everything right of this pixel is filled + scanline[x] += stbtt__position_trapezoid_area(height, x_top, x+1.0f, x_bottom, x+1.0f); + scanline_fill[x] += height; // everything right of this pixel is filled } else { int x,x1,x2; - float y_crossing, step, sign, area; + float y_crossing, y_final, step, sign, area; // covers 2+ pixels if (x_top > x_bottom) { // flip scanline vertically; signed area is the same @@ -3148,29 +3152,79 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, dy = -dy; t = x0, x0 = xb, xb = t; } + STBTT_assert(dy >= 0); + STBTT_assert(dx >= 0); x1 = (int) x_top; x2 = (int) x_bottom; // compute intersection with y axis at x1+1 - y_crossing = (x1+1 - x0) * dy + y_top; + y_crossing = y_top + dy * (x1+1 - x0); + + // compute intersection with y axis at x2 + y_final = y_top + dy * (x2 - x0); + + // x1 x_top x2 x_bottom + // y_top +------|-----+------------+------------+--------|---+------------+ + // | | | | | | + // | | | | | | + // sy0 | Txxxxx|............|............|............|............| + // y_crossing | *xxxxx.......|............|............|............| + // | | xxxxx..|............|............|............| + // | | /- xx*xxxx........|............|............| + // | | dy < | xxxxxx..|............|............| + // y_final | | \- | xx*xxx.........|............| + // sy1 | | | | xxxxxB...|............| + // | | | | | | + // | | | | | | + // y_bottom +------------+------------+------------+------------+------------+ + // + // goal is to measure the area covered by '.' in each pixel + + // if x2 is right at the right edge of x1, y_crossing can blow up, github #1057 + // @TODO: maybe test against sy1 rather than y_bottom? + if (y_crossing > y_bottom) + y_crossing = y_bottom; sign = e->direction; - // area of the rectangle covered from y0..y_crossing - area = sign * (y_crossing-sy0); - // area of the triangle (x_top,y0), (x+1,y0), (x+1,y_crossing) - scanline[x1] += area * (1-((x_top - x1)+(x1+1-x1))/2); - step = sign * dy; + // area of the rectangle covered from sy0..y_crossing + area = sign * (y_crossing-sy0); + + // area of the triangle (x_top,sy0), (x1+1,sy0), (x1+1,y_crossing) + scanline[x1] += stbtt__sized_triangle_area(area, x1+1 - x_top); + + // check if final y_crossing is blown up; no test case for this + if (y_final > y_bottom) { + y_final = y_bottom; + dy = (y_final - y_crossing ) / (x2 - (x1+1)); // if denom=0, y_final = y_crossing, so y_final <= y_bottom + } + + // in second pixel, area covered by line segment found in first pixel + // is always a rectangle 1 wide * the height of that line segment; this + // is exactly what the variable 'area' stores. it also gets a contribution + // from the line segment within it. the THIRD pixel will get the first + // pixel's rectangle contribution, the second pixel's rectangle contribution, + // and its own contribution. the 'own contribution' is the same in every pixel except + // the leftmost and rightmost, a trapezoid that slides down in each pixel. + // the second pixel's contribution to the third pixel will be the + // rectangle 1 wide times the height change in the second pixel, which is dy. + + step = sign * dy * 1; // dy is dy/dx, change in y for every 1 change in x, + // which multiplied by 1-pixel-width is how much pixel area changes for each step in x + // so the area advances by 'step' every time + for (x = x1+1; x < x2; ++x) { - scanline[x] += area + step/2; + scanline[x] += area + step/2; // area of trapezoid is 1*step/2 area += step; } - y_crossing += dy * (x2 - (x1+1)); + STBTT_assert(STBTT_fabs(area) <= 1.01f); // accumulated error from area += step unless we round step down + STBTT_assert(sy1 > y_final-0.01f); - STBTT_assert(STBTT_fabs(area) <= 1.01f); - - scanline[x2] += area + sign * (1-((x2-x2)+(x_bottom-x2))/2) * (sy1-y_crossing); + // area covered in the last pixel is the rectangle from all the pixels to the left, + // plus the trapezoid filled by the line segment in this pixel all the way to the right edge + scanline[x2] += area + sign * stbtt__position_trapezoid_area(sy1-y_final, (float) x2, x2+1.0f, x_bottom, x2+1.0f); + // the rest of the line is filled based on the total height of the line segment in this pixel scanline_fill[x2] += sign * (sy1-sy0); } } else { @@ -3178,6 +3232,9 @@ static void stbtt__fill_active_edges_new(float *scanline, float *scanline_fill, // clipping logic. since this does not match the intended use // of this library, we use a different, very slow brute // force implementation + // note though that this does happen some of the time because + // x_top and x_bottom can be extrapolated at the top & bottom of + // the shape and actually lie outside the bounding box int x; for (x=0; x < len; ++x) { // cases: @@ -4414,15 +4471,14 @@ static int stbtt__compute_crossings_x(float x, float y, int nverts, stbtt_vertex float y_frac; int winding = 0; - orig[0] = x; - orig[1] = y; - // make sure y never passes through a vertex of the shape y_frac = (float) STBTT_fmod(y, 1.0f); if (y_frac < 0.01f) y += 0.01f; else if (y_frac > 0.99f) y -= 0.01f; + + orig[0] = x; orig[1] = y; // test a ray from (-infinity,y) to (x,y) @@ -4484,35 +4540,35 @@ static float stbtt__cuberoot( float x ) return (float) STBTT_pow( x,1.0f/3.0f); } -// x^3 + c*x^2 + b*x + a = 0 +// x^3 + a*x^2 + b*x + c = 0 static int stbtt__solve_cubic(float a, float b, float c, float* r) { - float s = -a / 3; - float p = b - a*a / 3; - float q = a * (2*a*a - 9*b) / 27 + c; + float s = -a / 3; + float p = b - a*a / 3; + float q = a * (2*a*a - 9*b) / 27 + c; float p3 = p*p*p; - float d = q*q + 4*p3 / 27; - if (d >= 0) { - float z = (float) STBTT_sqrt(d); - float u = (-q + z) / 2; - float v = (-q - z) / 2; - u = stbtt__cuberoot(u); - v = stbtt__cuberoot(v); - r[0] = s + u + v; - return 1; - } else { - float u = (float) STBTT_sqrt(-p/3); - float v = (float) STBTT_acos(-STBTT_sqrt(-27/p3) * q / 2) / 3; // p3 must be negative, since d is negative - float m = (float) STBTT_cos(v); + float d = q*q + 4*p3 / 27; + if (d >= 0) { + float z = (float) STBTT_sqrt(d); + float u = (-q + z) / 2; + float v = (-q - z) / 2; + u = stbtt__cuberoot(u); + v = stbtt__cuberoot(v); + r[0] = s + u + v; + return 1; + } else { + float u = (float) STBTT_sqrt(-p/3); + float v = (float) STBTT_acos(-STBTT_sqrt(-27/p3) * q / 2) / 3; // p3 must be negative, since d is negative + float m = (float) STBTT_cos(v); float n = (float) STBTT_cos(v-3.141592/2)*1.732050808f; - r[0] = s + u * 2 * m; - r[1] = s - u * (m + n); - r[2] = s - u * (m - n); + r[0] = s + u * 2 * m; + r[1] = s - u * (m + n); + r[2] = s - u * (m - n); //STBTT_assert( STBTT_fabs(((r[0]+a)*r[0]+b)*r[0]+c) < 0.05f); // these asserts may not be safe at all scales, though they're in bezier t parameter units so maybe? //STBTT_assert( STBTT_fabs(((r[1]+a)*r[1]+b)*r[1]+c) < 0.05f); //STBTT_assert( STBTT_fabs(((r[2]+a)*r[2]+b)*r[2]+c) < 0.05f); - return 3; + return 3; } } @@ -4589,18 +4645,17 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc for (i=0; i < num_verts; ++i) { float x0 = verts[i].x*scale_x, y0 = verts[i].y*scale_y; - // check against every point here rather than inside line/curve primitives -- @TODO: wrong if multiple 'moves' in a row produce a garbage point, and given culling, probably more efficient to do within line/curve - float dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); - if (dist2 < min_dist*min_dist) - min_dist = (float) STBTT_sqrt(dist2); - - if (verts[i].type == STBTT_vline) { + if (verts[i].type == STBTT_vline && precompute[i] != 0.0f) { float x1 = verts[i-1].x*scale_x, y1 = verts[i-1].y*scale_y; + float dist,dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); + if (dist2 < min_dist*min_dist) + min_dist = (float) STBTT_sqrt(dist2); + // coarse culling against bbox //if (sx > STBTT_min(x0,x1)-min_dist && sx < STBTT_max(x0,x1)+min_dist && // sy > STBTT_min(y0,y1)-min_dist && sy < STBTT_max(y0,y1)+min_dist) - float dist = (float) STBTT_fabs((x1-x0)*(y0-sy) - (y1-y0)*(x0-sx)) * precompute[i]; + dist = (float) STBTT_fabs((x1-x0)*(y0-sy) - (y1-y0)*(x0-sx)) * precompute[i]; STBTT_assert(i != 0); if (dist < min_dist) { // check position along line @@ -4627,7 +4682,8 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc float ax = x1-x0, ay = y1-y0; float bx = x0 - 2*x1 + x2, by = y0 - 2*y1 + y2; float mx = x0 - sx, my = y0 - sy; - float res[3],px,py,t,it; + float res[3] = {0.f,0.f,0.f}; + float px,py,t,it,dist2; float a_inv = precompute[i]; if (a_inv == 0.0) { // if a_inv is 0, it's 2nd degree so use quadratic formula float a = 3*(ax*bx + ay*by); @@ -4654,6 +4710,10 @@ STBTT_DEF unsigned char * stbtt_GetGlyphSDF(const stbtt_fontinfo *info, float sc float d = (mx*ax+my*ay) * a_inv; num = stbtt__solve_cubic(b, c, d, res); } + dist2 = (x0-sx)*(x0-sx) + (y0-sy)*(y0-sy); + if (dist2 < min_dist*min_dist) + min_dist = (float) STBTT_sqrt(dist2); + if (num >= 1 && res[0] >= 0.0f && res[0] <= 1.0f) { t = res[0], it = 1.0f - t; px = it*it*x0 + 2*t*it*x1 + t*t*x2; @@ -4913,6 +4973,12 @@ STBTT_DEF int stbtt_CompareUTF8toUTF16_bigendian(const char *s1, int len1, const // FULL VERSION HISTORY // +// 1.25 (2021-07-11) many fixes +// 1.24 (2020-02-05) fix warning +// 1.23 (2020-02-02) query SVG data for glyphs; query whole kerning table (but only kern not GPOS) +// 1.22 (2019-08-11) minimize missing-glyph duplication; fix kerning if both 'GPOS' and 'kern' are defined +// 1.21 (2019-02-25) fix warning +// 1.20 (2019-02-07) PackFontRange skips missing codepoints; GetScaleFontVMetrics() // 1.19 (2018-02-11) OpenType GPOS kerning (horizontal only), STBTT_fmod // 1.18 (2018-01-29) add missing function // 1.17 (2017-07-23) make more arguments const; doc fix