[3.0] Implement name-related improvements identified in previous Vulkan PR #2503

Exanite · 2025-11-24T22:59:50Z

Summary of the PR

This PR focuses on implementing the naming-related improvements identified in #2457.
Depending on the scope of the tasks, some of these tasks may be pushed to another PR.

Important changes:

Handle types are now named as -HandleEXT instead of -EXTHandle.
- Eg: AccelerationStructureHandleKHR
Function pointer delegate types are now named as -DelegateEXT instead of EXTDelegate.
- Eg: pfn struct BufferCallbackSOFT and pfn delegate BufferCallbackDelegateSOFT
Functions with data type suffixes following a number such as alGetSourcei64vDirectSOFT are now trimmed and prettified as GetSourcei64vDirectSOFT instead of GetSourcei64VDirectSOFT. Note the capitalization of v. This is because affixes are added after prettification.
Vendor suffixes are now kept strictly uppercased.
OpenGL vendor suffix trimming is now generalized and can be configured and used for any Khronos API.
- Notably, TrimEnumMemberImpliedVendors trims enum member vendor suffixes if it matches the enum type vendor suffix.
Struct properties are now prettified. They were previously ignored.
NativeName is a new attribute that saves the name output by ClangSharp. This for the most part isn't used by the generator, but can be useful for the end user.
NameAffix is a new attribute that allows prefixes/suffixes to be declared upfront and reordered. The idea is that mods add the attribute to identifiers and PrettifyNames applies the affixes during trimming and prettification.
A large portion of the trimming/PrettifyNames code has been rewritten.
- NameTrimmer has been kept mostly the same.
- INameTrimmer.Order is used to order the trimmers instead of the version.
- PrettifyNames.Visitor's functionality is mostly the same, but also gathers name affix data.
- MixKhronosData.Trim is almost all replaced by the name affix system. This is implemented in MixKhronosData.RewriterPhase3 (yes, there are 3 rewriters, but this keeps things simpler without adding much time cost).
- Most usages of tuples have been replaced with record structs.
- Most nullable collections (eg: List<string>?) have been made non-nullable. Most of these get allocated anyway and it makes the code more maintainable. If there is any performance issue (mainly concerning the Microsoft job), I will take the time to optimize it.
- Prettification (as in calling the Prettify extension method) is now implemented as another trimmer. Prettification now happens before name conflict resolution and before name affixes are added.
Handle structs now have constructors since they were previously not possible to construct (field is readonly).
The StripAttributes mod can be used to remove attributes from the final bindings.
- Currently the following are removed: NativeTypeName, NameAffix, Transformed

Related issues, Discord discussions, or proposals

Previous Vulkan PR (initial bindings generation): #2457
Discord thread: https://discord.com/channels/521092042781229087/1376331581198827520/1442651368207941643

Further Comments

Tasks not part of this PR

These are the tasks from my previous PR. These have been sorted and trimmed down to ensure that this PR remains focused. These may be added to this PR.

If you want to see the original, unmodified set of tasks, please see #2457.

These will also be part of a future PR.

Apply BoolType transformation to VkBool32 in structs. They currently are only handled for functions.
Add default field values to structs where it makes sense (eg: SType)
Ensure SupportedApiProfiles attributes are correct
- Properly resolve API profiles for Flags/FlagBits types
- Prefer name from NativeName for resolving API profiles

Future PRs

Current Todos

Prepare to merge.

Finish self code review
Generate bindings on Windows for consistency
Temporarily remove generated files from PR during code review
- This needs to be done since there are too many generated files and they hide some of the manually changed files.
- Revert the commit after code review: Revert "Revert after review: Revert all generated bindings changes" Exanite/Silk.NET#18
Review the generated bindings as a second code review
Consider updating OpenAL submodule and regenerating

Completed Todos

Newest groups at the top. Order within a group is chronological.

Note that I also wrote a summary at the top. The summary is more comprehensive, but this section can be useful getting additional context. Also see my commit descriptions if more context is needed.

INameTrimmer.Order

Add priority system to INameTrimmer.
- I implemented the new name affixer system using trimmers, so this introduced 3 new trimmers in order to separate each stage properly. There is now a new INameTrimmer.Order property and internal TrimmerOrder enum.

Fix misc issues I noticed

VkVendorId members are not trimmed properly
Figure out why the members of the enum AttribMask in OpenGL are not getting rewritten.
- Initial investigation shows that the fieldSymbol.ConstantValue is null, but why it is null is unclear. Maybe a Roslyn bug? Example member: DepthBufferBit = unchecked((uint)0x00000100). Note that similar expressions in Vulkan are fine, eg: unchecked((ulong)0x00000002UL). Maybe it is because the literal type and cast type are different.
- Wait, are these the enums that we generate?
- Yup, they are. MixKhronosData was outputting subtly invalid type names. I changed it to use ParseTypeName(baseType) instead of IdentifierName(baseType).

Fix issues introduced by name affix system

Identify and fix issues introduced by name affixation. Also just identify and fix naming issues in general.
- Data type trimming in OpenAL seems to be broken. Probably OpenGL as well.
- Check if I need to reimplement vendor suffix removal for OpenGL. I probably do.
  - Discuss: I decided to change the vendor suffix removal for enum members so that it removes the member suffix if it matches the type suffix. This prevents cases where a member of a different suffix is added, causing all members to have their suffixes restored.
  - Discuss: The above change made it so that the member suffix removal code is usable for Vulkan so I enabled it for Vulkan as well. See PresentModeKHR to see how it looks (the KHR suffixed members have their suffixes removed, but EXT remains the same).
- Reapply some of my MixKhronosData code removals to the current develop/3.0 branch and see what changes would be made. This is to ensure I don't accidentally remove functionality when deleting code.
Ensure other APIs are configured consistently with Vulkan. Eg: Ensure affix priorities are set, etc.

Name affix system

Properly trim prefixed/suffixed names, such as PFNVkDebugUtilsMessengerCallbackEXT and BufferTHandle
- PFNVkDebugUtilsMessengerCallbackEXT prefix
- PFNVkDebugUtilsMessengerCallbackDelegateEXT suffix
- AccelerationStructureHandleKHR suffix
- Extract vendor extensions from names and store into NameSuffix attributes.
- Revert "hacky" THandle fix.
Consider renaming handle types as HandleEXT instead of EXTHandle for readability.
- This is fairly doable. The above todos track this.

Name metadata

Name prettification

~~Change naming convention to not capitalize acronyms (i.e., strictly pascal cased)~~
- ~~See: https://discord.com/channels/521092042781229087/1376331581198827520/1395097379329282089~~
- ~~Update generated method class names in the rsp files to be strictly pascal case~~
Fix StdVideoEncodeH264SliceHeaderFlags property names. They currently aren't getting prettified.

Fix bugs from original PR

Enums containing negative values should not have an unsigned backing type.

Handle struct improvements

Handle structs don't have an easy way of being constructed (field is readonly and no constructor).

… renamer

This looks like it's from some sort of built-in renamer. Don't think we'll ever use this since we have a custom renamer.

… work with native name attributes

…lass

Not sure why these were not being coerced when the Vulkan PR was merged, but they started getting coerced in this PR. This technically is a good thing since it means the coerce backing types code is now working as previously intended. However, the previously intended implementation missed an edge case, which this commit fixes.

This is because the structs were impossible to reasonably construct before.

Technically this is from my update PR into Curin's branch (curin#101), but is effectively the same as backporting the changes from Curin's branch. Exact commit that I copied the changes from: 0cc698a

VaListTagHandle is an extra handle struct that seems to generate on Linux (and not on Windows) and breaks global prefix determination.

OpenAL: ContextErrorCode seems to always be replaced with ErrorCode, even on Windows. Not sure why. This also happened during the last PR, but I didn't commit it.

…name trimmer code

Honestly, what I wrote is a complete guess, I'll likely revisit these once I understand them more.

…e for GL/EGL

…s.OpenGL.cs

This reverts commit 9c9fbfc.

Exanite · 2025-12-06T22:11:56Z

Going to revert acronym casing changes as discussed in the Discord before reopening PR for review.

Exanite

Self code review complete. Going to mark as ready for review.

Note that I only have the non-generated changes committed.
The generated changes are here: Exanite#19

This is because the generated changes hide the non-generated changes (it goes over the 1k file limit).

Feel free to comment on the linked PR as well.
It will be merged into this PR after the non-generated changes are reviewed.

DO NOT merge the PR until the generated changes are merged, and preferably, reviewed.

Exanite · 2025-12-07T00:32:38Z

sources/SilkTouch/SilkTouch/Mods/PrettifyNames.cs

+                    + "conflicts with members of other types.",
+                    responseFile.FilePath,
+                    key
+                );


This is from the Microsoft branch

Exanite · 2025-12-07T00:33:13Z

sources/SilkTouch/SilkTouch/Mods/PrettifyNames.cs

+    /// Then if no override is found, then the name's affixes are removed,
+    /// the name is prettified, and the name's affixes are added back.
+    /// </summary>
+    private string ApplyPrettifyOnlyPipeline(


This is from the Microsoft branch, but heavily modified.

Exanite · 2025-12-07T00:36:54Z

sources/SilkTouch/SilkTouch/Mods/PrettifyNames.cs

+        ICulturedStringTransformer nameTransformer)
+    {
+        // Check for overrides
+        foreach (var (nativeName, overriddenName) in nameOverrides)


Ideally this code isn't duplicated with the code in Trim(), but to do this performantly requires a decent amount of refactoring.

Exanite · 2025-12-07T00:41:01Z

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

+                        attributes = attributes.WithNativeName(groupInfo.NativeName);
+                    }
+
+                    var baseTypeSyntax = ParseTypeName(baseType);


ParseTypeName fixes an issue where IFieldSymbol.ConstantValue was returning null.

Initial empty commit

90f7348

github-project-automation bot added this to Silk.NET Development Tracker Nov 24, 2025

github-project-automation bot moved this to Todo in Silk.NET Development Tracker Nov 24, 2025

Exanite marked this pull request as draft November 24, 2025 22:59

Exanite added 26 commits November 25, 2025 01:55

Edit docs

a6c9af7

Add NativeName attribute

aac17e3

Add start of MarkNativeNames mod

69291ed

Successfully mark structs with NativeName attribute

9eac50d

Mark most identifiers with the NativeName attribute

76046df

Cleanup

7231782

Add StripAttributes mod for removing unwanted attributes

bd0b4a4

Fix MarkNativeNames mod config not being loaded

b23b859

Add StripAttributes to Vulkan generator config and regenerate bindings

869ea13

Cleanup

6c86b0b

Remove unused code in PrettifyNames, pretty sure this is from the old…

91a92b5

… renamer

Remove unused code from PrettifyNames

456f3b6

This looks like it's from some sort of built-in renamer. Don't think we'll ever use this since we have a custom renamer.

Add ModUtils.TryGetNativeName and WithNativeName to make it easier to…

94336cb

… work with native name attributes

Fix incorrect attribute filtering ()

4042cdf

Cleanup

10328a0

Move attribute related code from ModUtils into a new AttributeUtils c…

c620aaa

…lass

Allow NativeName to be placed on methods

fd45a6f

Add constructor to generated handle structs

f286f65

This is because the structs were impossible to reasonably construct before.

Cleanup using statements after splitting ModUtils into two classes

553d33f

Backport PrettifyNames changes from Curin's Microsoft branch

43a2336

Technically this is from my update PR into Curin's branch (curin#101), but is effectively the same as backporting the changes from Curin's branch. Exact commit that I copied the changes from: 0cc698a

Add GlobalPrefixHints for SDL bindings and regenerate on Linux

e3b0568

VaListTagHandle is an extra handle struct that seems to generate on Linux (and not on Windows) and breaks global prefix determination.

Regenerate all bindings on Linux

5537269

OpenAL: ContextErrorCode seems to always be replaced with ErrorCode, even on Windows. Not sure why. This also happened during the last PR, but I didn't commit it.

Add CandidateNames record structs and replace the tuples used by the …

81aa49d

…name trimmer code

Add documentation for CandidateNames structs

89ca280

Honestly, what I wrote is a complete guess, I'll likely revisit these once I understand them more.

Replace usages of Enumerable.Empty with []

00243f1

Exanite added 6 commits December 6, 2025 12:41

Regenerate bindings on Windows

7b45449

Fix compile errors in tests

558a8b1

Exclude SDL_SetWindowsMessageHook

e9c9f39

Exclude SDL_FILE, SDL_LINE, SDL_NULL_WHILE_LOOP_CONDITION

cd5b2c9

Fix compile errors and update windowing code to use strict pascal cas…

c7300c3

…e for GL/EGL

Revert after review: Revert all generated bindings changes

9c9fbfc

Exanite force-pushed the feature/vulkan-bindings-3.0-improvements branch from 77f3ef3 to 9c9fbfc Compare December 6, 2025 18:30

Exanite added 2 commits December 6, 2025 13:34

Revert incorrect OpenGL capitalization changes in SdlContext

5cd9029

Revert incorrect OpenGL capitalization changes in SdlSurfaceComponent…

fac347c

…s.OpenGL.cs

This comment was marked as outdated.

Sign in to view

Exanite marked this pull request as ready for review December 6, 2025 18:48

Exanite requested a review from a team as a code owner December 6, 2025 18:48

This comment was marked as outdated.

Sign in to view

Revert "Revert after review: Revert all generated bindings changes"

a1c0f23

This reverts commit 9c9fbfc.

Exanite mentioned this pull request Dec 6, 2025

Revert "Revert after review: Revert all generated bindings changes" Exanite/Silk.NET#18

Merged

Exanite marked this pull request as draft December 6, 2025 22:11

Exanite added 3 commits December 6, 2025 17:55

Begin reverting acronym casing change

48d182f

Update openal-soft submodule

16f5753

Revert change to EGLPlatformInfo

53fbdd3

Exanite force-pushed the feature/vulkan-bindings-3.0-improvements branch from b06e648 to 53fbdd3 Compare December 6, 2025 23:02

Exanite added 2 commits December 6, 2025 19:01

Regenerate bindings on Windows

8aefc51

Revert after review: Revert all generated bindings changes

9bbf8be

Exanite force-pushed the feature/vulkan-bindings-3.0-improvements branch from c6a07d7 to 9bbf8be Compare December 7, 2025 00:18

Exanite added 3 commits December 6, 2025 19:19

Revert changes to ContextSourceExtensions

4634117

Revert changes to SdlEventProcessor

787081a

Revert changes to SdlSurfaceComponents

2fa139f

Exanite mentioned this pull request Dec 7, 2025

Revert "Revert after review: Revert all generated bindings changes" Exanite/Silk.NET#19

Open

Exanite commented Dec 7, 2025

View reviewed changes

Exanite marked this pull request as ready for review December 7, 2025 00:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[3.0] Implement name-related improvements identified in previous Vulkan PR #2503

[3.0] Implement name-related improvements identified in previous Vulkan PR #2503

Uh oh!

Exanite commented Nov 24, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Exanite commented Dec 6, 2025

Uh oh!

Exanite left a comment

Uh oh!

Exanite Dec 7, 2025

Uh oh!

Exanite Dec 7, 2025

Uh oh!

Exanite Dec 7, 2025 •

edited

Loading

Uh oh!

Exanite Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

[3.0] Implement name-related improvements identified in previous Vulkan PR #2503

Are you sure you want to change the base?

[3.0] Implement name-related improvements identified in previous Vulkan PR #2503

Uh oh!

Conversation

Exanite commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of the PR

Related issues, Discord discussions, or proposals

Further Comments

Tasks not part of this PR

Current Todos

Completed Todos

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Exanite commented Dec 6, 2025

Uh oh!

Exanite left a comment

Choose a reason for hiding this comment

Uh oh!

Exanite Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Exanite Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Exanite Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Exanite Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Exanite commented Nov 24, 2025 •

edited

Loading

Exanite Dec 7, 2025 •

edited

Loading