Screen Capturing

[hobnob]

Allows for capturing a screen using the context, fulfilling #735

Usage:

val screenshot: Asset.Image =
  context
      .captureScreen(
          ScreenCaptureConfig
              .default
              .withName("screenshot1")
              .withExcludeLayers(Batch(uiKey))
   )

Breaking Change:
Also adds an additional property to AssetEvent.AssetBatchLoaded detailing the assets that were loaded in the last AssetEvent.LoadAssetBatch event

[davesmith00000]

Looks good. I've left some comments. I think the main one is about passing the renderer to the framecontext.

I think the solution you have here is probably as good a job as you can do without a deeper (and trickier!) integration with the renderer.

The alternative I'm thinking of wouldn't need you to retain the previous data because you'd render to two canvas's at once (if some flag was set), dropping the layers you wanted to skip. Don't know if it would work of course, because I haven't tried it!

[davesmith00000]

I'd be tempted to drop this from the WebGL1 implementation. WebGL1 is very limited - really only good enough to display a message saying "don't use this" - and I'd hope no-one is trying to build anything screen capture worthy in it. What do you think?

[hobnob]

I think all the time we have a WebGL1 implementation we should support it.. It doesn't add much work in this case, so I think we should keep it

[davesmith00000]

This looks good. So if I'm reading correctly, the process is:

1. Take the previous scene (so that you can filter out the layers people don't want to capture).
2. Set up a new canvas.
3. Re-render which effectively overwrites the usual canvas context.
4. Grab it, and stuff it into the new canvas.
5. Save it.

Have I got that right?

[hobnob]

Yup, that's pretty much the process 🙂

[davesmith00000]

Looks good, thanks @hobnob. 🔥