Package foundry.veil.api.client.render.profiler

Interface VeilRenderProfiler

public interface VeilRenderProfiler
Collects render information for the PipelineStatisticsViewer.
Since:
2.0.0

  • Method Details

    • get

      static VeilRenderProfiler get()
      Returns:
      The currently active profiler instance

    • push

      void push(String name, RenderProfilerCounter... statistics)
      Pushes a region onto the profile stack. This will only collect information if being viewed in the profiler window.
      Parameters:
      name - The name of the region to push
      statistics - The statistics to capture or empty to capture all available

    • push

      void push(Supplier<String> name, RenderProfilerCounter... statistics)
      Pushes a region onto the profile stack. This will only collect information if being viewed in the profiler window.
      Parameters:
      name - The name of the region to push
      statistics - The statistics to capture or empty to capture all available

    • pop

      void pop()
      Pops the current region.

    • popPush

      void popPush(String name, RenderProfilerCounter... statistics)
      Pops, then pushes a region onto the profile stack. This will only collect information if being viewed in the profiler window.
      Parameters:
      name - The name of the region to push
      statistics - The statistics to capture or empty to capture all available

    • popPush

      void popPush(Supplier<String> name, RenderProfilerCounter... statistics)
      Pops, then pushes a region onto the profile stack. This will only collect information if being viewed in the profiler window.
      Parameters:
      name - The name of the region to push
      statistics - The statistics to capture or empty to capture all available