Qt3D job run stats

Add a way to write to a trace.qt3d file stats about the frame jobs

Then use the qt3dprofiler tool to visualize the trace file

This is enabled by defining QT3D_JOBS_RUN_STATS at compile time

Change-Id: I4d2faaf5189cd91ecc88b7ca0ca3e3e1f2f60498
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

1 files changed, 90 insertions, 0 deletions

diff --git a/src/render/jobs/job_common_p.h b/src/render/jobs/job_common_p.h
new file mode 100644
index 000000000..f347036ce
--- /dev/null
+++ b/src/render/jobs/job_common_p.h
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 Paul Lemire
+** 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$
+**
+****************************************************************************/
+
+#ifndef QT3DRENDER_RENDER_JOB_COMMON_P_H
+#define QT3DRENDER_RENDER_JOB_COMMON_P_H
+
+#include <Qt3DCore/private/qaspectjob_p.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+namespace Render {
+
+namespace JobTypes {
+
+    enum JobType {
+        LoadBuffer = 0,
+        FrameCleanup,
+        FramePreparation,
+        CalcBoundingVolume,
+        CalcTriangleVolume,
+        LoadGeometry,
+        LoadScene,
+        LoadTextureData,
+        PickBoundingVolume,
+        RenderView,
+        UpdateTransform,
+        UpdateBoundingVolume
+    };
+
+} // JobTypes
+
+} // Render
+
+} // Qt3DRender
+
+#ifdef QT3D_JOBS_RUN_STATS
+
+#include <Qt3DCore/private/qaspectjob_p.h>
+
+#define SET_JOB_RUN_STAT_TYPE(job, type, instance) \
+    Qt3DCore::QAspectJobPrivate::get(job)->m_stats.jobId.typeAndInstance[0] = type; \
+    Qt3DCore::QAspectJobPrivate::get(job)->m_stats.jobId.typeAndInstance[1] = instance;
+
+#else
+
+#define SET_JOB_RUN_STAT_TYPE(job, type, instance)
+
+#endif
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_RENDER_JOB_COMMON_P_H