feat: Implement Snapshot mixin on PositionComponent #2695
Conversation
projectitis
changed the title
|
I think there are differences between the rendering of the github runner and my own computer. The 3 golden tests I wrote are failing with a 2-3% margin (i.e. quite small). I also have other golden tests failing on my local machine for other tests. Most of them with very small margins (e.g. 0.5%). |
Yup, they have to be generated on a Linux machine. I can generate them for you if you want. |
|
Updated the goldens, won't have time to review until Wednesday next week though (Flutter & Friends starts on Sunday, so it's a loooot to organize 😅). |
|
Wow, what an amazing event! Great speaker line up. Good luck with the workshop! |
I know right, I picked them myself. 😂 |
|
I wish I wasn't so far away. Would love to attend :) |
They look good! Thank you. |
|
Apparently our pipeline was a bit broken, there are some very minor analyze issues in this PR (missing trailing commas) |
|
ok, ready for another look when you have time :) |
|
Sorry, I found some documentation errors I introduced :( |
|
|
||
| Layers and snapshots share some common features, including the ability to pre-render and cache | ||
| objects for improved performance. However, they also have unique features which make them better | ||
| suited for different use-cases. |
There was a problem hiding this comment.
while I think both sections below do a good job of describing each feature in a vacuum, I think this paragraph could give more details about what are the differences and what rationale I should use to choose one or the other
There was a problem hiding this comment.
I've added a description. Please amend it if you don't agree!
To be honest, I'm not sure of when you might use a Layer instead of a Snapshot, unless you don't want the overhead of a position component. Layers support processors (of which there is only 1 so far, but more could be made). However processors are sort of doubling-up on Effects?
This is what I have (below) -
There was a problem hiding this comment.
Layers and Snapshots
Layers and snapshots share some common features, including the ability to pre-render and cache
objects for improved performance. However, they also have unique features which make them better
suited for different use-cases.
Snapshot is a mixin that can be added to any PositionComponent. Use this for:
- Mixing in to existing game objects (that are
PositionComponents). - Caching game objects, such as sprites, that are complex to render.
- Drawing the same object many times without rendering it each time.
- Capturing an image snapshot to save as a screenshot (for example).
Layer is a class. Use or extend this class for:
- Structuring your game with logical layers (e.g. UI, foreground, main, background).
- Grouping objects to form a complex scene, and then caching it (e.g. a background layer).
- Processor support. Layers allow user-defined processors to run pre- and post- render.
There was a problem hiding this comment.
Let's keep it like that for now and then we can extend on that in a follow-up. :)
Description
This implements a
Snapshotmixin onPositionComponentthat allows:PictureorImagesnapshot to be taken at any timeInternally the snapshot is cached and redrawn as a
Picture. After testing with bothImageandPictureI found thatImagehad no performance improvement, and the rendering quality was lower.A helper method
snapshotToImagewas added to allow the user better control of generating anImagefrom the internalPicturesnapshot if that is desired.See the documentation in this PR for more details.
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues
Closes #2693