Main Page   Class List   Class Members  

  • Main Page
  • User's Guide
  • Modules
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

sdk/extensions/serialization/include/NvBlastExtSerialization.h

Go to the documentation of this file.
00001 // This code contains NVIDIA Confidential Information and is disclosed to you
00002 // under a form of NVIDIA software license agreement provided separately to you.
00003 //
00004 // Notice
00005 // NVIDIA Corporation and its licensors retain all intellectual property and
00006 // proprietary rights in and to this software and related documentation and
00007 // any modifications thereto. Any use, reproduction, disclosure, or
00008 // distribution of this software and related documentation without an express
00009 // license agreement from NVIDIA Corporation is strictly prohibited.
00010 //
00011 // ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
00012 // NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
00013 // THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
00014 // MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
00015 //
00016 // Information and code furnished is believed to be accurate and reliable.
00017 // However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
00018 // information or for any infringement of patents or other rights of third parties that may
00019 // result from its use. No license is granted by implication or otherwise under any patent
00020 // or patent rights of NVIDIA Corporation. Details are subject to change without notice.
00021 // This code supersedes and replaces all information previously supplied.
00022 // NVIDIA Corporation products are not authorized for use as critical
00023 // components in life support devices or systems without express written approval of
00024 // NVIDIA Corporation.
00025 //
00026 // Copyright (c) 2020 NVIDIA Corporation. All rights reserved.
00027 
00028 
00029 #pragma once
00030 
00031 #include "NvBlastGlobals.h"
00032 
00033 
00034 namespace Nv
00035 {
00036 namespace Blast
00037 {
00038 
00042 class ExtSerialization
00043 {
00044 public:
00046     struct EncodingID
00047     {
00048         enum Enum
00049         {
00050             CapnProtoBinary =   NVBLAST_FOURCC('C', 'P', 'N', 'B'),
00051             RawBinary =         NVBLAST_FOURCC('R', 'A', 'W', ' '),
00052         };
00053     };
00054 
00056     class BufferProvider
00057     {
00058     public:
00059         virtual void*   requestBuffer(size_t size) = 0;
00060     };
00061 
00067     virtual bool        setSerializationEncoding(uint32_t encodingID) = 0;
00068 
00075     virtual uint32_t    getSerializationEncoding() const = 0;
00076 
00084     virtual void        setBufferProvider(BufferProvider* bufferProvider) = 0;
00085 
00096     virtual bool        peekHeader(uint32_t* objectTypeID, uint32_t* encodingID, uint64_t* dataSize, const void* buffer, uint64_t bufferSize) = 0;
00097 
00106     virtual const void* skipObject(uint64_t& bufferSize, const void* buffer) = 0;
00107 
00118     virtual void*       deserializeFromBuffer(const void* buffer, uint64_t bufferSize, uint32_t* objectTypeIDPtr = nullptr) = 0;
00119 
00129     virtual uint64_t    serializeIntoBuffer(void*& buffer, const void* object, uint32_t objectTypeID) = 0;
00130 
00134     virtual void        release() = 0;
00135 
00136 protected:
00140     virtual             ~ExtSerialization() {}
00141 };
00142 
00143 }   // namespace Blast
00144 }   // namespace Nv
00145 
00146 
00148 
00156 NVBLAST_API Nv::Blast::ExtSerialization*    NvBlastExtSerializationCreate();
Copyright © 2015-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com