HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups 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 {
36 };
37 
38 /// Event types.
40 {
46 };
47 
48 /// Object types.
50 {
60 };
61 
62 // Enumeration of stat types.
64 {
75 };
76 
77 /// Viewport types recognized by the performance monitor.
79 {
83 };
84 
85 /// Script types recognized by the performance monitor.
87 {
91 };
92 
93 // Enumeration of attribute types.
95 {
102 };
103 
104 // Enumeration of public profile attributes.
106 {
112 };
113 
114 // Enumeration of public stats attributes.
116 {
126 };
127 
128 // Enumeration of public stat definition attributes.
130 {
137 };
138 
139 // Time formats to use in event logs.
141 {
145 };
146 
147 /// Return the (display) name of the given event type.
149 
150 /// Return the (display) name of the given category.
151 UT_API const char *UTgetCategoryName(UT_PerfMonCategory category);
152 
153 /// Return the (display) name of the given event object type.
154 UT_API const char *UTgetObjectTypeName(UT_PerfMonObjectType object_type);
155 
156 /// Return the (display) name of the given stat type.
157 UT_API const char *UTgetStatTypeName(UT_PerfMonStatType stat_type);
158 
159 /// Return the event type enum of the given event type name.
161  UTgetEventType(const char *type_name);
162 
163 /// Return the category enum of the given category name.
165  UTgetCategory(const char *category_name);
166 
167 /// Return the enum type of the given object type name.
169  UTgetObjectType(const char *type_name);
170 
171 /// Return the enum type of the given stat type name.
173  UTgetStatType(const char *type_name);
174 
175 /// Return the (display) name of the given profile attribute.
177 
178 /// Return the type of the given profile attribute.
181 
182 /// Return the (display) name of the given stats attribute.
184 
185 /// Return the (display) name of the given stat definition attribute.
187 
188 /// Return the profile attribute bound to the given (display) name.
189 /// Return UT_PERFMON_INVALID_PROFILE_ATTR if no such attribute exists.
191  UTgetProfileAttribute(const char *attr_name);
192 
193 /// Return the type of the given stats attribute.
196 
197 /// Return the stats attribute bound to the given (display) name.
198 /// Return UT_PERFMON_INVALID_STATS_ATTR if no such attribute exists.
200  UTgetStatsAttribute(const char *attr_name);
201 
202 /// Return the stat definition attribute bound to the given (display) name.
203 /// Return UT_PERFMON_INVALID_STAT_DEF_ATTR if no such attribute exists.
205  UTgetStatDefAttribute(const char *attr_name);
206 
207 /// Initialize data structures internal to this module.
208 /// This should only be called once from the UT_Performance constructor.
210 #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:13
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.
GLuint GLuint GLsizei GLenum type
Definition: glew.h:1253
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.
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.