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/group__cooking.html | 442 +++++++++++++++++++++ 1 file changed, 442 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/group__cooking.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/group__cooking.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/group__cooking.html b/PhysX_3.4/Documentation/PhysXAPI/files/group__cooking.html new file mode 100644 index 00000000..23280266 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/group__cooking.html @@ -0,0 +1,442 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: Cooking + + + + + + + +
+

Cooking

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes

struct  PxMeshCookingHint
 Enumeration for mesh cooking hints. More...
struct  PxBVH33MidphaseDesc
 Structure describing parameters affecting BVH33 midphase mesh structure. More...
struct  PxBVH34MidphaseDesc
 Structure describing parameters affecting BVH34 midphase mesh structure. More...
struct  PxConvexFlag
 Flags which describe the format and behavior of a convex mesh. More...
class  PxConvexMeshDesc
 Descriptor class for PxConvexMesh. More...
struct  PxPlatform
struct  PxConvexMeshCookingResult
 Result from convex cooking. More...
struct  PxConvexMeshCookingType
 Enumeration for convex mesh cooking algorithms. More...
struct  PxTriangleMeshCookingResult
 Result from triangle mesh cooking. More...
struct  PxMeshPreprocessingFlag
 Enum for the set of mesh pre-processing parameters. More...
struct  PxCookingParams
 Structure describing parameters affecting mesh cooking. More...
class  PxCooking
class  PxMidphaseDesc
 Structure describing parameters affecting midphase mesh structure. More...
class  PxTriangleMeshDesc
 Descriptor class for PxTriangleMesh. More...
class  PxClothMeshDesc
 Descriptor class for a cloth mesh. More...

Typedefs

typedef PxFlags
+< PxConvexFlag::Enum, PxU16 > 		PxConvexFlags
 collection of set bits defined in PxConvexFlag.
typedef PxFlags
+< PxMeshPreprocessingFlag::Enum,
+PxU32 > 		PxMeshPreprocessingFlags

Functions

PX_DEPRECATED PX_FORCE_INLINE PxU32 PxGetGaussMapVertexLimitForPlatform (PxPlatform::Enum targetPlatform)
PX_C_EXPORT
+PX_PHYSX_COOKING_API
+physx::PxCooking *PX_CALL_CONV 		PxCreateCooking (physx::PxU32 version, physx::PxFoundation &foundation, const physx::PxCookingParams &params)
 Create an instance of the cooking interface.
PX_INLINE PxConvexMeshDesc::PxConvexMeshDesc ()
 constructor sets to default.
PX_INLINE void PxConvexMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxConvexMeshDesc::isValid () const
 Returns true if the descriptor is valid.
PX_INLINE PxTriangleMeshDesc::PxTriangleMeshDesc ()
 Constructor sets to default.
PX_INLINE void PxTriangleMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxTriangleMeshDesc::isValid () const
 Returns true if the descriptor is valid.
PX_INLINE PxClothMeshDesc::PxClothMeshDesc ()
 constructor sets to default.
PX_INLINE void PxClothMeshDesc::setToDefault ()
 (re)sets the structure to the default.
PX_INLINE bool PxClothMeshDesc::isValid () const
 Returns true if the descriptor is valid.
+

Typedef Documentation

+ +
+
+ + + + +
typedef PxFlags<PxConvexFlag::Enum,PxU16> PxConvexFlags
+
+
+ +

+collection of set bits defined in PxConvexFlag. +

+

See also:
PxConvexFlag
+ +
+

+ +

+
+ + + + +
typedef PxFlags<PxMeshPreprocessingFlag::Enum,PxU32> PxMeshPreprocessingFlags
+
+
+ +

+ +

+

+

Function Documentation

+ +
+
+ + + + + + + + +
PX_INLINE bool PxClothMeshDesc::isValid (  )  const [inherited]
+
+
+ +

+Returns true if the descriptor is valid. +

+

Returns:
True if the current settings are valid
+ +

References PxBoundedData::count, PxStridedData::data, PxMeshFlag::e16_BIT_INDICES, PxClothMeshDesc::flags, PxClothMeshDesc::invMasses, PxClothMeshDesc::points, PxClothMeshDesc::quads, PxStridedData::stride, and PxClothMeshDesc::triangles.

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE bool PxTriangleMeshDesc::isValid (  )  const [inherited]
+
+
+ +

+Returns true if the descriptor is valid. +

+

Returns:
true if the current settings are valid
+ +

Reimplemented from PxSimpleTriangleMesh.

+ +

References PxBoundedData::count, PxTypedStridedData< TDataType >::data, PxStridedData::data, PxTriangleMeshDesc::materialIndices, PxSimpleTriangleMesh::points, PxTypedStridedData< TDataType >::stride, and PxSimpleTriangleMesh::triangles.

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE bool PxConvexMeshDesc::isValid (  )  const [inherited]
+
+
+ +

+Returns true if the descriptor is valid. +

+

Returns:
True if the current settings are valid
+ +

References PxBoundedData::count, PxStridedData::data, PxConvexFlag::e16_BIT_INDICES, PxConvexFlag::eCOMPUTE_CONVEX, PxConvexFlag::ePLANE_SHIFTING, PxConvexMeshDesc::flags, PxConvexMeshDesc::indices, PxConvexMeshDesc::points, PxConvexMeshDesc::polygons, PxConvexMeshDesc::quantizedCount, PxStridedData::stride, and PxConvexMeshDesc::vertexLimit.

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE PxClothMeshDesc::PxClothMeshDesc (  )  [inherited]
+
+
+ +

+constructor sets to default. +

+ +

Referenced by PxClothMeshDesc::setToDefault().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE PxConvexMeshDesc::PxConvexMeshDesc (  )  [inherited]
+
+
+ +

+constructor sets to default. +

+ +

Referenced by PxConvexMeshDesc::setToDefault().

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
PX_C_EXPORT PX_PHYSX_COOKING_API physx::PxCooking* PX_CALL_CONV PxCreateCooking (physx::PxU32  version,
physx::PxFoundation &  foundation,
const physx::PxCookingParams &  params 
)
+
+
+ +

+Create an instance of the cooking interface. +

+Note that the foundation object is handled as an application-wide singleton in statically linked executables and a DLL-wide singleton in dynamically linked executables. Therefore, if you are using the runtime SDK in the same executable as cooking, you should pass the Physics's copy of foundation (acquired with PxPhysics::getFoundation()) to the cooker. This will also ensure correct handling of memory for objects passed from the cooker to the SDK.

+To use cooking in standalone mode, create an instance of the Foundation object with PxCreateCookingFoundation. You should pass the same foundation object to all instances of the cooking interface.

+

Parameters:
+ + + + +
[in] version the SDK version number
[in] foundation the foundation object associated with this instance of the cooking interface.
[in] params the parameters for this instance of the cooking interface
+
+
Returns:
true on success.
+ +
+

+ +

+
+ + + + + + + + + +
PX_DEPRECATED PX_FORCE_INLINE PxU32 PxGetGaussMapVertexLimitForPlatform (PxPlatform::Enum  targetPlatform  ) 
+
+
+ +

+ +

References PxPlatform::eARM, PxPlatform::ePC, and PX_ASSERT_WITH_MESSAGE.

+ +

Referenced by PxCookingParams::PxCookingParams().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE PxTriangleMeshDesc::PxTriangleMeshDesc (  )  [inherited]
+
+
+ +

+Constructor sets to default. +

+ +

References PxTriangleMeshDesc::setToDefault().

+ +

Referenced by PxTriangleMeshDesc::setToDefault().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE void PxClothMeshDesc::setToDefault (  )  [inherited]
+
+
+ +

+(re)sets the structure to the default. +

+ +

References PxClothMeshDesc::PxClothMeshDesc().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE void PxTriangleMeshDesc::setToDefault (  )  [inherited]
+
+
+ +

+(re)sets the structure to the default. +

+ +

Reimplemented from PxSimpleTriangleMesh.

+ +

References PxTriangleMeshDesc::PxTriangleMeshDesc().

+ +

Referenced by PxTriangleMeshDesc::PxTriangleMeshDesc().

+ +
+

+ +

+
+ + + + + + + + +
PX_INLINE void PxConvexMeshDesc::setToDefault (  )  [inherited]
+
+
+ +

+(re)sets the structure to the default. +

+ +

References PxConvexMeshDesc::PxConvexMeshDesc().

+ +
+

+

+ +

+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