Merge pull request #734 from aws-lumberyard-dev/nvsickle/DebugInfoDisplay
Restore debug rendering to the viewportmain
Nicholas Van Sickle
5 years ago
committed by
GitHub
commit
46c0c35c26
@ -0,0 +1,12 @@
|
|||||||
|
#
|
||||||
|
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
# its licensors.
|
||||||
|
#
|
||||||
|
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
# distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
#
|
||||||
|
|
||||||
|
add_subdirectory(Code)
|
||||||
@ -0,0 +1,52 @@
|
|||||||
|
#
|
||||||
|
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
# its licensors.
|
||||||
|
#
|
||||||
|
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
# distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
#
|
||||||
|
|
||||||
|
ly_add_target(
|
||||||
|
NAME AtomViewportDisplayInfo GEM_MODULE
|
||||||
|
NAMESPACE Gem
|
||||||
|
FILES_CMAKE
|
||||||
|
atomviewportdisplayinfo_files.cmake
|
||||||
|
INCLUDE_DIRECTORIES
|
||||||
|
PRIVATE
|
||||||
|
Source
|
||||||
|
PUBLIC
|
||||||
|
Include
|
||||||
|
BUILD_DEPENDENCIES
|
||||||
|
PRIVATE
|
||||||
|
AZ::AzCore
|
||||||
|
AZ::AtomCore
|
||||||
|
Legacy::CryCommon
|
||||||
|
Gem::Atom_RHI.Reflect
|
||||||
|
Gem::Atom_RPI.Public
|
||||||
|
)
|
||||||
|
|
||||||
|
################################################################################
|
||||||
|
# Tests
|
||||||
|
################################################################################
|
||||||
|
if(PAL_TRAIT_BUILD_TESTS_SUPPORTED)
|
||||||
|
ly_add_target(
|
||||||
|
NAME AtomViewportDisplayInfo.Tests ${PAL_TRAIT_TEST_TARGET_TYPE}
|
||||||
|
NAMESPACE Gem
|
||||||
|
FILES_CMAKE
|
||||||
|
atomviewportdisplayinfo_test_files.cmake
|
||||||
|
INCLUDE_DIRECTORIES
|
||||||
|
PRIVATE
|
||||||
|
Include
|
||||||
|
Tests
|
||||||
|
BUILD_DEPENDENCIES
|
||||||
|
PRIVATE
|
||||||
|
AZ::AzTest
|
||||||
|
)
|
||||||
|
ly_add_googletest(
|
||||||
|
NAME Gem::AtomViewportDisplayInfo.Tests
|
||||||
|
)
|
||||||
|
endif()
|
||||||
|
|
||||||
@ -0,0 +1,61 @@
|
|||||||
|
/*
|
||||||
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
* its licensors.
|
||||||
|
*
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
* distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#pragma once
|
||||||
|
#include <AzCore/base.h>
|
||||||
|
#include <AzCore/EBus/EBus.h>
|
||||||
|
|
||||||
|
namespace AZ
|
||||||
|
{
|
||||||
|
namespace AtomBridge
|
||||||
|
{
|
||||||
|
//! The level of information to display in the viewport info display overlay.
|
||||||
|
enum class ViewportInfoDisplayState : int
|
||||||
|
{
|
||||||
|
NoInfo = 0,
|
||||||
|
NormalInfo = 1,
|
||||||
|
FullInfo = 2,
|
||||||
|
CompactInfo = 3,
|
||||||
|
Invalid
|
||||||
|
};
|
||||||
|
|
||||||
|
//! This bus is used to request changes to the viewport info display overlay.
|
||||||
|
class AtomViewportInfoDisplayRequests
|
||||||
|
: public AZ::EBusTraits
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
static const AZ::EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Single;
|
||||||
|
static const AZ::EBusAddressPolicy AddressPolicy = EBusAddressPolicy::Single;
|
||||||
|
|
||||||
|
//! Gets the current viewport info overlay state.
|
||||||
|
virtual ViewportInfoDisplayState GetDisplayState() const = 0;
|
||||||
|
//! Sets the current viewport info overlay state.
|
||||||
|
//! The overlay will be drawn to the default viewport context every frame, if enabled.
|
||||||
|
virtual void SetDisplayState(ViewportInfoDisplayState state) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
using AtomViewportInfoDisplayRequestBus = AZ::EBus<AtomViewportInfoDisplayRequests>;
|
||||||
|
|
||||||
|
//! This bus is used to listen for state changes in the viewport info display overlay.
|
||||||
|
class AtomViewportInfoDisplayNotifications
|
||||||
|
: public AZ::EBusTraits
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
static const AZ::EBusHandlerPolicy HandlerPolicy = EBusHandlerPolicy::Multiple;
|
||||||
|
static const AZ::EBusAddressPolicy AddressPolicy = EBusAddressPolicy::Single;
|
||||||
|
|
||||||
|
//! Called when the ViewportInfoDisplayState (via the r_displayInfo CVar) has changed.
|
||||||
|
virtual void OnViewportInfoDisplayStateChanged([[maybe_unused]]ViewportInfoDisplayState state){}
|
||||||
|
};
|
||||||
|
|
||||||
|
using AtomViewportInfoDisplayNotificationBus = AZ::EBus<AtomViewportInfoDisplayNotifications>;
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,316 @@
|
|||||||
|
/*
|
||||||
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
* its licensors.
|
||||||
|
*
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
* distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "AtomViewportDisplayInfoSystemComponent.h"
|
||||||
|
|
||||||
|
#include <AzCore/Serialization/SerializeContext.h>
|
||||||
|
#include <AzCore/Serialization/EditContext.h>
|
||||||
|
#include <AzCore/Serialization/EditContextConstants.inl>
|
||||||
|
|
||||||
|
#include <AzCore/Console/IConsole.h>
|
||||||
|
#include <AzCore/Interface/Interface.h>
|
||||||
|
#include <Atom/RPI.Public/ViewportContextBus.h>
|
||||||
|
#include <Atom/RPI.Public/ViewportContext.h>
|
||||||
|
#include <Atom/RPI.Public/View.h>
|
||||||
|
#include <Atom/RPI.Public/Pass/ParentPass.h>
|
||||||
|
#include <Atom/RHI/Factory.h>
|
||||||
|
|
||||||
|
#include <CryCommon/ISystem.h>
|
||||||
|
#include <CryCommon/IConsole.h>
|
||||||
|
|
||||||
|
namespace AZ::Render
|
||||||
|
{
|
||||||
|
AZ_CVAR(int, r_displayInfo, 1, [](const int& newDisplayInfoVal)->void
|
||||||
|
{
|
||||||
|
// Forward this event to the system component so it can update accordingly.
|
||||||
|
// This callback only gets triggered by console commands, so this will not recurse.
|
||||||
|
AtomBridge::AtomViewportInfoDisplayRequestBus::Broadcast(
|
||||||
|
&AtomBridge::AtomViewportInfoDisplayRequestBus::Events::SetDisplayState,
|
||||||
|
aznumeric_cast<AtomBridge::ViewportInfoDisplayState>(newDisplayInfoVal)
|
||||||
|
);
|
||||||
|
}, AZ::ConsoleFunctorFlags::DontReplicate,
|
||||||
|
"Toggles debugging information display.\n"
|
||||||
|
"Usage: r_displayInfo [0=off/1=show/2=enhanced/3=compact]"
|
||||||
|
);
|
||||||
|
AZ_CVAR(float, r_fpsCalcInterval, 1.0f, nullptr, AZ::ConsoleFunctorFlags::DontReplicate,
|
||||||
|
"The time period over which to calculate the framerate for r_displayInfo."
|
||||||
|
);
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::Reflect(AZ::ReflectContext* context)
|
||||||
|
{
|
||||||
|
if (AZ::SerializeContext* serialize = azrtti_cast<AZ::SerializeContext*>(context))
|
||||||
|
{
|
||||||
|
serialize->Class<AtomViewportDisplayInfoSystemComponent, AZ::Component>()
|
||||||
|
->Version(0)
|
||||||
|
;
|
||||||
|
|
||||||
|
if (AZ::EditContext* ec = serialize->GetEditContext())
|
||||||
|
{
|
||||||
|
ec->Class<AtomViewportDisplayInfoSystemComponent>("Viewport Display Info", "Manages debug viewport information through r_displayInfo")
|
||||||
|
->ClassElement(Edit::ClassElements::EditorData, "")
|
||||||
|
->Attribute(Edit::Attributes::AppearsInAddComponentMenu, AZ_CRC("System", 0xc94d118b))
|
||||||
|
->Attribute(Edit::Attributes::AutoExpand, true)
|
||||||
|
;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
|
||||||
|
{
|
||||||
|
provided.push_back(AZ_CRC("ViewportDisplayInfoService"));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
|
||||||
|
{
|
||||||
|
incompatible.push_back(AZ_CRC("ViewportDisplayInfoService"));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required)
|
||||||
|
{
|
||||||
|
required.push_back(AZ_CRC("RPISystem", 0xf2add773));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::GetDependentServices([[maybe_unused]] AZ::ComponentDescriptor::DependencyArrayType& dependent)
|
||||||
|
{
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::Activate()
|
||||||
|
{
|
||||||
|
AZ::Name apiName = AZ::RHI::Factory::Get().GetName();
|
||||||
|
if (!apiName.IsEmpty())
|
||||||
|
{
|
||||||
|
m_rendererDescription = AZStd::string::format("Atom using %s RHI", apiName.GetCStr());
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::RPI::ViewportContextNotificationBus::Handler::BusConnect(
|
||||||
|
AZ::RPI::ViewportContextRequests::Get()->GetDefaultViewportContextName());
|
||||||
|
AZ::AtomBridge::AtomViewportInfoDisplayRequestBus::Handler::BusConnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::Deactivate()
|
||||||
|
{
|
||||||
|
AZ::AtomBridge::AtomViewportInfoDisplayRequestBus::Handler::BusDisconnect();
|
||||||
|
AZ::RPI::ViewportContextNotificationBus::Handler::BusDisconnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::RPI::ViewportContextPtr AtomViewportDisplayInfoSystemComponent::GetViewportContext() const
|
||||||
|
{
|
||||||
|
return AZ::RPI::ViewportContextRequests::Get()->GetDefaultViewportContext();
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::DrawLine(AZStd::string_view line, AZ::Color color)
|
||||||
|
{
|
||||||
|
m_drawParams.m_color = color;
|
||||||
|
AZ::Vector2 textSize = m_fontDrawInterface->GetTextSize(m_drawParams, line);
|
||||||
|
m_fontDrawInterface->DrawScreenAlignedText2d(m_drawParams, line);
|
||||||
|
m_drawParams.m_position.SetY(m_drawParams.m_position.GetY() + textSize.GetY() + m_lineSpacing);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::OnRenderTick()
|
||||||
|
{
|
||||||
|
if (!m_fontDrawInterface)
|
||||||
|
{
|
||||||
|
auto fontQueryInterface = AZ::Interface<AzFramework::FontQueryInterface>::Get();
|
||||||
|
if (!fontQueryInterface)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
m_fontDrawInterface =
|
||||||
|
fontQueryInterface->GetDefaultFontDrawInterface();
|
||||||
|
}
|
||||||
|
AZ::RPI::ViewportContextPtr viewportContext = GetViewportContext();
|
||||||
|
|
||||||
|
if (!m_fontDrawInterface || !viewportContext || !viewportContext->GetRenderScene())
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
m_fpsInterval = AZStd::chrono::seconds(r_fpsCalcInterval);
|
||||||
|
|
||||||
|
UpdateFramerate();
|
||||||
|
|
||||||
|
const AtomBridge::ViewportInfoDisplayState displayLevel = GetDisplayState();
|
||||||
|
if (displayLevel == AtomBridge::ViewportInfoDisplayState::NoInfo)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (m_updateRootPassQuery)
|
||||||
|
{
|
||||||
|
if (auto rootPass = AZ::RPI::PassSystemInterface::Get()->GetRootPass())
|
||||||
|
{
|
||||||
|
rootPass->SetPipelineStatisticsQueryEnabled(displayLevel != AtomBridge::ViewportInfoDisplayState::CompactInfo);
|
||||||
|
m_updateRootPassQuery = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_drawParams.m_drawViewportId = viewportContext->GetId();
|
||||||
|
auto viewportSize = viewportContext->GetViewportSize();
|
||||||
|
m_drawParams.m_position = AZ::Vector3(viewportSize.m_width, 0.f, 1.f);
|
||||||
|
m_drawParams.m_color = AZ::Colors::White;
|
||||||
|
m_drawParams.m_scale = AZ::Vector2(0.7f);
|
||||||
|
m_drawParams.m_hAlign = AzFramework::TextHorizontalAlignment::Right;
|
||||||
|
m_drawParams.m_monospace = false;
|
||||||
|
m_drawParams.m_depthTest = false;
|
||||||
|
m_drawParams.m_virtual800x600ScreenSize = true;
|
||||||
|
m_drawParams.m_scaleWithWindow = false;
|
||||||
|
m_drawParams.m_multiline = true;
|
||||||
|
m_drawParams.m_lineSpacing = 0.5f;
|
||||||
|
|
||||||
|
// Calculate line spacing based on the font's actual line height
|
||||||
|
const float lineHeight = m_fontDrawInterface->GetTextSize(m_drawParams, " ").GetY();
|
||||||
|
m_lineSpacing = lineHeight * m_drawParams.m_lineSpacing;
|
||||||
|
|
||||||
|
DrawRendererInfo();
|
||||||
|
if (displayLevel == AtomBridge::ViewportInfoDisplayState::FullInfo)
|
||||||
|
{
|
||||||
|
DrawCameraInfo();
|
||||||
|
}
|
||||||
|
if (displayLevel != AtomBridge::ViewportInfoDisplayState::CompactInfo)
|
||||||
|
{
|
||||||
|
DrawPassInfo();
|
||||||
|
}
|
||||||
|
DrawFramerate();
|
||||||
|
}
|
||||||
|
|
||||||
|
AtomBridge::ViewportInfoDisplayState AtomViewportDisplayInfoSystemComponent::GetDisplayState() const
|
||||||
|
{
|
||||||
|
return aznumeric_cast<AtomBridge::ViewportInfoDisplayState>(r_displayInfo.operator int());
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::SetDisplayState(AtomBridge::ViewportInfoDisplayState state)
|
||||||
|
{
|
||||||
|
r_displayInfo = aznumeric_cast<int>(state);
|
||||||
|
AtomBridge::AtomViewportInfoDisplayNotificationBus::Broadcast(
|
||||||
|
&AtomBridge::AtomViewportInfoDisplayNotificationBus::Events::OnViewportInfoDisplayStateChanged,
|
||||||
|
state);
|
||||||
|
m_updateRootPassQuery = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::DrawRendererInfo()
|
||||||
|
{
|
||||||
|
DrawLine(m_rendererDescription, AZ::Colors::Yellow);
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::DrawCameraInfo()
|
||||||
|
{
|
||||||
|
AZ::RPI::ViewportContextPtr viewportContext = GetViewportContext();
|
||||||
|
AZ::RPI::ViewPtr currentView = viewportContext->GetDefaultView();
|
||||||
|
if (currentView == nullptr)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
auto viewportSize = viewportContext->GetViewportSize();
|
||||||
|
AzFramework::CameraState cameraState;
|
||||||
|
AzFramework::SetCameraClippingVolumeFromPerspectiveFovMatrixRH(cameraState, currentView->GetViewToClipMatrix());
|
||||||
|
const AZ::Transform transform = currentView->GetCameraTransform();
|
||||||
|
const AZ::Vector3 translation = transform.GetTranslation();
|
||||||
|
const AZ::Vector3 rotation = transform.GetEulerDegrees();
|
||||||
|
DrawLine(AZStd::string::format(
|
||||||
|
"CamPos=%.2f %.2f %.2f Angl=%3.0f %3.0f %4.0f ZN=%.2f ZF=%.0f",
|
||||||
|
translation.GetX(), translation.GetY(), translation.GetZ(),
|
||||||
|
rotation.GetX(), rotation.GetY(), rotation.GetZ(),
|
||||||
|
cameraState.m_nearClip, cameraState.m_farClip
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::DrawPassInfo()
|
||||||
|
{
|
||||||
|
auto rootPass = AZ::RPI::PassSystemInterface::Get()->GetRootPass();
|
||||||
|
const RPI::PipelineStatisticsResult stats = rootPass->GetLatestPipelineStatisticsResult();
|
||||||
|
AZStd::function<int(const AZ::RPI::Ptr<AZ::RPI::Pass>)> containingPassCount = [&containingPassCount](const AZ::RPI::Ptr<AZ::RPI::Pass> pass)
|
||||||
|
{
|
||||||
|
int count = 1;
|
||||||
|
if (auto passAsParent = pass->AsParent())
|
||||||
|
{
|
||||||
|
for (const auto& child : passAsParent->GetChildren())
|
||||||
|
{
|
||||||
|
count += containingPassCount(child);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return count;
|
||||||
|
};
|
||||||
|
const int numPasses = containingPassCount(rootPass);
|
||||||
|
DrawLine(AZStd::string::format(
|
||||||
|
"Total Passes: %d Vertex Count: %lld Primitive Count: %lld",
|
||||||
|
numPasses,
|
||||||
|
aznumeric_cast<long long>(stats.m_vertexCount),
|
||||||
|
aznumeric_cast<long long>(stats.m_primitiveCount)
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::UpdateFramerate()
|
||||||
|
{
|
||||||
|
if (!m_tickRequests)
|
||||||
|
{
|
||||||
|
m_tickRequests = AZ::TickRequestBus::FindFirstHandler();
|
||||||
|
if (!m_tickRequests)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::ScriptTimePoint currentTime = m_tickRequests->GetTimeAtCurrentTick();
|
||||||
|
// Only keep as much sampling data as is required by our FPS history.
|
||||||
|
while (!m_fpsHistory.empty() && (currentTime.Get() - m_fpsHistory.front().Get()) > m_fpsInterval)
|
||||||
|
{
|
||||||
|
m_fpsHistory.pop_front();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Discard entries with a zero time-delta (can happen when we don't have window focus).
|
||||||
|
if (m_fpsHistory.empty() || (currentTime.Get() - m_fpsHistory.back().Get()) != AZStd::chrono::seconds(0))
|
||||||
|
{
|
||||||
|
m_fpsHistory.push_back(currentTime);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void AtomViewportDisplayInfoSystemComponent::DrawFramerate()
|
||||||
|
{
|
||||||
|
AZStd::chrono::duration<double> actualInterval = AZStd::chrono::seconds(0);
|
||||||
|
AZStd::optional<AZ::ScriptTimePoint> lastTime;
|
||||||
|
AZStd::optional<double> minFPS;
|
||||||
|
AZStd::optional<double> maxFPS;
|
||||||
|
for (const AZ::ScriptTimePoint& time : m_fpsHistory)
|
||||||
|
{
|
||||||
|
if (lastTime.has_value())
|
||||||
|
{
|
||||||
|
AZStd::chrono::duration<double> deltaTime = time.Get() - lastTime.value().Get();
|
||||||
|
double fps = AZStd::chrono::seconds(1) / deltaTime;
|
||||||
|
if (!minFPS.has_value())
|
||||||
|
{
|
||||||
|
minFPS = fps;
|
||||||
|
maxFPS = fps;
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
minFPS = AZStd::min(minFPS.value(), fps);
|
||||||
|
maxFPS = AZStd::max(maxFPS.value(), fps);
|
||||||
|
}
|
||||||
|
actualInterval += deltaTime;
|
||||||
|
}
|
||||||
|
lastTime = time;
|
||||||
|
}
|
||||||
|
|
||||||
|
const double averageFPS = aznumeric_cast<double>(m_fpsHistory.size()) / actualInterval.count();
|
||||||
|
const double frameIntervalSeconds = m_fpsInterval.count();
|
||||||
|
|
||||||
|
DrawLine(
|
||||||
|
AZStd::string::format(
|
||||||
|
"FPS %.1f [%.0f..%.0f], frame avg over %.1fs",
|
||||||
|
averageFPS,
|
||||||
|
minFPS.value_or(0.0),
|
||||||
|
maxFPS.value_or(0.0),
|
||||||
|
frameIntervalSeconds),
|
||||||
|
AZ::Colors::Yellow);
|
||||||
|
}
|
||||||
|
} // namespace AZ::Render
|
||||||
@ -0,0 +1,79 @@
|
|||||||
|
/*
|
||||||
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
* its licensors.
|
||||||
|
*
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
* distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <AzCore/Component/Component.h>
|
||||||
|
|
||||||
|
#include <CryCommon/CrySystemBus.h>
|
||||||
|
#include <AzCore/Script/ScriptTimePoint.h>
|
||||||
|
#include <AzFramework/Entity/EntityDebugDisplayBus.h>
|
||||||
|
#include <AzFramework/Font/FontInterface.h>
|
||||||
|
#include <Atom/RPI.Public/Base.h>
|
||||||
|
#include <Atom/RPI.Public/ViewportContextBus.h>
|
||||||
|
#include <AtomLyIntegration/AtomViewportDisplayInfo/AtomViewportInfoDisplayBus.h>
|
||||||
|
|
||||||
|
namespace AZ
|
||||||
|
{
|
||||||
|
class TickRequests;
|
||||||
|
|
||||||
|
namespace Render
|
||||||
|
{
|
||||||
|
class AtomViewportDisplayInfoSystemComponent
|
||||||
|
: public AZ::Component
|
||||||
|
, public AZ::RPI::ViewportContextNotificationBus::Handler
|
||||||
|
, public AZ::AtomBridge::AtomViewportInfoDisplayRequestBus::Handler
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_COMPONENT(AtomViewportDisplayInfoSystemComponent, "{AC32F173-E7E2-4943-8E6C-7C3091978221}");
|
||||||
|
|
||||||
|
static void Reflect(AZ::ReflectContext* context);
|
||||||
|
|
||||||
|
static void GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided);
|
||||||
|
static void GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible);
|
||||||
|
static void GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required);
|
||||||
|
static void GetDependentServices(AZ::ComponentDescriptor::DependencyArrayType& dependent);
|
||||||
|
|
||||||
|
protected:
|
||||||
|
// AZ::Component overrides...
|
||||||
|
void Activate() override;
|
||||||
|
void Deactivate() override;
|
||||||
|
|
||||||
|
// AZ::RPI::ViewportContextNotificationBus::Handler overrides...
|
||||||
|
void OnRenderTick() override;
|
||||||
|
|
||||||
|
// AZ::AtomBridge::AtomViewportInfoDisplayRequestBus::Handler overrides...
|
||||||
|
AtomBridge::ViewportInfoDisplayState GetDisplayState() const override;
|
||||||
|
void SetDisplayState(AtomBridge::ViewportInfoDisplayState state) override;
|
||||||
|
|
||||||
|
private:
|
||||||
|
AZ::RPI::ViewportContextPtr GetViewportContext() const;
|
||||||
|
void DrawLine(AZStd::string_view line, AZ::Color color = AZ::Colors::White);
|
||||||
|
|
||||||
|
void UpdateFramerate();
|
||||||
|
|
||||||
|
void DrawRendererInfo();
|
||||||
|
void DrawCameraInfo();
|
||||||
|
void DrawPassInfo();
|
||||||
|
void DrawFramerate();
|
||||||
|
|
||||||
|
AZStd::string m_rendererDescription;
|
||||||
|
AzFramework::TextDrawParameters m_drawParams;
|
||||||
|
AzFramework::FontDrawInterface* m_fontDrawInterface = nullptr;
|
||||||
|
float m_lineSpacing;
|
||||||
|
AZStd::chrono::duration<double> m_fpsInterval = AZStd::chrono::seconds(1);
|
||||||
|
AZStd::deque<AZ::ScriptTimePoint> m_fpsHistory;
|
||||||
|
AZStd::optional<AZStd::chrono::system_clock::time_point> m_lastMemoryUpdate;
|
||||||
|
AZ::TickRequests* m_tickRequests = nullptr;
|
||||||
|
bool m_updateRootPassQuery = true;
|
||||||
|
};
|
||||||
|
} // namespace Render
|
||||||
|
} // namespace AZ
|
||||||
@ -0,0 +1,51 @@
|
|||||||
|
/*
|
||||||
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
* its licensors.
|
||||||
|
*
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
* distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzCore/Memory/SystemAllocator.h>
|
||||||
|
#include <AzCore/RTTI/RTTI.h>
|
||||||
|
#include <AzCore/Module/Module.h>
|
||||||
|
|
||||||
|
#include "AtomViewportDisplayInfoSystemComponent.h"
|
||||||
|
|
||||||
|
namespace AZ
|
||||||
|
{
|
||||||
|
namespace Render
|
||||||
|
{
|
||||||
|
class AtomViewportDisplayInfoModule
|
||||||
|
: public AZ::Module
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
AZ_RTTI(AtomViewportDisplayInfoModule, "{B10C0E55-03A1-4A46-AE3E-D3615AEAA659}", AZ::Module);
|
||||||
|
AZ_CLASS_ALLOCATOR(AtomViewportDisplayInfoModule, AZ::SystemAllocator, 0);
|
||||||
|
|
||||||
|
AtomViewportDisplayInfoModule()
|
||||||
|
: AZ::Module()
|
||||||
|
{
|
||||||
|
m_descriptors.insert(m_descriptors.end(), {
|
||||||
|
AtomViewportDisplayInfoSystemComponent::CreateDescriptor(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
AZ::ComponentTypeList GetRequiredSystemComponents() const override
|
||||||
|
{
|
||||||
|
return AZ::ComponentTypeList{
|
||||||
|
azrtti_typeid<AtomViewportDisplayInfoSystemComponent>(),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
};
|
||||||
|
} // namespace Render
|
||||||
|
} // namespace AZ
|
||||||
|
|
||||||
|
// DO NOT MODIFY THIS LINE UNLESS YOU RENAME THE GEM
|
||||||
|
// The first parameter should be GemName_GemIdLower
|
||||||
|
// The second should be the fully qualified name of the class above
|
||||||
|
AZ_DECLARE_MODULE_CLASS(Gem_AtomViewportDisplayInfo, AZ::Render::AtomViewportDisplayInfoModule)
|
||||||
@ -0,0 +1,20 @@
|
|||||||
|
/*
|
||||||
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
* its licensors.
|
||||||
|
*
|
||||||
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
* distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <AzTest/AzTest.h>
|
||||||
|
|
||||||
|
AZ_UNIT_TEST_HOOK(DEFAULT_UNIT_TEST_ENV);
|
||||||
|
|
||||||
|
TEST(AtomViewportDisplayInfoSanityTest, Sanity)
|
||||||
|
{
|
||||||
|
EXPECT_EQ(1, 1);
|
||||||
|
}
|
||||||
@ -0,0 +1,16 @@
|
|||||||
|
#
|
||||||
|
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
# its licensors.
|
||||||
|
#
|
||||||
|
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
# distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
#
|
||||||
|
|
||||||
|
set(FILES
|
||||||
|
Source/AtomViewportDisplayInfoSystemComponent.cpp
|
||||||
|
Source/AtomViewportDisplayInfoSystemComponent.h
|
||||||
|
Source/Module.cpp
|
||||||
|
)
|
||||||
@ -0,0 +1,14 @@
|
|||||||
|
#
|
||||||
|
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||||
|
# its licensors.
|
||||||
|
#
|
||||||
|
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||||
|
# distribution (the "License"). All use of this software is governed by the License,
|
||||||
|
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||||
|
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
#
|
||||||
|
|
||||||
|
set(FILES
|
||||||
|
Source/Tests/test_Main.cpp
|
||||||
|
)
|
||||||
@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"gem_name": "AtomLyIntegration_AtomViewportDisplayInfo",
|
||||||
|
"display_name": "Atom Viewport Display Info Overlay",
|
||||||
|
"summary": "Provides a diagnostic viewport overlay for the default O3DE Atom viewport.",
|
||||||
|
"canonical_tags": [
|
||||||
|
"Gem"
|
||||||
|
],
|
||||||
|
"user_tags": [
|
||||||
|
"AtomLyIntegration",
|
||||||
|
"AtomViewportDisplayInfo"
|
||||||
|
]
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue