Fixes crash when specifying invalid font #2153
Conversation
… can't find what was selected.
…le name. Retrieve the font name while retrieving the font object. Use retrieved data in the _GetProposedFont methods instead of re-resolving it.
| // - style - Normal, italic, etc. | ||
| // Return Value: | ||
| // - Smart pointer holding interface reference for queryable font data. | ||
| [[nodiscard]] Microsoft::WRL::ComPtr<IDWriteFontFace1> DxEngine::_ResolveFontFaceWithFallback(std::wstring& familyName, |
There was a problem hiding this comment.
should this be the not-oft-used std::wstring& const?
|
|
||
| // Make our output buffer and resize it so it is allocated. | ||
| std::wstring retVal; | ||
| retVal.resize(length); |
There was a problem hiding this comment.
do we need to remove the extra terminating null on the wstring after this?
There was a problem hiding this comment.
er after it is populated
|
Should we cherry-pick this back to 20H1? |
Maybe? It's only for the DX renderer which is hidden unless you know the magic dance so it's not high impact. But it is early so it might be an easy sell? |
Sure. |
…ack pattern to doc comment on method.
|
🎉 Handy links: |
ghost
mentioned this pull request
* Stop the crash with fonts by trying a few fallback/backup fonts if we can't find what was selected. * Create fallback pattern for finding a font. Resolve and pass the locale name. Retrieve the font name while retrieving the font object. Use retrieved data in the _GetProposedFont methods instead of re-resolving it. * Add details to schema about fallback. Finish comment explaining fallback pattern to doc comment on method. (cherry picked from commit 56589c0)
Summary of the Pull Request
Adds fallback routine for when a font name is missing instead of crashing due to uncaught exception thrown when font cannot be found.
PR Checklist
Detailed Description of the Pull Request / Additional comments
For GDI and for DirectX using the stock Layouts and Formats, if your chosen font face name isn't found... something else is just picked on your behalf. When I wrote our custom DX code, I instead threw an exception when I couldn't find the chosen font face. That exception was uncaught and led to a crash.
I decided to just make the custom code act more like the stock code and attempt to choose a fallback if we cannot find what you've requested. I also improved a bit of the passing around of the chosen font name and added locale name information while I was at it.
Validation Steps Performed