Refactor parameters to info structs and add debug support #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thatcosmonaut
changed the title
madebr
reviewed
Dec 19, 2024
| @@ -45,15 +45,15 @@ typedef enum SDL_ShaderCross_ShaderStage | |||
| SDL_SHADERCROSS_SHADERSTAGE_COMPUTE | |||
| } SDL_ShaderCross_ShaderStage; | |||
|
|
|||
| typedef struct SDL_ShaderCross_GraphicsShaderInfo | |||
| typedef struct SDL_ShaderCross_GraphicsShaderMetadata | |||
There was a problem hiding this comment.
Is this type sufficiently future proof?
I mean, we'll never need more metadata of a shader?
There was a problem hiding this comment.
Properties in an out struct is kind of awkward no? I guess this would be a problem if we extended SDL's CreateShaderInfo though
| bool enableDebug; /**< Allows debug info to be emitted when relevant. Can be useful for graphics debuggers like RenderDoc. */ | ||
| const char *name; /**< A UTF-8 name to associate with the shader. Optional, can be NULL. */ | ||
|
|
||
| SDL_PropertiesID props; /**< A properties ID for extensions. Should be 0 if no extensions are needed. */ |
There was a problem hiding this comment.
Windows creation has an easy entry point (SDL_CreateWindow) and an "advanced mode" (SDL_CreateWindowFromProperties).
Can shadercross do the same? I'd like to avoid properties and struct member values to clash.
There was a problem hiding this comment.
Maybe, but we'd be almost doubling the API surface which is pretty cumbersome.
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For future-proofing the API now takes info structs with a SDL_PropertiesID for extensions.
This PR also adds shader debug info support and source debugging in HLSL -> SPIR-V debug workflows in RenderDoc should work out of the box now.
Resolves #64
Resolves #66
Supersedes #65