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.

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

Replace stdlib on Slang API with CoreModule #5405

Conversation

jkwak-work
Copy link
Collaborator

@jkwak-work jkwak-work commented Oct 24, 2024

This is a breaking change in a way that the Slang API function names are changed. All of them are commented as "experimental" and we wouldn't provide a back-ward compatibility for them.

Following functions are renamed:

  • compileStdLib() -> compileCoreModule()
  • loadStdLib() -> loadCoreModule()
  • saveStdLib() -> saveCoreModule()
  • slang_createGlobalSessionWithoutStdLib() -> slang_createGlobalSessionWithoutCoreModule()
  • slang_getEmbeddedStdLib() -> slang_getEmbeddedCoreModule()
  • hasDeferredStdLib() -> hasDeferredCoreModule()

Following command-line arguments are renamed:

  • "-load-stdlib" -> "-load-core-module"
  • "-save-stdlib" -> "-save-core-module"
  • "-save-stdlib-bin-source" -> "-save-core-module-bin-source"
  • "-compile-stdlib" -> "-compile-core-module"

@jkwak-work jkwak-work added the pr: breaking change PRs with breaking changes label Oct 24, 2024
@jkwak-work jkwak-work self-assigned this Oct 24, 2024
@csyonghe
Copy link
Collaborator

-load-stdlib should be -load-core-module.

All current mention of stdlib in the compiler codebase should be changed to core-module. There should be no mention of standard modules in any of our source code files because everything we have is jsut the core module.

@jkwak-work
Copy link
Collaborator Author

-load-stdlib should be -load-core-module.

All current mention of stdlib in the compiler codebase should be changed to core-module. There should be no mention of standard modules in any of our source code files because everything we have is jsut the core module.

I will change as suggested.

@jkwak-work jkwak-work force-pushed the feature/replace_StdLib_with_CoreModule_or_StandardModules_for_public_slang_APIs branch from 2bef62f to 119ce89 Compare October 25, 2024 00:18
@jkwak-work jkwak-work changed the title Replace stdlib on Slang API with CoreModule or StandardModules Replace stdlib on Slang API with CoreModule Oct 25, 2024
@jkwak-work jkwak-work force-pushed the feature/replace_StdLib_with_CoreModule_or_StandardModules_for_public_slang_APIs branch from 119ce89 to 7ecf620 Compare October 25, 2024 00:23
csyonghe
csyonghe previously approved these changes Oct 25, 2024
@csyonghe
Copy link
Collaborator

csyonghe commented Oct 25, 2024

Also need to update docs/build_reference.ps1. (just change the slangc argument in the script).

This is a breaking change in a way that the Slang API function names are
changed. All of them are commented as "experimental" and we wouldn't
provide a back-ward compatibility for them.

Following functions are renamed:
 - compileStdLib() -> compileCoreModule()
 - loadStdLib() -> loadStandardModules()
 - saveStdLib() -> saveStandardModules()
 - slang_createGlobalSessionWithoutStdLib() ->
   slang_createGlobalSessionWithoutCoreModule()
 - slang_getEmbeddedStdLib() -> slang_getEmbeddedCoreModule()
 - hasDeferredStdLib() -> hasDeferredCoreModule()

Following command-line arguments are renamed:
 - "-load-stdlib" -> "-load-standard-modules"
 - "-save-stdlib" -> "-save-standard-modules"
 - "-compile-stdlib" -> "-compile-core-module"
@jkwak-work jkwak-work force-pushed the feature/replace_StdLib_with_CoreModule_or_StandardModules_for_public_slang_APIs branch from d0dc40c to 210fbaa Compare October 25, 2024 04:48
@jkwak-work
Copy link
Collaborator Author

This PR is for #5335 but it doesn't close.
This PR is limited to "breaking changes".
I still need to work more on the issue.

@jkwak-work jkwak-work merged commit 4bad669 into shader-slang:master Oct 25, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: breaking change PRs with breaking changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants