aboutsummaryrefslogtreecommitdiff
path: root/APEX_1.4/include/ApexInterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'APEX_1.4/include/ApexInterface.h')
-rw-r--r--APEX_1.4/include/ApexInterface.h62
1 files changed, 62 insertions, 0 deletions
diff --git a/APEX_1.4/include/ApexInterface.h b/APEX_1.4/include/ApexInterface.h
new file mode 100644
index 00000000..42afcb4c
--- /dev/null
+++ b/APEX_1.4/include/ApexInterface.h
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2008-2015, NVIDIA CORPORATION. All rights reserved.
+ *
+ * NVIDIA CORPORATION and its licensors retain all intellectual property
+ * and proprietary rights in and to this software, related documentation
+ * and any modifications thereto. Any use, reproduction, disclosure or
+ * distribution of this software and related documentation without an express
+ * license agreement from NVIDIA CORPORATION is strictly prohibited.
+ */
+
+
+#ifndef APEX_INTERFACE_H
+#define APEX_INTERFACE_H
+
+/*!
+\file
+\brief class ApexInterface
+*/
+
+#include "ApexUsingNamespace.h"
+#include "RWLockable.h"
+
+namespace nvidia
+{
+namespace apex
+{
+
+PX_PUSH_PACK_DEFAULT
+
+/**
+\brief Base class for all interface classes implemented by APEX SDK
+
+User callback interfaces should not derive from this class.
+*/
+class ApexInterface : public RWLockable
+{
+public:
+ ApexInterface() : userData(NULL) {}
+
+ /**
+ \brief Release an object instance.
+
+ Calling this will unhook the class and delete it from memory.
+ You should not keep any reference to this class instance after calling release
+ */
+ virtual void release() = 0;
+
+ /**
+ \brief User data variable.
+
+ Practical in scenarios where this object has a clear and unique owner,
+ not so useful in other scenarios.
+ */
+ void* userData;
+};
+
+PX_POP_PACK
+
+}
+} // end namespace nvidia::apex
+
+#endif // APEX_INTERFACE_H