summaryrefslogtreecommitdiffstats
path: root/src/render/jobs/loadtexturedatajob.cpp
blob: b8663e4a7e1f9871fdfe6f63b8e59dde23503779 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/****************************************************************************
**
** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "loadtexturedatajob_p.h"
#include <Qt3DRender/private/nodemanagers_p.h>
#include <Qt3DRender/private/managers_p.h>
#include <Qt3DRender/private/texturedatamanager_p.h>
#include <Qt3DRender/private/qtextureimage_p.h>
#include <Qt3DRender/qtextureimagedata.h>
#include <Qt3DRender/qtexturedata.h>
#include <QThread>
#include <Qt3DRender/private/job_common_p.h>
#include <Qt3DRender/private/qtextureimagedata_p.h>

QT_BEGIN_NAMESPACE

namespace Qt3DRender {
namespace Render {

namespace {

typedef QPair<HTextureData, QTextureImageData *> HandleDataPair;

HandleDataPair textureDataFromGenerator(TextureDataManager *textureDataManager,
                                        QTextureImageDataGeneratorPtr generator)
{
    HTextureData textureDataHandle;
    QTextureImageData *data = nullptr;

    QMutexLocker locker(textureDataManager->mutex());
    // We don't want to take the chance of having two jobs uploading the same functor
    // because of sync issues

    textureDataHandle = textureDataManager->textureDataFromFunctor(generator);

    // Texture data handle isn't null == there's already a matching TextureData
    if (!textureDataHandle.isNull()) {
        data = textureDataManager->data(textureDataHandle);
    } else {
        // Texture data is null -> we need to generate it
        QTextureImageDataPtr dataPtr = generator->operator ()();
        if (dataPtr.isNull()) {
            qCDebug(Jobs) << Q_FUNC_INFO << "Texture has no raw data";
        } else {
            // Save the QTextureImageDataPtr with it's functor as a key
            textureDataHandle = textureDataManager->acquire();
            data = textureDataManager->data(textureDataHandle);
            *data = *(dataPtr.data());
            textureDataManager->addTextureDataForFunctor(textureDataHandle, generator);
        }
    }

    return qMakePair(textureDataHandle, data);
}

void createTextureFromGenerator(TextureDataManager *textureDataManager,
                                Texture *texture)
{
    QTextureGeneratorPtr generator = texture->dataGenerator();
    const QTextureDataPtr generatedData = generator->operator ()();

    // TO DO set the status of the texture based on the status of the functor

    // Use the first QTexImageData loaded to determine the target / mipmaps
    // if not specified

    if (texture->target() != QAbstractTexture::TargetAutomatic)
        qWarning() << "When a texture provides a generator, it's target is expected to be TargetAutomatic";

    texture->setTarget(static_cast<QAbstractTexture::Target>(generatedData->target()));
    texture->setSize(generatedData->width(), generatedData->height(), generatedData->depth());
    texture->setLayers(generatedData->layers());
    texture->setFormat(generatedData->format());

    // Note: These texture data handles aren't associated with a QTextureImageDataGenerator
    // and will therefore be destroyed when the Texture element is destroyed or cleaned up
    const QVector<QTextureImageDataPtr> imageData = generatedData->imageData();

    if (imageData.size() > 0) {
        QMutexLocker locker(textureDataManager->mutex());
        // We don't want to take the chance of having two jobs uploading the same functor
        // because of sync issues

        // Set the mips level based on the first image if autoMipMapGeneration is disabled
        if (!texture->isAutoMipMapGenerationEnabled())
            texture->setMipLevels(imageData.first()->mipLevels());

        for (QTextureImageDataPtr dataPtr : imageData) {
            HTextureData textureDataHandle = textureDataManager->acquire();
            QTextureImageData *data = textureDataManager->data(textureDataHandle);
            *data = *(dataPtr.data());
            texture->addTextureDataHandle(textureDataHandle);
        }
    }
}

} // anonymous

LoadTextureDataJob::LoadTextureDataJob(Qt3DCore::QNodeId textureId)
    : m_textureId(textureId)
{
    SET_JOB_RUN_STAT_TYPE(this, JobTypes::LoadTextureData, 0);
}

LoadTextureDataJob::~LoadTextureDataJob()
{
}

void LoadTextureDataJob::run()
{
    qCDebug(Jobs) << "Entering" << Q_FUNC_INFO << QThread::currentThread();

    Texture *txt = m_manager->textureManager()->lookupResource(m_textureId);
    TextureDataManager *textureDataManager = m_manager->manager<QTextureImageData, TextureDataManager>();

    if (txt != nullptr) {
        // We need to clear the TextureData handles of the texture in case it was previously
        // loaded with a different functor
        txt->releaseTextureDataHandles();

        // If the texture has a functor we used it to generate embedded TextureImages
        if (txt->dataGenerator())
            createTextureFromGenerator(textureDataManager, txt);

        // Load update each TextureImage
        const auto texImgHandles = txt->textureImages();
        for (HTextureImage texImgHandle : texImgHandles) {
            TextureImage *texImg = m_manager->textureImageManager()->data(texImgHandle);
            if (texImg != nullptr && texImg->isDirty() && !texImg->dataGenerator().isNull()) {
                QTextureImageDataGeneratorPtr generator = texImg->dataGenerator();

                QPair<HTextureData, QTextureImageData *> handleData = textureDataFromGenerator(textureDataManager, generator);

                // If using QTextureImage, notify the frontend of the change in status
                const QImageTextureDataFunctor *imageGenerator = functor_cast<QImageTextureDataFunctor>(generator.data());
                if (imageGenerator)
                    texImg->setStatus(imageGenerator->status());

                HTextureData textureDataHandle = handleData.first;
                QTextureImageData *data = handleData.second;

                // XXX released textureDataManager mutex, do we have a race here?

                // Update HTextureImage Functor to release TextureData when needed
                TextureDataManager *textureDataManager = m_manager->manager<QTextureImageData, TextureDataManager>();
                textureDataManager->assignFunctorToTextureImage(generator, texImgHandle);

                // Set texture size of texture if the first layer / level / face has a valid size
                // otherwise assume the size was set on the texture itself
                if (texImg->layer() == 0 && texImg->mipLevel() == 0 &&
                        texImg->face() == QAbstractTexture::CubeMapPositiveX) {

                    if (data == nullptr) {
                        qWarning() << "Texture data is null, texture data failed to load";
                    } else {
                        // Set the size of the texture based on the layer 0 / level 0
                        // if the functor provides something valid. Otherwise we assume the texture
                        // already has the correct size
                        if (data->width() != -1 && data->height() != -1 && data->depth() != -1) {
                            txt->setSize(data->width(), data->height(), data->depth());
                        }
                        // Set the format of the texture if the texture format is set to Automatic
                        if (txt->format() == QAbstractTexture::Automatic) {
                            txt->setFormat(static_cast<QAbstractTexture::TextureFormat>(data->format()));
                        }
                    }
                }
                // Set the textureDataHandle on the texture image
                // Note: this internally updates the DNA of the TextureImage
                texImg->setTextureDataHandle(textureDataHandle);
                if (data)
                    texImg->updateDNA(::qHash(QTextureImageDataPrivate::get(data)->m_data));
            }
        }
        // Tell the renderer to reload/upload to GPU the TextureImage for the Texture
        // next frame
        txt->requestTextureDataUpdate();
    }
}

} // namespace Render
} // namespace Qt3DRender

QT_END_NAMESPACE