FilamentEngine.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <string>
 
namespace filament {
class Engine;
}
 
namespace cloudViewer {
namespace visualization {
namespace rendering {
 
class FilamentResourceManager;
 
class EngineInstance {
public:
    enum class RenderingType { kDefault, kOpenGL, kVulkan, kMetal };
 
    // Selects backend to use.
    // Should be called before instance usage.
    // If not called, platform available default backend will be used.
    static void SelectBackend(RenderingType type);
 
    static void EnableHeadless();
 
    // Specifies path to load shaders and skyboxes from. Must be called before
    // instance usage, or default path will be used.
    static void SetResourcePath(const std::string& resource_path);
    static const std::string& GetResourcePath();
 
    static filament::Engine& GetInstance();
    static FilamentResourceManager& GetResourceManager();
 
    static void DestroyInstance();
 
    ~EngineInstance();
 
private:
    static EngineInstance& Get();
 
    EngineInstance();
 
    static RenderingType type_;
    static bool is_headless_;
    static std::string resource_path_;
    filament::Engine* engine_;
    FilamentResourceManager* resource_manager_;
};
 
}  // namespace rendering
}  // namespace visualization
}  // namespace cloudViewer