Difference between revisions of "How to write cross GLProfile compatible shader using JOGL"

From JogampWiki
Jump to navigation Jump to search
(initial version (thx to Xerxes Ranby for starting it on forum))
 
Line 14: Line 14:
 
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/javax/media/opengl/GLContext.html#getGLSLVersionNumber%28%29 GLContext's getGLSLVersionNumber()], which returns the GLSL <code>VersionNumber</code> matching the GLContext's OpenGL version.
 
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/javax/media/opengl/GLContext.html#getGLSLVersionNumber%28%29 GLContext's getGLSLVersionNumber()], which returns the GLSL <code>VersionNumber</code> matching the GLContext's OpenGL version.
 
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/javax/media/opengl/GLContext.html#getGLSLVersionString%28%29 GLContext's getGLSLVersionString()], which returns the ''GLSL version directive'' matching the GLContext's OpenGL version.
 
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/javax/media/opengl/GLContext.html#getGLSLVersionString%28%29 GLContext's getGLSLVersionString()], which returns the ''GLSL version directive'' matching the GLContext's OpenGL version.
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#addGLSLVersion%28javax.media.opengl.GL2ES2%29 ShaderCode's addGLSLVersion(..)], which adds the matching  ''GLSL version directive'' to the shader code.
+
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#addGLSLVersion%28javax.media.opengl.GL2ES2%29 ShaderCode's addGLSLVersion(..)], which adds the matching  ''GLSL version directive'' to the shader code.
  
 
== GLSL Precision Directive ==
 
== GLSL Precision Directive ==
Line 22: Line 22:
 
Users may either add such ''precision directive'' in their code in a fine grained manner adjusting precision to their tasks,
 
Users may either add such ''precision directive'' in their code in a fine grained manner adjusting precision to their tasks,
 
or they may utilize a JOGL's feature:
 
or they may utilize a JOGL's feature:
* [{SERVER}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#addDefaultShaderPrecision%28javax.media.opengl.GL2ES2,%20int%29 ShaderCode's addDefaultShaderPrecision(..)], which adds ''default precision directive'' to the shader code.
+
* [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#addDefaultShaderPrecision%28javax.media.opengl.GL2ES2,%20int%29 ShaderCode's addDefaultShaderPrecision(..)], which adds ''default precision directive'' to the shader code.
  
 
== GLSL Version &amp; Default Precision Directive ==
 
== GLSL Version &amp; Default Precision Directive ==
 
The ''GLSL version and default precision'' directives maybe performed by the  
 
The ''GLSL version and default precision'' directives maybe performed by the  
[{SERVER}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html ShaderCode] class,
+
[{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html ShaderCode] class,
which can load your code from an input stream (URI source) or CharSequence array and customize it appropriately via [{SERVER}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#defaultShaderCustomization%28javax.media.opengl.GL2ES2,%20boolean,%20boolean%29 defaultShaderCustomization(..)].
+
which can load your code from an input stream (URI source) or CharSequence array and customize it appropriately via [{{SERVER}}/deployment/jogamp-current/javadoc/jogl/javadoc/com/jogamp/opengl/util/glsl/ShaderCode.html#defaultShaderCustomization%28javax.media.opengl.GL2ES2,%20boolean,%20boolean%29 defaultShaderCustomization(..)].
  
 
<code>ShaderCode</code> also allows users to perform further custom editing ''on the fly''.
 
<code>ShaderCode</code> also allows users to perform further custom editing ''on the fly''.
  
 
Have a look at how GLSL shaders are loaded inside the jogamp jogl junit tests using <code>ShaderCode</code> for cross platform GLSL use:
 
Have a look at how GLSL shaders are loaded inside the jogamp jogl junit tests using <code>ShaderCode</code> for cross platform GLSL use:
[{SERVER}/git/?p=jogl.git;a=blob;f=src/test/com/jogamp/opengl/test/junit/jogl/demos/es2/RedSquareES2.java;hb=HEAD#l91 RedSquareES2].
+
[{{SERVER}}/git/?p=jogl.git;a=blob;f=src/test/com/jogamp/opengl/test/junit/jogl/demos/es2/RedSquareES2.java;hb=HEAD#l91 RedSquareES2].
  
=== GLSL Version Compatibility ===
+
== GLSL Version Compatibility ==
==== GLSL Version >= 130 ====
+
=== GLSL Version >= 130 ===
 
GLSL version >= 130 uses in and out keywords instead of attributes and varying.   
 
GLSL version >= 130 uses in and out keywords instead of attributes and varying.   
 
it also requires the fragment shader to explicitly define the out variable.  
 
it also requires the fragment shader to explicitly define the out variable.  

Revision as of 03:52, 14 December 2013

Note: To be refined / edited!

In order to create cross platform GLSL shaders the following three points have to be taken into account:

GLSL Version Directive

Some OpenGL implementations require the GLSL version directive #version <number> to be explicitly included in the shader source as the first directive.

The GLSL version directive shall match the OpenGL version of the context, see GLContext's GLSLVersionNumber.

If any of above requirements are not fulfilled the shader code compilation might fail on certain platforms and OpenGL version.

Users may compose their shader at runtime to comply with the GLSL version directive utilizing JOGL's features:

GLSL Precision Directive

In case you target ES2, ES3 or >= GL3 OpenGL contexts one needs to add a precision qualifier to your variable declarations or use a shader wide default precision qualifier directive.

Users may either add such precision directive in their code in a fine grained manner adjusting precision to their tasks, or they may utilize a JOGL's feature:

GLSL Version & Default Precision Directive

The GLSL version and default precision directives maybe performed by the ShaderCode class, which can load your code from an input stream (URI source) or CharSequence array and customize it appropriately via defaultShaderCustomization(..).

ShaderCode also allows users to perform further custom editing on the fly.

Have a look at how GLSL shaders are loaded inside the jogamp jogl junit tests using ShaderCode for cross platform GLSL use: RedSquareES2.

GLSL Version Compatibility

GLSL Version >= 130

GLSL version >= 130 uses in and out keywords instead of attributes and varying. it also requires the fragment shader to explicitly define the out variable. Compatibility with previous GLSL versions can be reached by adding some GLSL pre-processor defines at the beginning of the shaders.

Vertex shader:

#if __VERSION__ >= 130
   #define attribute in
   #define varying out
#endif

Fragment shader:

#if __VERSION__ >= 130
   #define varying in
   out vec4 mgl_FragColor;
 #else
   #define mgl_FragColor gl_FragColor  
#endif

Look at the Cross platform GLSL shaders used by the JogAmp JOGL junit tests how to add the pre-processor defines:

JOGL Unit Test Shader.