Skip to content

[Merged by Bors] - Gamepad type is Copy; do not require / return references to it in Gamepads API #5296

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 7 commits into from
Closed

[Merged by Bors] - Gamepad type is Copy; do not require / return references to it in Gamepads API #5296

wants to merge 7 commits into from

Conversation

alice-i-cecile
Copy link
Member

Objective

  • The Gamepad type is a tiny value-containing type that implements Copy.
  • By convention, references to Copy types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
  • This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

Solution

  • Make assorted methods on Gamepads take / return a raw Gamepad, rather than &Gamepad.

Migration Guide

  • Gamepads::iter now returns an iterator of Gamepad. rather than an iterator of &Gamepad.
  • Gamepads::contains now accepts a Gamepad, rather than a &Gamepad.

@alice-i-cecile alice-i-cecile added A-Input Player input via keyboard, mouse, gamepad, and more C-Code-Quality A section of code that is hard to understand or change C-Usability A targeted quality-of-life change that makes Bevy easier to use labels Jul 12, 2022
@Nilirad Nilirad added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jul 12, 2022
@Nilirad
Copy link
Contributor

Nilirad commented Jul 12, 2022

Labeled as breaking change since it changes function signatures.

hymm
hymm approved these changes Jul 13, 2022
View reviewed changes
Copy link
Contributor

@hymm hymm left a comment

Choose a reason for hiding this comment

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

LGTM

alice-i-cecile
alice-i-cecile commented Sep 3, 2022
View reviewed changes
alice-i-cecile
alice-i-cecile commented Sep 3, 2022
View reviewed changes
alice-i-cecile
alice-i-cecile commented Sep 3, 2022
View reviewed changes
alice-i-cecile
alice-i-cecile commented Sep 3, 2022
View reviewed changes
tim-blackbird
tim-blackbird approved these changes Sep 3, 2022
View reviewed changes
@alice-i-cecile @tim-blackbird
Periods
c8d1feb 
Co-authored-by: ira <JustTheCoolDude@gmail.com>
@alice-i-cecile
Copy link
Member Author

bors r+

bors bot pushed a commit that referenced this pull request Sep 3, 2022
@alice-i-cecile
Gamepad type is Copy; do not require / return references to it in…
5849042 
… `Gamepads` API (#5296)

# Objective

- The `Gamepad` type is a tiny value-containing type that implements `Copy`.
- By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
- This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

## Solution

- Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`.

## Migration Guide

- `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`.
- `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.
@bors
Copy link
Contributor

bors bot commented Sep 3, 2022

Build failed:

TimJentzsch
TimJentzsch reviewed Sep 3, 2022
View reviewed changes
@alice-i-cecile @TimJentzsch
Documentation consistency
0d2818d 
Co-authored-by: TimJentzsch <tim-jentzsch@gmx.de>
@alice-i-cecile
Copy link
Member Author

bors retry

bors bot pushed a commit that referenced this pull request Sep 3, 2022
@alice-i-cecile
Gamepad type is Copy; do not require / return references to it in…
7a29c70 
… `Gamepads` API (#5296)

# Objective

- The `Gamepad` type is a tiny value-containing type that implements `Copy`.
- By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
- This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

## Solution

- Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`.

## Migration Guide

- `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`.
- `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.
@bors
Copy link
Contributor

bors bot commented Sep 3, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Gamepad type is Copy; do not require / return references to it in Gamepads API [Merged by Bors] - Gamepad type is Copy; do not require / return references to it in Gamepads API Sep 3, 2022
@bors bors bot closed this Sep 3, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@alice-i-cecile @james7132
Gamepad type is Copy; do not require / return references to it in…
cab3f56 
… `Gamepads` API (bevyengine#5296)

# Objective

- The `Gamepad` type is a tiny value-containing type that implements `Copy`.
- By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
- This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

## Solution

- Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`.

## Migration Guide

- `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`.
- `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@alice-i-cecile @ItsDoot
Gamepad type is Copy; do not require / return references to it in…
ccfcbf6 
… `Gamepads` API (bevyengine#5296)

# Objective

- The `Gamepad` type is a tiny value-containing type that implements `Copy`.
- By convention, references to `Copy` types should be avoided, as they can introduce overhead and muddle the semantics of what's going on.
- This allows us to reduce boilerplate reference manipulation and lifetimes in user facing code.

## Solution

- Make assorted methods on `Gamepads` take / return a raw `Gamepad`, rather than `&Gamepad`.

## Migration Guide

- `Gamepads::iter` now returns an iterator of `Gamepad`. rather than an iterator of `&Gamepad`.
- `Gamepads::contains` now accepts a `Gamepad`, rather than a `&Gamepad`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
3 more reviewers

@hymm hymm hymm approved these changes

@TimJentzsch TimJentzsch TimJentzsch approved these changes

@tim-blackbird tim-blackbird tim-blackbird approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
A-Input Player input via keyboard, mouse, gamepad, and more C-Code-Quality A section of code that is hard to understand or change C-Usability A targeted quality-of-life change that makes Bevy easier to use M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@alice-i-cecile @Nilirad @hymm @TimJentzsch @tim-blackbird