-
Notifications
You must be signed in to change notification settings - Fork 15
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
List of things to improve in the HLSL language #104
Open
hekota
wants to merge
2
commits into
llvm:main
Choose a base branch
from
hekota:list-of-things-to-improve
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
<!-- {% raw %} --> | ||
|
||
# List of Things to Improve in the HLSL Language | ||
|
||
* Proposal: [NNNN](NNNN-things-to-improve.md) | ||
* Author(s): [Helena Kotas](https://github.com/hekota) | ||
* Status: **Design In Progress** | ||
|
||
## Introduction | ||
|
||
This document includes a list of features that we might consider removing in a | ||
future version of the HLSL language. It includes things that: | ||
- have unusual syntax or odd behavior | ||
- are remnants of outdated features that are no longer used or relevant | ||
- are construct that are generally considered "not very nice" from a language | ||
point of view | ||
|
||
## Motivation | ||
|
||
We strive to evolve HLSL into a modern shader language. In order to so we need | ||
to recognize odd, outdated or obscure features that are no longer used or that | ||
we do not wish to support going forward. | ||
|
||
## List of Things to Improve | ||
|
||
### 1. Global variables outside of `cbuffer` context | ||
|
||
All global variables declared outside of `cbuffer` context go implicitly into | ||
`$Globals` constant buffer. Any initializers on global variables are ignored. | ||
|
||
Possible solutions: | ||
- Require all global variables to be declared withing `cbuffer` context and stop supporting `$Globals` | ||
- Require any top-level global variable to be declared with `const` and report error if it is | ||
initialized. | ||
- Get rid of `cbuffer` entirely and just use `ConstantBuffer` instead so we have more regular syntax for other types of buffers. | ||
|
||
### 2. Nested `cbuffer` declarations | ||
|
||
Nesting of `cbuffer` declarations and allowing functions inside `cbuffer` | ||
declaration context. | ||
|
||
```c++ | ||
cbuffer CB { | ||
int a; | ||
|
||
cbuffer CB { // duplicate name ok | ||
int b; | ||
|
||
int foo(int x) { | ||
return x * 2*; | ||
}; | ||
} | ||
}; | ||
``` | ||
|
||
This is equivalent to: | ||
|
||
```c++ | ||
cbuffer CB { | ||
int a; | ||
}; | ||
|
||
cbuffer CB { // duplicate name ok | ||
int b; | ||
}; | ||
|
||
int foo(int x) { | ||
return x * 2*; | ||
}; | ||
|
||
``` | ||
https://godbolt.org/z/PeW4E3aj3 | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. My 2c: we should get rid of cbuffer entirely and just use |
||
|
||
## Acknowledgments | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if a proposal document is the right way to capture this? Any reason not to use issues for each thing? Then a proposal document can be written with a concrete proposal on addressing the thing-that-needs-to-be-improved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've created this list based on a @llvm-beanz's suggestion that it would be helpful to have one place that lists all of the not-so-nice features and obscure constructs in the language. We can then refer to it when designing a new language version. Issues would probably too as long as they are labeled such that they're easy to find.