Note required features for screen recording#2335
Note required features for screen recording#2335alice-i-cecile merged 2 commits intobevyengine:mainfrom
Conversation
alice-i-cecile
added
A-News
S-Needs-Review
C-Editing
kfc35
left a comment
kfc35
left a comment
There was a problem hiding this comment.
The main concern to using dev-docs here for me is if the enum or the screen record plugin change on main past the 0.18.0 release as far as I understand
I’m personally OK with that to start, but maybe it’s worth writing a caveat about those docs pointing to the dev docs, which may get out of date as time goes on forward
(Is there something we can do now or for future releases that generate these docs if desired?)
I think that this is likely to be more distracting than useful.
I think we can enable all features when building the docs on docs.rs? |
alice-i-cecile
added
S-Ready-For-Final-Review
it-me-joda
left a comment
it-me-joda
left a comment
There was a problem hiding this comment.
Minor nits. Take 'em or leave 'em
| This process has been streamlined, with the new [`EasyScreenshotPlugin`] allowing you to take a screenshot with consistent formatting with a single button press. With its default settings, once you add this plugin to your application, a PNG screenshot will be taken when you press the `PrintScreen` key. You can change the trigger key, or the screenshot format between PNG, JPEG or BMP. | ||
|
|
||
| We've taken this one step further, allowing you to record video directly from Bevy, with the new `EasyScreenRecordPlugin`. This plugins add a toggle key, space bar by default, that will toggle screen recording. Recording can also be started and stopped programmatically with the `RecordScreen` messages. | ||
| We've taken this one step further, allowing you to record video directly from Bevy, with the new [`EasyScreenRecordPlugin`]. This plugins add a toggle key, space bar by default, that will toggle screen recording. Recording can also be started and stopped programmatically with the [`RecordScreen`] messages. |
There was a problem hiding this comment.
| We've taken this one step further, allowing you to record video directly from Bevy, with the new [`EasyScreenRecordPlugin`]. This plugins add a toggle key, space bar by default, that will toggle screen recording. Recording can also be started and stopped programmatically with the [`RecordScreen`] messages. | |
| We've taken this one step further, allowing you to record video directly from Bevy, with the new [`EasyScreenRecordPlugin`]. This plugin adds a toggle key, space bar by default, that will toggle screen recording. Recording can also be started and stopped programmatically with the [`RecordScreen`] messages. |
| We've taken this one step further, allowing you to record video directly from Bevy, with the new [`EasyScreenRecordPlugin`]. This plugins add a toggle key, space bar by default, that will toggle screen recording. Recording can also be started and stopped programmatically with the [`RecordScreen`] messages. | ||
|
|
||
| Screen recording is currently not supported on Windows due to challenges with video codecs. | ||
| While all dev-tools features are off-by default, screen recording is a bit trickier to activate due to this limitation. |
There was a problem hiding this comment.
| While all dev-tools features are off-by default, screen recording is a bit trickier to activate due to this limitation. | |
| While all dev-tools features are off by default, screen recording is a bit trickier to activate due to this limitation. |
3 participants
This is important, hard to discover information, so I've added a note about the exact incantation needed to enable this new feature.
Part of #2320.
I've also hyperlinked the structs, relying on the dev-docs links. These aren't showing up on the docs.rs page at all, I think because they're not part of the default features.
IMO these links are better than nothing, but if y'all disagree I'll remove them.