internal/builtinshader: add a comment to the generated file

hajimehoshi · Dec 8, 2024 · 191caa5 · 191caa5
1 parent 4a7701c
commit 191caa5
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/internal/builtinshader/defs.go b/internal/builtinshader/defs.go
diff --git a/internal/builtinshader/gen.go b/internal/builtinshader/gen.go
@@ -46,6 +46,11 @@ const license = `// Copyright 2024 The Ebitengine Authors
 // limitations under the License.
 `
 
+const note = `// This file is intended for precompiled shaders that will be introduced in the future.
+// All constant names are underscores and not actually used,
+// so they do not affect the binary file size.
+`
+
 func xmain() error {
 	f, err := os.Create("defs.go")
 	if err != nil {
@@ -61,6 +66,12 @@ func xmain() error {
 	if _, err := w.WriteString(license); err != nil {
 		return err
 	}
+	if _, err := w.WriteString("\n"); err != nil {
+		return err
+	}
+	if _, err := w.WriteString(note); err != nil {
+		return err
+	}
 	if _, err := w.WriteString("\npackage builtinshader\n"); err != nil {
 		return err
 	}