Skip to content

Commit 4f35ce2

Browse files
committed
Update readme gallery and changelog
1 parent 34d8162 commit 4f35ce2

File tree

2 files changed

+54
-12
lines changed

2 files changed

+54
-12
lines changed

changelog.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,20 @@
1717
#### Autoscroll mode
1818
Autoscroll mode, or scrolling with the middle mouse button, is now featured in RmlUi. #422 #423 (thanks @igorsegallafa)
1919

20-
This mode is automatically enabled by the context whenever a middle mouse button press is detected, and there is an element to scroll under the mouse. This can effectively be disabled by simply not submitting middle mouse button presses, or by using another button index when submitting the button to the context.
20+
This mode is automatically enabled by the context whenever a middle mouse button press is detected, and there is an element to scroll under the mouse. There is also support for holding the middle mouse button to scroll.
2121

22-
When autoscroll mode is active, a cursor name is submitted to clients which indicates the state of the autoscroll, so that clients can display an appropriate cursor to the user. These cursor names all start with `rmlui-cursor-`, and take priority over any active `cursor` property. See the new [documentation section on scrolling](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/contexts.html#scrolling) for details.
22+
When autoscroll mode is active, a cursor name is submitted to clients which indicates the state of the autoscroll, so that clients can display an appropriate cursor to the user. These cursor names all start with `rmlui-scroll-`, and take priority over any active `cursor` property. If desired, autoscroll mode can be disabled entirely by simply not submitting middle mouse button presses, or by using another button index when submitting the button to the context.
23+
24+
See the new [documentation section on scrolling](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/contexts.html#scrolling) for details.
2325

2426
#### Smooth scrolling
25-
Smooth scrolling is now supported in RmlUi, and enabled by default. This makes a given scroll action animate smoothly towards its destination. Smooth scrolling can be activated in several situations, including:
27+
Smooth scrolling is now supported in RmlUi, and enabled by default. This makes a some scroll actions animate smoothly towards its destination. Smooth scrolling may become active in the following situations:
2628

2729
- During a call to `Context::ProcessMouseWheel()`.
2830
- When clicking a scrollbar's arrow keys or track.
2931
- When calling any of the `Element::Scroll...()` methods with the `ScrollBehavior::Smooth` enum value.
3032

31-
The default smooth scroll behavior is enabled by default. This can be disabled or tweaked on the context as described below.
33+
Smooth scrolling can be disabled or tweaked on the context, as described below.
3234

3335
#### Context interface
3436
Smooth scrolling can be disabled, or tweaked, by calling the following method on a given context:
@@ -57,6 +59,15 @@ The `mousescroll` event no longer performs scrolling on an element, and no longe
5759
5860
- New [`overscroll-behavior` property](https://mikke89.github.io/RmlUiDoc/pages/rcss/user_interface.html#overscroll-behavior). An element's closest scrollable ancestor is decided by scroll chaining, which can be controlled using this property. The `contain` value can be used to ensure that mouse wheel scrolling is not propagated outside a given element, regardless of whether its scrollbars are visible.
5961
- Added animation support for decorators. #421 (thanks @0suddenly0)
62+
- Sibling selectors will now also match hidden elements.
63+
64+
### On-demand rendering (power saving mode)
65+
66+
In games, the update and render loop normally run as fast as possible. However, in some applications it is desirable to reduce CPU usage and power consumption when the application is idle. RmlUi now provides the necessary utilities to achieve this. Implemented in #436 (thanks @Thalhammer), see also #331 #417 #430.
67+
68+
Users of RmlUi control their own update loop, however, this feature requires some support from the library side, because the application needs to know e.g. when animations are happening or when a text cursor should blink. In short, to implement this, users can now query the context for `Context::GetNextUpdateDelay()`, which returns the time until the next update loop should be run again.
69+
70+
See the [on-demand rendering documentation](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/contexts.html#on-demand-rendering) for details and examples.
6071
6172
### Text selection interface
6273
@@ -81,13 +92,16 @@ See the [form controls documentation](https://mikke89.github.io/RmlUiDoc/pages/c
8192
- Make the `:checked` pseudo class active on the `<select>` element whenever its options list is open, for better styling capabilities.
8293
- Fix max length in text input fields not always clamping the value, such as when pasting text.
8394
- The slider input now only responds to the primary mouse button.
95+
- The slider input is now only draggable from the track or bar, instead of the whole element.
96+
- Fixed input elements not always being correctly setup when changing types.
8497

85-
### Bug fixes
98+
### Stability improvements
8699

87100
- Fix a potential crash during plugin shutdown. #415 (thanks @LoneBoco)
88101

89102
### Data bindings
90103

104+
- Add new [data-alias attribute](https://mikke89.github.io/RmlUiDoc/pages/data_bindings/views_and_controllers.html#data-alias) to make templates work with outside variables. #432 (thanks @dakror)
91105
- Add method to retrieve the `DataTypeRegister` during model construction. #412 #413 (thanks @LoneBoco)
92106
- Add ability to provide a separate data type register to use when constructing a new data model. Can be useful to provide a distinct type register for each shared library accessing the same context. Alternatively, allows different contexts to share a single type register. #409 (thanks @eugeneko)
93107

@@ -112,7 +126,7 @@ See the [form controls documentation](https://mikke89.github.io/RmlUiDoc/pages/c
112126

113127
### Breaking changes
114128

115-
- The `mousewheel` event no longer scrolls an element, see scrolling changes above.
129+
- The `mousescroll` event no longer scrolls an element, see scrolling changes above. Its `wheel_delta` parameter has been renamed to `wheel_delta_y`.
116130
- The signature of `Context::ProcessMouseWheel` has been changed, the old signature is still available but deprecated.
117131

118132

readme.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -351,27 +351,55 @@ Users can now edit the text field to change the animal. The data bindings ensure
351351
**Game interface from the 'invader' sample**\
352352
![Game interface](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/invader.png)
353353
354-
**Game menu**
354+
**Game menu**\
355355
![Game menu](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/menu_screen.png)
356356
357+
**Simple game from the 'databinding' sample**\
358+
![Databinding sample](https://raw.githubusercontent.com/mikke89/RmlUiDoc/df1651db94e69f2977bc0344864ec061b56b104e/assets/gallery/data_binding.png)
359+
360+
**[alt:V](https://altv.mp/) installer - a multiplayer client for GTA:V**\
361+
![alt:V installer collage](https://user-images.githubusercontent.com/5490330/230487770-275fe98f-753f-4b35-b2e1-1e20a798f5e8.png)
362+
363+
**[Unvanquished](https://unvanquished.net/) - a first-person shooter game with real-time strategy elements**\
364+
![Unvanquished 0.54 collage](https://user-images.githubusercontent.com/5490330/230487771-5108a273-8b76-4216-8324-d9e5af102622.jpg)
365+
366+
**Installer software by [@xland](https://github.com/xland)**\
367+
![xland installer collage](https://user-images.githubusercontent.com/5490330/230487763-ec4d28e7-7ec6-44af-89f2-d2cbad8f44c1.png)
368+
357369
**Form controls from the 'demo' sample**\
358370
![Form controls](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/forms.png)
359371
360372
**Sandbox from the 'demo' sample, try it yourself!**\
361373
![Sandbox](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/sandbox.png)
362374
363-
**Visual testing framework**\
364-
![Sandbox](https://github.com/mikke89/RmlUiDoc/blob/c7253748d1bcf6dd33d97ab4fe8b6731a7ee3dac/assets/gallery/visual_tests_flex.png)
375+
**Visual testing framework - for built-in automated layout tests**\
376+
![Visual testing framework](https://github.com/mikke89/RmlUiDoc/blob/c7253748d1bcf6dd33d97ab4fe8b6731a7ee3dac/assets/gallery/visual_tests_flex.png)
377+
378+
**Flexbox layout**\
379+
![Flexbox](https://github.com/mikke89/RmlUiDoc/blob/4cf0c6ac23b822174e69e5f1413b71254230c619/assets/images/flexbox-example.png)
380+
381+
382+
**Animations and transitions from the 'animation' sample**
365383
384+
[Animation sample](https://user-images.githubusercontent.com/5490330/230486839-de3ca062-6641-48e0-aa6a-ef2b26c3aad5.webm)
385+
386+
\
387+
**Transitions and transforms on a game menu**
388+
389+
[Game main menu](https://user-images.githubusercontent.com/5490330/230487193-cd07b565-2e9b-4570-aa37-7dd7746dd9c9.webm)
390+
391+
\
392+
**Camera movement in a game menu**
393+
394+
[Transforms applied to game menu](https://user-images.githubusercontent.com/5490330/230487217-f499dfca-5304-4b99-896d-07791926da2b.webm)
395+
396+
\
366397
**Transitions on mouse hover (entirely in RCSS)**\
367398
![Transition](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/transition.gif)
368399
369400
**Animated transforms (entirely in RCSS)**\
370401
![Transform](https://github.com/mikke89/RmlUiDoc/blob/3f319d8464e73b821179ff8d20537013af5b9810/assets/gallery/transform.gif)
371402
372-
**Flexbox layout**\
373-
![Flexbox](https://github.com/mikke89/RmlUiDoc/blob/4cf0c6ac23b822174e69e5f1413b71254230c619/assets/images/flexbox-example.png)
374-
375403
**Vector animations with the [Lottie plugin](https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/lottie.html)**\
376404
![Lottie animation](https://github.com/mikke89/RmlUiDoc/blob/086385e119f0fc6e196229b785e91ee0252fe4b4/assets/gallery/lottie.gif)
377405

0 commit comments

Comments
 (0)