FS#25 - Change sf::PostFx to a more general purpose pixel shader class (sf::Shader)

Updated the PostFx sample, renamed to Shader
Renamed all the static X::CanUseX() functions to X::IsAvailable() to make the API more consistent
Moved .def files from /build/VC200X to /src in CSFML
Minors fixes in CSFML

git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1258 4e206d99-4929-0410-ac5d-dfc041789085

dotnet/samples/bin/datas/post-fx/blur.sfx

@@ -1,16 +0,0 @@
-texture framebuffer
-float offset
-
-effect
-{
-	vec2 offx = vec2(offset, 0.0);
-	vec2 offy = vec2(0.0, offset);
-
-	vec4 c0 = framebuffer(_in);
-	vec4 c1 = framebuffer(_in - offy);
-	vec4 c2 = framebuffer(_in + offy);
-	vec4 c3 = framebuffer(_in - offx);
-	vec4 c4 = framebuffer(_in + offx);
-
-	_out = c0 * 0.2 + c1 * 0.2 + c2 * 0.2 + c3 * 0.2 + c4 * 0.2;
-}

dotnet/samples/bin/datas/post-fx/colorize.sfx

@@ -1,10 +0,0 @@
-texture framebuffer
-vec3 color
-
-effect
-{
-	vec4 pixel = framebuffer(_in);
-	float gray = pixel.r * 0.39 + pixel.g * 0.50 + pixel.b * 0.11;
-
-	_out = vec4(gray * color, 1.0) * 0.6 + pixel * 0.4;
-}

dotnet/samples/bin/datas/post-fx/fisheye.sfx

@@ -1,12 +0,0 @@
-texture framebuffer
-vec2 mouse
-
-effect
-{
-	float len = distance(_in, mouse) * 7.0;
-
-	if (len < 1.0)
-		_out = framebuffer(_in + (_in - mouse) * len);
-	else
-		_out = framebuffer(_in);	
-}

dotnet/samples/bin/datas/post-fx/nothing.sfx

@@ -1,6 +0,0 @@
-texture framebuffer
-
-effect
-{
-	_out = framebuffer(_in);
-}

dotnet/samples/bin/datas/post-fx/pixelate.sfx

@@ -1,11 +0,0 @@
-texture framebuffer
-vec2 mouse
-
-effect
-{
-	float factor = 5 + 100 * length(mouse);
-
-	vec2 pos = floor(_in * factor) / factor;
-
-	_out = framebuffer(pos);	
-}

dotnet/samples/bin/datas/post-fx/wave.sfx

@@ -1,12 +0,0 @@
-texture framebuffer
-texture wave
-vec2 offset
-
-effect
-{
-	vec2 texoffset = wave(_in * offset).xy;
-	texoffset -= vec2(0.5, 0.5);
-	texoffset *= 0.05;
-
-	_out = framebuffer(_in + texoffset);
-}

dotnet/samples/bin/datas/shader/blur.sfx

@@ -0,0 +1,16 @@
+uniform sampler2D texture;
+uniform float offset;
+
+void main()
+{
+	vec2 offx = vec2(offset, 0.0);
+	vec2 offy = vec2(0.0, offset);
+
+	vec4 c0 = texture2D(texture, gl_TexCoord[0].xy);
+	vec4 c1 = texture2D(texture, gl_TexCoord[0].xy - offy);
+	vec4 c2 = texture2D(texture, gl_TexCoord[0].xy + offy);
+	vec4 c3 = texture2D(texture, gl_TexCoord[0].xy - offx);
+	vec4 c4 = texture2D(texture, gl_TexCoord[0].xy + offx);
+
+	gl_FragColor =  gl_Color * (c0 * 0.2 + c1 * 0.2 + c2 * 0.2 + c3 * 0.2 + c4 * 0.2);
+}

dotnet/samples/bin/datas/shader/colorize.sfx

@@ -0,0 +1,11 @@
+uniform sampler2D texture;
+uniform vec3 color;
+
+void main()
+{
+	vec4 pixel = texture2D(texture, gl_TexCoord[0].xy) * gl_Color;
+	float gray = pixel.r * 0.39 + pixel.g * 0.50 + pixel.b * 0.11;
+
+	gl_FragColor = vec4(gray * color, 1.0) * 0.6 + pixel * 0.4;
+	gl_FragColor.a = pixel.a;
+}

dotnet/samples/bin/datas/shader/fisheye.sfx

@@ -0,0 +1,13 @@
+uniform sampler2D texture;
+uniform vec2 mouse;
+
+void main()
+{
+	float len = distance(gl_TexCoord[0].xy, mouse) * 7.0;
+
+    vec2 coords = gl_TexCoord[0].xy;
+	if (len < 1.0)
+		coords += (gl_TexCoord[0].xy - mouse) * len;
+
+    gl_FragColor = texture2D(texture, coords) * gl_Color;	
+}

dotnet/samples/bin/datas/shader/nothing.sfx

@@ -0,0 +1,6 @@
+uniform sampler2D texture;
+
+void main()
+{
+	gl_FragColor = texture2D(texture, gl_TexCoord[0].xy) * gl_Color;
+}

dotnet/samples/bin/datas/shader/pixelate.sfx

@@ -0,0 +1,10 @@
+uniform sampler2D texture;
+uniform vec2 mouse;
+
+void main()
+{
+	float factor = 5 + 100 * length(mouse);
+	vec2 pos = floor(gl_TexCoord[0].xy * factor + 0.5) / factor;
+
+	gl_FragColor = texture2D(texture, pos) * gl_Color;	
+}

dotnet/samples/bin/datas/shader/wave.sfx

@@ -0,0 +1,12 @@
+uniform sampler2D texture;
+uniform sampler2D wave;
+uniform vec2 offset;
+
+void main()
+{
+	vec2 texoffset = texture2D(wave, (gl_TexCoord[0].xy * offset).xy);
+	texoffset -= vec2(0.5, 0.5);
+	texoffset *= 0.05;
+
+	gl_FragColor = texture2D(texture, gl_TexCoord[0].xy + texoffset) * gl_Color;
+}

dotnet/samples/post-fx/PostFx.cs

@@ -1,184 +0,0 @@
-using System;
-using System.Collections.Generic;
-using SFML;
-using SFML.Graphics;
-using SFML.Window;
-
-namespace sample_postfx
-{
-    static class Program
-    {
-        private static Dictionary<string, PostFx>            effects;
-        private static Dictionary<string, PostFx>.Enumerator currentEffect;
-        private static String2D                              curFXStr;
-
-        /// <summary>
-        /// The main entry point for the application.
-        /// </summary>
-        static void Main()
-        {
-            // Create the main window
-            RenderWindow window = new RenderWindow(new VideoMode(800, 600), "SFML.Net PostFX");
-
-            // Setup event handlers
-            window.Closed     += new EventHandler(OnClosed);
-            window.KeyPressed += new EventHandler<KeyEventArgs>(OnKeyPressed);
-
-            // Check that the system can use post effects
-            if (PostFx.CanUsePostFX == false)
-            {
-                DisplayError(window);
-                return;
-            }
-
-            // Load a background image to display
-            Sprite background = new Sprite(new Image("datas/post-fx/background.jpg"));
-
-            // Load a sprite which we'll move into the scene
-            Sprite entity = new Sprite(new Image("datas/post-fx/sprite.png"));
-
-            // Load the text font
-            Font cheeseburger = new Font("datas/post-fx/cheeseburger.ttf");
-
-            // Load the image needed for the wave effect
-            Image waveImage = new Image("datas/post-fx/wave.jpg");
-
-            // Load all effects
-            effects = new Dictionary<string, PostFx>();
-            effects["nothing"]  = new PostFx("datas/post-fx/nothing.sfx");
-            effects["blur"]     = new PostFx("datas/post-fx/blur.sfx");
-            effects["colorize"] = new PostFx("datas/post-fx/colorize.sfx");
-            effects["fisheye"]  = new PostFx("datas/post-fx/fisheye.sfx");
-            effects["wave"]     = new PostFx("datas/post-fx/wave.sfx");
-            effects["pixelate"] = new PostFx("datas/post-fx/pixelate.sfx");
-            currentEffect = effects.GetEnumerator();
-            currentEffect.MoveNext();
-
-            // Do specific initializations
-            effects["nothing"].SetTexture("framebuffer", null);
-            effects["blur"].SetTexture("framebuffer", null);
-            effects["blur"].SetParameter("offset", 0.0F);
-            effects["colorize"].SetTexture("framebuffer", null);
-            effects["colorize"].SetParameter("color", 1.0F, 1.0F, 1.0F);
-            effects["fisheye"].SetTexture("framebuffer", null);
-            effects["wave"].SetTexture("framebuffer", null);
-            effects["wave"].SetTexture("wave", waveImage);
-            effects["pixelate"].SetTexture("framebuffer", null);
-
-            // Define a string for displaying current effect description
-            curFXStr = new String2D();
-            curFXStr.Text = "Current effect is \"" + currentEffect.Current.Key + "\"";
-            curFXStr.Font = cheeseburger;
-            curFXStr.Position = new Vector2(20.0F, 0.0F);
-            curFXStr.Color = new Color(150, 70, 110);
-
-            // Define a string for displaying help
-            String2D infoStr = new String2D();
-            infoStr.Text = "Move your mouse to change the effect parameters\nPress numpad + to change effect\nWarning : some effects may not work\ndepending on your graphics card";
-            infoStr.Font = cheeseburger;
-            infoStr.Position = new Vector2(20.0F, 460.0F);
-            infoStr.Color = new Color(200, 100, 150);
-
-            // Start the game loop
-            float time = 0.0F;
-            while (window.IsOpened())
-            {
-                // Process events
-                window.DispatchEvents();
-
-                // Get the mouse position in the range [0, 1]
-                float x = window.Input.GetMouseX() / (float)window.Width;
-                float y = window.Input.GetMouseY() / (float)window.Height;
-
-                // Update the current effect
-                if      (currentEffect.Current.Key == "blur")     currentEffect.Current.Value.SetParameter("offset", x * y * 0.1f);
-                else if (currentEffect.Current.Key == "colorize") currentEffect.Current.Value.SetParameter("color", 0.3f, x, y);
-                else if (currentEffect.Current.Key == "fisheye")  currentEffect.Current.Value.SetParameter("mouse", x, 1.0F - y);
-                else if (currentEffect.Current.Key == "wave")     currentEffect.Current.Value.SetParameter("offset", x, y);
-                else if (currentEffect.Current.Key == "pixelate") currentEffect.Current.Value.SetParameter("mouse", x, y);
-
-                // Animate the sprite
-                time += window.GetFrameTime();
-                float entityX = (float)(Math.Cos(time * 1.3) + 1.2) * 300;
-                float entityY = (float)(Math.Cos(time * 0.8) + 1.2) * 200;
-                entity.Position = new Vector2(entityX, entityY);
-                entity.Rotation = time * 100;
-
-                // Clear the window
-                window.Clear();
-
-                // Draw background, the sprite and apply the post-fx
-                window.Draw(background);
-                window.Draw(entity);
-                window.Draw(currentEffect.Current.Value);
-
-                // Draw interface strings
-                window.Draw(curFXStr);
-                window.Draw(infoStr);
-
-                // Finally, display the rendered frame on screen
-                window.Display();
-            }
-        }
-
-        /// <summary>
-        /// Fonction called when the post-effects are not supported ;
-        /// Display an error message and wait until the user exits
-        /// </summary>
-        private static void DisplayError(RenderWindow window)
-        {
-            // Define a string for displaying the error message
-            String2D errorStr = new String2D("Sorry, your system doesn't support post-effects");
-            errorStr.Position = new Vector2(100.0F, 250.0F);
-            errorStr.Color = new Color(200, 100, 150);
-
-            // Start the game loop
-            while (window.IsOpened())
-            {
-                // Process events
-                window.DispatchEvents();
-
-                // Clear the window
-                window.Clear();
-
-                // Draw the error message
-                window.Draw(errorStr);
-
-                // Finally, display the rendered frame on screen
-                window.Display();
-            }
-        }
-
-        /// <summary>
-        /// Function called when the window is closed
-        /// </summary>
-        static void OnClosed(object sender, EventArgs e)
-        {
-            RenderWindow window = (RenderWindow)sender;
-            window.Close();
-        }
-
-        /// <summary>
-        /// Function called when a key is pressed
-        /// </summary>
-        static void OnKeyPressed(object sender, KeyEventArgs e)
-        {
-            RenderWindow window = (RenderWindow)sender;
-            if (e.Code == KeyCode.Escape)
-            {
-                // Close the window
-                window.Close();
-            }
-            else if (e.Code == KeyCode.Add)
-            {
-                // Advance to the next effect
-                if (currentEffect.MoveNext() == false)
-                {
-                    currentEffect = effects.GetEnumerator();
-                    currentEffect.MoveNext();
-                }
-                curFXStr.Text = "Current effect is \"" + currentEffect.Current.Key + "\"";
-            }
-        }
-    }
-}

dotnet/samples/shader/Shader.cs

@@ -0,0 +1,249 @@
+using System;
+using System.Collections.Generic;
+using SFML;
+using SFML.Graphics;
+using SFML.Window;
+
+namespace sample_shader
+{
+    /// <summary>
+    /// A class to simplify shader selection
+    /// </summary>
+    class ShaderSelector
+    {
+        // Constructor
+        public ShaderSelector(Dictionary<string, Shader> owner)
+        {
+            myOwner = owner;
+            myIterator = owner.GetEnumerator();
+            myIterator.MoveNext();
+        }
+
+        // Select the next shader
+        public void GotoNext()
+        {
+            if (myIterator.MoveNext() == false)
+            {
+                myIterator = myOwner.GetEnumerator();
+                myIterator.MoveNext();
+            }
+        }
+
+        // Update the shader parameters
+        public void Update(float x, float y)
+        {
+            if      (myIterator.Current.Key == "blur")     myIterator.Current.Value.SetParameter("offset", x * y * 0.05f);
+            else if (myIterator.Current.Key == "colorize") myIterator.Current.Value.SetParameter("color", 0.3f, x, y);
+            else if (myIterator.Current.Key == "fisheye")  myIterator.Current.Value.SetParameter("mouse", x, y);
+            else if (myIterator.Current.Key == "wave")     myIterator.Current.Value.SetParameter("offset", x, y);
+            else if (myIterator.Current.Key == "pixelate") myIterator.Current.Value.SetParameter("mouse", x, y);
+        }
+
+        // Get the name of the current shader
+        public string Name
+        {
+            get {return myIterator.Current.Key;}
+        }
+
+        // Get the current shader
+        public Shader Shader
+        {
+            get {return myIterator.Current.Value;}
+        }
+
+        private Dictionary<string, Shader> myOwner;
+        private Dictionary<string, Shader>.Enumerator myIterator;
+    };
+
+    static class Program
+    {
+        private static Dictionary<string, Shader> shaders;
+        private static ShaderSelector             backgroundShader;
+        private static ShaderSelector             entityShader;
+        private static ShaderSelector             globalShader;
+        private static String2D                   shaderStr;
+
+        /// <summary>
+        /// The main entry point for the application.
+        /// </summary>
+        static void Main()
+        {
+            // Create the main window
+            RenderWindow window = new RenderWindow(new VideoMode(800, 600), "SFML.Net Shader");
+
+            // Setup event handlers
+            window.Closed     += new EventHandler(OnClosed);
+            window.KeyPressed += new EventHandler<KeyEventArgs>(OnKeyPressed);
+
+            // Check that the system can use shaders
+            if (Shader.IsAvailable == false)
+            {
+                DisplayError(window);
+                return;
+            }
+
+            // Create the render image
+            RenderImage image = new RenderImage(window.Width, window.Height);
+
+            // Load a background image to display
+            Sprite background = new Sprite(new Image("datas/shader/background.jpg"));
+            background.Image.Smooth = false;
+
+            // Load a sprite which we'll move into the scene
+            Sprite entity = new Sprite(new Image("datas/shader/sprite.png"));
+
+            // Load the text font
+            Font font = new Font("datas/shader/arial.ttf", 20);
+
+            // Load the image needed for the wave effect
+            Image waveImage = new Image("datas/shader/wave.jpg");
+
+            // Load all effects
+            shaders = new Dictionary<string, Shader>();
+            shaders["nothing"]  = new Shader("datas/shader/nothing.sfx");
+            shaders["blur"]     = new Shader("datas/shader/blur.sfx");
+            shaders["colorize"] = new Shader("datas/shader/colorize.sfx");
+            shaders["fisheye"]  = new Shader("datas/shader/fisheye.sfx");
+            shaders["wave"]     = new Shader("datas/shader/wave.sfx");
+            shaders["pixelate"] = new Shader("datas/shader/pixelate.sfx");
+            backgroundShader = new ShaderSelector(shaders);
+            entityShader     = new ShaderSelector(shaders);
+            globalShader     = new ShaderSelector(shaders);
+
+            // Do specific initializations
+            shaders["nothing"].SetTexture("texture", Shader.CurrentTexture);
+            shaders["blur"].SetTexture("texture", Shader.CurrentTexture);
+            shaders["blur"].SetParameter("offset", 0.0F);
+            shaders["colorize"].SetTexture("texture", Shader.CurrentTexture);
+            shaders["colorize"].SetParameter("color", 1.0F, 1.0F, 1.0F);
+            shaders["fisheye"].SetTexture("texture", Shader.CurrentTexture);
+            shaders["wave"].SetTexture("texture", Shader.CurrentTexture);
+            shaders["wave"].SetTexture("wave", waveImage);
+            shaders["pixelate"].SetTexture("texture", Shader.CurrentTexture);
+
+            // Define a string for displaying current effect description
+            shaderStr = new String2D();
+            shaderStr.Font = font;
+            shaderStr.Size = 20;
+            shaderStr.Position = new Vector2(5.0F, 0.0F);
+            shaderStr.Color = new Color(250, 100, 30);
+            shaderStr.Text = "Background shader: \"" + backgroundShader.Name + "\"\n" +
+                             "Flower shader: \"" + entityShader.Name + "\"\n" +
+                             "Global shader: \"" + globalShader.Name + "\"\n";
+
+            // Define a string for displaying help
+            String2D infoStr = new String2D();
+            infoStr.Font = font;
+            infoStr.Size = 20;
+            infoStr.Position = new Vector2(5.0F, 510.0F);
+            infoStr.Color = new Color(250, 100, 30);
+            infoStr.Text = "Move your mouse to change the shaders' parameters\n" +
+                           "Press numpad 1 to change the background shader\n" +
+                           "Press numpad 2 to change the flower shader\n" +
+                           "Press numpad 3 to change the global shader";
+
+            // Start the game loop
+            float time = 0.0F;
+            while (window.IsOpened())
+            {
+                // Process events
+                window.DispatchEvents();
+
+                // Get the mouse position in the range [0, 1]
+                //float x = window.Input.GetMouseX() / (float)window.Width;
+                //float y = window.Input.GetMouseY() / (float)window.Height;
+                float x = (float)(Math.Cos(time * 1.3) + 1) * 0.5F;
+                float y = (float)(Math.Sin(time * 0.8) + 1) * 0.5F;
+
+                // Update the shaders
+                backgroundShader.Update(x, y);
+                entityShader.Update(x, y);
+                globalShader.Update(x, y);
+
+                // Animate the sprite
+                time += window.GetFrameTime();
+                float entityX = (float)(Math.Cos(time * 1.3) + 1.2) * 300;
+                float entityY = (float)(Math.Cos(time * 0.8) + 1.2) * 200;
+                entity.Position = new Vector2(entityX, entityY);
+                entity.Rotation = time * 100;
+
+                // Draw the background and the moving entity to the render image
+                image.Draw(background, backgroundShader.Shader);
+                image.Draw(entity, entityShader.Shader);
+                image.Display();
+
+                // Draw the contents of the render image to the window
+                window.Draw(new Sprite(image.Image), globalShader.Shader);
+
+                // Draw interface strings
+                window.Draw(shaderStr);
+                window.Draw(infoStr);
+
+                // Finally, display the rendered frame on screen
+                window.Display();
+            }
+        }
+
+        /// <summary>
+        /// Fonction called when the post-effects are not supported ;
+        /// Display an error message and wait until the user exits
+        /// </summary>
+        private static void DisplayError(RenderWindow window)
+        {
+            // Define a string for displaying the error message
+            String2D errorStr = new String2D("Sorry, your system doesn't support shaders");
+            errorStr.Position = new Vector2(100.0F, 250.0F);
+            errorStr.Color = new Color(200, 100, 150);
+
+            // Start the game loop
+            while (window.IsOpened())
+            {
+                // Process events
+                window.DispatchEvents();
+
+                // Clear the window
+                window.Clear();
+
+                // Draw the error message
+                window.Draw(errorStr);
+
+                // Finally, display the rendered frame on screen
+                window.Display();
+            }
+        }
+
+        /// <summary>
+        /// Function called when the window is closed
+        /// </summary>
+        static void OnClosed(object sender, EventArgs e)
+        {
+            RenderWindow window = (RenderWindow)sender;
+            window.Close();
+        }
+
+        /// <summary>
+        /// Function called when a key is pressed
+        /// </summary>
+        static void OnKeyPressed(object sender, KeyEventArgs e)
+        {
+            RenderWindow window = (RenderWindow)sender;
+
+            // Escape key : exit
+            if (e.Code == KeyCode.Escape)
+                window.Close();
+
+            // Numpad : switch effect
+            switch (e.Code)
+            {
+                case KeyCode.Numpad1 : backgroundShader.GotoNext(); break;
+                case KeyCode.Numpad2 : entityShader.GotoNext();     break;
+                case KeyCode.Numpad3 : globalShader.GotoNext();     break;
+            }
+
+            // Update the text
+            shaderStr.Text = "Background shader: \"" + backgroundShader.Name + "\"\n" +
+                             "Flower shader: \"" + entityShader.Name + "\"\n" +
+                             "Global shader: \"" + globalShader.Name + "\"\n";
+        }
+    }
+}

dotnet/samples/shader/sample-shader.csproj

@@ -7,13 +7,14 @@
     <ProjectGuid>{9D4738F7-34EA-433A-A765-AF85A52A174D}</ProjectGuid>
     <OutputType>WinExe</OutputType>
     <AppDesignerFolder>Properties</AppDesignerFolder>
-    <RootNamespace>sample_postfx</RootNamespace>
-    <AssemblyName>post-fx</AssemblyName>
+    <RootNamespace>sample_shader</RootNamespace>
+    <AssemblyName>shader</AssemblyName>
     <FileUpgradeFlags>
     </FileUpgradeFlags>
     <OldToolsVersion>2.0</OldToolsVersion>
     <UpgradeBackupLocation>
     </UpgradeBackupLocation>
+    <StartupObject>sample_shader.Program</StartupObject>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -43,7 +44,7 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="PostFx.cs" />
+    <Compile Include="Shader.cs" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="Properties\" />

dotnet/samples/sound_capture/SoundCapture.cs

@@ -13,7 +13,7 @@ namespace sample_soundcapture
         static void Main(string[] args)
         {
             // Check that the device can capture audio
-            if (SoundRecorder.CanCapture == false)
+            if (SoundRecorder.IsAvailable == false)
             {
                 Console.WriteLine("Sorry, audio capture is not supported by your system");
                 return;