Debug Commands

Console Commands

  • FLEXVIS Enables visualization of Flex container particles, and FlexActor bounds. Particles will be colored according to their group, the container bounds are drawn in white wireframe, while each actor’s bounds are drawn in green wireframe
  • STAT FLEX Enables on screen profiling timers and counters, see the stats section for more details.
  • STAT FLEXGPU Enables the GPU kernel timers, this profiling mode is quite expensive, so it needs to first be enabled with “stat group enable Flexgpu”, be sure to disable it with “stat group disable Flexgpu” before doing any whole-frame profiling.
_images/FlexVisOn.jpg

Stats

Timers

  • Update Data Time (CPU) The time it takes to push any parameter or particle changes from the CPU to Flex. The largest cost in this is usually memory transfer overhead related to the number of particles in the container.
  • Skin Mesh Time (CPU) Time spent on the render thread updating vertex buffers for clothing actors.
  • Solver Tick Time (CPU) This is the CPU time it takes to launch all the Flex GPU work from the CPU.
  • Update Actors Time (CPU) The CPU time to update all the FlexActors, this includes time to update actor bounds and process any particle updates from the simulation.
  • Update Bounds Time (CPU) The CPU time spent updating FlexActor bounds
  • Update Collision Shapes Time (CPU) The CPU time spent updating collisions shapes, this includes the time to gather the collision shapes overlapping each FlexActor bounds. If it is high then it may mean there are too many collision shapes overlapping FlexActors, or simply too many actors.
  • Wait Time (CPU) This is the time the CPU spends waiting for the GPU to complete the simulation work, if this is high then it means the GPU is spending a long time in the simulation kernels, use “stat Flexgpu” to get more details on the GPU bottlenecks.

Counters

  • Container Count The number of active containers.
  • Instance Count The number of actors using the container, this includes static mesh actors, ropes, and particle components.
  • Particle Count The total number of active particles in all containers.
  • Spring Count The total number of active springs in all containers.
  • Shape Count The total number of active shape constraints in all containers, soft bodies will contribute multiple shapes, and rigid bodies just one.
  • Static Convex Count The total number of convex shapes in all containers.
  • Static Triangle Count The total number triangles in all containers.
  • Force Field Count The total number of active force fields.
  • Active Mesh Actor Count The total number of FlexActors active in the level
  • Active Mesh Particle Count The total number of particles belonging to FlexActors, does not count the particles from emitters, ropes, etc
_images/stats.jpg