Gazebo Rendering

API Reference

3.7.2
gz/rendering/ShaderType.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef GZ_RENDERING_SHADERTYPE_HH_
18 #define GZ_RENDERING_SHADERTYPE_HH_
19 
20 #include <string>
21 #include "gz/rendering/config.hh"
22 #include "gz/rendering/Export.hh"
23 
24 namespace ignition
25 {
26  namespace rendering
27  {
28  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
29  //
34  enum IGNITION_RENDERING_VISIBLE ShaderType
35  {
38 
40  ST_PIXEL = 1,
41 
43  ST_VERTEX = 2,
44 
47 
50 
52  ST_COUNT = 5,
53  };
54 
57  class IGNITION_RENDERING_VISIBLE ShaderUtil
58  {
62  public: static bool IsValid(ShaderType _type);
63 
69  public: static ShaderType Sanitize(ShaderType _type);
70 
74  public: static std::string Name(ShaderType _type);
75 
81  public: static ShaderType Enum(const std::string &_name);
82 
84  private: static const char *names[ST_COUNT];
85  };
86  }
87  }
88 }
89 #endif
STL class.
@ ST_NORM_OBJ
Object-space normal map shader.
Definition: gz/rendering/ShaderType.hh:46
static ShaderType Enum(const std::string &_name)
Get enum value by human-readable name. The given string should match watch is returned by GetName....
static ShaderType Sanitize(ShaderType _type)
Sanitize given type. If the given value is invalid, ST_UNKNOWN will be returned, otherwise input will...
static std::string Name(ShaderType _type)
Get human-readable name for shader type value.
@ ST_NORM_TAN
Tangent-space normal map shader.
Definition: gz/rendering/ShaderType.hh:49
@ ST_VERTEX
Per vertex lighting shader.
Definition: gz/rendering/ShaderType.hh:43
static bool IsValid(ShaderType _type)
Determine if given type is valid ShaderType enum.
@ ST_UNKNOWN
Unknown or errant type.
Definition: gz/rendering/ShaderType.hh:37
Provides supporting functions for ShaderType enum.
Definition: gz/rendering/ShaderType.hh:57
@ ST_PIXEL
Per pixel lighting shader.
Definition: gz/rendering/ShaderType.hh:40
ShaderType
Available types of shaders. Note that not all rendering-engines will be able to use each type....
Definition: gz/rendering/ShaderType.hh:34
@ ST_COUNT
Total number of shader types.
Definition: gz/rendering/ShaderType.hh:52