1. Manuals
  2. Tumbleweed
  3. Coin-devel
  4. profiler(3)

Scroll to navigation

profiler(3) Library Functions Manual profiler(3)

NAME

profiler - Scene Graph Profiling

SYNOPSIS

Classes


class SbProfilingData
Data structure for gathering scene graph traversal profiling information. class SoProfiler
Main static class for initializing the scene graph profiling subsystem. class SoProfilerElement
The SoProfilerElement element class is for registering statistics during scene graph traversals. class SoProfilerStats
The SoProfilerStats class is a node for exposing profiling results gathered by SoProfilerElement. class SoProfilingReportGenerator
Convenience report generator functionality.

Detailed Description

Coin includes some scene graph profiling functionality. This functionality is intended for use during application development for identifying performance bottlenecks in Coin-based applications with regards to how Coin is being used and with regards to problems with how Coin is implemented.

The profiling code can be enabled in existing Coin applications without the need of adding any code by enabling it through the use of some environment variables. For particular profiling needs, the default behaviour you can trigger through environment variables might not work that well (you might have a specialized render pipeline that causes the output to be garbled) or focus on the information you need (the full application might perhaps add noise to the system that Coin won't separate out). In such cases, programmatic access to the profiling subsystem will be necessary to get the better results.

Since

Coin 3.0

profiling_intro

Enabling profiling in Coin

To enable profiling in Coin, use the environment variable COIN_PROFILER. When profiling is enabled, Coin will gather profiling data during every scene graph traversal by any action.

Enabling the default profiling display

To get some profiling data shown on the screen, you also need to use the COIN_PROFILER_OVERLAY environment variable.

This will give you the default profiling graphics, which shows a top-list of node timings categorized by node types, a scrolling graph of action traversal timings, and a scene graph navigator for closer scene graph inspection.

Read the profiling data

The SoProfilerStats node can be used to fetch the profiling data in the scene graph. If it is positioned anywhere in the scene graph, the fields of the node will be updated every time SoGLRenderAction is applied to the scene graph, with profiling data gathered from every traversal through the scene graph since the last SoGLRenderAction, up to the point where SoProfilerStats is located. Depending of how you wish to use the data, either attach sensors to the fields, or connect the the fields on other coin nodes to the fields on SoProfilerStats.

Author

Generated automatically by Doxygen for Coin from the source code.

Version 3.1.3 Coin