121 lines
4.2 KiB
C++
121 lines
4.2 KiB
C++
// 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-2013 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_BINARY_CONVERTER
|
|
#define PX_BINARY_CONVERTER
|
|
/** \addtogroup cooking
|
|
@{
|
|
*/
|
|
|
|
#include "common/PxPhysXCommon.h"
|
|
|
|
#ifndef PX_DOXYGEN
|
|
namespace physx
|
|
{
|
|
#endif
|
|
|
|
class PxInputStream;
|
|
class PxOutputStream;
|
|
|
|
struct PxConverterReportMode
|
|
{
|
|
enum Enum
|
|
{
|
|
eNONE, //!< Silent mode. If enabled, no information is sent to the error stream.
|
|
eNORMAL, //!< Normal mode. If enabled, only important information is sent to the error stream.
|
|
eVERBOSE, //!< Verbose mode. If enabled, detailed information is sent to the error stream.
|
|
};
|
|
};
|
|
|
|
/**
|
|
\brief Binary converter for serialized streams.
|
|
|
|
The binary converter class is targeted at converting binary streams from authoring platforms,
|
|
such as windows, osx or linux to any game runtime platform supported by PhysX. Particularly
|
|
it is currently not supported to run the converter on a platforms that has an endian mismatch
|
|
with the platform corresponding to the source binary file and source meta data.
|
|
|
|
If you want to use multiple threads for batch conversions, please create one instance
|
|
of this class for each thread.
|
|
*/
|
|
class PxBinaryConverter
|
|
{
|
|
protected:
|
|
PxBinaryConverter() {}
|
|
virtual ~PxBinaryConverter() {}
|
|
|
|
public:
|
|
/**
|
|
\brief Releases binary converter
|
|
*/
|
|
virtual void release() = 0;
|
|
|
|
/**
|
|
\brief Sets desired report mode.
|
|
|
|
\param[in] mode Report mode
|
|
*/
|
|
virtual void setReportMode(PxConverterReportMode::Enum mode) = 0;
|
|
|
|
/**
|
|
\brief Setups source and target meta-data streams
|
|
|
|
The source meta data provided needs to have the same endianness as the platform the converter is run on.
|
|
The meta data needs to be set before calling the conversion method.
|
|
|
|
\param[in] srcMetaData Source platform's meta-data stream
|
|
\param[in] dstMetaData Target platform's meta-data stream
|
|
|
|
\return True if success
|
|
*/
|
|
virtual bool setMetaData(PxInputStream& srcMetaData, PxInputStream& dstMetaData) = 0;
|
|
|
|
/**
|
|
\brief Converts binary stream from source platform to target platform
|
|
|
|
The converter needs to be configured with source and destination meta data before calling the conversion method.
|
|
The source meta data needs to correspond to the same platform as the source binary data.
|
|
|
|
\param[in] srcStream Source stream
|
|
\param[in] srcSize Number of bytes to convert
|
|
\param[in] targetStream Target stream
|
|
|
|
\return True if success
|
|
*/
|
|
virtual bool convert(PxInputStream& srcStream, PxU32 srcSize, PxOutputStream& targetStream) = 0;
|
|
};
|
|
|
|
#ifndef PX_DOXYGEN
|
|
} // namespace physx
|
|
#endif
|
|
|
|
/** @} */
|
|
#endif
|