hkNativePackfileUtils.h
上传用户:yisoukefu
上传日期:2020-08-09
资源大小:39506k
文件大小:4k
源码类别:

其他游戏

开发平台:

Visual C++

  1. /* 
  2.  * 
  3.  * Confidential Information of Telekinesys Research Limited (t/a Havok). Not for disclosure or distribution without Havok's
  4.  * prior written consent. This software contains code, techniques and know-how which is confidential and proprietary to Havok.
  5.  * Level 2 and Level 3 source code contains trade secrets of Havok. Havok Software (C) Copyright 1999-2009 Telekinesys Research Limited t/a Havok. All Rights Reserved. Use of this software is subject to the terms of an end user license agreement.
  6.  * 
  7.  */
  8. #ifndef HK_NATIVE_PACKFILE_UTILS_H
  9. #define HK_NATIVE_PACKFILE_UTILS_H
  10. #include <Common/Serialize/hkSerialize.h>
  11. #include <Common/Serialize/Packfile/Binary/hkPackfileHeader.h>
  12. #include <Common/Base/Reflection/Registry/hkTypeInfoRegistry.h>
  13. #include <Common/Serialize/Resource/hkResource.h>
  14. /// The hkNativePackfileUtils functions are designed to work with native
  15. /// packfile and may be used only to load files in one step that do not require
  16. /// any versioning steps.
  17. namespace hkNativePackfileUtils
  18. {
  19. /// Calculates size for memory block in bytes required to store only objects
  20. /// from native packfile. Returns -1 if the packfileData header is invalid.
  21. /// Use validatePackfileHeader to find the exact error.
  22. int HK_CALL getRequiredBufferSize(const void* packfileData, int dataSize);
  23. /// Load buffer from a preallocated memory chunk.
  24. /// Given a native binary packfile that is already in
  25. /// memory, fill in the buffer with objects only, fixup all the pointers,
  26. /// process some objects that require a finishing step (i.e. to initialize
  27. /// members which have not been serialized or to initialize vtables) and
  28. /// return pointer to top level object in the file.
  29. /// If "userRegistry" is not null, apply these finishing steps, otherwise
  30. /// use finish registry from hkBuiltinTypeRegistry.
  31. ///
  32. /// This function does not do any memory allocation and the
  33. /// user must ensure that "outBuffer" remains valid for the lifetime
  34. /// of the packfile.
  35. /// The "packfileData" content is not modified and is not in use when the
  36. /// hkNativePackfileUtils::load is complete.
  37. void* HK_CALL load(const void* packfileData, int dataSize, void* outBuffer, int outBufferSize, const hkTypeInfoRegistry* userRegistry = HK_NULL);
  38. /// Get the imports/exports a loaded packfile.
  39. void HK_CALL getImportsExports(void* loadedBuffer, hkArray<hkResource::Export>& expOut, hkArray<hkResource::Import>& impOut );
  40. /// Unload objects in the buffer previously loaded with the hkNativePackfileUtils::load
  41. /// function, cleanup and destruct objects to prevent memory leaks. 
  42. /// This function must be called when the packfile lifetime is finished.
  43. /// The "buffer" content is not in use when the hkNativePackfileUtils::unload is
  44. /// complete, and it can be released.
  45. void HK_CALL unload(void* loadedBuffer, int bufferSize);
  46. /// Check that the header is valid. If errOut is not null, a more detailed
  47. /// description is written on failure.
  48. hkResult validatePackfileHeader(const void* packfileData, const char**errOut );
  49. }
  50. #endif // HK_NATIVE_PACKFILE_UTILS_H
  51. /*
  52. * Havok SDK - NO SOURCE PC DOWNLOAD, BUILD(#20090216)
  53. * Confidential Information of Havok.  (C) Copyright 1999-2009
  54. * Telekinesys Research Limited t/a Havok. All Rights Reserved. The Havok
  55. * Logo, and the Havok buzzsaw logo are trademarks of Havok.  Title, ownership
  56. * rights, and intellectual property rights in the Havok software remain in
  57. * Havok and/or its suppliers.
  58. * Use of this software for evaluation purposes is subject to and indicates
  59. * acceptance of the End User licence Agreement for this product. A copy of
  60. * the license is included with this software and is also available at www.havok.com/tryhavok.
  61. */