Skip to content

fix: fix ctd modifying pSamplerDesc#1252

Merged
doodlum merged 1 commit into
community-shaders:devfrom
alandtse:pSamplerDesc_ctd
Jul 13, 2025
Merged

fix: fix ctd modifying pSamplerDesc#1252
doodlum merged 1 commit into
community-shaders:devfrom
alandtse:pSamplerDesc_ctd

Conversation

@alandtse
Copy link
Copy Markdown
Collaborator

@alandtse alandtse commented Jul 13, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of sampler state creation to preserve input settings and prevent unintended modifications.

Copilot AI review requested due to automatic review settings July 13, 2025 09:19
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 13, 2025

Walkthrough

The change updates the implementation of the ID3D11Device_CreateSamplerState::thunk function to ensure that the input sampler descriptor (pSamplerDesc) is not modified directly. Instead, a local copy is made, and modifications are applied to the copy before proceeding.

Changes

File(s) Change Summary
src/Hooks.cpp Refactored to avoid mutating the input pointer in ID3D11Device_CreateSamplerState::thunk; now uses a local copy for clamping MaxAnisotropy.

Possibly related PRs

Suggested reviewers

  • davo0411

Poem

A sampler desc came hopping by,
"Don't change me!" was its gentle cry.
So now a copy, fresh and neat,
Gets clamped and sent off with swift feet.
Immutable fields, we now respect—
Bugs and side effects, we deflect!
🐇✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 329ae0e and 67fa87c.

📒 Files selected for processing (1)
  • src/Hooks.cpp (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build plugin and addons
🔇 Additional comments (1)
src/Hooks.cpp (1)

300-302: Excellent fix for maintaining parameter immutability.

This change correctly addresses the issue of modifying an input parameter that should be treated as immutable. Creating a local copy before modification is the proper approach here, as it:

  • Preserves the caller's original data
  • Maintains the expected API contract
  • Prevents potential side effects from parameter mutation
  • Has minimal performance impact for a small struct copy
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR prevents the original sampler descriptor from being mutated by copying it before clamping its MaxAnisotropy value.

  • Removed in-place modification of pSamplerDesc
  • Introduced a local copy (descCopy) and applied the clamp to that
  • Passed the modified copy into the downstream function
Comments suppressed due to low confidence (2)

src/Hooks.cpp:300

  • [nitpick] The variable name descCopy is generic; consider renaming it to something more descriptive like sanitizedDesc or mutableDesc to clarify its purpose.
		D3D11_SAMPLER_DESC descCopy = *pSamplerDesc;  // make a copy, pSamplerDesc is supposed to be immutable

src/Hooks.cpp:300

  • Consider adding a unit test to verify that the original pSamplerDesc remains unchanged after CreateSamplerState and that the clamping logic correctly applies to the copy.
		D3D11_SAMPLER_DESC descCopy = *pSamplerDesc;  // make a copy, pSamplerDesc is supposed to be immutable

@github-actions
Copy link
Copy Markdown

Using provided base ref: 329ae0e
Using base ref: 329ae0e
Base commit date: 2025-07-13T01:15:09-07:00 (Sunday, July 13, 2025 01:15 AM)
No actionable suggestions for changed features.

@github-actions
Copy link
Copy Markdown

✅ A pre-release build is available for this PR:
Download

@doodlum doodlum merged commit e0a4481 into community-shaders:dev Jul 13, 2025
15 checks passed
alandtse added a commit to alandtse/open-shaders that referenced this pull request Jul 20, 2025
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.

4 participants