aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Include/cooking/PxCooking.h
diff options
context:
space:
mode:
authorgit perforce import user <a@b>2016-10-25 12:29:14 -0600
committerSheikh Dawood Abdul Ajees <Sheikh Dawood Abdul Ajees>2016-10-25 18:56:37 -0500
commit3dfe2108cfab31ba3ee5527e217d0d8e99a51162 (patch)
treefa6485c169e50d7415a651bf838f5bcd0fd3bfbd /PhysX_3.4/Include/cooking/PxCooking.h
downloadphysx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.tar.xz
physx-3.4-3dfe2108cfab31ba3ee5527e217d0d8e99a51162.zip
Initial commit:
PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167]
Diffstat (limited to 'PhysX_3.4/Include/cooking/PxCooking.h')
-rw-r--r--PhysX_3.4/Include/cooking/PxCooking.h628
1 files changed, 628 insertions, 0 deletions
diff --git a/PhysX_3.4/Include/cooking/PxCooking.h b/PhysX_3.4/Include/cooking/PxCooking.h
new file mode 100644
index 00000000..4d635cf6
--- /dev/null
+++ b/PhysX_3.4/Include/cooking/PxCooking.h
@@ -0,0 +1,628 @@
+// 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-2016 NVIDIA Corporation. All rights reserved.
+// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
+// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.
+
+
+#ifndef PX_COOKING_H
+#define PX_COOKING_H
+/** \addtogroup cooking
+@{
+*/
+#include "common/PxPhysXCommonConfig.h"
+#include "common/PxTolerancesScale.h"
+#include "cooking/Pxc.h"
+
+#include "cooking/PxConvexMeshDesc.h"
+#include "cooking/PxTriangleMeshDesc.h"
+#include "cooking/PxMidphaseDesc.h"
+#include "geometry/PxTriangleMesh.h"
+
+#if !PX_DOXYGEN
+namespace physx
+{
+#endif
+
+class PxBinaryConverter;
+class PxPhysicsInsertionCallback;
+class PxFoundation;
+
+struct PX_DEPRECATED PxPlatform
+{
+ enum Enum
+ {
+ ePC,
+ eARM
+ };
+};
+
+PX_DEPRECATED PX_FORCE_INLINE PxU32 PxGetGaussMapVertexLimitForPlatform(PxPlatform::Enum targetPlatform)
+{
+ PX_ASSERT_WITH_MESSAGE( (targetPlatform >= PxPlatform::ePC) &&
+ (targetPlatform <= PxPlatform::eARM),
+ "Unexpected platform in PxGetGaussMapVertexLimitForPlatform");
+
+ PxU32 limit = 0;
+ switch(targetPlatform)
+ {
+ case PxPlatform::ePC:
+ limit = 32; break;
+ case PxPlatform::eARM:
+ limit = 32; break;
+ }
+ return limit;
+}
+
+/**
+\brief Result from convex cooking.
+*/
+struct PxConvexMeshCookingResult
+{
+ enum Enum
+ {
+ /**
+ \brief Convex mesh cooking succeeded.
+ */
+ eSUCCESS,
+
+ /**
+ \brief Convex mesh cooking failed, algorithm couldn't find 4 initial vertices without a small triangle.
+
+ @see PxCookingParams::areaTestEpsilon PxConvexFlag::eCHECK_ZERO_AREA_TRIANGLES
+ */
+ eZERO_AREA_TEST_FAILED,
+
+ /**
+ \brief Convex mesh cooking succeeded, but the algorithm has reached the 255 polygons limit.
+ The produced hull does not contain all input vertices. Try to simplify the input vertices
+ or try to use the eINFLATE_CONVEX or the eQUANTIZE_INPUT flags.
+
+ @see PxConvexFlag::eINFLATE_CONVEX PxConvexFlag::eQUANTIZE_INPUT
+ */
+ ePOLYGONS_LIMIT_REACHED,
+
+ /**
+ \brief Something unrecoverable happened. Check the error stream to find out what.
+ */
+ eFAILURE
+ };
+};
+
+/** \brief Enumeration for convex mesh cooking algorithms. */
+struct PxConvexMeshCookingType
+{
+ enum Enum
+ {
+ /**
+ \brief Legacy incremental algorithm using the inflation skinWidth parameter.
+
+ The algorithm produces a hull with inflated planes. The hull's vertices are not the input vertices;
+ new vertices are created from the inflated plane's intersections.
+
+ \note This algorithm is less stable and produces worse results than eQUICK_HULL; it is recommended to use
+ the eQUICKHULL algorithm.
+
+ \note This legacy algorithm will be removed in future releases.
+
+ */
+ eINFLATION_INCREMENTAL_HULL PX_DEPRECATED = 0,
+
+ /**
+ \brief The Quickhull algorithm constructs the hull from the given input points. The resulting hull
+ will only contain a subset of the input points.
+
+ */
+ eQUICKHULL
+ };
+};
+
+/**
+\brief Result from triangle mesh cooking
+*/
+struct PxTriangleMeshCookingResult
+{
+ enum Enum
+ {
+ /**
+ \brief Everything is A-OK.
+ */
+ eSUCCESS = 0,
+
+ /**
+ \brief a triangle is too large for well-conditioned results. Tessellate the mesh for better behavior, see the user guide section on cooking for more details.
+ */
+ eLARGE_TRIANGLE,
+
+ /**
+ \brief Something unrecoverable happened. Check the error stream to find out what.
+ */
+ eFAILURE
+ };
+};
+
+/**
+
+\brief Enum for the set of mesh pre-processing parameters.
+
+*/
+
+struct PxMeshPreprocessingFlag
+{
+ enum Enum
+ {
+ /**
+ \brief When set, mesh welding is performed. See PxCookingParams::meshWeldTolerance. Clean mesh must be enabled.
+ */
+ eWELD_VERTICES = 1 << 0,
+
+ /**
+ \brief When set, mesh cleaning is disabled. This makes cooking faster.
+
+ When clean mesh is not performed, mesh welding is also not performed.
+
+ It is recommended to use only meshes that passed during validateTriangleMesh.
+
+ */
+ eDISABLE_CLEAN_MESH = 1 << 1,
+
+ /**
+ \brief When set, active edges are set for each triangle edge. This makes cooking faster but slow up contact generation.
+ */
+ eDISABLE_ACTIVE_EDGES_PRECOMPUTE = 1 << 2,
+
+ /**
+ \brief When set, 32-bit indices will always be created regardless of triangle count.
+
+ \note By default mesh will be created with 16-bit indices for triangle count <= 0xFFFF and 32-bit otherwise.
+ */
+ eFORCE_32BIT_INDICES = 1 << 3
+ };
+};
+
+typedef PxFlags<PxMeshPreprocessingFlag::Enum,PxU32> PxMeshPreprocessingFlags;
+
+/**
+
+\brief Structure describing parameters affecting mesh cooking.
+
+@see PxSetCookingParams() PxGetCookingParams()
+*/
+struct PxCookingParams
+{
+ /**
+ \brief Target platform
+
+ Should be set to the platform which you intend to load the cooked mesh data on. This allows
+ the SDK to optimize the mesh data in an appropriate way for the platform and make sure that
+ endianness issues are accounted for correctly.
+
+ <b>Default value:</b> Same as the platform on which the SDK is running.
+ */
+ PxPlatform::Enum targetPlatform;
+ /**
+ \brief Skin width for convexes.
+
+ Specifies the amount to inflate the convex mesh when the inflation algorithm is used.
+
+ The value is used for moving planes outward, and beveling sharp edges. This helps the hull generator
+ code produce more stable convexes for collision detection. Please note that the resulting hull will
+ increase its size, so contact generation may produce noticeable separation between shapes. The separation
+ distance can be reduced by decreasing the contactOffset and restOffset. See the user's manual on
+ 'Shapes - Tuning Shape Collision Behavior' for details.
+
+ Change the value if the produced hulls are too thin or improper for your usage. Increasing the value
+ too much will result in incorrect hull size and a large separation between shapes.
+
+ \note skinWidth is only used when PxConvexMeshCookingType::eINFLATION_INCREMENTAL_HULL is enabled.
+
+ @see PxConvexMeshCookingType PxConvexFlag::eINFLATE_CONVEX
+
+ <b>Default value:</b> 0.025f*PxTolerancesScale.length
+
+ <b>Range:</b> (0.0f, PX_MAX_F32)
+ */
+ PX_DEPRECATED float skinWidth;
+
+ /**
+ \brief Zero-size area epsilon used in convex hull computation.
+
+ If the area of a triangle of the hull is below this value, the triangle will be rejected. This test
+ is done only if PxConvexFlag::eCHECK_ZERO_AREA_TRIANGLES is used.
+
+ @see PxConvexFlag::eCHECK_ZERO_AREA_TRIANGLES
+
+ <b>Default value:</b> 0.06f*PxTolerancesScale.length*PxTolerancesScale.length
+
+ <b>Range:</b> (0.0f, PX_MAX_F32)
+ */
+ float areaTestEpsilon;
+
+ /**
+ \brief Convex hull creation algorithm.
+
+ <b>Default value:</b> PxConvexMeshCookingType::eQUICKHULL
+
+ @see PxConvexMeshCookingType
+ */
+ PxConvexMeshCookingType::Enum convexMeshCookingType;
+
+ /**
+ \brief When true, the face remap table is not created. This saves a significant amount of memory, but the SDK will
+ not be able to provide the remap information for internal mesh triangles returned by collisions,
+ sweeps or raycasts hits.
+
+ <b>Default value:</b> false
+ */
+ bool suppressTriangleMeshRemapTable;
+
+ /**
+ \brief When true, the triangle adjacency information is created. You can get the adjacency triangles
+ for a given triangle from getTriangle.
+
+ <b>Default value:</b> false
+ */
+ bool buildTriangleAdjacencies;
+
+ /**
+ \brief When true, addigional information required for GPU-accelerated rigid body simulation is created. This can increase memory usage and cooking times for convex meshes and triangle meshes.
+
+ <b>Default value:</b> false
+ */
+ bool buildGPUData;
+
+ /**
+ \brief Tolerance scale is used to check if cooked triangles are not too huge. This check will help with simulation stability.
+
+ \note The PxTolerancesScale values have to match the values used when creating a PxPhysics or PxScene instance.
+
+ @see PxTolerancesScale
+ */
+ PxTolerancesScale scale;
+
+ /**
+ \brief Mesh pre-processing parameters. Used to control options like whether the mesh cooking performs vertex welding before cooking.
+
+ <b>Default value:</b> 0
+ */
+ PxMeshPreprocessingFlags meshPreprocessParams;
+
+ /**
+ \brief Mesh cooking hint. Used to specify mesh hierarchy construction preference.
+
+ \note Deprecated in 3.4, parameter moved to PxBVH33MidphaseDesc.
+
+ @see PxBVH33MidphaseDesc, PxMidphaseDescUnion
+
+ <b>Default value:</b> PxMeshCookingHint::eSIM_PERFORMANCE
+ */
+ PX_DEPRECATED PxMeshCookingHint::Enum meshCookingHint;
+
+ /**
+ \brief Controls the trade-off between mesh size and runtime performance.
+
+ Using a value of 1.0 will produce a larger cooked mesh with generally higher runtime performance,
+ using 0.0 will produce a smaller cooked mesh, with generally lower runtime performance.
+
+ Values outside of [0,1] range will be clamped and cause a warning when any mesh gets cooked.
+
+ \note Deprecated in 3.4, parameter moved to PxBVH33MidphaseDesc.
+
+ <b>Default value:</b> 0.55
+ <b>Range:</b> [0.0f, 1.0f]
+ */
+ PX_DEPRECATED PxF32 meshSizePerformanceTradeOff;
+
+ /**
+ \brief Mesh weld tolerance. If mesh welding is enabled, this controls the distance at which vertices are welded.
+ If mesh welding is not enabled, this value defines the acceptance distance for mesh validation. Provided no two vertices are within this distance, the mesh is considered to be
+ clean. If not, a warning will be emitted. Having a clean, welded mesh is required to achieve the best possible performance.
+
+ The default vertex welding uses a snap-to-grid approach. This approach effectively truncates each vertex to integer values using meshWeldTolerance.
+ Once these snapped vertices are produced, all vertices that snap to a given vertex on the grid are remapped to reference a single vertex. Following this,
+ all triangles' indices are remapped to reference this subset of clean vertices. It should be noted that the vertices that we do not alter the
+ position of the vertices; the snap-to-grid is only performed to identify nearby vertices.
+
+ The mesh validation approach also uses the same snap-to-grid approach to identify nearby vertices. If more than one vertex snaps to a given grid coordinate,
+ we ensure that the distance between the vertices is at least meshWeldTolerance. If this is not the case, a warning is emitted.
+
+ <b>Default value:</b> 0.0
+ */
+ PxReal meshWeldTolerance;
+
+ /**
+ \brief Controls the desired midphase desc structure for triangle meshes.
+
+ \note If PxMeshMidPhase::eINVALID is used, the default PxMeshMidPhase::eBVH33 is used and the deprecated parameters PxCookingParams::meshCookingHint and
+ PxCookingParams::meshSizePerformanceTradeOff are used.
+
+ @see PxBVH33MidphaseDesc, PxBVH34MidphaseDesc, PxMidphaseDesc
+
+ <b>Default value:</b> PxMeshMidPhase::eINVALID
+ */
+ PxMidphaseDesc midphaseDesc;
+
+ /**
+ \brief Vertex limit beyond which additional acceleration structures are computed for each convex mesh. Increase that limit to reduce memory usage.
+ Computing the extra structures all the time does not guarantee optimal performance. There is a per-platform break-even point below which the
+ extra structures actually hurt performance.
+
+ <b>Default value:</b> 32
+ */
+ PxU32 gaussMapLimit;
+
+ PxCookingParams(const PxTolerancesScale& sc):
+ skinWidth (0.025f*sc.length),
+ areaTestEpsilon (0.06f*sc.length*sc.length),
+ convexMeshCookingType (PxConvexMeshCookingType::eQUICKHULL),
+ suppressTriangleMeshRemapTable (false),
+ buildTriangleAdjacencies (false),
+ buildGPUData (false),
+ scale (sc),
+ meshPreprocessParams (0),
+ meshCookingHint (PxMeshCookingHint::eSIM_PERFORMANCE),
+ meshSizePerformanceTradeOff (0.55f),
+ meshWeldTolerance (0.f)
+ {
+#if PX_INTEL_FAMILY
+ targetPlatform = PxPlatform::ePC;
+#elif PX_ARM_FAMILY
+ targetPlatform = PxPlatform::eARM;
+#else
+#error Unknown platform
+#endif
+ gaussMapLimit = PxGetGaussMapVertexLimitForPlatform(targetPlatform);
+ }
+};
+
+class PxCooking
+{
+public:
+ /**
+ \brief Closes this instance of the interface.
+
+ This function should be called to cleanly shut down the Cooking library before application exit.
+
+ \note This function is required to be called to release foundation usage.
+
+ */
+ virtual void release() = 0;
+
+ /**
+ \brief Sets cooking parameters
+
+ \param[in] params Cooking parameters
+
+ @see getParams()
+ */
+ virtual void setParams(const PxCookingParams& params) = 0;
+
+ /**
+ \brief Gets cooking parameters
+
+ \return Current cooking parameters.
+
+ @see PxCookingParams setParams()
+ */
+ virtual const PxCookingParams& getParams() = 0;
+
+ /**
+ \brief Checks endianness is the same between cooking & target platforms
+
+ \return True if there is and endian mismatch.
+ */
+ virtual bool platformMismatch() = 0;
+
+ /**
+ \brief Cooks a triangle mesh. The results are written to the stream.
+
+ To create a triangle mesh object it is necessary to first 'cook' the mesh data into
+ a form which allows the SDK to perform efficient collision detection.
+
+ cookTriangleMesh() allows a mesh description to be cooked into a binary stream
+ suitable for loading and performing collision detection at runtime.
+
+ Example
+
+ \include PxCookTriangleMesh_Example.cpp
+
+ \param[in] desc The triangle mesh descriptor to read the mesh from.
+ \param[in] stream User stream to output the cooked data.
+ \param[out] condition Result from triangle mesh cooking.
+ \return true on success
+
+ @see cookConvexMesh() setParams() PxPhysics.createTriangleMesh() PxTriangleMeshCookingResult::Enum
+ */
+ virtual bool cookTriangleMesh(const PxTriangleMeshDesc& desc, PxOutputStream& stream, PxTriangleMeshCookingResult::Enum* condition = NULL) = 0;
+
+ /**
+ \brief Cooks and creates a triangle mesh and inserts it into PxPhysics.
+
+ \note PxPhysicsInsertionCallback can be obtained through PxPhysics::getPhysicsInsertionCallback().
+
+ \param[in] desc The triangle mesh descriptor to read the mesh from.
+ \param[in] insertionCallback The insertion interface from PxPhysics.
+ \return PxTriangleMesh pointer on success.
+
+ @see cookTriangleMesh() setParams() PxPhysics.createTriangleMesh() PxPhysicsInsertionCallback
+ */
+ virtual PxTriangleMesh* createTriangleMesh(const PxTriangleMeshDesc& desc, PxPhysicsInsertionCallback& insertionCallback) = 0;
+
+ /**
+ \brief Verifies if the triangle mesh is valid. Prints an error message for each inconsistency found.
+
+ The following conditions are true for a valid triangle mesh:
+ 1. There are no duplicate vertices (within specified vertexWeldTolerance. See PxCookingParams::meshWeldTolerance)
+ 2. There are no large triangles (within specified PxTolerancesScale.)
+
+ \param[in] desc The triangle mesh descriptor to read the mesh from.
+
+ \return true if all the validity conditions hold, false otherwise.
+
+ @see cookTriangleMesh()
+ */
+ virtual bool validateTriangleMesh(const PxTriangleMeshDesc& desc) = 0;
+
+ /**
+ \brief Cooks a convex mesh. The results are written to the stream.
+
+ To create a triangle mesh object it is necessary to first 'cook' the mesh data into
+ a form which allows the SDK to perform efficient collision detection.
+
+ cookConvexMesh() allows a mesh description to be cooked into a binary stream
+ suitable for loading and performing collision detection at runtime.
+
+ Example
+
+ \include PxCookConvexMesh_Example.cpp
+
+ \note The number of vertices and the number of convex polygons in a cooked convex mesh is limited to 255.
+ \note If those limits are exceeded in either the user-provided data or the final cooked mesh, an error is reported.
+
+ \param[in] desc The convex mesh descriptor to read the mesh from.
+ \param[in] stream User stream to output the cooked data.
+ \param[out] condition Result from convex mesh cooking.
+ \return true on success.
+
+ @see cookTriangleMesh() setParams() PxConvexMeshCookingResult::Enum
+ */
+ virtual bool cookConvexMesh(const PxConvexMeshDesc& desc, PxOutputStream& stream, PxConvexMeshCookingResult::Enum* condition = NULL) = 0;
+
+ /**
+ \brief Cooks and creates a convex mesh and inserts it into PxPhysics.
+
+ \note This method does the same as cookConvexMesh, but the produced convex mesh is not stored
+ into a stream but is directly inserted in PxPhysics. Use this method if you are unable to cook offline.
+
+ \note PxPhysicsInsertionCallback can be obtained through PxPhysics::getPhysicsInsertionCallback().
+
+ \param[in] desc The convex mesh descriptor to read the mesh from.
+ \param[in] insertionCallback The insertion interface from PxPhysics.
+ \return PxConvexMesh pointer on success
+
+ @see cookConvexMesh() setParams() PxPhysicsInsertionCallback
+ */
+ virtual PxConvexMesh* createConvexMesh(const PxConvexMeshDesc& desc, PxPhysicsInsertionCallback& insertionCallback) = 0;
+
+ /**
+ \brief Verifies if the convex mesh is valid. Prints an error message for each inconsistency found.
+
+ The convex mesh descriptor must contain an already created convex mesh - the vertices, indices and polygons must be provided.
+
+ \note This function should be used if PxConvexFlag::eDISABLE_MESH_VALIDATION is planned to be used in release builds.
+
+ \param[in] desc The convex mesh descriptor to read the mesh from.
+
+ \return true if all the validity conditions hold, false otherwise.
+
+ @see cookConvexMesh()
+ */
+ virtual bool validateConvexMesh(const PxConvexMeshDesc& desc) = 0;
+
+
+ /**
+ \brief Computed hull polygons from given vertices and triangles. Polygons are needed for PxConvexMeshDesc rather than triangles.
+
+ Please note that the resulting polygons may have different number of vertices. Some vertices may be removed.
+ The output vertices, indices and polygons must be used to construct a hull.
+
+ The provided PxAllocatorCallback does allocate the out array's. It is the user responsibility to deallocated those
+ array's.
+
+ \param[in] mesh Simple triangle mesh containing vertices and triangles used to compute polygons.
+ \param[in] inCallback Memory allocator for out array allocations.
+ \param[out] nbVerts Number of vertices used by polygons.
+ \param[out] vertices Vertices array used by polygons.
+ \param[out] nbIndices Number of indices used by polygons.
+ \param[out] indices Indices array used by polygons.
+ \param[out] nbPolygons Number of created polygons.
+ \param[out] hullPolygons Polygons array.
+ \return true on success
+
+ @see cookConvexMesh() PxConvexFlags PxConvexMeshDesc PxSimpleTriangleMesh
+ */
+ virtual bool computeHullPolygons(const PxSimpleTriangleMesh& mesh, PxAllocatorCallback& inCallback, PxU32& nbVerts, PxVec3*& vertices,
+ PxU32& nbIndices, PxU32*& indices, PxU32& nbPolygons, PxHullPolygon*& hullPolygons) = 0;
+
+ /**
+ \brief Cooks a heightfield. The results are written to the stream.
+
+ To create a heightfield object there is an option to precompute some of calculations done while loading the heightfield data.
+
+ cookHeightField() allows a heightfield description to be cooked into a binary stream
+ suitable for loading and performing collision detection at runtime.
+
+ \param[in] desc The heightfield descriptor to read the HF from.
+ \param[in] stream User stream to output the cooked data.
+ \return true on success
+
+ @see PxPhysics.createHeightField()
+ */
+ virtual bool cookHeightField(const PxHeightFieldDesc& desc, PxOutputStream& stream) = 0;
+
+ /**
+ \brief Cooks and creates a heightfield mesh and inserts it into PxPhysics.
+
+ \param[in] desc The heightfield descriptor to read the HF from.
+ \param[in] insertionCallback The insertion interface from PxPhysics.
+ \return PxHeightField pointer on success
+
+ @see cookConvexMesh() setParams() PxPhysics.createTriangleMesh() PxPhysicsInsertionCallback
+ */
+ virtual PxHeightField* createHeightField(const PxHeightFieldDesc& desc, PxPhysicsInsertionCallback& insertionCallback) = 0;
+
+
+protected:
+ virtual ~PxCooking(){}
+};
+
+#if !PX_DOXYGEN
+} // namespace physx
+#endif
+
+/**
+\brief 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.
+
+\param[in] version the SDK version number
+\param[in] foundation the foundation object associated with this instance of the cooking interface.
+\param[in] params the parameters for this instance of the cooking interface
+\return true on success.
+*/
+PX_C_EXPORT PX_PHYSX_COOKING_API physx::PxCooking* PX_CALL_CONV PxCreateCooking(physx::PxU32 version,
+ physx::PxFoundation& foundation,
+ const physx::PxCookingParams& params);
+
+/** @} */
+#endif