Skip to content

TODO.md

Latest commit

 

History

History
132 lines (87 loc) · 5.11 KB

TODO.md

File metadata and controls

132 lines (87 loc) · 5.11 KB

Project Name - TODO

A list of planned features, improvements, and tasks for this project.

CPX (Complexity Points) - 1 to 5 scale:

  • 1 - Single file control/component
  • 2 - Single file control/component with single function change dependencies
  • 3 - Multi-file control/component or single file with multiple dependencies, no architecture changes
  • 4 - Multi-file control/component with multiple dependencies and significant logic, possible minor architecture changes
  • 5 - Large feature spanning multiple components and subsystems, major architecture changes

Instructions for the TODO list:

  • Move all completed items into separate Completed section
  • Consolidate all completed TODO items by combining similar ones and shortening the descriptions where possible

How TODO file should be iterated:

  • First handle the Uncategorized section, if any similar issues already are on the TODO list, increase their priority instead of adding duplicates (categorize all at once)
  • When Uncategorized section is empty, start by fixing Active Bugs (take one at a time)
  • After Active Bugs, handle the rest of the TODO file by priority and complexity (High priority takes precedance, then CPX points) (take one at a time).

Features

High Priority

No high priority items

Medium Priority

No medium priority items

Lower Priority

No lower priority items

Improvements

Medium Priority

  • CPX 3 - Add safe wrapper methods for unsafe P/Invoke functions in Nuklear class
    • Create managed overloads that handle pointer marshalling internally
    • Target commonly used functions like nk_label, nk_button, nk_edit_string, etc.

Documentation LOW PRIORITY

  • API reference documentation
  • Getting started guide
  • Architecture overview

Code Cleanup & Technical Debt

Medium Priority

No medium priority items

Code Refactoring

No refactoring items

Known Issues / Bugs

Active Bugs

  • CPX 4 - Window dragging broken: window stays in place, only clip zone moves
    • Root Cause: C# struct field offsets don't match native due to size mismatches
    • Mismatches Found:
      • nk_context: C#=18360 vs native=19064 (704 bytes difference)
      • nk_style: C#=8640 vs native=9336 (696 bytes difference)
      • nk_input: C#=856 vs native=864 (8 bytes difference)
      • nk_context.draw_list offset: C#=12528 vs native=13232
    • Workaround Applied: Allocate native sizes for structs (fixes nk_convert crash)
    • Remaining Issue: Direct C# field access reads wrong memory locations
    • Fix Options:
      1. Correct nk_input and nk_style struct definitions in C# (CPX 5)
      2. Add P/Invoke getter functions for commonly accessed fields (CPX 3)
      3. Add padding fields to align C# structs with native layout (CPX 4)

Uncategorized (Analyze and create TODO entries in above appropriate sections with priority. Do not fix or implement them just yet. Assign complexity points where applicable. Do not delete this section when you are done, just empty it)

No uncategorized items

Notes

  • Try to edit files and use tools WITHOUT POWERSHELL where possible, shell scripts get stuck and then manually terminate
  • C# projects should target .NET 9
  • Nuklear2 is the latest version of the original native GUI library Nuklear
  • Keep small project summary as a separate section here (Summary) and up to date to keep track

Summary

NuklearDotNet is a C# binding library for the Nuklear immediate-mode GUI library. Structure:

  • NuklearDotNet/ - Core C# bindings (P/Invoke declarations, structs, API wrapper)
  • Nuklear2/ - Native C source for building Nuklear2.dll (uses nuklear2_c/src headers)
  • Example_Raylib/ - Raylib-cs backend example
  • Example_SFML/ - SFML backend example
  • Example_MonoGame/ - MonoGame backend example
  • Example_WindowsForms/ - WinForms backend example
  • ExampleShared/ - Shared example UI code

Completed

Features

  • CPX 3 - Expanded Raylib example with widget showcase: sliders, progress, checkbox, radio, color picker, properties, knob, chart, collapsible groups

Improvements

  • CPX 3 - Created Raylib backend using raylib_cs NuGet package (v6.1.1), removed legacy bundled bindings
  • CPX 4 - Full Nuklear2 multi-file build: enabled nk_knob_, nk_nine_slice_, nk_widget_disable_*, nk_spacer, nk_rule_horizontal, scroll functions, and 48 more exports

Fixed Bugs

  • CPX 4 - Demo crashes at nk_convert: struct size mismatches (nk_context 704 bytes too small in C#); fixed by allocating native sizes via debug helpers
  • CPX 3 - Demo crashes at startup: switched to nk_init_default, nk_font_atlas_init_default, nk_buffer_init_default; fixed Group method to only call nk_group_end when begin succeeded
  • CPX 2 - Updated Example_Raylib.cs to raylib_cs v6.x API (PascalCase properties/enums)
  • CPX 1 - Added Example_Raylib project to solution (was already present)
  • CPX 2 - NU1201: Updated target framework to net9.0 in Example_SFML, Example_MonoGame, Example_WindowsForms
  • CPX 3 - NU1105: Fixed incorrect project reference paths