Changes between Version 37 and Version 38 of Coding_Conventions

Timestamp:

May 8, 2018, 10:21:38 PM (6 years ago)

Author:

Vladislav Belov

Comment:

--

Coding_Conventions

@@ -407 +407 @@
 == GLSL ==
  * Use the same basic formatting as described above for C++.
+ * Use lowerCamelCase for names:
+{{{
+#!glsl
+// Bad
+vec2 local_position;
+mat4 CalculateInvertMatrix(...);
+int _pixelcounter;
+
+// Good
+vec2 localPosition;
+mat4 calculateInvertMatrix(...);
+int pixelCounter;
+}}}
  * File extensions for shaders:
-    * .fs - fragment shader
-    * .vs - vertex shader
-    * .gs - geometry shader
-    * .cs - compute shader
+    * `.fs` - fragment shader
+    * `.vs` - vertex shader
+    * `.gs` - geometry shader
+    * `.cs` - compute shader
  * All GLSL files should start with right [[https://www.khronos.org/opengl/wiki/Core_Language_(GLSL)#Version|version]].
 {{{
-#!cpp
+#!glsl
 #version 120
 }}}
- * Prefer to use own uniforms instead of built-in
+ * Prefer to use own uniforms instead of built-in (`gl_ProjectionMatrix`, `gl_ModelViewProjectionMatrix`, etc).
+ * Strictly follow specifications for the selected version. Some drivers ignore errors, that can fail others.
+ * Prefer to use swizzle masks:
+{{{
+#!glsl
+vec4 a;
+vec2 b;
+
+// Simple assign.
+a.x = b.x;
+a.y = b.z;
+
+// Assign with swizzle mask.
+a = b.xz;
+}}}
+ * Prefer to use prefixes for global variables to distinguish them: `a_` - for attributes, `v_` for varyings, `u_` - for uniforms.
+{{{#!glsl
+uniform mat4 u_invertTransform;
+
+varying vec2 v_uv;
+
+attribute vec3 a_normal;
+}}}