Skip to content

docs: Clarify description of newly-optional fields in DepthStencilState#9180

Merged
ErichDonGubler merged 1 commit intogfx-rs:trunkfrom
andyleiserson:jj-push-uyuw
Mar 9, 2026
Merged

docs: Clarify description of newly-optional fields in DepthStencilState#9180
ErichDonGubler merged 1 commit intogfx-rs:trunkfrom
andyleiserson:jj-push-uyuw

Conversation

@andyleiserson
Copy link
Copy Markdown
Contributor

Related to #9178.

Updates the CHANGELOG and rustdoc of the depth_write_enabled and depth_compare fields in DepthStencilState, which were made optional in #8840.

The intent is to clarify:

  1. These fields must be Some when they are applicable to the configuration.
  2. The conditions when that is the case.
  3. When not applicable to the configuration, the fields may be None, and it is probably clearest if they are None, but specific Some values are also accepted.

Testing
n/a

Squash or Rebase? Squash

@ErichDonGubler ErichDonGubler merged commit 0afad95 into gfx-rs:trunk Mar 9, 2026
56 checks passed
@andyleiserson andyleiserson deleted the jj-push-uyuw branch March 9, 2026 22:40
ErichDonGubler added a commit to erichdongubler-mozilla/wgpu that referenced this pull request Mar 10, 2026
andyleiserson pushed a commit that referenced this pull request Mar 11, 2026
* style(CHANGELOG): ensure double newline b/w paragraph and fenced code blocks

Regressed by <#9180>. I missed this
in review.

* docs(CHANGELOG): fix up formatting for #9141

* docs(CHANGELOG): clarify that `get_current_texture` in a `Surface` method
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants