Skip to content

document canvas field on window in wasm #4683

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

Closed
mockersf wants to merge 1 commit into from
Closed

document canvas field on window in wasm #4683

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion crates/bevy_window/src/window.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,8 @@ pub struct WindowDescriptor {
/// macOS X transparent works with winit out of the box, so this issue might be related to: <https://github.com/gfx-rs/wgpu/issues/687>
/// Windows 11 is related to <https://github.com/rust-windowing/winit/issues/2082>
pub transparent: bool,
#[cfg(target_arch = "wasm32")]
/// This field is only available in wasm. Can take a CSS selector to an HTML canvas
#[cfg(any(target_arch = "wasm32", doc))]

@bjorn3 bjorn3 May 7, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe use #[doc(cfg(target_arch = "wasm32"))] too? That shows the cfg as part of the documentation. I'm not sure if it is stable already, but if not you could gate it to docs.rs.

@mockersf mockersf May 8, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's unstable: https://doc.rust-lang.org/rustdoc/unstable-features.html#doccfg-recording-what-platforms-or-features-are-required-for-code-to-be-present
Do you know if it or https://doc.rust-lang.org/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg would be stabilised soon?

I'm not sure how to gate it for docs.rs, it seems it's only available through a var env in a build.rs script: https://docs.rs/about/builds#detecting-docsrs

pub canvas: Option<String>,
}

Expand Down