aboutsummaryrefslogtreecommitdiff
path: root/sdk/toolkit/include/NvBlastTkSerializable.h
blob: 93b9b47eab8a49561c82220cb9e61fc07b63bcd2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
* Copyright (c) 2016-2017, NVIDIA CORPORATION.  All rights reserved.
*
* NVIDIA CORPORATION and its licensors retain all intellectual property
* and proprietary rights in and to this software, 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.
*/

#ifndef NVBLASTTKSERIALIZABLE_H
#define NVBLASTTKSERIALIZABLE_H


#include "NvBlastTkIdentifiable.h"


// Forward declarations
namespace physx
{
namespace general_PxIOStream2
{
class PxFileBuf;
}
}


namespace Nv
{
namespace Blast
{

/**
TkSerializable objects support the serialize interface, and are returned by TkFramework::deserialize.
*/
class TkSerializable : public TkIdentifiable
{
public:
	/**
	Write the object data to the user-defined PxFileBuf stream.

	\param[in]	stream	User-defined stream object.

	\return true if serialization was successful, false otherwise.
	*/
	virtual bool	serialize(physx::general_PxIOStream2::PxFileBuf& stream) const = 0;

	// Data

	/**
	Integer field available to the user.  This data is serialized.
	*/
	uint64_t	userIntData;
};

} // namespace Blast
} // namespace Nv


#endif // ifndef NVBLASTTKSERIALIZABLE_H