Skip to content

Commit 1a34877

Browse files
committed
Update readme and changelog
1 parent bd5e167 commit 1a34877

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

changelog.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
### Prevent single pixel gaps between elements
1818

19-
This release addresses the issue of 1px gaps appearing between fractionally sized elements when placed border-to-border. This was particularly pronounced in DPI-scaled layouts, as that often leads to fractionally sized elements. Resolves #438, see also #502.
19+
This release addresses the issue of 1px gaps appearing between fractionally sized elements when placed border-to-border. This was particularly pronounced in DPI-scaled layouts, as that often leads to fractionally sized elements.
2020

21-
The solution involves rounding the rendered sizes of elements based on their absolute positions to ensure that the bottom/right of one element matches the top/left of the next element. This implies that the rendered size of a fractional element may vary by up to one pixel. This generally matches how web browsers behave. Floating-point precision issues may still cause rare gaps, but the improvements should cover almost all cases. See the [commit message](https://github.com/mikke89/RmlUi/commit/b197f985b328d5493af3190e27d4290bb496ff1d) for details.
21+
The solution involves rounding the rendered sizes of elements based on their absolute positions to ensure that the bottom/right of one element matches the top/left of the next element. This implies that the rendered size of a fractional element may vary by up to one pixel. This generally matches how web browsers behave. Floating-point precision issues may still cause rare gaps, but the improvements should cover almost all cases. See the [commit message](https://github.com/mikke89/RmlUi/commit/b197f985b328d5493af3190e27d4290bb496ff1d) for details. Resolves #438, thanks to @mwl4 for the extensive initiative and proof of concept.
2222

2323
Fixes several situations with single pixel gaps and overlaps:
2424

@@ -67,14 +67,13 @@ The `<handle>` element has received several major improvements.
6767

6868
### Input elements
6969

70-
- Improve navigation of `<select>` elements when using controller/keyboard navigation. #566 (thanks @Paril)
70+
- Improve navigation of `<select>` elements when using controller/keyboard navigation. #565 #566 (thanks @Paril)
7171
- Scroll to the selected options as one is moving up or down the list.
7272
- Scroll to the selected option when opening up the selection box.
73-
- Add ability to programmatically show or hide the selection box.
73+
- Add ability to programmatically [show or hide](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/element_packages/form.html#drop-down-select-box) the selection box.
7474
- Fix some layout and behavior issues of the `<select>` element.
75-
- Fix some issues related to specifying the height of the select arrow element.
75+
- Fix issues related to specifying the height of the select arrow element.
7676
- Fix an issue where the selection box would scroll to the top-left corner when the document layout is updated.
77-
-
7877
- Fix an issue where the contents of the `<input type="text">` and `<textarea>` elements could sometimes unintentionally scroll to a new place after a layout update.
7978

8079
### Elements

readme.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ RmlUi is the C++ user interface package based on the HTML and CSS standards, des
1414

1515
RmlUi aims at being a light-weight and performant library with its own layouting engine and few dependencies. In essence, RmlUi takes your HTML/CSS-like source files and turns them into vertices, indices and draw commands, and then you bring your own renderer to draw them. And of course there is full access to the element hierarchy/DOM, event handling, and all the interactivity and customizability you would expect. All of this directly from C++, or optionally from scripting languages using plugins. The core library compiles down to fractions of the size it takes to integrate a fully fledged web browser.
1616

17-
RmlUi is based around the XHTML1 and CSS2 standards while borrowing features from HTML5 and CSS3, and extends them with features suited towards real-time applications. Take a look at the [conformance](#conformance) and [enhancements](#enhancements) sections below for details.
17+
RmlUi is based around the XHTML1 and CSS2 standards while integrating features from HTML5 and CSS3, and extends them with features suited towards real-time applications. Take a look at the [conformance](#conformance) and [enhancements](#enhancements) sections below for details.
1818

1919
Documentation is located at https://mikke89.github.io/RmlUiDoc/
2020

2121
## Features
2222

23-
- Cross-platform architecture: Windows, macOS, Linux, iOS, etc.
23+
- Cross-platform architecture: Windows, Linux, macOS, Android, iOS, Switch, and more.
2424
- Dynamic layout system.
2525
- Full animation and transform support.
2626
- Efficient application-wide styling, with a custom-built templating engine.
27-
- Fully featured control set: buttons, sliders, drop-downs, etc.
27+
- Fully featured control set: buttons, sliders, drop-downs, and more.
2828
- Runtime visual debugging suite.
2929

3030
## Extensible
@@ -42,7 +42,6 @@ Documentation is located at https://mikke89.github.io/RmlUiDoc/
4242
- The library generates vertices, indices, and textures for the user to render how they like.
4343
- File handling and the font engine can optionally be fully replaced by the user.
4444

45-
4645
## Conformance
4746

4847
RmlUi aims to support the most common and familiar features from HTML and CSS, while keeping the library light and performant. We do not aim to be fully compliant with CSS or HTML, in particular when it conflicts with lightness and performance. Users are generally expected to author documents specifically for RmlUi, but any experience and skills from web design should be transferable.
@@ -73,7 +72,7 @@ RmlUi adds features and enhancements over CSS and HTML where it makes sense, mos
7372
- [Sprite sheets](https://mikke89.github.io/RmlUiDoc/pages/rcss/sprite_sheets.html). Define and use sprites with easy high DPI support.
7473
- [Templates](https://mikke89.github.io/RmlUiDoc/pages/rml/templates.html). Making windows look consistent.
7574
- [Localization](https://mikke89.github.io/RmlUiDoc/pages/localisation.html). Translate any text in the document.
76-
75+
- [Spatial navigation](https://mikke89.github.io/RmlUiDoc/pages/rcss/user_interface.html#nav). Suitable for controllers.
7776

7877
## Dependencies
7978

@@ -373,7 +372,7 @@ Users can now edit the text field to change the animal. The data bindings ensure
373372
374373
[Effects sample video](https://github.com/mikke89/RmlUi/assets/5490330/bdc0422d-867d-4090-9d48-e7159e3adc18)
375374
376-
**[Killing Time: Resurrected](https://www.nightdivestudios.com/) by [Nightdive Studios](https://www.nightdivestudios.com/) and [Ziggurat Interactive](https://www.ziggurat.games/game/killing-time-resurrected) - remastered version of the classic shooter game - user interface made with RmlUi**\
375+
**[Killing Time: Resurrected](https://nightdivestudios.com/killing-time-resurrected/) by [Nightdive Studios](https://www.nightdivestudios.com/) and [Ziggurat Interactive](https://www.ziggurat.games/game/killing-time-resurrected) - remastered version of the classic shooter game - user interface made with RmlUi**\
377376
![Killing Time: Resurrected collage](https://raw.githubusercontent.com/mikke89/RmlUiDoc/7ca874cc506986a789e2c9a317a4e23f359d2316/assets/gallery/killing_time_resurrected_collage.webp)
378377
379378
**[alt:V](https://altv.mp/) installer - a multiplayer client for GTA:V**\
@@ -395,6 +394,9 @@ Users can now edit the text field to change the animal. The data bindings ensure
395394
**Sandbox from the 'demo' sample, try it yourself!**\
396395
![Sandbox](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/sandbox.png?raw=true)
397396
397+
**Collage of advanced effects:**\
398+
![Collage of advanced effects](https://github.com/user-attachments/assets/71840d6f-903e-45fe-9e34-a02ed1ddae07)
399+
398400
**Visual testing framework - for built-in automated layout tests**\
399401
![Visual testing framework](https://github.com/mikke89/RmlUiDoc/blob/c7253748d1bcf6dd33d97ab4fe8b6731a7ee3dac/assets/gallery/visual_tests_flex.png?raw=true)
400402

0 commit comments

Comments
 (0)