[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:

Naming convention used by PrettifyNames has been to be strictly pascal cased. This has implications for the rest of the codebase since the term, GL, exists outside of generated code.
- Eg: GL becomes Gl. RGB becomes Rgb
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 the only exception to the naming convention and are 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

New Tasks

Current Todos

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

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).

Things to watch for during review

I regenerated all of the bindings, but on Linux. I'll probably commit the Windows version before undrafting for consistency.

SDL: VaListTagHandle is a handle struct that generates on Linux, but not Windows. This struct breaks global prefix determination, so I added SDL as a global prefix hint for PrettifyNames in the generator config.
OpenAL: ContextErrorCode was replaced with ErrorCode. This also happened in the previous PR, but I didn't commit it. ContextErrorCode was originally added during the OpenAL PR. This happens on both Linux and Windows. Maybe this is a Mac specific inconsistency? Or was this enum manually added?

… 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.

…bugging

…vulkan-bindings-3.0-data-type-trimming

…yway. Will profile and optimize later.

…ging

… the process

…ffix attributes

…version

Exanite

Initial self code review. PR is not yet ready for review or merge.

Exanite · 2025-12-04T09:14:09Z

eng/silktouch/openal/alsoft/generate.rsp

 openal-soft-al.h
 --methodClassName
-AL
+Al


I replaced most usages of AL and GL with Al and Gl (I still need to double check comments since my renames don't catch that).
However, I did not change namespaces, so they still use OpenAL/GL instead of OpenAl/Gl.

This is more consistent with the rest of the bindings, but I'm not sure if we want to make an exception here and use GL instead. Notably SDL is already lowercased as Sdl so I didn't change that.

Exanite · 2025-12-04T09:18:46Z

sources/OpenAL/OpenAL/al/EfxEaxReverbPropertiesFlLateReverbPan.gen.cs


 namespace Silk.NET.OpenAL;

+[NativeName("_flLateReverbPan_e__FixedBuffer")]


Not sure how I feel about this native name. Probably fine?

Exanite · 2025-12-04T09:19:20Z

sources/OpenAL/OpenAL/al/EfxEaxReverbPropertiesFlLateReverbPan.gen.cs

 [InlineArray(3)]
 public partial struct EfxEaxReverbPropertiesFlLateReverbPan
 {
+    [NativeName("e0")]


Also not sure how I feel about this native name. Probably fine?

Exanite · 2025-12-04T09:20:59Z

sources/OpenAL/OpenAL/al/EfxReverbPreset.gen.cs

-    [NativeTypeName("const EFXEAXREVERBPROPERTIES")]
-    public static ref readonly EfxEaxReverbProperties Generic
+    [NativeName("EFX_REVERB_PRESET_GENERIC_")]
+    public static ref readonly EfxEaxReverbProperties EfxReverbPresetGeneric


Need to investigate this.

Exanite · 2025-12-05T10:36:51Z

sources/SilkTouch/SilkTouch/Naming/NameUtils.cs

@@ -37,42 +37,43 @@ public static partial class NameUtils
        "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_"
    );

+    private static readonly IStringTransformer[] _prettifyTransformers = [new NameTransformer()];


This avoids an allocation due to the params keyword every time Prettify is called.

sources/Core/Core/Annotations/NameAffixAttribute.cs

Exanite · 2025-12-05T11:09:21Z

sources/SilkTouch/SilkTouch/Mods/Common/ModUtils.cs

-    /// </summary>
-    /// <param name="node">The original method.</param>
-    /// <returns>The modified method.</returns>
-    public static MethodDeclarationSyntax WithRenameSafeAttributeLists(


All Attribute related code in ModUtils has been moved to AttributeUtils

Exanite · 2025-12-06T10:00:47Z

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

    /// <inheritdoc />
    public void Trim(NameTrimmerContext context)
    {
-        if (context.Names is null || context.JobKey is null)


Most of Trim was replaced by RewriterPhase3 below

Exanite · 2025-12-06T10:01:15Z

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

@@ -1800,7 +1505,7 @@ public bool TryGetSymbolMetadata(
    /// while the lookbehind asserts that the ending match will not overreach into the end of a word.
    /// </summary>
    // NOTE: LET THIS BE A LESSON! Do NOT add x (fixed) here, these will frequently conflict with integer overloads.
-    [GeneratedRegex("(?<!xe)([fdh]v?|u?[isb](64)?v?|v|i_v|fi|hi)$")]
+    [GeneratedRegex("(?<!xe)((?<!Rewin)[dhf]v?|u?[isb](64)?v?|v|i_v|fi|hi)$")]


Rewindv in OpenAL was getting trimmed as Rewin

Exanite · 2025-12-06T10:04:07Z

sources/SilkTouch/SilkTouch/Mods/MixKhronosData.cs

    private static readonly char[] _listSeparators = { ',', '|', '+' };

-    private static readonly Dictionary<string, string> _defaultEnumNativeTypeNameMaps =


This dictionary was effectively unused.

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 27 commits December 3, 2025 11:07

Add ToString implementations for CandidateNames structs for easier de…

8cbed7e

…bugging

Add comment explaining PreventPrettificationHack

596a6aa

Avoid adding redundant secondaries

1712060

Merge branch 'feature/vulkan-bindings-3.0-improvements' into feature/…

90bb541

…vulkan-bindings-3.0-data-type-trimming

Regen OpenAL on Linux

39b782c

Change secondaries to be non-nullable since I allocate all of them an…

fb55107

…yway. Will profile and optimize later.

Regen OpenGL on Linux

e3236b0

Disable stripping for NameAffix attributes in OpenAL for easier debug…

82d3b7f

…ging

Rework the NameAffix properties and what they do again

76fb8cf

Update config options and adjust docs a bit more

67c7867

Edit docs

32d4e64

Store the NameAffixAttribute declaration order

eaa93cb

Update order and priority of data type suffixes

b7428f5

Attempt to get data trimming working and apparently fix a few bugs in…

2ea6a43

… the process

Fix AL_VOCAL_MORPHER_PHONEME_T's -T suffix getting trimmed

24ce296

Edit doc comment on NameAffixerEarlyTrimmer.Version

b0bff43

Regenerate all bindings on Linux

1023090

Strip all NameAffix attributes for OpenAL since I'm no longer debugging

3f575ff

Sort and ensure consistent attribute targets for NativeName and NameA…

9a90036

…ffix attributes

Fix formatting

8dcd207

Don't mark parameters with the NativeName attribute

22a2c95

Add INameTrimmer.Order property and sort trimmers by that instead of …

1536c15

…version

Fix OpenAL's alSourceRewindv getting trimmed as alSourceRewin

97586d6

Fix incorrect range indexing

f414752

Change prettification to occur before affixes are re-added

58524e3

Rename NameAffix.Priority to DiscriminatorPriority for clarity

5cc9c6e

Cleanup RewriterPhase3 code in MixKhronosData

f75dd7f

Exanite force-pushed the feature/vulkan-bindings-3.0-improvements branch 2 times, most recently from b1c03ee to f75dd7f Compare December 6, 2025 10:21

Exanite commented Dec 6, 2025

View reviewed changes

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

Exanite commented Nov 24, 2025 •

edited

Loading

Uh oh!

Exanite left a comment

Uh oh!

Exanite Dec 4, 2025

Uh oh!

Exanite Dec 4, 2025

Uh oh!

Exanite Dec 4, 2025

Uh oh!

Exanite Dec 4, 2025

Uh oh!

Exanite Dec 5, 2025

Uh oh!

Uh oh!

Exanite Dec 5, 2025

Uh oh!

Exanite Dec 6, 2025

Uh oh!

Exanite Dec 6, 2025

Uh oh!

Exanite Dec 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant


		namespace Silk.NET.OpenAL;

		[NativeName("_flLateReverbPan_e__FixedBuffer")]

		private static readonly char[] _listSeparators = { ',', '\|', '+' };

		private static readonly Dictionary<string, string> _defaultEnumNativeTypeNameMaps =

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

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

New Tasks

Current Todos

Completed Todos

Things to watch for during review

Uh oh!

Exanite left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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