bevyengine / bevy

A refreshingly simple data-driven game engine built in Rust
https://bevyengine.org
Apache License 2.0
35k stars 3.43k forks source link

Document methods relative to projection #13731

Open Selene-Amanita opened 3 months ago

Selene-Amanita commented 3 months ago

Following https://github.com/bevyengine/bevy/issues/8492, a bunch of methods were renamed, it basically erased a lot of references to "projection" and replaced them with "clip". I didn't see this PR until after it happened, but I find the documentation (not the migration guide) surrounding it a bit lacking (not saying it's the fault/responsibility of the PR/its author, some of it was also the case before):

Even if those things wouldn't matter much for someone that just codes a simple game, it might matter to plugin writers and people who want to understand how the rendering side of Bevy works.

JMS55 commented 3 months ago

https://gpuweb.github.io/gpuweb/#clip-space-coordinates

Selene-Amanita commented 3 months ago

Thanks, that's what I thought it was.

I still think it should be explained in Bevy's doc though (and that you get from world space to clip space using the projection), or at the very least link to this doc, even though I find it a bit not super clear for people who aren't familiar with rendering stuff.

I'm not saying Bevy's doc should be a course on rendering, but I do think it should try to explain what's going on without necessarily going into details.