aboutsummaryrefslogtreecommitdiff
path: root/NvCloth/samples/SampleBase/task/PxCpuDispatcher.h
diff options
context:
space:
mode:
Diffstat (limited to 'NvCloth/samples/SampleBase/task/PxCpuDispatcher.h')
-rw-r--r--NvCloth/samples/SampleBase/task/PxCpuDispatcher.h79
1 files changed, 79 insertions, 0 deletions
diff --git a/NvCloth/samples/SampleBase/task/PxCpuDispatcher.h b/NvCloth/samples/SampleBase/task/PxCpuDispatcher.h
new file mode 100644
index 0000000..ffd5cfd
--- /dev/null
+++ b/NvCloth/samples/SampleBase/task/PxCpuDispatcher.h
@@ -0,0 +1,79 @@
+// This code contains NVIDIA Confidential Information and is disclosed to you
+// under a form of NVIDIA software license agreement provided separately to you.
+//
+// Notice
+// NVIDIA Corporation and its licensors retain all intellectual property and
+// proprietary rights in and to this software and 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.
+//
+// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
+// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
+// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
+// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
+//
+// Information and code furnished is believed to be accurate and reliable.
+// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
+// information or for any infringement of patents or other rights of third parties that may
+// result from its use. No license is granted by implication or otherwise under any patent
+// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
+// This code supersedes and replaces all information previously supplied.
+// NVIDIA Corporation products are not authorized for use as critical
+// components in life support devices or systems without express written approval of
+// NVIDIA Corporation.
+//
+// Copyright (c) 2008-2017 NVIDIA Corporation. All rights reserved.
+
+#ifndef PXTASK_PXCPUDISPATCHER_H
+#define PXTASK_PXCPUDISPATCHER_H
+
+#include "task/PxTaskDefine.h"
+#include "foundation/PxSimpleTypes.h"
+
+namespace physx
+{
+
+class PxBaseTask;
+
+/**
+ \brief A CpuDispatcher is responsible for scheduling the execution of tasks passed to it by the SDK.
+
+ A typical implementation would for example use a thread pool with the dispatcher
+ pushing tasks onto worker thread queues or a global queue.
+
+ @see PxBaseTask
+ @see PxTask
+ @see PxTaskManager
+*/
+class PxCpuDispatcher
+{
+public:
+ /**
+ \brief Called by the TaskManager when a task is to be queued for execution.
+
+ Upon receiving a task, the dispatcher should schedule the task
+ to run when resource is available. After the task has been run,
+ it should call the release() method and discard it's pointer.
+
+ \param[in] task The task to be run.
+
+ @see PxBaseTask
+ */
+ virtual void submitTask( PxBaseTask& task ) = 0;
+
+ /**
+ \brief Returns the number of available worker threads for this dispatcher.
+
+ The SDK will use this count to control how many tasks are submitted. By
+ matching the number of tasks with the number of execution units task
+ overhead can be reduced.
+ */
+ virtual uint32_t getWorkerCount() const = 0;
+
+ virtual ~PxCpuDispatcher() {}
+};
+
+} // end physx namespace
+
+#endif // PXTASK_PXCPUDISPATCHER_H