qt-everywhere-src-5.15.1/qtquick3d/src/runtimerender/qssgrenderthreadpool_p.h

/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Quick 3D.
**
** $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$
**
****************************************************************************/

#ifndef QSSG_RENDER_THREAD_POOL_H
#define QSSG_RENDER_THREAD_POOL_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtQuick3DRuntimeRender/private/qtquick3druntimerenderglobal_p.h>

#include <QtCore/QSharedPointer>

QT_BEGIN_NAMESPACE

using QSSGTaskCallback = void (*)(void *);

enum class TaskStates
{
    UnknownTask = 0,
    Queued,
    Running,
};

enum class CancelReturnValues
{
    TaskCanceled = 0,
    TaskRunning,
    TaskNotFound,
};

class Q_QUICK3DRUNTIMERENDER_EXPORT QSSGAbstractThreadPool
{
public:
    QAtomicInt ref;
    virtual ~QSSGAbstractThreadPool();
    // Add a task to be run at some point in the future.
    // Tasks will be run roughly in order they are given.
    // The returned value is a handle that can be used to query
    // details about the task
    // Cancel function will be called if the thread pool is destroyed or
    // of the task gets canceled.
    virtual quint64 addTask(void *inUserData, QSSGTaskCallback inFunction, QSSGTaskCallback inCancelFunction) = 0;
    virtual TaskStates getTaskState(quint64 inTaskId) = 0;
    virtual CancelReturnValues cancelTask(quint64 inTaskId) = 0;

    static QSSGRef<QSSGAbstractThreadPool> createThreadPool(qint32 inNumThreads = 4);
};
QT_END_NAMESPACE
#endif