Skip to content

Fix scene stall and excessive memory usage caused by CReflectionProbe deserialization bugs #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Fix scene stall and excessive memory usage caused by CReflectionProbe deserialization bugs #605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7359772
Initial plan
Copilot Oct 2, 2025
9938d08
Fix duplicate resolution deserialization in CReflectionProbe
Copilot Oct 2, 2025
5a0e7dc
Add resolution validation and fix assertion bug in CReflectionProbe
Copilot Oct 2, 2025
487c72d
Fix typo in AddDefaultAtmosphere actor name
Copilot Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions Sources/Overload/OvCore/src/OvCore/ECS/Components/CReflectionProbe.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ float OvCore::ECS::Components::CReflectionProbe::GetBrightness() const
void OvCore::ECS::Components::CReflectionProbe::SetCubemapResolution(uint32_t p_resolution)
{
OVASSERT(p_resolution > 0, "Cubemap resolution must be greater than 0");
OVASSERT((p_resolution & (p_resolution - 1)) == 0 > 0, "Cubemap resolution must be a power of 2");
OVASSERT((p_resolution & (p_resolution - 1)) == 0, "Cubemap resolution must be a power of 2");

if (p_resolution != m_resolution)
{
Expand Down Expand Up @@ -198,11 +198,8 @@ void OvCore::ECS::Components::CReflectionProbe::OnDeserialize(tinyxml2::XMLDocum
{
using namespace OvCore::Helpers;

// Not ideal, but avoids garbage value from overriding the current resolution.
if (p_node->FirstChildElement("resolution"))
{
m_resolution = Serializer::DeserializeInt(p_doc, p_node, "resolution");
}
const uint32_t previousResolution = m_resolution;
const ECaptureSpeed previousCaptureSpeed = m_captureSpeed;

Serializer::DeserializeUint32(p_doc, p_node, "refresh_mode", reinterpret_cast<uint32_t&>(m_refreshMode));
Serializer::DeserializeUint32(p_doc, p_node, "capture_speed", reinterpret_cast<uint32_t&>(m_captureSpeed));
Expand All @@ -214,6 +211,21 @@ void OvCore::ECS::Components::CReflectionProbe::OnDeserialize(tinyxml2::XMLDocum
Serializer::DeserializeBoolean(p_doc, p_node, "box_projection", m_boxProjection);

m_captureFaceIndex = 0;

// Validate resolution (must be power of 2)
if (m_resolution == 0 || (m_resolution & (m_resolution - 1)) != 0)
{
m_resolution = previousResolution; // Restore previous valid value
}

// Reallocate resources if resolution or double buffering requirements changed
const bool resolutionChanged = m_resolution != previousResolution;
const bool doubleBufferingChanged = RequiresDoubleBuffering(m_captureSpeed) != RequiresDoubleBuffering(previousCaptureSpeed);

if (resolutionChanged || doubleBufferingChanged)
{
_AllocateResources();
}
}

void OvCore::ECS::Components::CReflectionProbe::OnInspector(OvUI::Internal::WidgetContainer& p_root)
Expand Down
2 changes: 1 addition & 1 deletion Sources/Overload/OvCore/src/OvCore/SceneSystem/Scene.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ void OvCore::SceneSystem::Scene::AddDefaultSkysphere()

void OvCore::SceneSystem::Scene::AddDefaultAtmosphere()
{
auto& atmosphere = CreateActor("Atmoshpere");
auto& atmosphere = CreateActor("Atmosphere");
auto& materialRenderer = atmosphere.AddComponent<ECS::Components::CMaterialRenderer>();
auto& modelRenderer = atmosphere.AddComponent<ECS::Components::CModelRenderer>();
modelRenderer.SetFrustumBehaviour(ECS::Components::CModelRenderer::EFrustumBehaviour::DISABLED);
Expand Down