Skip to content

Sync README and docblocks with the API #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobLoach merged 1 commit into from
Jul 28, 2026
Merged

Sync README and docblocks with the API #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 27 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Use the [Nuklear](https://github.com/Immediate-Mode-UI/Nuklear) immediate mode c
```
3. Use `InitNuklear(fontSize)` or `InitNuklearEx(font, fontSize)` to create the nuklear context...
``` c
struct nk_context *ctx = InitNuklear(10);
struct nk_context *ctx = InitNuklear(13);
```
4. Build your Nuklear GUI through the standard [Nuklear API](https://github.com/Immediate-Mode-UI/Nuklear/wiki/Window)
5. Update the input for the GUI using `UpdateNuklear(ctx)`
Expand All @@ -35,7 +35,7 @@ int main() {
InitWindow(640, 480, "raylib-nuklear example");

// Create the Nuklear Context
int fontSize = 10;
int fontSize = 13;
struct nk_context *ctx = InitNuklear(fontSize);

while (!WindowShouldClose()) {
Expand Down Expand Up @@ -78,19 +78,24 @@ struct nk_context* InitNuklear(int fontSize); // Initialize the N
struct nk_context* InitNuklearEx(Font font, float fontSize); // Initialize the Nuklear GUI context, with a custom font
bool IsNuklearValid(struct nk_context* ctx); // Check if the Nuklear context is valid
Font LoadFontFromNuklear(int fontSize); // Loads the default Nuklear font
void UpdateNuklear(struct nk_context* ctx); // Update the input state and internal components for Nuklear
void UpdateNuklear(struct nk_context* ctx); // Update the input state and internal components for Nuklear
void UpdateNuklearEx(struct nk_context* ctx, float deltaTime); // Update the input state and internal components for Nuklear, with a custom frame time
void DrawNuklear(struct nk_context* ctx); // Render the Nuklear GUI on the screen
void UnloadNuklear(struct nk_context* ctx); // Deinitialize the Nuklear context
struct nk_color ColorToNuklearColor(Color color); // Convert a raylib Color to a Nuklear color object
struct nk_colorf ColorToNuklearColorF(Color color); // Convert a raylib Color to a Nuklear floating color
struct Color NuklearColorToColor(struct nk_color color); // Convert a Nuklear color to a raylib Color
struct Color NuklearColorFToColor(struct nk_colorf color); // Convert a Nuklear floating color to a raylib Color
struct Rectangle NuklearRectToRectangle(struct nk_context* ctx, struct nk_rect rect); // Convert a Nuklear rectangle to a raylib Rectangle
void DrawNuklear(struct nk_context* ctx); // Render the Nuklear GUI on the screen
void UnloadNuklear(struct nk_context* ctx); // Deinitialize the Nuklear context
struct nk_color ColorToNuklearColor(Color color); // Convert a raylib Color to a Nuklear color object
struct nk_colorf ColorToNuklearColorF(Color color); // Convert a raylib Color to a Nuklear floating color
Color NuklearColorToColor(struct nk_color color); // Convert a Nuklear color to a raylib Color
Color NuklearColorFToColor(struct nk_colorf color); // Convert a Nuklear floating color to a raylib Color
Rectangle NuklearRectToRectangle(struct nk_context* ctx, struct nk_rect rect); // Convert a Nuklear rectangle to a raylib Rectangle
struct nk_rect RectangleToNuklearRect(struct nk_context* ctx, Rectangle rect); // Convert a raylib Rectangle to a Nuklear Rectangle
struct nk_image TextureToNuklearImage(Texture tex); // Get a Nuklear image from a Texture
void SetNuklearScaling(struct nk_context * ctx, float scaling); // Sets the scaling for the given Nuklear context
float GetNuklearScaling(struct nk_context * ctx); // Retrieves the scaling of the given Nuklear context
struct nk_image TextureToNuklearImage(Texture texture); // Get a Nuklear image from a Texture
struct nk_image TextureToNuklearImageEx(Texture texture, Rectangle region); // Get a Nuklear image from a sub-region of a Texture
struct nk_vec2 Vector2ToNuklearVec2(Vector2 vec); // Convert a raylib Vector2 to a Nuklear nk_vec2
Vector2 NuklearVec2ToVector2(struct nk_vec2 vec); // Convert a Nuklear nk_vec2 to a raylib Vector2
void SetNuklearScaling(struct nk_context* ctx, float scaling); // Sets the scaling for the given Nuklear context
float GetNuklearScaling(struct nk_context* ctx); // Retrieves the scaling of the given Nuklear context
KeyboardKey NuklearKeyToKeyboardKey(nk_rune key); // Convert an nk_rune key binding to a raylib KeyboardKey
nk_rune KeyboardKeyToNuklearKey(KeyboardKey key); // Convert a raylib KeyboardKey to an nk_rune key binding
```

See the [Nuklear API documenation](https://immediate-mode-ui.github.io/Nuklear/doc/nuklear.html) for more how to use Nuklear.
Expand All @@ -99,12 +104,15 @@ See the [Nuklear API documenation](https://immediate-mode-ui.github.io/Nuklear/d

The following macros can be defined before including `raylib-nuklear.h` to tune behavior:

| Macro | Description |
|---|---|
| `RAYLIB_NUKLEAR_DOUBLE_CLICK_THRESHOLD` | Max seconds between clicks to register a double-click |
| `RAYLIB_NUKLEAR_POLYGON_FILL_MAX_POINTS` | Max points allowed for `NK_COMMAND_POLYGON_FILLED` |
| `RAYLIB_NUKLEAR_INCLUDE_DEFAULT_FONT` | Define to enable Nuklear's built-in baked font |
| `RAYLIB_NUKLEAR_FONT_SPACING_RATIO` | Character spacing as a fraction of the font size |
| Macro | Default | Description |
|---|---|---|
| `RAYLIB_NUKLEAR_DEFAULT_FONTSIZE` | `13` | Font size used when a font size of 0 is provided |
| `RAYLIB_NUKLEAR_DEFAULT_ARC_SEGMENTS` | `20` | Amount of segments used when drawing an arc |
| `RAYLIB_NUKLEAR_DEFAULT_FONT_GLYPHS` | `95` | Amount of glyphs to load for the default font |
| `RAYLIB_NUKLEAR_DOUBLE_CLICK_THRESHOLD` | `0.3` | Max seconds between clicks to register a double-click |
| `RAYLIB_NUKLEAR_POLYGON_FILL_MAX_POINTS` | `64` | Max points allowed for `NK_COMMAND_POLYGON_FILLED` |
| `RAYLIB_NUKLEAR_INCLUDE_DEFAULT_FONT` | undefined | Define to enable Nuklear's built-in baked font |
| `RAYLIB_NUKLEAR_FONT_SPACING_RATIO` | `0.01f` | Character spacing as a fraction of the font size |

## Comparision

Expand Down
6 changes: 3 additions & 3 deletions include/raylib-nuklear.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ InitNuklearContext(struct nk_user_font* userFont)
/**
* Initialize the Nuklear context for use with Raylib.
*
* @param fontSize The size of the font to use for GUI text. Use 0 to use the default font size of 10.
* @param fontSize The size of the font to use for GUI text. Use 0 to use RAYLIB_NUKLEAR_DEFAULT_FONTSIZE.
*
* @return The nuklear context, or NULL on error.
*/
Expand Down Expand Up @@ -385,7 +385,7 @@ InitNuklear(int fontSize)
* Initialize the Nuklear context for use with Raylib, with a supplied custom font.
*
* @param font The custom raylib font to use with Nuklear.
* @param fontSize The desired size of the font. Use 0 to set the default size of 10.
* @param fontSize The desired size of the font. Use 0 to use RAYLIB_NUKLEAR_DEFAULT_FONTSIZE.
*
* @return The nuklear context, or NULL on error.
*/
Expand Down Expand Up @@ -438,7 +438,7 @@ NK_API bool IsNuklearValid(struct nk_context* ctx) {
/**
* Load the default Nuklear font. Requires `RAYLIB_NUKLEAR_INCLUDE_DEFAULT_FONT` to be defined.
*
* @param size The size of the font to load (optional). Provide 0 if you'd like to use the default size from Nuklear.
* @param size The size of the font to load (optional). Provide 0 to use RAYLIB_NUKLEAR_DEFAULT_FONTSIZE.
*
* @return The loaded font, or an empty font on error.
*
Expand Down
Loading