✨ Add a way to handle error with CUDA and more generally with the interop plugin #5

Author: davidAlgis

InteropUnityCUDA/Assets/Actions/InteropHandler.cs

@@ -6,6 +6,15 @@
 
 namespace ActionUnity
 {
+    [Flags]
+    public enum ErrorBehavior
+    {
+        DO_NOTHING = 1,
+        ASSERT = 2,
+        DISABLE_ACTION = 4,
+    };
+
+    
     /// <summary>
     /// This class will handle interoperability between Unity/Graphics API/GPGPU Technology
     /// It is used to register and call particular action (other unity plugin
@@ -20,6 +29,11 @@ public abstract class InteropHandler : MonoBehaviour
         [DllImport(_dllPluginInterop)]
         private static extern void StartLog();
 
+        [DllImport(_dllPluginInterop)]
+        protected static extern int GetErrorBehavior();
+        
+        [DllImport(_dllPluginInterop)]
+        private static extern void SetErrorBehavior(int behavior);
 
         [DllImport(_dllPluginInterop)]
         public static extern bool IsSupported();
@@ -51,6 +65,8 @@ private void Awake()
             {
                 Debug.LogError("Interoperability is not supported.");        
             }
+
+            SetErrorBehavior(ErrorBehavior.DISABLE_ACTION);
         }
 
         public void InitializeInteropHandler()
@@ -101,6 +117,11 @@ protected virtual void OnDestroyActions()
 
         }
 
+        protected void SetErrorBehavior(ErrorBehavior errorBehavior)
+        {
+            SetErrorBehavior((int)errorBehavior);
+        }
+
         #region ACTION_CALLER
 
         /// <summary>

InteropUnityCUDA/Assets/Actions/InteropHandlerSample.cs

@@ -26,6 +26,7 @@ public class InteropHandlerSample : InteropHandler
         [SerializeField] private int _sizeBuffer = 256;
 
         private Texture2D _texture;
+        // private RenderTexture _texture;
         private Texture2DArray _textureArray;
         private Texture2D _textureForDisplay0;
         private Texture2D _textureForDisplay1;
@@ -38,6 +39,8 @@ private void CreateTexture()
         {
             _texture = new Texture2D(_sizeTexture, _sizeTexture, TextureFormat.RGBAFloat, false, true);
             _texture.Apply();
+            // _texture = new RenderTexture(_sizeTexture, _sizeTexture, 1, RenderTextureFormat.ARGB32);
+            // _texture.Create();
             _rawImageOneTexture.texture = _texture;
         }
 

Plugin/PluginInteropUnityCUDA/include/Action.h

@@ -20,4 +20,5 @@ class UNITY_INTERFACE_EXPORT Action
 	virtual int Start() = 0;
 	virtual int Update() = 0;
 	virtual int OnDestroy() = 0;
+	bool IsActive = true;
 };

Plugin/PluginInteropUnityCUDA/include/Buffer/vertex_buffer.h

@@ -19,38 +19,37 @@ class VertexBuffer
 		/**
 		 * Register the buffer in CUDA, this has to be override because it depends on the graphics api
 		 */
-		UNITY_INTERFACE_EXPORT virtual void registerBufferInCUDA() = 0;
+		UNITY_INTERFACE_EXPORT virtual int registerBufferInCUDA() = 0;
 
 		/**
 		 * Unregister the buffer in CUDA, this has to be override because it depends on the graphics api
 		 */
-		UNITY_INTERFACE_EXPORT virtual void unregisterBufferInCUDA() = 0;
+		UNITY_INTERFACE_EXPORT virtual int unregisterBufferInCUDA() = 0;
 
 
 		/**
 		 * Map resources to CUDA
 		 * return an array of T* defined on device memory and which can be edited in cuda
 		 */
 		template <typename T>
-		UNITY_INTERFACE_EXPORT T* mapResources()
+		UNITY_INTERFACE_EXPORT int mapResources(T** vertexPtr)
 		{
 			// map resource
-			CUDA_CHECK(cudaGraphicsMapResources(1, &_graphicsResource, 0));
+			CUDA_CHECK_RETURN(cudaGraphicsMapResources(1, &_graphicsResource, 0));
 			// pointer toward an array of float4 on device memory : the compute buffer
-			T* vertexPtr;
 			// number of bytes that has been readed
 			size_t numBytes;
 			// map the resources on a float4 array that can be modify on device
-			CUDA_CHECK(cudaGraphicsResourceGetMappedPointer((void**)&vertexPtr, &numBytes,
+			CUDA_CHECK_RETURN(cudaGraphicsResourceGetMappedPointer((void**)vertexPtr, &numBytes,
 				_graphicsResource));
-			return vertexPtr;
+			return SUCCESS_INTEROP_CODE;
 		}
 
 		/**
 		 * Unmap resources from CUDA
 		 * This function will wait for all previous GPU activity to complete
 		 */
-		UNITY_INTERFACE_EXPORT void unmapResources();
+		UNITY_INTERFACE_EXPORT int unmapResources();
 
 		/**
 		 * Get the default dimension block (8,1,1)

Plugin/PluginInteropUnityCUDA/include/Buffer/vertex_buffer_D3D11.h

@@ -14,8 +14,8 @@ class VertexBuffer_D3D11 : public VertexBuffer
 public:
 	VertexBuffer_D3D11(void* bufferHandle, int size);
 	~VertexBuffer_D3D11();
-	virtual void registerBufferInCUDA();
-	virtual void unregisterBufferInCUDA();
+	virtual int registerBufferInCUDA();
+	virtual int unregisterBufferInCUDA();
 
 };
 

Plugin/PluginInteropUnityCUDA/include/Buffer/vertex_buffer_OpenGLCoreES.h

@@ -13,8 +13,8 @@ class VertexBuffer_OpenGLCoreES : public VertexBuffer
 public:
 	VertexBuffer_OpenGLCoreES(void* bufferHandle, int size);
 	~VertexBuffer_OpenGLCoreES();
-	virtual void registerBufferInCUDA();
-	virtual void unregisterBufferInCUDA();
+	virtual int registerBufferInCUDA();
+	virtual int unregisterBufferInCUDA();
 
 };
 

Plugin/PluginInteropUnityCUDA/include/Texture/texture.h

@@ -27,13 +27,13 @@ class Texture
      * Register the texture in CUDA, this has to be override because it depends
      *  on the graphics api
      */
-    UNITY_INTERFACE_EXPORT virtual void registerTextureInCUDA() = 0;
+    UNITY_INTERFACE_EXPORT virtual int registerTextureInCUDA() = 0;
 
     /**
      * Unregistered the texture in CUDA, this has to be override because it
      *  depends on the graphics api
      */
-    UNITY_INTERFACE_EXPORT virtual void unregisterTextureInCUDA() = 0;
+    UNITY_INTERFACE_EXPORT virtual int unregisterTextureInCUDA() = 0;
 
     /**
      * For some API (DX11) CUDA cannot edit the texture created by Unity
@@ -46,7 +46,7 @@ class Texture
      * texture has not been modify in Unity. Tips : not necessary for write only
      * in CUDA or read only in Unity
      */
-    UNITY_INTERFACE_EXPORT virtual void copyUnityTextureToAPITexture() = 0;
+    UNITY_INTERFACE_EXPORT virtual int copyUnityTextureToAPITexture() = 0;
 
     /**
      * For some API (DX11) CUDA cannot edit the texture created by Unity
@@ -59,20 +59,20 @@ class Texture
      * texture in CUDA, or if the texture is only write only in Unity. Tips :
      * not necessary for read only in CUDA or write only in Unity
      */
-    UNITY_INTERFACE_EXPORT virtual void copyAPITextureToUnityTexture() = 0;
+    UNITY_INTERFACE_EXPORT virtual int copyAPITextureToUnityTexture() = 0;
 
     /**
      * Map the cuda array from the graphics resources and create a surface
      * object from it. To write into the surface object use the getter of
      * _surfObjArray.
      */
-    UNITY_INTERFACE_EXPORT void mapTextureToSurfaceObject();
+    UNITY_INTERFACE_EXPORT int mapTextureToSurfaceObject();
 
     /**
      * Unmap the cuda array from graphics resources and destroy surface object
      * This function will wait for all previous GPU activity to complete
      */
-    UNITY_INTERFACE_EXPORT void unmapTextureToSurfaceObject();
+    UNITY_INTERFACE_EXPORT int unmapTextureToSurfaceObject();
 
     /**
      * Get the default dimension block (8,8,1)

Plugin/PluginInteropUnityCUDA/include/Texture/texture_D3D11.h

@@ -26,12 +26,12 @@ class Texture_D3D11 : public Texture
                   int textureDepth, RenderAPI *renderAPI);
     ~Texture_D3D11();
 
-    virtual void registerTextureInCUDA();
-    virtual void unregisterTextureInCUDA();
+    virtual int registerTextureInCUDA();
+    virtual int unregisterTextureInCUDA();
 
     protected:
-    virtual void copyUnityTextureToAPITexture();
-    virtual void copyAPITextureToUnityTexture();
+    virtual int copyUnityTextureToAPITexture();
+    virtual int copyAPITextureToUnityTexture();
 
     private:
     int copyUnityTextureToBuffer();

Plugin/PluginInteropUnityCUDA/include/Texture/texture_OpenGLCoreES.h

@@ -15,11 +15,11 @@ class Texture_OpenGLCoreES : public Texture
 public:
 	Texture_OpenGLCoreES(void* textureHandle, int textureWidth, int textureHeight, int textureDepth);
 	~Texture_OpenGLCoreES();
-	virtual void registerTextureInCUDA();
-	virtual void unregisterTextureInCUDA();
+	virtual int registerTextureInCUDA();
+	virtual int unregisterTextureInCUDA();
 protected:
-	virtual void copyUnityTextureToAPITexture();
-	virtual void copyAPITextureToUnityTexture();
+	virtual int copyUnityTextureToAPITexture();
+	virtual int copyAPITextureToUnityTexture();
 };
 
 #endif