From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classphysx_1_1PxGpuTask.html | 218 +++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxGpuTask.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxGpuTask.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxGpuTask.html b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxGpuTask.html new file mode 100644 index 00000000..39c0ed49 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classphysx_1_1PxGpuTask.html @@ -0,0 +1,218 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: physx::PxGpuTask Class Reference + + + + + + + +
physx::PxGpuTask +
+
+

physx::PxGpuTask Class Reference

PxTask implementation for launching CUDA work. +More... +

+#include <PxGpuTask.h> +

+

+Inheritance diagram for physx::PxGpuTask:
+
+

Inheritance graph
+ +physx::PxTaskphysx::PxBaseTask +
[legend]
+
+Collaboration diagram for physx::PxGpuTask:
+
+

Collaboration graph
+ +physx::PxTaskphysx::PxBaseTaskphysx::PxTaskManager +
[legend]
+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 PxGpuTask ()
virtual bool launchInstance (CUstream stream, int kernelIndex)=0
 iterative "run" function for a PxGpuTask
virtual PxGpuTaskHint::Enum getTaskHint () const =0
 Returns a hint indicating the function of this task.
void setCompletionTask (PxBaseTask &task)
 Specify a task that will have its reference count decremented when this task is released.
void release ()
 Release method implementation.

Protected Attributes

PxBaseTask * mComp
 A pointer to the completion task.
+

Detailed Description

+PxTask implementation for launching CUDA work.

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
physx::PxGpuTask::PxGpuTask (  )  [inline]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + +
virtual PxGpuTaskHint::Enum physx::PxGpuTask::getTaskHint (  )  const [pure virtual]
+
+
+ +

+Returns a hint indicating the function of this task. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual bool physx::PxGpuTask::launchInstance (CUstream  stream,
int  kernelIndex 
) [pure virtual]
+
+
+ +

+iterative "run" function for a PxGpuTask +

+The GpuDispatcher acquires the CUDA context for the duration of this function call, and it is highly recommended that the PxGpuTask use the provided CUstream for all kernels.

+kernelIndex will be 0 for the initial call and incremented before each subsequent call. Once launchInstance() returns false, its PxGpuTask is considered completed and is released. +

+

+ +

+
+ + + + + + + + +
void physx::PxGpuTask::release (  )  [inline, virtual]
+
+
+ +

+Release method implementation. +

+ +

Reimplemented from physx::PxTask.

+ +

References mComp, and physx::PxBaseTask::removeReference().

+ +
+

+ +

+
+ + + + + + + + + +
void physx::PxGpuTask::setCompletionTask (PxBaseTask &  task  )  [inline]
+
+
+ +

+Specify a task that will have its reference count decremented when this task is released. +

+ +

References mComp.

+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
PxBaseTask* physx::PxGpuTask::mComp [protected]
+
+
+ +

+A pointer to the completion task. +

+ +

Referenced by release(), and setCompletionTask().

+ +
+

+

The documentation for this class was generated from the following file: +
+ +

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3