Ignition Rendering

API Reference

6.3.1
GraphicsAPI.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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 IGNITION_RENDERING_GRAPHICSAPI_HH_
18 #define IGNITION_RENDERING_GRAPHICSAPI_HH_
19 
20 #include <string>
21 #include "ignition/rendering/config.hh"
22 #include "ignition/rendering/Export.hh"
23 
24 namespace ignition
25 {
26  namespace rendering
27  {
28  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
29 
31  enum class IGNITION_RENDERING_VISIBLE GraphicsAPI : uint16_t
32  {
37 
40 
42  OPENGL = 1,
43 
45  DIRECT3D11 = 2,
46 
48  VULKAN = 3,
49 
51  METAL = 4,
52 
57  };
58 
60  class IGNITION_RENDERING_VISIBLE GraphicsAPIUtils
61  {
67  public: static std::string Str(GraphicsAPI _e);
68 
74  public: static GraphicsAPI Set(const std::string &_str);
75  };
76  }
77  }
78 }
79 #endif
GraphicsAPI
The graphics API used by the render engine.
Definition: GraphicsAPI.hh:31
Direct3D11 graphics interface.
Vulkan graphics interface.
Metal graphics interface.
OpenGL graphics interface.
STL class.
Utils to convert GraphicsAPI to and from strings.
Definition: GraphicsAPI.hh:60
Unknown graphics interface.