Open3D (C++ API)  0.16.1
FilamentEngine.h
Go to the documentation of this file.
1// ----------------------------------------------------------------------------
2// - Open3D: www.open3d.org -
3// ----------------------------------------------------------------------------
4// The MIT License (MIT)
5//
6// Copyright (c) 2018-2021 www.open3d.org
7//
8// Permission is hereby granted, free of charge, to any person obtaining a copy
9// of this software and associated documentation files (the "Software"), to deal
10// in the Software without restriction, including without limitation the rights
11// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12// copies of the Software, and to permit persons to whom the Software is
13// furnished to do so, subject to the following conditions:
14//
15// The above copyright notice and this permission notice shall be included in
16// all copies or substantial portions of the Software.
17//
18// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24// IN THE SOFTWARE.
25// ----------------------------------------------------------------------------
26
27#pragma once
28
29#include <string>
30
31namespace filament {
32class Engine;
33}
34
35namespace open3d {
36namespace visualization {
37namespace rendering {
38
39class FilamentResourceManager;
40
42public:
43 enum class RenderingType { kDefault, kOpenGL, kVulkan, kMetal };
44
45 // Selects backend to use.
46 // Should be called before instance usage.
47 // If not called, platform available default backend will be used.
48 static void SelectBackend(RenderingType type);
49
52 static void EnableHeadless();
53
54 // Specifies path to load shaders and skyboxes from. Must be called before
55 // instance usage, or default path will be used.
56 static void SetResourcePath(const std::string& resource_path);
57 static const std::string& GetResourcePath();
58
59 static filament::Engine& GetInstance();
61
65 static void DestroyInstance();
66
68
69private:
70 static EngineInstance& Get();
71
73
74 static RenderingType type_;
75 static bool is_headless_;
76 static std::string resource_path_;
77 filament::Engine* engine_;
78 FilamentResourceManager* resource_manager_;
79};
80
81} // namespace rendering
82} // namespace visualization
83} // namespace open3d
static void DestroyInstance()
Definition: FilamentEngine.cpp:94
static void SelectBackend(RenderingType type)
Definition: FilamentEngine.cpp:58
static void SetResourcePath(const std::string &resource_path)
Definition: FilamentEngine.cpp:62
static FilamentResourceManager & GetResourceManager()
Definition: FilamentEngine.cpp:74
static const std::string & GetResourcePath()
Definition: FilamentEngine.cpp:70
static filament::Engine & GetInstance()
Definition: FilamentEngine.cpp:72
RenderingType
Definition: FilamentEngine.h:43
~EngineInstance()
Definition: FilamentEngine.cpp:78
static void EnableHeadless()
Definition: FilamentEngine.cpp:60
Definition: FilamentResourceManager.h:69
char type
Definition: FilePCD.cpp:60
Definition: FilamentEngine.h:31
Definition: PinholeCameraIntrinsic.cpp:35