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

Better Warnings for Custom Pixel Shader Compilation Failures #17435

Closed
blitzRahul opened this issue Jun 15, 2024 · 0 comments · Fixed by #17436
Closed

Better Warnings for Custom Pixel Shader Compilation Failures #17435

blitzRahul opened this issue Jun 15, 2024 · 0 comments · Fixed by #17436
Labels
Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. Needs-Tag-Fix Doesn't match tag requirements Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting

Comments

@blitzRahul
Copy link
Contributor

blitzRahul commented Jun 15, 2024 •
edited
Loading

Description of the new feature/enhancement

Right now, when D3DCompileFromFile fails, a warning is displayed that says "Unable to compile the specified pixel shader." To make it easier to debug custom shader files, it would be helpful to see the exact error message from the compiler.
Current Warning:
original

Proposed technical implementation details

Error Type | Expected Outcome
Compile Time Error | Warning window with the exact error message from compiler
File not Found | Warning window with file not found + location of file as seen in settings.json
Path not Found | Similar behaviour

I will be creating a pull request shortly.
@blitzRahul blitzRahul added the Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. label Jun 15, 2024
@microsoft-github-policy-service microsoft-github-policy-service bot added Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting Needs-Tag-Fix Doesn't match tag requirements labels Jun 15, 2024
@blitzRahul blitzRahul mentioned this issue Jun 15, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Jun 21, 2024
@blitzRahul
Display useful pixel shader compilation errors (#17436)
fa40733 
More descriptive warnings are triggered when custom pixel shader
compilation fails.

If D3DCompileFromFile fails and the compiler generates an error message-
the message is converted to a wstring and is sent as a parameter when
calling p.warningCallback.
Changes were made to resources.resw and TermControl.cpp to accommodate
this.

## Validation Steps Performed
I tested the following errors that may be encountered while developing a
custom pixel shader:
1. Compile time errors
2. File not found error
3. Path not found error
4. Access denied error

Fixes #17435

TAEF tests passed:
Summary: Total=294, Passed=294, Failed=0, Blocked=0, Not Run=0,
Skipped=0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Issue-Feature Complex enough to require an in depth planning process and actual budgeted, scheduled work. Needs-Tag-Fix Doesn't match tag requirements Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Display useful pixel shader compilation errors blitzRahul/terminal
1 participant
@blitzRahul