HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pluginDesc.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HF_PLUGIN_DESC_H
25 #define PXR_IMAGING_HF_PLUGIN_DESC_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/base/tf/token.h"
29 
30 #include <vector>
31 
33 
34 
35 ///
36 /// Common structure used to report registered plugins in one of the plugin
37 /// registries. The id token is used for internal api communication
38 /// about the name of the plugin.
39 /// displayName is a human readable name given to the plugin intended
40 /// to be used in menus.
41 /// priority is used to provide an ordering of plugins. The plugin
42 /// with the highest priority is determined to be the default (unless
43 /// overridden by the application). In the event of a tie
44 /// the string version of id is used to sort alphabetically ('a' has priority
45 /// over 'b').
46 ///
47 struct HfPluginDesc {
50  int priority;
51 };
52 
53 typedef std::vector<HfPluginDesc> HfPluginDescVector;
54 
55 
57 
58 #endif // PXR_IMAGING_HF_PLUGIN_DESC_H
std::string displayName
Definition: pluginDesc.h:49
Definition: token.h:87
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
std::vector< HfPluginDesc > HfPluginDescVector
Definition: pluginDesc.h:53
TfToken id
Definition: pluginDesc.h:48