Skip to content

Commit dd35d1a

Browse files
author
Thomas Harrison
committed
Add deprecation notice
1 parent 5222f80 commit dd35d1a

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ make build CONFIG=Release
2525
make install CONFIG=Release
2626
```
2727

28+
## Deprecation Notice
29+
30+
The following have been deprecated and will be removed or replaced in a future
31+
release.
32+
33+
| What will be removed | Why |
34+
| ------------------------- | --------------------------------------------------- |
35+
| `Shader::defaultShader()` | This shader will always outlive the OpenGL context. |
36+
2837
## CMake Options
2938

3039
| Option | Description | Default |

include/glpp/Shader.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ namespace glpp {
187187
*
188188
* This shader takes a Vertex from VBO.hpp,
189189
*
190+
* @deprecated A default shader will be provided in a different form, if
191+
* at all, in future releases. This shader will always outlive the
192+
* OpenGL context.
193+
*
190194
* Uniforms:
191195
* - mvp: mat4
192196
* - model: mat4

src/Shader.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ void main() {
249249
FragColor = texture(gTexture, FragTex);
250250
})";
251251

252+
[[deprecated("A default shader will be provided in a different form, if at all, in future releases")]]
252253
Shader & Shader::defaultShader() {
253254
static Shader shader(defaultVertexShaderSource,
254255
defaultFragmentShaderSource);

0 commit comments

Comments
 (0)