HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_PerfMonTypes.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: UT_PerfMonTypes.h (UT Library, C++)
7  *
8  * COMMENTS:
9  *
10  * Performance monitor enumerations, defines, structures.
11  */
12 
13 #ifndef __UT_PerfMonTypes__
14 #define __UT_PerfMonTypes__
15 
16 #include "UT_API.h"
17 
18 /// Default file extension to use for profiles.
19 #define UT_PERFMON_PROFILE_FILE_EXTENSION ".hperf"
20 
21 static const int UT_PERFORMANCE_INVALID_FRAME = -1;
22 
23 /// Categories.
25 {
35 };
36 
37 /// Event types.
39 {
45 };
46 
47 /// Object types.
49 {
58 };
59 
60 // Enumeration of stat types.
62 {
73 };
74 
75 /// Viewport types recognized by the performance monitor.
77 {
81 };
82 
83 /// Script types recognized by the performance monitor.
85 {
89 };
90 
91 // Enumeration of attribute types.
93 {
100 };
101 
102 // Enumeration of public profile attributes.
104 {
110 };
111 
112 // Enumeration of public stats attributes.
114 {
124 };
125 
126 // Enumeration of public stat definition attributes.
128 {
135 };
136 
137 // Time formats to use in event logs.
139 {
143 };
144 
145 /// Return the (display) name of the given event type.
147 
148 /// Return the (display) name of the given category.
149 UT_API const char *UTgetCategoryName(UT_PerfMonCategory category);
150 
151 /// Return the (display) name of the given event object type.
152 UT_API const char *UTgetObjectTypeName(UT_PerfMonObjectType object_type);
153 
154 /// Return the (display) name of the given stat type.
155 UT_API const char *UTgetStatTypeName(UT_PerfMonStatType stat_type);
156 
157 /// Return the event type enum of the given event type name.
159  UTgetEventType(const char *type_name);
160 
161 /// Return the category enum of the given category name.
163  UTgetCategory(const char *category_name);
164 
165 /// Return the enum type of the given object type name.
167  UTgetObjectType(const char *type_name);
168 
169 /// Return the enum type of the given stat type name.
171  UTgetStatType(const char *type_name);
172 
173 /// Return the (display) name of the given profile attribute.
175 
176 /// Return the type of the given profile attribute.
179 
180 /// Return the (display) name of the given stats attribute.
182 
183 /// Return the (display) name of the given stat definition attribute.
185 
186 /// Return the profile attribute bound to the given (display) name.
187 /// Return UT_PERFMON_INVALID_PROFILE_ATTR if no such attribute exists.
189  UTgetProfileAttribute(const char *attr_name);
190 
191 /// Return the type of the given stats attribute.
194 
195 /// Return the stats attribute bound to the given (display) name.
196 /// Return UT_PERFMON_INVALID_STATS_ATTR if no such attribute exists.
198  UTgetStatsAttribute(const char *attr_name);
199 
200 /// Return the stat definition attribute bound to the given (display) name.
201 /// Return UT_PERFMON_INVALID_STAT_DEF_ATTR if no such attribute exists.
203  UTgetStatDefAttribute(const char *attr_name);
204 
205 /// Initialize data structures internal to this module.
206 /// This should only be called once from the UT_Performance constructor.
208 #endif
UT_PerfMonLogTimeFormat
UT_API UT_PerfMonStatDefAttribute UTgetStatDefAttribute(const char *attr_name)
UT_PerfMonEventType
Event types.
UT_API UT_PerfMonEventType UTgetEventType(const char *type_name)
Return the event type enum of the given event type name.
UT_API UT_PerfMonAttributeType UTgetStatsAttrType(UT_PerfMonStatsAttribute attr)
Return the type of the given stats attribute.
UT_API void UTinitPerfMonTypes()
UT_API UT_PerfMonProfileAttribute UTgetProfileAttribute(const char *attr_name)
UT_API const char * UTgetStatDefAttrName(UT_PerfMonStatDefAttribute attr)
Return the (display) name of the given stat definition attribute.
#define UT_API
Definition: UT_API.h:12
UT_API const char * UTgetStatTypeName(UT_PerfMonStatType stat_type)
Return the (display) name of the given stat type.
UT_PerfMonProfileAttribute
UT_API const char * UTgetCategoryName(UT_PerfMonCategory category)
Return the (display) name of the given category.
UT_PerfMonObjectType
Object types.
UT_API UT_PerfMonStatsAttribute UTgetStatsAttribute(const char *attr_name)
UT_API const char * UTgetObjectTypeName(UT_PerfMonObjectType object_type)
Return the (display) name of the given event object type.
UT_PerfMonStatType
UT_PerfMonCategory
Categories.
UT_PerfMonViewportType
Viewport types recognized by the performance monitor.
UT_API const char * UTgetProfileAttrName(UT_PerfMonProfileAttribute attr)
Return the (display) name of the given profile attribute.
UT_API UT_PerfMonAttributeType UTgetProfileAttrType(UT_PerfMonProfileAttribute attr)
Return the type of the given profile attribute.
UT_API UT_PerfMonObjectType UTgetObjectType(const char *type_name)
Return the enum type of the given object type name.
UT_PerfMonAttributeType
UT_PerfMonStatsAttribute
UT_API const char * UTgetEventTypeName(UT_PerfMonEventType type)
Return the (display) name of the given event type.
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
UT_PerfMonStatDefAttribute
UT_PerfMonScriptType
Script types recognized by the performance monitor.
UT_API UT_PerfMonCategory UTgetCategory(const char *category_name)
Return the category enum of the given category name.
UT_API const char * UTgetStatsAttrName(UT_PerfMonStatsAttribute attr)
Return the (display) name of the given stats attribute.
UT_API UT_PerfMonStatType UTgetStatType(const char *type_name)
Return the enum type of the given stat type name.