| 1 | // Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB). |
|---|
| 2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only |
|---|
| 3 | |
|---|
| 4 | #include "qfrustumculling.h" |
|---|
| 5 | |
|---|
| 6 | QT_BEGIN_NAMESPACE |
|---|
| 7 | |
|---|
| 8 | namespace Qt3DRender { |
|---|
| 9 | /*! |
|---|
| 10 | \class Qt3DRender::QFrustumCulling |
|---|
| 11 | \inmodule Qt3DRender |
|---|
| 12 | \since 5.7 |
|---|
| 13 | \ingroup framegraph |
|---|
| 14 | \brief Enable frustum culling for the FrameGraph. |
|---|
| 15 | |
|---|
| 16 | A QFrustumCulling class enables frustum culling of the drawable entities based on |
|---|
| 17 | the camera view and QGeometry bounds of the entities. If QFrustumCulling is present in |
|---|
| 18 | the FrameGraph, only the entities whose QGeometry bounds intersect with the camera |
|---|
| 19 | frustum, i.e. the view of the camera, are drawn. If QFrustumCulling is not present, |
|---|
| 20 | all drawable entities will be drawn. The camera is selected by a QCameraSelector |
|---|
| 21 | frame graph node in the current hierarchy. Frustum culling can save a lot of GPU |
|---|
| 22 | processing time when the rendered scene is complex. |
|---|
| 23 | |
|---|
| 24 | \sa QCameraSelector |
|---|
| 25 | */ |
|---|
| 26 | |
|---|
| 27 | /*! |
|---|
| 28 | \qmltype FrustumCulling |
|---|
| 29 | \inqmlmodule Qt3D.Render |
|---|
| 30 | \instantiates Qt3DRender::QFrustumCulling |
|---|
| 31 | \inherits FrameGraphNode |
|---|
| 32 | \since 5.7 |
|---|
| 33 | \brief Enable frustum culling for the FrameGraph. |
|---|
| 34 | |
|---|
| 35 | A FrustumCulling type enables frustum culling of the drawable entities based on |
|---|
| 36 | the camera view and Geometry bounds of the entities. If FrustumCulling is present in |
|---|
| 37 | the FrameGraph, only the entities whose Geometry bounds intersect with the camera |
|---|
| 38 | frustum, i.e. the view of the camera, are drawn. If FrustumCulling is not present, |
|---|
| 39 | all drawable entities will be drawn. The camera is selected by a CameraSelector |
|---|
| 40 | frame graph node in the current hierarchy. Frustum culling can save a lot of GPU |
|---|
| 41 | processing time when the rendered scene is complex. |
|---|
| 42 | |
|---|
| 43 | \sa CameraSelector |
|---|
| 44 | */ |
|---|
| 45 | |
|---|
| 46 | /*! |
|---|
| 47 | The constructor creates an instance with the specified \a parent. |
|---|
| 48 | */ |
|---|
| 49 | QFrustumCulling::QFrustumCulling(Qt3DCore::QNode *parent) |
|---|
| 50 | : QFrameGraphNode(parent) |
|---|
| 51 | { |
|---|
| 52 | } |
|---|
| 53 | |
|---|
| 54 | /*! \internal */ |
|---|
| 55 | QFrustumCulling::~QFrustumCulling() |
|---|
| 56 | { |
|---|
| 57 | } |
|---|
| 58 | |
|---|
| 59 | } // Qt3DRender |
|---|
| 60 | |
|---|
| 61 | QT_END_NAMESPACE |
|---|
| 62 | |
|---|
| 63 | #include "moc_qfrustumculling.cpp" |
|---|
| 64 | |
|---|
| 65 | |
|---|
