Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Render* to Gpu* #10390

Closed
wants to merge 1 commit into from
Closed

Conversation

kurtkuehnert
Copy link
Contributor

@kurtkuehnert kurtkuehnert commented Nov 5, 2023

Objective

Improve the consistency of the render module. See #7157 for more context

Solution

  • This PR only focuses on renaming the type and variable names.

  • renamed type names Render{Device, Queue, Adapter, AdapterInfo, Instance, Settings} to GPU{Device, Queue, Adapter, AdapterInfo, Instance, Settings}

  • renamed variable names render_{device, queue, adapter, adapter_info, instance, context} to gpu_{device, queue, adapter, adapter_info, instance, context}

  • maybe slightly controversial: I have additionally renamed a few occurrences of the variable name device and queue, which refer to a GPUDevice or GPUQueue, to gpu_device and gpu_queue for consistency's sake.

  • many small changes and renames for consistency's sake

@alice-i-cecile alice-i-cecile added A-Rendering Drawing game state to the screen C-Usability A simple quality-of-life change that makes Bevy easier to use X-Controversial There is active debate or serious implications around merging this PR C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide labels Nov 8, 2023
Copy link
Contributor

github-actions bot commented Nov 8, 2023

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@alice-i-cecile
Copy link
Member

Before we merge this, we should have a comprehensive migration guide ready :) I understand wanting to hold off until the bikeshedding is done though.

@@ -135,12 +135,12 @@ macro_rules! embedded_path {
/// * `src`
/// * `render`
/// * `rock.wgsl`
/// * `mod.rs`
/// * `gpu_resource`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this change for? It replaced a clear filename with something entirely different.

@alice-i-cecile
Copy link
Member

On that list, we should probably just close the rename Render to Gpu PR at this point. I was in favor of it, but it's been too long and too many things changed so whether we decided to do it or not it will need to a new PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Rendering Drawing game state to the screen C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Usability A simple quality-of-life change that makes Bevy easier to use X-Controversial There is active debate or serious implications around merging this PR
Projects
Status: Candidate
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants