Debug overlays class. More...
Inheritance diagram for Castor3D::DebugOverlays:
Collaboration diagram for Castor3D::DebugOverlays:
Public Member Functions | |
| DebugOverlays (Engine &p_engine) | |
| Constructor. More... | |
| ~DebugOverlays () | |
| Destructor. More... | |
| void | Initialise (OverlayManager &p_manager) |
| Initialisation function, retrieves the overlays from the given overlay manager. More... | |
| void | Cleanup () |
| Clean up function. More... | |
| void | StartFrame () |
| Resets all frame counters. More... | |
| void | EndFrame (uint32_t p_vertices, uint32_t p_faces, uint32_t p_objects) |
| Updates the overlays texts. More... | |
| void | EndGpuTask () |
| Used to add to the GPU time, the time elapsed between now and the last call of either EndGpuTask or EndCpuTask. More... | |
| void | EndCpuTask () |
| Used to add to the GPU time, the time elapsed between now and the last call of either EndGpuTask or EndCpuTask. More... | |
| void | Show (bool p_show) |
| Show or hide debug overlays. More... | |
Detailed Description
Debug overlays class.
- Date
- 17/09/2015
- Version
- 0.8.0
- Remarks
- Contains all datas and methods to update and display debug overlays.
If not shown, all the methods will be deactivated.
Constructor & Destructor Documentation
◆ DebugOverlays()
| Castor3D::DebugOverlays::DebugOverlays | ( | Engine & | p_engine | ) |
Constructor.
- Parameters
-
[in] p_engine The engine.
◆ ~DebugOverlays()
| Castor3D::DebugOverlays::~DebugOverlays | ( | ) |
Destructor.
Member Function Documentation
◆ Cleanup()
| void Castor3D::DebugOverlays::Cleanup | ( | ) |
Clean up function.
◆ EndCpuTask()
| void Castor3D::DebugOverlays::EndCpuTask | ( | ) |
Used to add to the GPU time, the time elapsed between now and the last call of either EndGpuTask or EndCpuTask.
◆ EndFrame()
| void Castor3D::DebugOverlays::EndFrame | ( | uint32_t | p_vertices, |
| uint32_t | p_faces, | ||
| uint32_t | p_objects | ||
| ) |
Updates the overlays texts.
- Parameters
-
[in] p_vertices The vertex count. [in] p_faces The face count. [in] p_objects The object count.
◆ EndGpuTask()
| void Castor3D::DebugOverlays::EndGpuTask | ( | ) |
Used to add to the GPU time, the time elapsed between now and the last call of either EndGpuTask or EndCpuTask.
◆ Initialise()
| void Castor3D::DebugOverlays::Initialise | ( | OverlayManager & | p_manager | ) |
Initialisation function, retrieves the overlays from the given overlay manager.
- Parameters
-
[in] p_manager The overlay manager.
◆ Show()
| void Castor3D::DebugOverlays::Show | ( | bool | p_show | ) |
Show or hide debug overlays.
- Parameters
-
[in] p_show The status.
◆ StartFrame()
| void Castor3D::DebugOverlays::StartFrame | ( | ) |
Resets all frame counters.
The documentation for this class was generated from the following file:
- Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/DebugOverlays.hpp
