Package com.victorvalentim.zividomelive.performance

Enum Class PerformanceMetric

java.lang.Object
java.lang.Enum<PerformanceMetric>
com.victorvalentim.zividomelive.performance.PerformanceMetric
All Implemented Interfaces:
Serializable, Comparable<PerformanceMetric>, Constable
public enum PerformanceMetric extends Enum<PerformanceMetric>
Named performance samples exposed by the experimental profiler.

PerformanceSnapshot.getStatistics(PerformanceMetric) always returns CPU-observed wall time. GPU elapsed statistics are a separate channel and currently exist only for RENDER_PIPELINE.

API stability: Experimental.

Since:
2.0.0

  • Enum Constant Details

    • FRAME_TOTAL

      public static final PerformanceMetric FRAME_TOTAL
      Interval between consecutive Processing pre-frame boundaries.

    • SCENE_UPDATE

      public static final PerformanceMetric SCENE_UPDATE
      Active scene update callback.

    • SCENE_RENDER

      public static final PerformanceMetric SCENE_RENDER
      Aggregate scene rendering across Standard targets and cubemap faces.

    • RENDER_PIPELINE

      public static final PerformanceMetric RENDER_PIPELINE
      Complete ziviDomeLive render pipeline on the Processing thread.

    • GRAPHICS_RESET

      public static final PerformanceMetric GRAPHICS_RESET
      Deferred output-target recreation.

    • STANDARD_RENDER

      public static final PerformanceMetric STANDARD_RENDER
      Aggregate Standard rendering across preview and output targets.

    • STANDARD_PREVIEW

      public static final PerformanceMetric STANDARD_PREVIEW
      Standard preview-target rendering.

    • STANDARD_OUTPUT

      public static final PerformanceMetric STANDARD_OUTPUT
      Standard output-target rendering.

    • CUBEMAP_TOTAL

      public static final PerformanceMetric CUBEMAP_TOTAL
      Complete master cubemap capture.

    • CUBEMAP_PREVIEW

      public static final PerformanceMetric CUBEMAP_PREVIEW
      Preview-resolution cubemap capture.

    • CUBEMAP_OUTPUT

      public static final PerformanceMetric CUBEMAP_OUTPUT
      Output-resolution cubemap capture.

    • CUBEMAP_POS_X

      public static final PerformanceMetric CUBEMAP_POS_X
      Positive-X cubemap face.

    • CUBEMAP_NEG_X

      public static final PerformanceMetric CUBEMAP_NEG_X
      Negative-X cubemap face.

    • CUBEMAP_POS_Y

      public static final PerformanceMetric CUBEMAP_POS_Y
      Positive-Y cubemap face.

    • CUBEMAP_NEG_Y

      public static final PerformanceMetric CUBEMAP_NEG_Y
      Negative-Y cubemap face.

    • CUBEMAP_POS_Z

      public static final PerformanceMetric CUBEMAP_POS_Z
      Positive-Z cubemap face.

    • CUBEMAP_NEG_Z

      public static final PerformanceMetric CUBEMAP_NEG_Z
      Negative-Z cubemap face.

    • CUBEMAP_BLIT

      public static final PerformanceMetric CUBEMAP_BLIT
      CPU-observed scratch-to-cubemap framebuffer blit submission.

    • CUBEMAP_MIPMAP

      public static final PerformanceMetric CUBEMAP_MIPMAP
      CPU-observed cubemap mipmap generation submission.

    • DOMEMASTER

      public static final PerformanceMetric DOMEMASTER
      Aggregate domemaster projection work.

    • DOMEMASTER_PREVIEW

      public static final PerformanceMetric DOMEMASTER_PREVIEW
      Preview domemaster projection work.

    • DOMEMASTER_OUTPUT

      public static final PerformanceMetric DOMEMASTER_OUTPUT
      Output domemaster projection work.

    • EQUIRECTANGULAR

      public static final PerformanceMetric EQUIRECTANGULAR
      Aggregate equirectangular projection work.

    • EQUIRECTANGULAR_PREVIEW

      public static final PerformanceMetric EQUIRECTANGULAR_PREVIEW
      Preview equirectangular projection work.

    • EQUIRECTANGULAR_OUTPUT

      public static final PerformanceMetric EQUIRECTANGULAR_OUTPUT
      Output equirectangular projection work.

    • SKYBOX

      public static final PerformanceMetric SKYBOX
      Aggregate skybox-layout projection work.

    • SKYBOX_PREVIEW

      public static final PerformanceMetric SKYBOX_PREVIEW
      Preview skybox-layout projection work.

    • SKYBOX_OUTPUT

      public static final PerformanceMetric SKYBOX_OUTPUT
      Output skybox-layout projection work.

    • OUTPUT_PIPELINE

      public static final PerformanceMetric OUTPUT_PIPELINE
      Rendering and submission of all enabled external outputs.

    • PREVIEW_PIPELINE

      public static final PerformanceMetric PREVIEW_PIPELINE
      Production of preview-resolution representations.

    • PREVIEW_COPY

      public static final PerformanceMetric PREVIEW_COPY
      GPU copy from an existing output projection into a preview target.

    • PREVIEW_COMPOSITE

      public static final PerformanceMetric PREVIEW_COMPOSITE
      Composition of the selected preview target into the Processing window.

    • FLOATING_PREVIEW

      public static final PerformanceMetric FLOATING_PREVIEW
      Composition of the floating domemaster thumbnail.

    • CONTROL_PANEL

      public static final PerformanceMetric CONTROL_PANEL
      Built-in ControlP5 panel update and drawing.

    • NDI_CAPTURE

      public static final PerformanceMetric NDI_CAPTURE
      NDI readback, CPU copy, and enqueue work on the Processing thread.

    • NDI_CONVERSION

      public static final PerformanceMetric NDI_CONVERSION
      ARGB-to-RGBA conversion on the NDI worker.

    • NDI_QUEUE

      public static final PerformanceMetric NDI_QUEUE
      Non-blocking NDI free/ready queue operations.

    • NDI_SEND

      public static final PerformanceMetric NDI_SEND
      Native Devolay sender-call duration on the NDI worker.

    • SYPHON

      public static final PerformanceMetric SYPHON
      Syphon publication-call duration.

    • SPOUT

      public static final PerformanceMetric SPOUT
      Spout publication-call duration.

  • Method Details

    • values

      public static PerformanceMetric[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PerformanceMetric valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null