Skip to main content

C# Fundamentals - Delegates

Delegates

Delegate means 'a representative', just as it's meaning it's implementation is the same as well. You have a delegate representing a function of yours.
A delegate is a wrapper around a pointer to a function ( you might be familiar with function pointers in C++ ). These delegates are also type safe and also have some features that make it way more useful than just a function pointer which we will be going over.
To use delegates first we need to declare one, It's syntax basically looks like this : 
[<modifiers>] delegate [return type] <Name>( [Parameter list])
Eg:
public delegate int MyDelegate(string str);
Delegates can be defined directly under a namespace or under a class.
Delegates can point to either static or instance methods.
To use a delegate we have to first instantiate a delegate. To Instantiate a delegate we have to pass a method as parameter or directly assign.
MyDelegate myDelegate = new MyDelegate(method); // As parameter
MyDelegate myDelegate = method // Directly assigning the method
Can call function with invoke member function or normally as well but using Invoke is better because it shows that it is a delegate (my opinion) 😇.
myDelegate(); // Option 1
myDelegate.Invoke(); // Option 2
So now we will look at how a delegate is used as a callback ( most common use ).
using System;
namespace BitShiftProductions
{    
    public delegate void CallBack(int i);
    public class ClassA
    {
        public void LongRunningTask(CallBack cb)
        {
             for(int i=0;i<100;i++)
               cb(i);
        }
    }    
    public class Program
    {
        static void UseProgressValue(int x)
        {
            Console.WriteLine("Processed : " + x + "%");
        }
        public static void Main(string[] args)
        {
            ClassA objA = new ClassA();
            CallBack callback = new CallBack(UseProgressValue);
            objA.LongRunningTask(callback);
        }
    }
}
Output:
Processed : 0%
Processed : 1%
Processed : 2%
Processed : 3%
.
.
.
Processed : 100%
Now I will introduce you to two properties Method & Target, They use reflection to provide us some details.
Method property :- Has data about the method being held and will display the function name and parameter list when printed.
Target property :- Has data about the object that the method is from. If the method is a static function then it will return null, otherwise it will display object's class data.
Now we will look at a more real world example:
using System;
namespace BitShiftProductions
{    
    public delegate bool MeetsCriteria(int[] intValues);
    public delegate void TargetTester();
    public class IntegerMaster
    {
        private int[] integers;
        public IntegerMaster(int[] ints){integers = ints;}
        public void DoMyIntegersMeetCriteria(MeetsCriteria funcVal)
        {
             if(funcVal(integers))             
                 Console.WriteLine("Meets Criteria For : " + funcVal.Method);             
            else
                Console.WriteLine("Does Not Meet Criteria" + funcVal.Method);
        }
    }    
    public class Program
    {
        static bool AreMultiplesOfTwo(int[] integers)
        {
            for(int i=0;i<integers.Length;i++)
            {
                if(integers[i]%2 != 0)
                    return false;
            }
            return true;
        }
        static bool GreaterThanTen(int[] integers)
        {
            for(int i=0;i<integers.Length;i++)
            {
                if(integers[i] <= 10)
                    return false;
            }
            return true;
        }
        static void PrintValues(TargetTester tester)
        {
            Console.WriteLine("Method of : " + tester.Target);
            tester.Invoke();
        }
        public static void Main(string[] args)
        {
            IntegerMaster ima = new IntegerMaster(new int[]{6,18,2,14,32,64,44});
            ima.DoMyIntegersMeetCriteria(AreMultiplesOfTwo);
            ima.DoMyIntegersMeetCriteria(GreaterThanTen);
            PrintValues(ima.PrintIntegers);
        }
    }
} 
Output:
Meets Criteria For : Boolean AreMultiplesOfTwo(Int32[])
Does Not Meet CriteriaBoolean GreaterThanTen(Int32[])
Method of : BitShiftProductions.IntegerMaster
Value at 0 = 6
Value at 1 = 18
Value at 2 = 2
Value at 3 = 14
Value at 4 = 32
Value at 5 = 64
Value at 6 = 44
Now let's look at what 'delegate chaining' is.
Delegate chaining is a feature that basically allows us to call a list of functions one after another in the order we added them and is a really useful feature especially when starting to work with events in C#.
For adding a new function to the delegate object 
syntax:
delegateObject += function;
For removing a previously added function from the delegate object 
syntax:
delegateObject -= function;
using System;
namespace BitShiftProductions
{    
    public delegate void Display();
    
    public class Program
    {
        static void PrintA(){Console.WriteLine("Printed A");}
        static void PrintB(){Console.WriteLine("Printed B");}
        static void PrintC(){Console.WriteLine("Printed C");}
        public static void Main(string[] args)
        {
            Display display = PrintA;
            display += PrintB;
            display += PrintC;
            display += PrintA;
            display();
            Console.WriteLine("Removing a Print A Function");
            display -= PrintA;
            display();
        }
    }
}
Printed A
Printed B
Printed C
Printed A
Removing Print A Function
Printed A
Printed B
Printed C
You can see that the last instance of PrintA was removed, not the first ,so removing the functions  acts in the form of a stack.
So whatever is added last is taken out first ( LIFO ).
Here is a section of code which is really important to remember while using delegates.
public delegate int GetValue();
static int Return5(){return 5;}
static int Return10(){return 10;}
public class Program
{
   public static void main()
   {
       GetValue getValue = Return5;
       getValue += Return10;
       int x = getValue();
       // x value will be 10
   }
}
The x value is 10 because that was the function that was added last, and when returning... that last function's return value is used.
Another useful feature is the 'Invocation list'.
There is a member function for delegates called ' GetInvocationList() ', It returns an array of delegates that are chained to that specific delegate object.
Eg:
Delegate[] displays = display.GetInvocationList();
for(int i=0;i<displays.Length;i++)
{
    ((Display)displays[i]).Invoke();
}
The above code basically gets an array of functions from the delegate object as type 'Delegate' and in order to use it as we did before, we have to cast it as type 'Display' to invoke it.
You somehow managed to get through all of that... now treat yourself to a snack.😌
For More C# Tutorials, go HERE.
Support Bitshift Programmer by leaving a like on Bitshift Programmer Facebook Page and be updated as soon as there is a new blog post.
If you have any questions that you might have about shaders or unity development in general don't be shy and leave a message on my facebook page or down in the comments.

Comments

Assets Worth Checking Out

POPULAR POSTS

Pixelation Shader - Unity Shader

Pixelation Shader This is the correct way (one of many) of showing pixelation as a post-processing effect. This effect will work in any aspect ratio without any pixel size scaling issues as well as it is very minimal in terms of coding it up.

In order to get this to work 2 components have to be set up:
1) The pixelation image effect
2) The script - which will be attached to the camera

So let's get started by creating a new image effect shader.
We will take a look at our Shaderlab properties :
_MainTex("Texture", 2D) = "white" {} That's it, Everything else will be private and not shown in the editor.
Now we will see what are defined along with the _MainTex but are private.
sampler2D _MainTex; int _PixelDensity; float2 _AspectRatioMultiplier; We will pass _PixelDensity & _AspectRatioMultiplier values from the script.
As this is an image effect there is no need to play around with the vertex shader.
Let's take a look at our fragment shader:
fixed4 frag (…

Alto's Adventure Style Procedural Surface Generation Part 1

Alto's Adventure Style - Procedural Surface Generation This game appears to be a strictly 2D game but if you have played it enough you will notice that some of the art assets used look like it's 3D ( I don't know if they are tho ). If you haven't played the game you are missing out on one the most visually pleasing and calming games out there ( There is literally a mode called Zen mode in the game ).
Anyway, I am going to show you how to make a procedural 2D world ( without the trees, buildings and background ) like in Alto's Adventure.
But you may notice I have a plane which is in in the Z-axis giving a depth to the surface which is not there in Alto's Adventure but if you want to know how to do it then that will be in part 2.
To achieve the same effect of Alto's Adventure ( I'm leaving that up to you ) only minimal changes are needed to the code that I am going to explain.
We are going to be using the plane mesh in unity for creating the 2D surface as th…

Curved Surface Shader [ Unity Implementation ]

Curved Surface Shader This is the shader that we will be having at the end of this tutorial.
 The curved surface shader is capable of achieving really varied visual effects from showing space-time curve due to gravity to a generic curved world shader that is seen in endless runners like Subway Surfers.
The concepts that you learn here can open you up to a new way of looking at shaders and if you didn't think they were the coolest thing ever already, hopefully let this be the turning point.😝.

Both the examples show above use the same exact material is just that different values have been passed to the shader.
Start by creating a new unlit shader in Unity and we will work our way from there.
First we define what the properties are:
_MainTex("Texture", 2D) = "white" {} _BendAmount("Bend Amount", Vector) = (1,1,1,1) _BendOrigin("Bend Origin", Vector) = (0,0,0,0) _BendFallOff("Bend Falloff", float) = 1.0 _BendFallOffStr("Falloff s…

Toon Liquid Shader - Unity Shader

Toon Liquid Shader This is how the shader will end up looking :
This shader is pretty neat and somewhat easy to implement as well as to understand. Since we will be adding some basic physics to the toon water as it is moved about we will have to support that in the vertex shader as well.
So let's start by looking at the properties :
Properties { _Colour ("Colour", Color) = (1,1,1,1) _FillAmount ("Fill Amount", Range(-10,10)) = 0.0 [HideInInspector] _WobbleX ("WobbleX", Range(-1,1)) = 0.0 [HideInInspector] _WobbleZ ("WobbleZ", Range(-1,1)) = 0.0 _TopColor ("Top Color", Color) = (1,1,1,1) _FoamColor ("Foam Line Color", Color) = (1,1,1,1) _Rim ("Foam Line Width", Range(0,0.1)) = 0.0 _RimColor ("Rim Color", Color) = (1,1,1,1) _RimPower ("Rim Power", Range(0,10)) = 0.0 } Just the usual stuff that we are used to. The only thing that may stand out is the [HideInInspector] tag, This works j…

Gift Wrapping Convex Hull Algorithm With Unity Implementation

Convex Hull Algorithm Convex Hull algorithms are one of those algorithms that keep popping up from time to time in seemingly unrelated fields from big data to image processing to collision detection in physics engines, It seems to be all over the place. Why should you care? Cus you can do magic with it and it seems so simple to implement when you first hear about it, but when you start thinking about it, you will realize why it's not such a straightforward thing to do.
Now that I got you interested (hopefully) and now we will see just what a convex hull is.
As you may have noticed a perimeter was made with the same points that was given and these perimeter points enclose the entire set of points.
Now we have to clear up the term 'Convex'.
Convex means no part of the object is caved inwards or that none of the internal angles made by the points exceed 180 degrees.
In this example of a concave shape internal angles go beyond 180 degrees.
What are those red lines for? Well...…