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.

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

[Merged by Bors] - Fix outdated and badly formatted docs for WindowDescriptor::transparent #6329

Closed
wants to merge 3 commits into from
Closed

[Merged by Bors] - Fix outdated and badly formatted docs for WindowDescriptor::transparent #6329

wants to merge 3 commits into from

Conversation

rparrett
Copy link
Contributor

@rparrett rparrett commented Oct 21, 2022 •
edited

Objective

See title

Before / After

Screen Shot 2022-10-21 at 10 51 12 AM

Screen Shot 2022-10-21 at 10 51 24 AM

Open questions

The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.

I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.

edit: Seems like we're good on Windows 11, thanks.

@mockersf
Copy link
Member

it works on macOS if I change

bevy/crates/bevy_render/src/view/window.rs

Line 199 in abbc0cf

alpha_mode: wgpu::CompositeAlphaMode::Auto,
to CompositeAlphaMode::PostMultiplied

@hymm
Copy link
Contributor

hymm commented Oct 21, 2022 •
edited

image
worked for me on windows 11

    App::new()
        .insert_resource(WindowDescriptor {
            transparent: false,
            ..default()
        })
        .insert_resource(ClearColor(Color::Rgba {
            red: 0.1,
            green: 0.1,
            blue: 0.1,
            alpha: 0.5,
        }))

hymm
hymm approved these changes Oct 21, 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.

Approving just the windows 11 related changes here. I can't test macOS.

@rparrett
Copy link
Contributor Author

rparrett commented Oct 21, 2022 •
edited

it works on macOS if I change

What would you suggest we do with this documentation of MacOS users? Should we create a bevy issue that documents the workaround and links to the wgpu issue and then link to that?

@targrub
Copy link
Contributor

targrub commented Oct 21, 2022 •
edited

Running the transparent_window example on Windows 11, I get a Bevy logo, circular, 100% clear (transparent, not translucent) outside that circle. Can't move the window, only close it through the Taskbar (or more drastic ways); can bring it in front of other windows by clicking on the logo. Title of window shown as "app" in Alt-Tab bar.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Windowing Platform-agnostic interface layer to run your app in labels Oct 21, 2022
@rparrett
Copy link
Contributor Author

Running the transparent_window example on Windows 11, I get a Bevy logo, circular, 100% clear (transparent, not translucent) outside that circle. Can't move the window, only close it through the Taskbar (or more drastic ways); can bring it in front of other windows by clicking on the logo. Title of window shown as "app" in Alt-Tab bar.

Thanks. I think that's normal, as that example also disables the title bar.

@alice-i-cecile alice-i-cecile added O-Linux Specific to the Linux desktop operating system O-MacOS Specific to the MacOS (Apple) desktop operating system labels Oct 21, 2022
@mockersf
Copy link
Member

What would you suggest we do with this documentation of MacOS users? Should we create a bevy issue that documents the workaround and links to the wgpu issue and then link to that?

Yeah, new issue sounds good 👍
We don't expose the wgpu config for CompositeAlphaMode anyway, and I'm not sure what impacts it could have

@mockersf mockersf added O-Windows Specific to the Windows desktop operating system and removed O-MacOS Specific to the MacOS (Apple) desktop operating system labels Oct 21, 2022
@rparrett
Copy link
Contributor Author

Alright, now linking off to the linux and mac specific bevy issues.

@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Oct 22, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Oct 24, 2022
@rparrett
Fix outdated and badly formatted docs for `WindowDescriptor::transpar…
1eb3f65 
…ent` (#6329)

# Objective

See title

## Before / After

<img width="988" alt="Screen Shot 2022-10-21 at 10 51 12 AM" src="https://user-images.githubusercontent.com/200550/197258517-29fec3e0-e272-4ab1-9f4c-c646b04876f2.png">
<img width="988" alt="Screen Shot 2022-10-21 at 10 51 24 AM" src="https://user-images.githubusercontent.com/200550/197258519-7fbaf058-fc2c-469e-ae34-5531f02a632f.png">

## Open questions

~~The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.~~

~~I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.~~

edit: Seems like we're good on Windows 11, thanks.
@bors
Copy link
Contributor

bors bot commented Oct 24, 2022

Build failed (retrying...):

bors bot pushed a commit that referenced this pull request Oct 24, 2022
@rparrett
Fix outdated and badly formatted docs for `WindowDescriptor::transpar…
c9888a9 
…ent` (#6329)

# Objective

See title

## Before / After

<img width="988" alt="Screen Shot 2022-10-21 at 10 51 12 AM" src="https://user-images.githubusercontent.com/200550/197258517-29fec3e0-e272-4ab1-9f4c-c646b04876f2.png">
<img width="988" alt="Screen Shot 2022-10-21 at 10 51 24 AM" src="https://user-images.githubusercontent.com/200550/197258519-7fbaf058-fc2c-469e-ae34-5531f02a632f.png">

## Open questions

~~The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.~~

~~I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.~~

edit: Seems like we're good on Windows 11, thanks.
@bors
Copy link
Contributor

bors bot commented Oct 24, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Fix outdated and badly formatted docs for WindowDescriptor::transparent [Merged by Bors] - Fix outdated and badly formatted docs for WindowDescriptor::transparent Oct 24, 2022
@bors bors bot closed this Oct 24, 2022
@mockersf mockersf added the hacktoberfest-accepted A PR that was accepted for Hacktoberfest, an annual open source event label Oct 24, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@rparrett @james7132
Fix outdated and badly formatted docs for `WindowDescriptor::transpar…
3eb9923 
…ent` (bevyengine#6329)

# Objective

See title

## Before / After

<img width="988" alt="Screen Shot 2022-10-21 at 10 51 12 AM" src="https://user-images.githubusercontent.com/200550/197258517-29fec3e0-e272-4ab1-9f4c-c646b04876f2.png">
<img width="988" alt="Screen Shot 2022-10-21 at 10 51 24 AM" src="https://user-images.githubusercontent.com/200550/197258519-7fbaf058-fc2c-469e-ae34-5531f02a632f.png">

## Open questions

~~The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.~~

~~I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.~~

edit: Seems like we're good on Windows 11, thanks.
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this pull request Dec 17, 2022
@rparrett @Pietrek14
Fix outdated and badly formatted docs for `WindowDescriptor::transpar…
8e3e465 
…ent` (bevyengine#6329)

# Objective

See title

## Before / After

<img width="988" alt="Screen Shot 2022-10-21 at 10 51 12 AM" src="https://user-images.githubusercontent.com/200550/197258517-29fec3e0-e272-4ab1-9f4c-c646b04876f2.png">
<img width="988" alt="Screen Shot 2022-10-21 at 10 51 24 AM" src="https://user-images.githubusercontent.com/200550/197258519-7fbaf058-fc2c-469e-ae34-5531f02a632f.png">

## Open questions

~~The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.~~

~~I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.~~

edit: Seems like we're good on Windows 11, thanks.
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@rparrett @ItsDoot
Fix outdated and badly formatted docs for `WindowDescriptor::transpar…
a820804 
…ent` (bevyengine#6329)

# Objective

See title

## Before / After

<img width="988" alt="Screen Shot 2022-10-21 at 10 51 12 AM" src="https://user-images.githubusercontent.com/200550/197258517-29fec3e0-e272-4ab1-9f4c-c646b04876f2.png">
<img width="988" alt="Screen Shot 2022-10-21 at 10 51 24 AM" src="https://user-images.githubusercontent.com/200550/197258519-7fbaf058-fc2c-469e-ae34-5531f02a632f.png">

## Open questions

~~The old docs previously linked to a winit but that was preventing transparency for working on Windows 11. The recent winit upgrade should have fixed this.~~

~~I'm unable to test on Windows 11 though, so someone should verify that we no longer need to call this out as being broken.~~

edit: Seems like we're good on Windows 11, thanks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hymm hymm hymm approved these changes

@mockersf mockersf mockersf approved these changes

Assignees
No one assigned
Labels
A-Windowing Platform-agnostic interface layer to run your app in C-Docs An addition or correction to our documentation hacktoberfest-accepted A PR that was accepted for Hacktoberfest, an annual open source event O-Linux Specific to the Linux desktop operating system O-Windows Specific to the Windows desktop operating system S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@rparrett @mockersf @hymm @targrub @alice-i-cecile