[WIP] Rendy v0.5.x

[valkum]

Description

Update to rendy v0.5.x and winit v0.20.0-alpha5
Feel free to contribute.

Currently an in place upgrade without any new features added. Might allow for OpenGL

Status

Vulkan complains about the device being dropped before an object. Needs investigation.
Rest is working.
Not responding window might be an issue with our dispatcher blocking the main thread. Needs separate issue.

Blockers

• Windows: 0.20 crashes if CoInitializeEx has been called with MULTITHREADED rust-windowing/winit#1255 (needs release)
• Add Error impl for BuildError rendy#245 (revert 85ee2e8 when 0.5.2 released)
  Status: Waiting for 0.5.2
• Experiment with an improved event design rust-windowing/winit#1374 (needs merge and release)
  WindowEvent in winit 0.20.0 is !Clone, which means we cannot read it from an event channel, then send it through StateEvent (which is what StateEventReader (generated by the EventReader derive) does).

Todo:

• Decide on Event<()> vs. Event<!>
  Decided by Tracking issue for promoting ! to a type (RFC 1216) rust-lang/rust#35121
• Rework MonitorIdent in amethyst_window
  Monitor changed in winit. I added a @todo
• Better error propagation
  Should we return underlying OOM Errors from submodules as CreationError::OutOfMemory or CreationError::Other
• Update all examples
• Fix tests

Changes

See Changelog of rendy and winit

PR Checklist

By placing an x in the boxes I certify that I have:

• Updated the content of the book if this PR would make the book outdated.
• Added a changelog entry if this will impact users, or modified more than 5 lines of Rust that wasn't a doc comment.
• Added unit tests for new code added in this PR.
• Acknowledged that by making this pull request I release this code under an MIT/Apache 2.0 dual licensing scheme.

If this modified or created any rs files:

• Ran cargo +stable fmt --all
• Ran cargo clippy --all --features "empty"
• Ran cargo test --all --features "empty"

[azriel91]

(eager review 😛, guessing i should wait)

[valkum]

Let's talk about the ergonomics of the new mainloop. (See updated examples)
I updated some examples (rendy, renderable, sprite_animation, sprite_camera_follow, sprites_ordered, tiles ) to work with the new API.
To be honest I don't like it.

What are your opinions?

[khionu]

Did you mean to commit this?

[valkum]

Oops should only exclude audio because of rust-windowing/winit#1255

[valkum]

Oh. The hightlight on github looked like I removed all defaults. Removing audio was intended because of the issue.

[azriel91]

Current branch state:

• Updated to winit 0.20.0
• Resolves compilation errors for rendy

It doesn't yet compile as winit::event::Event is !Clone, which is needed for our StateEvent. rust-windowing/winit#1374 improves the situation (WindowEvent will be Clone, though Event itself will not be).

• Rework MonitorIdent in amethyst_window may be done (amethyst_window compiles, and has fixed the logical size to physical size conversions (winit returns PhysicalSize by default now, previously logical size))

[azriel91]

Something to watch (unblocks the StateEvent breakage): rust-windowing/winit#1456

[semtexzv]

Possible way to get amethyst usecase unblocked: rust-windowing/winit#1478

// Edit: Took my fix to winit, rebased the rendy branch on top of master. Seems to compile on linux so far.
https://github.com/semtexzv/amethyst/tree/rendy_v5
& more rewritten examples
https://github.com/semtexzv/amethyst/tree/rendy-all

It seems that we'll need to make Application::run take EventLoop as an argument, current ergonomics are terrible.

@azriel91 Feel free to pull my changes

[azriel91]

@semtexzv Heya, thank you very much for your effort 🙇‍♂️! I'm on another project for 2 weeks, but after that shall be focusing a lot on getting WASM going, and your changes definitely help!

[azriel91]

Closing -- best follow the WASM project, and use the wasm branch.