NvBlastExtSerialization.h

Go to the documentation of this file.

// 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) 2020 NVIDIA Corporation. All rights reserved.


#pragma once

#include "NvBlastGlobals.h"


namespace Nv
{
namespace Blast
{

class ExtSerialization
{
public:
    struct EncodingID
    {
        enum Enum
        {
            CapnProtoBinary =   NVBLAST_FOURCC('C', 'P', 'N', 'B'),
            RawBinary =         NVBLAST_FOURCC('R', 'A', 'W', ' '),
        };
    };

    class BufferProvider
    {
    public:
        virtual void*   requestBuffer(size_t size) = 0;
    };

    virtual bool        setSerializationEncoding(uint32_t encodingID) = 0;

    virtual uint32_t    getSerializationEncoding() const = 0;

    virtual void        setBufferProvider(BufferProvider* bufferProvider) = 0;

    virtual bool        peekHeader(uint32_t* objectTypeID, uint32_t* encodingID, uint64_t* dataSize, const void* buffer, uint64_t bufferSize) = 0;

    virtual const void* skipObject(uint64_t& bufferSize, const void* buffer) = 0;

    virtual void*       deserializeFromBuffer(const void* buffer, uint64_t bufferSize, uint32_t* objectTypeIDPtr = nullptr) = 0;

    virtual uint64_t    serializeIntoBuffer(void*& buffer, const void* object, uint32_t objectTypeID) = 0;

    virtual void        release() = 0;

protected:
    virtual             ~ExtSerialization() {}
};

}   // namespace Blast
}   // namespace Nv



NVBLAST_API Nv::Blast::ExtSerialization*    NvBlastExtSerializationCreate();