#84 Add occlusion culling feature

Author: ducphamhong

CMakeProjects.cmake

@@ -9,6 +9,7 @@ if (BUILD_EXAMPLE)
 	subdirs (Samples/DrawPrimitives)
 	subdirs (Samples/Instancing)
 	subdirs (Samples/LuckyDraw)
+	subdirs (Samples/OcclusionQuery)
 	subdirs (Samples/Physics)
 	subdirs (Samples/Sponza)
 	subdirs (Samples/SkinnedMesh)

Projects/Irrlicht/Source/CD3D11Driver.cpp

@@ -611,24 +611,23 @@ namespace irr
 					return;
 
 				bool available = block;
-				GUID tmp;
-				u32 size = sizeof(DWORD);
-				u32 r = 0;
+				UINT64 tmp;
+				u32 size = sizeof(UINT64);
 
 				if (!block)
-					available = (reinterpret_cast<ID3D11Query*>(OcclusionQueries[index].PID)->GetPrivateData(tmp, &size, &r) == S_OK);
+					available = Context->GetData(reinterpret_cast<ID3D11Query*>(OcclusionQueries[index].PID), &tmp, size, 0) == S_OK;
 				else
 				{
 					do
 					{
-						HRESULT hr = reinterpret_cast<ID3D11Query*>(OcclusionQueries[index].PID)->GetPrivateData(tmp, &size, &r);
+						HRESULT hr = Context->GetData(reinterpret_cast<ID3D11Query*>(OcclusionQueries[index].PID), &tmp, size, 0);
 						available = (hr == S_OK);
 						if (hr != S_FALSE)
 							break;
 					} while (!available);
 				}
 				if (available)
-					OcclusionQueries[index].Result = r;
+					OcclusionQueries[index].Result = (u32)tmp;
 			}
 		}
 

Projects/Main/Source/SkylichtEngine.h

@@ -109,6 +109,9 @@ This file is part of the "Skylicht Engine".
 #include "SkinnedInstancing/CRenderSkinnedInstancing.h"
 #include "VertexAnimation/CRenderMeshInstancingVAT.h"
 
+// OcclusionQuery
+#include "OcclusionQuery/COcclusionQuery.h"
+
 // 3D Animation
 #include "Animation/CAnimationManager.h"
 #include "Animation/CAnimationController.h"

Projects/Skylicht/Components/Source/Primitive/CPrimitive.cpp

@@ -233,6 +233,17 @@ namespace Skylicht
 		return m_material;
 	}
 
+	CMesh* CPrimitive::getMesh()
+	{
+		CEntityManager* entityMgr = m_gameObject->getEntityManager();
+
+		CPrimitiveRenderer* renderer = entityMgr->getSystem<CPrimitiveRenderer>();
+		if (renderer)
+			return renderer->getMesh(m_type);
+
+		return NULL;
+	}
+
 	void CPrimitive::setCustomMaterial(CMaterial* material)
 	{
 		if (material)
@@ -245,4 +256,15 @@ namespace Skylicht
 			m_useCustomMaterial = false;
 		}
 	}
+
+	void CPrimitive::setInstancing(bool b)
+	{
+		m_instancing = b;
+		for (CEntity* entity : m_entities)
+		{
+			CPrimiviteData* data = GET_ENTITY_DATA(entity, CPrimiviteData);
+			if (data)
+				data->Instancing = b;
+		}
+	}
 }

Projects/Skylicht/Components/Source/Primitive/CPrimitive.h

@@ -26,6 +26,7 @@ This file is part of the "Skylicht Engine".
 
 #include "CPrimiviteData.h"
 #include "Entity/CEntityHandler.h"
+#include "RenderMesh/CMesh.h"
 
 namespace Skylicht
 {
@@ -68,12 +69,11 @@ namespace Skylicht
 
 		CMaterial* getMaterial();
 
+		CMesh* getMesh();
+
 		void setCustomMaterial(CMaterial* material);
 
-		inline void setInstancing(bool b)
-		{
-			m_instancing = b;
-		}
+		void setInstancing(bool b);
 
 		inline bool isInstancing()
 		{

Projects/Skylicht/Components/Source/Primitive/CPrimitiveRenderer.cpp

@@ -165,6 +165,11 @@ namespace Skylicht
 		}
 	}
 
+	CMesh* CPrimitiveRenderer::getMesh(CPrimiviteData::EPrimitive type)
+	{
+		return m_meshTangent[type];
+	}
+
 	void CPrimitiveRenderer::renderPrimitive(CEntityManager* entityManager,
 		CPrimiviteData** primitives,
 		CMesh* mesh,

Projects/Skylicht/Components/Source/Primitive/CPrimitiveRenderer.h

@@ -56,6 +56,8 @@ namespace Skylicht
 
 		virtual void render(CEntityManager* entityManager);
 
+		CMesh* getMesh(CPrimiviteData::EPrimitive type);
+
 		void renderPrimitive(CEntityManager* entityManager,
 			CPrimiviteData** primitives,
 			CMesh* mesh,

Projects/Skylicht/Engine/Source/Entity/CEntityManager.cpp

@@ -37,6 +37,7 @@ This file is part of the "Skylicht Engine".
 #include "RenderMesh/CSoftwareSkinningSystem.h"
 #include "SkinnedInstancing/CSkinnedMeshRendererInstancing.h"
 #include "SkinnedInstancing/CSkinnedInstanceAnimationSystem.h"
+#include "OcclusionQuery/COcclusionQueryRenderer.h"
 #include "Culling/CVisibleSystem.h"
 #include "Culling/CCullingSystem.h"
 #include "LOD/CLODSystem.h"
@@ -76,6 +77,7 @@ namespace Skylicht
 		addRenderSystem<CSkinnedMeshRenderer>();
 		addRenderSystem<CMeshRendererInstancing>();
 		addRenderSystem<CSkinnedMeshRendererInstancing>();
+		addRenderSystem<COcclusionQueryRenderer>();
 		addRenderSystem<CDebugRenderer>();
 	}
 

Projects/Skylicht/Engine/Source/Entity/IRenderSystem.h

@@ -39,6 +39,7 @@ namespace Skylicht
 		{
 			Sky = 0,
 			Opaque,
+			OcclusionQuery,
 			Transparent,
 			Effect,
 		};

Projects/Skylicht/Engine/Source/OcclusionQuery/COcclusionQuery.cpp

@@ -0,0 +1,54 @@
+/*
+!@
+MIT License
+
+Copyright (c) 2020 Skylicht Technology CO., LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This file is part of the "Skylicht Engine".
+https://github.com/skylicht-lab/skylicht-engine
+!#
+*/
+
+#include "pch.h"
+#include "COcclusionQuery.h"
+
+#include "GameObject/CGameObject.h"
+#include "Entity/CEntity.h"
+
+namespace Skylicht
+{
+	COcclusionQuery::COcclusionQuery() :
+		m_queryData(NULL)
+	{
+
+	}
+
+	COcclusionQuery::~COcclusionQuery()
+	{
+		if (m_gameObject)
+			m_gameObject->getEntity()->removeData<COcclusionQueryData>();
+	}
+
+	void COcclusionQuery::initComponent()
+	{
+		m_queryData = m_gameObject->getEntity()->addData<COcclusionQueryData>();
+	}
+
+	void COcclusionQuery::updateComponent()
+	{
+
+	}
+}

Projects/Skylicht/Engine/Source/OcclusionQuery/COcclusionQuery.h

@@ -0,0 +1,61 @@
+/*
+!@
+MIT License
+
+Copyright (c) 2020 Skylicht Technology CO., LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This file is part of the "Skylicht Engine".
+https://github.com/skylicht-lab/skylicht-engine
+!#
+*/
+
+#pragma once
+
+#include "Components/CComponentSystem.h"
+#include "COcclusionQueryData.h"
+
+namespace Skylicht
+{
+	class SKYLICHT_API COcclusionQuery : public CComponentSystem
+	{
+	protected:
+		COcclusionQueryData* m_queryData;
+
+	public:
+		COcclusionQuery();
+
+		virtual ~COcclusionQuery();
+
+		virtual void initComponent();
+
+		virtual void updateComponent();
+
+		inline void setAABBox(const core::aabbox3df& box)
+		{
+			m_queryData->setAABBox(box);
+		}
+
+		inline u32 getResult()
+		{
+			return m_queryData->QueryResult;
+		}
+
+		inline bool getVisible()
+		{
+			return m_queryData->QueryVisible;
+		}
+	};
+}

Projects/Skylicht/Engine/Source/OcclusionQuery/COcclusionQueryData.cpp

@@ -0,0 +1,82 @@
+/*
+!@
+MIT License
+
+Copyright (c) 2024 Skylicht Technology CO., LTD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+This file is part of the "Skylicht Engine".
+https://github.com/skylicht-lab/skylicht-engine
+!#
+*/
+
+#include "pch.h"
+#include "COcclusionQueryData.h"
+
+namespace Skylicht
+{
+	IMPLEMENT_DATA_TYPE_INDEX(COcclusionQueryData);
+
+	COcclusionQueryData::COcclusionQueryData() :
+		m_node(NULL),
+		m_registerQuery(false),
+		NeedValidate(true),
+		QueryResult(0),
+		QueryVisible(false)
+	{
+		float scale = 0.5f;
+		m_box.MinEdge.set(-scale, -scale, -scale);
+		m_box.MaxEdge.set(scale, scale, scale);
+
+		// Note:
+		// Use scene-node for compatibility with some functions OcclusionQuery from Irrlicht
+		ISceneManager* smgr = getIrrlichtDevice()->getSceneManager();
+		m_node = new COcclusionQuerySceneNode(smgr->getRootSceneNode(), smgr, this);
+
+		updateLocalTransform();
+	}
+
+	COcclusionQueryData::~COcclusionQueryData()
+	{
+		if (m_registerQuery)
+			getVideoDriver()->removeOcclusionQuery(m_node);
+
+		m_node->remove();
+		m_node->drop();
+	}
+
+	void COcclusionQueryData::setAABBox(const core::aabbox3df& box)
+	{
+		m_box = box;
+		updateLocalTransform();
+	}
+
+	void COcclusionQueryData::updateLocalTransform()
+	{
+		m_node->BBox = m_box;
+
+		m_localTransform.makeIdentity();
+		m_localTransform.setScale(m_box.getExtent());
+		m_localTransform.setTranslation(m_box.getCenter());
+
+		NeedValidate = true;
+	}
+
+	void COcclusionQueryData::registerQuery(CMesh* mesh)
+	{
+		getVideoDriver()->addOcclusionQuery(m_node, mesh);
+		m_registerQuery = true;
+	}
+}