renaming to Thermion

thermion_dart/native/include/filament/filament/DebugRegistry.h

@@ -0,0 +1,141 @@
+/*
+ * Copyright (C) 2018 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+//! \file
+
+#ifndef TNT_FILAMENT_DEBUGREGISTRY_H
+#define TNT_FILAMENT_DEBUGREGISTRY_H
+
+#include <filament/FilamentAPI.h>
+
+#include <utils/compiler.h>
+
+#include <math/mathfwd.h>
+
+#include <stddef.h>
+
+namespace filament {
+
+/**
+ * A registry of runtime properties used exclusively for debugging
+ *
+ * Filament exposes a few properties that can be queried and set, which control certain debugging
+ * features of the engine. These properties can be set at runtime at anytime.
+ *
+ */
+class UTILS_PUBLIC DebugRegistry : public FilamentAPI {
+public:
+
+    /**
+     * Queries whether a property exists
+     * @param name The name of the property to query
+     * @return true if the property exists, false otherwise
+     */
+    bool hasProperty(const char* UTILS_NONNULL name) const noexcept;
+
+    /**
+     * Queries the address of a property's data from its name
+     * @param name Name of the property we want the data address of
+     * @return Address of the data of the \p name property
+     * @{
+     */
+    void* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name);
+
+    void const* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) const noexcept;
+
+    template<typename T>
+    inline T* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) {
+        return static_cast<T*>(getPropertyAddress(name));
+    }
+
+    template<typename T>
+    inline T const* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) const noexcept {
+        return static_cast<T*>(getPropertyAddress(name));
+    }
+
+    template<typename T>
+    inline bool getPropertyAddress(const char* UTILS_NONNULL name,
+            T* UTILS_NULLABLE* UTILS_NONNULL p) {
+        *p = getPropertyAddress<T>(name);
+        return *p != nullptr;
+    }
+
+    template<typename T>
+    inline bool getPropertyAddress(const char* UTILS_NONNULL name,
+            T* const UTILS_NULLABLE* UTILS_NONNULL p) const noexcept {
+        *p = getPropertyAddress<T>(name);
+        return *p != nullptr;
+    }
+    /** @}*/
+
+    /**
+     * Set the value of a property
+     * @param name Name of the property to set the value of
+     * @param v Value to set
+     * @return true if the operation was successful, false otherwise.
+     * @{
+     */
+    bool setProperty(const char* UTILS_NONNULL name, bool v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, int v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, float v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float2 v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float3 v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float4 v) noexcept;
+    /** @}*/
+
+    /**
+     * Get the value of a property
+     * @param name Name of the property to get the value of
+     * @param v A pointer to a variable which will hold the result
+     * @return true if the call was successful and \p v was updated
+     * @{
+     */
+    bool getProperty(const char* UTILS_NONNULL name, bool* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, int* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, float* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float2* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float3* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float4* UTILS_NONNULL v) const noexcept;
+    /** @}*/
+
+    struct DataSource {
+        void const* UTILS_NULLABLE data;
+        size_t count;
+    };
+
+    DataSource getDataSource(const char* UTILS_NONNULL name) const noexcept;
+
+    struct FrameHistory {
+        using duration_ms = float;
+        duration_ms target{};
+        duration_ms targetWithHeadroom{};
+        duration_ms frameTime{};
+        duration_ms frameTimeDenoised{};
+        float scale = 1.0f;
+        float pid_e = 0.0f;
+        float pid_i = 0.0f;
+        float pid_d = 0.0f;
+    };
+
+protected:
+    // prevent heap allocation
+    ~DebugRegistry() = default;
+};
+
+
+} // namespace filament
+
+#endif /* TNT_FILAMENT_DEBUGREGISTRY_H */