physx::Sn::ConvX Class Reference

Inheritance diagram for physx::Sn::ConvX:

Collaboration diagram for physx::Sn::ConvX:

Public Member Functions
virtual void	release ()
	Releases binary converter.
virtual void	setReportMode (PxConverterReportMode::Enum mode)
	Sets desired report mode.
PX_FORCE_INLINE bool	silentMode () const
PX_FORCE_INLINE bool	verboseMode () const
virtual bool	setMetaData (PxInputStream &srcMetaData, PxInputStream &dstMetaData)
	Setups source and target meta-data streams.
virtual bool	compareMetaData () const
	Test utility function to compare two sets of meta data.
virtual bool	convert (PxInputStream &srcStream, PxU32 srcSize, PxOutputStream &targetStream)
	Converts binary stream from source platform to target platform.
Public Member Functions inherited from physx::PxUserAllocated
PX_INLINE void *	operator new (size_t, void *address)
PX_INLINE void	operator delete (void *, void *)
template<typename Alloc >
PX_INLINE void *	operator new (size_t size, Alloc alloc, const char *fileName, int line)
template<typename Alloc >
PX_INLINE void *	operator new (size_t size, size_t, Alloc alloc, const char *fileName, int line)
template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, Alloc alloc, const char *fileName, int line)
template<typename Alloc >
PX_INLINE void *	operator new[] (size_t size, size_t, Alloc alloc, const char *fileName, int line)
template<typename Alloc >
PX_INLINE void	operator delete (void *ptr, Alloc alloc, const char *fileName, int line)
template<typename Alloc >
PX_INLINE void	operator delete[] (void *ptr, Alloc alloc, const char *fileName, int line)
PX_INLINE void	operator delete (void *ptr)
PX_INLINE void	operator delete[] (void *ptr)

Friends
class	MetaData
struct	MetaClass

Member Function Documentation

compareMetaData()

bool Sn::ConvX::compareMetaData ( ) const

virtual

Test utility function to compare two sets of meta data.

The meta data needs to be set before calling the compareMetaData method. This method will issue PxErrorCode::eDEBUG_INFO messages if mismatches are encountered.

Returns

True if meta data is equivalend

Implements physx::PxBinaryConverter.

convert()

bool Sn::ConvX::convert ( PxInputStream &  srcStream, PxU32  srcSize, PxOutputStream &  targetStream  )

virtual

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.

Parameters

[in]	srcStream	Source stream
[in]	srcSize	Number of bytes to convert
[in]	targetStream	Target stream

Returns

True if success

Implements physx::PxBinaryConverter.

release()

void Sn::ConvX::release ( )

virtual

Releases binary converter.

Implements physx::PxBinaryConverter.

setMetaData()

bool Sn::ConvX::setMetaData ( PxInputStream &  srcMetaData, PxInputStream &  dstMetaData  )

virtual

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.

Parameters

[in]	srcMetaData	Source platform's meta-data stream
[in]	dstMetaData	Target platform's meta-data stream

Returns

True if success

See also

PxSerialization::dumpBinaryMetaData

Implements physx::PxBinaryConverter.

setReportMode()

virtual void physx::Sn::ConvX::setReportMode ( PxConverterReportMode::Enum  mode )

inlinevirtual

Sets desired report mode.

Parameters

[in]

mode

Report mode

Implements physx::PxBinaryConverter.

---

The documentation for this class was generated from the following files:

• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX.h
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_Align.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_Convert.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_Error.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_MetaData.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_Output.cpp
• RavEngine/deps/physx/physx/source/physxextensions/src/serialization/Binary/SnConvX_Union.cpp