.TH "coin_profiler" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
coin_profiler \- Scene Graph Profiling
.PP
 \- Coin includes some scene graph profiling functionality\&.  

.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBSoProfiler\fP"
.br
.RI "Main static class for initializing the scene graph profiling subsystem\&. "
.ti -1c
.RI "class \fBSoProfilerElement\fP"
.br
.RI "The \fBSoProfilerElement\fP element class is for registering statistics during scene graph traversals\&. "
.ti -1c
.RI "class \fBSoProfilerOverlayKit\fP"
.br
.RI "The \fBSoProfilerOverlayKit\fP element class is yet to be documented\&. "
.ti -1c
.RI "class \fBSoProfilerStats\fP"
.br
.RI "The \fBSoProfilerStats\fP class is a node for exposing profiling results gathered by \fI\fBSoProfilerElement\fP\fP\&. "
.ti -1c
.RI "class \fBSoProfilingReportGenerator\fP"
.br
.RI "Convenience report generator functionality\&. "
.ti -1c
.RI "class \fBSoScrollingGraphKit\fP"
.br
.RI "The \fBSoScrollingGraphKit\fP element class is yet to be documented\&. "
.ti -1c
.RI "class \fBSoProfilerTopKit\fP"
.br
.RI "The \fBSoProfilerTopKit\fP element class is yet to be documented\&. "
.ti -1c
.RI "class \fBSoProfilerVisualizeKit\fP"
.br
.RI "The \fBSoProfilerVisualizeKit\fP element class is yet to be documented\&. "
.ti -1c
.RI "class \fBSbProfilingData\fP"
.br
.RI "Data structure for gathering scene graph traversal profiling information\&. "
.in -1c
.SH "Detailed Description"
.PP 
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\&.
.PP
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\&.
.PP
\fBSince\fP
.RS 4
Coin \fB3\&.0\fP 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.