summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/foundation/SerializationTypes.h
blob: c7fe5ce73a3eaa6f24f12d80aeb2dc79fc81ee7c (plain)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#pragma once
#ifndef QT3DS_RENDER_SERIALIZATION_TYPES_H
#define QT3DS_RENDER_SERIALIZATION_TYPES_H
#include "EASTL/hash_map.h"
#include "foundation/Qt3DSDataRef.h"
#include "foundation/Qt3DSMemoryBuffer.h"
#include "foundation/Qt3DSContainers.h"

namespace qt3ds {
namespace foundation {

    struct SStrRemapMap : public nvhash_map<char8_t *, QT3DSU32>
    {
        typedef nvhash_map<char8_t *, QT3DSU32> TBaseType;
        SStrRemapMap(NVAllocatorCallback &inAlloc, const char *inName)
            : TBaseType(inAlloc, inName)
        {
        }
    };

    struct SPtrOffsetMap : public nvhash_map<const void *, QT3DSU32>
    {
        typedef nvhash_map<const void *, QT3DSU32> TBaseType;
        SPtrOffsetMap(NVAllocatorCallback &inAlloc, const char *inName)
            : TBaseType(inAlloc, inName)
        {
        }
    };

    struct SWriteBuffer : public MemoryBuffer<>
    {
        SWriteBuffer(NVAllocatorCallback &inAlloc, const char *inName)
            : MemoryBuffer<>(ForwardingAllocator(inAlloc, inName))
        {
        }
    };

    // Simple data reader that mimics a string
    struct SDataReader
    {
        QT3DSU8 *m_CurrentPtr;
        QT3DSU8 *m_EndPtr;
        SDataReader(QT3DSU8 *inStartPtr, QT3DSU8 *inEndPtr)
            : m_CurrentPtr(inStartPtr)
            , m_EndPtr(inEndPtr)
        {
        }

        template <typename TDataType>
        TDataType *Load()
        {
            if ((m_CurrentPtr + sizeof(TDataType)) > m_EndPtr) {
                QT3DS_ASSERT(false);
                return NULL;
            }
            TDataType *theType = reinterpret_cast<TDataType *>(m_CurrentPtr);
            m_CurrentPtr += sizeof(TDataType);
            return theType;
        }

        template <typename TDataType>
        void MemCopy(TDataType *dt, QT3DSU32 count)
        {
            if (count) {
                QT3DSU32 loadSize = count * sizeof(TDataType);
                QT3DSU32 amountLeft = (QT3DSU32)(m_EndPtr - m_CurrentPtr);
                QT3DSU32 amountLoaded = NVMin(loadSize, amountLeft);
                memCopy(dt, m_CurrentPtr, amountLoaded);
                m_CurrentPtr += amountLoaded;
                if (amountLoaded < loadSize) {
                    QT3DS_ASSERT(false);
                    QT3DSU8 *rawPtr = (QT3DSU8 *)dt;
                    rawPtr += amountLoaded;
                    size_t leftover = loadSize - amountLoaded;
                    // zeroing things out at least is an attempt to provide ordered
                    // data that may prevent a crash in some cases.
                    memZero(rawPtr, (QT3DSU32)leftover);
                }
            }
        }

        // Don't make a habit of using this a lot.
        template <typename TDataType>
        TDataType &LoadRef()
        {
            TDataType *retval = Load<TDataType>();
            if (!retval)
                QT3DS_ASSERT(false);
            return *retval;
        }

        void Align(size_t alignment)
        {
            size_t offset = (size_t)(m_CurrentPtr);
            if (offset % alignment)
                m_CurrentPtr += (alignment - (offset % alignment));
        }

        void Align() { Align(sizeof(void *)); }
    };
}
}
#endif