Document wgpu & wgpu-core features #4886
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Main focus on wgpu since this is where most users enter. wgpu-hal features are still undocumented for now
|
thanks for the corrections! |
cwfitzgerald
approved these changes
Dec 17, 2023
5 tasks
ErichDonGubler
added a commit
to erichdongubler-mozilla/wgpu
that referenced
this pull request
Dec 22, 2023
Re-implements gfx-rs#4886 (CC @Wumpf) without the `document-features` crate, which has issues integrating into Firefox builds after being `cargo vendor`ed into its repository. This issue is being tracked against slint-ui/document-features#20. Once resolved, I expect that we will want to revert this PR in its entirety, since `document-features` is still a good addition to `wgpu`'s documentation story. Internally, consensus has already been achieved for this change. Firefox's ability to build unfortunately take priority over this particular convenience. Hopefully, we won't have to compromise shortly! I tested this by ensuring that the HTML output of our existing `document_features::document_features!(…)` usage was exactly the same. There should be exactly zero regressions in the current state of documentation for users. For maintainers, I have added a disclaimer that one needs to keep changes in sync. with the relevant `Cargo.toml` manifests.
ErichDonGubler
added a commit
that referenced
this pull request
Dec 22, 2023
Re-implements #4886 (CC @Wumpf) without the `document-features` crate, which has issues integrating into Firefox builds after being `cargo vendor`ed into its repository. This issue is being tracked against slint-ui/document-features#20. Once resolved, I expect that we will want to revert this PR in its entirety, since `document-features` is still a good addition to `wgpu`'s documentation story. Internally, consensus has already been achieved for this change. Firefox's ability to build unfortunately take priority over this particular convenience. Hopefully, we won't have to compromise shortly! I tested this by ensuring that the HTML output of our existing `document_features::document_features!(…)` usage was exactly the same. There should be exactly zero regressions in the current state of documentation for users. For maintainers, I have added a disclaimer that one needs to keep changes in sync. with the relevant `Cargo.toml` manifests.
ErichDonGubler
added a commit
to erichdongubler-mozilla/wgpu
that referenced
this pull request
Dec 22, 2023
Re-implements gfx-rs#4886 (CC @Wumpf) without the `document-features` crate, which has issues integrating into Firefox builds after being `cargo vendor`ed into its repository. This issue is being tracked against slint-ui/document-features#20. Once resolved, I expect that we will want to revert this PR in its entirety, since `document-features` is still a good addition to `wgpu`'s documentation story. Internally, consensus has already been achieved for this change. Firefox's ability to build unfortunately take priority over this particular convenience. Hopefully, we won't have to compromise shortly! I tested this by ensuring that the HTML output of our existing `document_features::document_features!(…)` usage was exactly the same. There should be exactly zero regressions in the current state of documentation for users. For maintainers, I have added a disclaimer that one needs to keep changes in sync. with the relevant `Cargo.toml` manifests.
ErichDonGubler
added a commit
that referenced
this pull request
Dec 22, 2023
Re-implements #4886 (CC @Wumpf) without the `document-features` crate, which has issues integrating into Firefox builds after being `cargo vendor`ed into its repository. This issue is being tracked against slint-ui/document-features#20. Once resolved, I expect that we will want to revert this PR in its entirety, since `document-features` is still a good addition to `wgpu`'s documentation story. Internally, consensus has already been achieved for this change. Firefox's ability to build unfortunately take priority over this particular convenience. Hopefully, we won't have to compromise shortly! I tested this by ensuring that the HTML output of our existing `document_features::document_features!(…)` usage was exactly the same. There should be exactly zero regressions in the current state of documentation for users. For maintainers, I have added a disclaimer that one needs to keep changes in sync. with the relevant `Cargo.toml` manifests.
moz-v2v-gh
pushed a commit
to mozilla/gecko-dev
that referenced
this pull request
Jan 3, 2024
…225e1744fd7. r=webgpu-reviewers,supply-chain-reviewers,teoxoy Changelog: * #4865 fix present mode for wgl By xiaopengli89 in gfx-rs/wgpu#4865 * #4873 Bump ctor from 0.2.5 to 0.2.6 By dependabot[bot] in gfx-rs/wgpu#4873 * #4874 Bump syn from 2.0.40 to 2.0.41 By dependabot[bot] in gfx-rs/wgpu#4874 * #4869 [naga wgsl-out] Include the `f` suffix on `f32` literals. By jimblandy in gfx-rs/wgpu#4869 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4870 [naga wgsl] Let unary operators accept and produce abstract types. By jimblandy in gfx-rs/wgpu#4870 * #4867 Reintroduce buffer snatching Part 1 By nical in gfx-rs/wgpu#4867 * #4882 Bump zerocopy from 0.7.26 to 0.7.31 By dependabot[bot] in gfx-rs/wgpu#4882 * #4878 Buffer snatching part 2 - Refactor create_buffer By nical in gfx-rs/wgpu#4878 * #4815 Add `wgpu` crate features for backends By daxpedda in gfx-rs/wgpu#4815 * #4887 Allow clippy::pattern_type_mismatch By nical in gfx-rs/wgpu#4887 * #4886 Document wgpu & wgpu-core features By Wumpf in gfx-rs/wgpu#4886 * #4826 validation: More detailed on incompatible BGL By scoopr in gfx-rs/wgpu#4826 * #4888 Web: add support for more `RawWindowHandle` variants By daxpedda in gfx-rs/wgpu#4888 * #4890 Bump thiserror from 1.0.50 to 1.0.51 By dependabot[bot] in gfx-rs/wgpu#4890 * #4880 Simplify `ResourceMaps` By nical in gfx-rs/wgpu#4880 * #4891 Make the naga version in trunk as high as the latest published one By nical in gfx-rs/wgpu#4891 * #4893 Avoid allocating memory every time we might log a label By nical in gfx-rs/wgpu#4893 * #4894 Remove some locks in BindGroup By nical in gfx-rs/wgpu#4894 * #4862 Ensure that DeviceLostCallbackC is always called exactly once By bradwerth in gfx-rs/wgpu#4862 * #4900 Support Device fence sharing with dx12 on Windows By sotaroikeda in gfx-rs/wgpu#4900 * #4903 Bump tokio from 1.35.0 to 1.35.1 By dependabot[bot] in gfx-rs/wgpu#4903 * #4895 Check that raw buffers and raw bind groups are valid By nical in gfx-rs/wgpu#4895 * #4901 fix: docs By miaobuao in gfx-rs/wgpu#4901 * #4892 Simplify some code around buffer unmapping By nical in gfx-rs/wgpu#4892 * #4896 Buffer snatching By nical in gfx-rs/wgpu#4896 * #4851 Eagerly release GPU resources when we lose the device. By bradwerth in gfx-rs/wgpu#4851 * #4906 Use nightly for docs By cwfitzgerald in gfx-rs/wgpu#4906 * #4908 Bump syn from 2.0.41 to 2.0.42 By dependabot[bot] in gfx-rs/wgpu#4908 * #4909 Bump profiling from 1.0.12 to 1.0.13 By dependabot[bot] in gfx-rs/wgpu#4909 * #4910 Bump anyhow from 1.0.75 to 1.0.76 By dependabot[bot] in gfx-rs/wgpu#4910 * #4913 Remove id32 Feature By cwfitzgerald in gfx-rs/wgpu#4913 * #4914 Add BGL Deduplication Index Test By cwfitzgerald in gfx-rs/wgpu#4914 * #4921 Fix typo "layout pipeline layout" -> "pipeline layout" By HactarCE in gfx-rs/wgpu#4921 * #4922 Bump winit from 0.29.4 to 0.29.5 By dependabot[bot] in gfx-rs/wgpu#4922 * #4924 Inline `document-features` usage, remove dep. By ErichDonGubler in gfx-rs/wgpu#4924 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4930 Bump winit from 0.29.5 to 0.29.6 By dependabot[bot] in gfx-rs/wgpu#4930 * #4929 Bump web-time from 0.2.3 to 0.2.4 By dependabot[bot] in gfx-rs/wgpu#4929 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4940 Align `wgpu_types::CompositeAlphaMode` serde serializations to spec By littledivy in gfx-rs/wgpu#4940 * #4936 Bump anyhow from 1.0.76 to 1.0.77 By dependabot[bot] in gfx-rs/wgpu#4936 * #4933 Bump thiserror from 1.0.51 to 1.0.52 By dependabot[bot] in gfx-rs/wgpu#4933 * #4932 Bump syn from 2.0.42 to 2.0.43 By dependabot[bot] in gfx-rs/wgpu#4932 Differential Revision: https://phabricator.services.mozilla.com/D197519
ErichDonGubler
pushed a commit
to erichdongubler-mozilla/firefox
that referenced
this pull request
Jan 5, 2024
…225e1744fd7. r=webgpu-reviewers,supply-chain-reviewers,teoxoy Changelog: * #4865 fix present mode for wgl By xiaopengli89 in gfx-rs/wgpu#4865 * #4873 Bump ctor from 0.2.5 to 0.2.6 By dependabot[bot] in gfx-rs/wgpu#4873 * #4874 Bump syn from 2.0.40 to 2.0.41 By dependabot[bot] in gfx-rs/wgpu#4874 * #4869 [naga wgsl-out] Include the `f` suffix on `f32` literals. By jimblandy in gfx-rs/wgpu#4869 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4850 [naga wgsl-in] Support abstract operands to binary operators. By jimblandy in gfx-rs/wgpu#4850 * #4870 [naga wgsl] Let unary operators accept and produce abstract types. By jimblandy in gfx-rs/wgpu#4870 * #4867 Reintroduce buffer snatching Part 1 By nical in gfx-rs/wgpu#4867 * #4882 Bump zerocopy from 0.7.26 to 0.7.31 By dependabot[bot] in gfx-rs/wgpu#4882 * #4878 Buffer snatching part 2 - Refactor create_buffer By nical in gfx-rs/wgpu#4878 * #4815 Add `wgpu` crate features for backends By daxpedda in gfx-rs/wgpu#4815 * #4887 Allow clippy::pattern_type_mismatch By nical in gfx-rs/wgpu#4887 * #4886 Document wgpu & wgpu-core features By Wumpf in gfx-rs/wgpu#4886 * #4826 validation: More detailed on incompatible BGL By scoopr in gfx-rs/wgpu#4826 * #4888 Web: add support for more `RawWindowHandle` variants By daxpedda in gfx-rs/wgpu#4888 * #4890 Bump thiserror from 1.0.50 to 1.0.51 By dependabot[bot] in gfx-rs/wgpu#4890 * #4880 Simplify `ResourceMaps` By nical in gfx-rs/wgpu#4880 * #4891 Make the naga version in trunk as high as the latest published one By nical in gfx-rs/wgpu#4891 * #4893 Avoid allocating memory every time we might log a label By nical in gfx-rs/wgpu#4893 * #4894 Remove some locks in BindGroup By nical in gfx-rs/wgpu#4894 * #4862 Ensure that DeviceLostCallbackC is always called exactly once By bradwerth in gfx-rs/wgpu#4862 * #4900 Support Device fence sharing with dx12 on Windows By sotaroikeda in gfx-rs/wgpu#4900 * #4903 Bump tokio from 1.35.0 to 1.35.1 By dependabot[bot] in gfx-rs/wgpu#4903 * #4895 Check that raw buffers and raw bind groups are valid By nical in gfx-rs/wgpu#4895 * #4901 fix: docs By miaobuao in gfx-rs/wgpu#4901 * #4892 Simplify some code around buffer unmapping By nical in gfx-rs/wgpu#4892 * #4896 Buffer snatching By nical in gfx-rs/wgpu#4896 * #4851 Eagerly release GPU resources when we lose the device. By bradwerth in gfx-rs/wgpu#4851 * #4906 Use nightly for docs By cwfitzgerald in gfx-rs/wgpu#4906 * #4908 Bump syn from 2.0.41 to 2.0.42 By dependabot[bot] in gfx-rs/wgpu#4908 * #4909 Bump profiling from 1.0.12 to 1.0.13 By dependabot[bot] in gfx-rs/wgpu#4909 * #4910 Bump anyhow from 1.0.75 to 1.0.76 By dependabot[bot] in gfx-rs/wgpu#4910 * #4913 Remove id32 Feature By cwfitzgerald in gfx-rs/wgpu#4913 * #4914 Add BGL Deduplication Index Test By cwfitzgerald in gfx-rs/wgpu#4914 * #4921 Fix typo "layout pipeline layout" -> "pipeline layout" By HactarCE in gfx-rs/wgpu#4921 * #4922 Bump winit from 0.29.4 to 0.29.5 By dependabot[bot] in gfx-rs/wgpu#4922 * #4924 Inline `document-features` usage, remove dep. By ErichDonGubler in gfx-rs/wgpu#4924 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4871 Speed up Naga's `cargo xtask validate wgsl` from 12s to 0.8s By jimblandy in gfx-rs/wgpu#4871 * #4930 Bump winit from 0.29.5 to 0.29.6 By dependabot[bot] in gfx-rs/wgpu#4930 * #4929 Bump web-time from 0.2.3 to 0.2.4 By dependabot[bot] in gfx-rs/wgpu#4929 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4902 [naga xtask] Run validation jobs in parallel, using jobserver. By jimblandy in gfx-rs/wgpu#4902 * #4940 Align `wgpu_types::CompositeAlphaMode` serde serializations to spec By littledivy in gfx-rs/wgpu#4940 * #4936 Bump anyhow from 1.0.76 to 1.0.77 By dependabot[bot] in gfx-rs/wgpu#4936 * #4933 Bump thiserror from 1.0.51 to 1.0.52 By dependabot[bot] in gfx-rs/wgpu#4933 * #4932 Bump syn from 2.0.42 to 2.0.43 By dependabot[bot] in gfx-rs/wgpu#4932 Differential Revision: https://phabricator.services.mozilla.com/D197519
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Connections
(none that I'm aware of)
Description
Documents our feature flags for wgpu & wgpu-core. Focused mainly on wgpu since this is where most users enter. Uses
document-featuresto spill out the whole thing into the api reference (see screenshot).Re-arranged feature flags for the purpose of structuring
Couldn't help myself and sorted a few crate deps as well alphabetically ;-).
Testing
Checklist
cargo fmt.cargo clippy. If applicable, add:--target wasm32-unknown-unknown--target wasm32-unknown-emscriptencargo xtask testto run tests.CHANGELOG.md. See simple instructions inside file.