When I was writing a C++ plugin for Unity in our upcoming iOS game (
Shadow Blade), I was thinking that it would be very good if I could write some debug logs into the Unity console. After going on and progressing the plugin without logs, suddenly an idea came to my mind! This is an explanation of how to redirect some debug text from a C++ plugin to Unity's console.
The method is based on Delegates in C#, Delegates can be treated as a typedef of a function pointers in C/C++ and you can call them from unmanaged code.
You can write a function in C# that takes a string as it's argument and print it into the Unity's console window, and then pass a pointer of this function to C++ dll, so you can call the function from C++ by it's pointer, this will redirect your strings from C++ to log window.
First of all define a delegate like this:
using System.Runtime.InteropServices;
...
[UnmanagedFunctionPointer(CallingConvention.Cdecl)]
public delegate void MyDelegate(string str);
...
This is a delegate of type a function that has a string argument and returns nothing. Take care of your calling conventions, by default calling conventions of a C++ project in Visual Studio are
__cdecl (/Gd) you can find it in the project properties -> C/C++ -> Advanced options.
Then write a method that you will call it from C++ to print the log string, this is a member function of a Unity script file (a mono script):
static void CallBackFunction(string str)
{
Debug.Log("::CallBaaaaaaack : " + str);
}
In the
Start() function of your Unity script instantiate the defined delegate:
MyDelegate callback_delegate = new MyDelegate( CallBackFunction );
// Convert callback_delegate into a function pointer that can be
// used in unmanaged code.
IntPtr intptr_delegate =
Marshal.GetFunctionPointerForDelegate(callback_delegate);
// Call the API passing along the function pointer.
SetDebugFunction( intptr_delegate );
The
SetDebugFunction is a method that assigns the function pointer to a pointer that you defined in your C++ code:
typedef void (*FuncPtr)( const char * );
FuncPtr Debug;
You can access this pointer in other source code by an extern modifier or any global access method you know such as writing a singleton class.
extern "C"
{
EXPORT_API void SetDebugFunction( FuncPtr fp )
{
Debug = fp;
}
}
Don't forget to import it in your C# code:
[DllImport ("UnityPlugin")]
public static extern void SetDebugFunction( IntPtr fp );
Now you can call this function everywhere in your C++ plugin:
...
Debug( "String From C++ Dll" );
...
And the resault:
(I called a function from my plugin that logs a string into console window)
Hi, I've read your work and though you described pretty much what you wanted to do with your solution, I think that in all fairness, this article is pretty unclear. You seem to be hopping from one place to the next with fairly little explainers as to what exactly you are doing. The end result is pretty much misleading as it just shows that the calls of your methods work - nothing more. It's a hardcoded string. Log some actual feedback from the C++ plugin.
To me, the two things that you certainly need to correct here are your explainers, your code examples and your end result.
Now, to me what you've done is a bit of an overkill, to tell you the truth. However, I did not down vote your work based on that - if you manage do present your idea in a way that is clear, concise and actually showcases a real result, I'll be more then happy to revise my vote.
Cheers.