e825f43935
Shader model (desktop or mobile) wasn't really accounted for in the UI. This means that we will get shaders that look like duplicates (same variant). In this work, we pass the current shader model from engine into the frontend and filter out variants of a different shader model. Moreover, for matinfo, we use a specific dbg shader model (matinfo) to indicate it is in that mode. We add UI in matinfo to show the shadermodel. So UI updates as well.
139 lines
4.2 KiB
C++
139 lines
4.2 KiB
C++
/*
|
|
* Copyright (C) 2019 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.
|
|
*/
|
|
|
|
#ifndef MATDBG_DEBUGSERVER_H
|
|
#define MATDBG_DEBUGSERVER_H
|
|
|
|
#include <utils/CString.h>
|
|
|
|
#include <backend/DriverEnums.h>
|
|
|
|
#include <private/filament/Variant.h>
|
|
|
|
#include <tsl/robin_map.h>
|
|
#include <utils/Mutex.h>
|
|
|
|
class CivetServer;
|
|
|
|
namespace filament::matdbg {
|
|
|
|
using MaterialKey = uint32_t;
|
|
|
|
struct MaterialRecord {
|
|
void* userdata;
|
|
const uint8_t* package;
|
|
size_t packageSize;
|
|
utils::CString name;
|
|
MaterialKey key;
|
|
VariantList activeVariants;
|
|
};
|
|
|
|
// Matches DriverEnums' ShaderModel
|
|
enum class DbgShaderModel {
|
|
MOBILE = 1, //!< Mobile level functionality
|
|
DESKTOP = 2, //!< Desktop level functionality
|
|
MATINFO = 10, //!< To indicate debug server is running from matinfo
|
|
};
|
|
|
|
/**
|
|
* Server-side material debugger.
|
|
*
|
|
* This class manages an HTTP server. It receives material packages from the Filament C++ engine or
|
|
* from a standalone tool such as matinfo.
|
|
*/
|
|
class DebugServer {
|
|
public:
|
|
static std::string_view const kSuccessHeader;
|
|
static std::string_view const kErrorHeader;
|
|
|
|
DebugServer(backend::Backend backend, backend::ShaderLanguage shaderLanguage,
|
|
DbgShaderModel perferredShaderModel, int port);
|
|
~DebugServer();
|
|
|
|
/**
|
|
* Notifies the debugger that the given material package is being loaded into the engine
|
|
* and returns a unique identifier for the material.
|
|
*/
|
|
MaterialKey addMaterial(const utils::CString& name, const void* data, size_t size,
|
|
void* userdata = nullptr);
|
|
|
|
/**
|
|
* Notifies the debugger that the given material has been deleted.
|
|
*/
|
|
void removeMaterial(MaterialKey key);
|
|
|
|
using EditCallback = void(*)(void* userdata, const utils::CString& name, const void*, size_t);
|
|
using QueryCallback = void(*)(void* userdata, VariantList* variants);
|
|
|
|
/**
|
|
* Sets up a callback that allows the Filament engine to listen for shader edits. The callback
|
|
* might be triggered from a secondary thread.
|
|
*/
|
|
void setEditCallback(EditCallback callback) { mEditCallback = callback; }
|
|
|
|
/**
|
|
* Sets up a callback that can ask the Filament engine which shader variants are active. The
|
|
* callback might be triggered from a secondary thread.
|
|
*/
|
|
void setQueryCallback(QueryCallback callback) { mQueryCallback = callback; }
|
|
|
|
bool isReady() const { return mServer; }
|
|
|
|
private:
|
|
// called from ApiHandler
|
|
MaterialRecord const* getRecord(const MaterialKey& key) const;
|
|
|
|
// called from ApiHandler
|
|
void updateActiveVariants();
|
|
|
|
// called from ApiHandler
|
|
/**
|
|
* Replaces the entire content of a particular shader variant. The given shader index uses the
|
|
* same ordering that the variants have within the package.
|
|
*/
|
|
bool handleEditCommand(const MaterialKey& mat, backend::Backend api, int shaderIndex,
|
|
const char* newShaderContent, size_t newShaderLength);
|
|
|
|
backend::Backend const mBackend;
|
|
backend::ShaderLanguage const mShaderLanguage;
|
|
DbgShaderModel const mPreferredShaderModel;
|
|
|
|
CivetServer* mServer;
|
|
|
|
tsl::robin_map<MaterialKey, MaterialRecord> mMaterialRecords;
|
|
mutable utils::Mutex mMaterialRecordsMutex;
|
|
|
|
utils::CString mHtml;
|
|
utils::CString mJavascript;
|
|
utils::CString mCss;
|
|
|
|
utils::CString mChunkedMessage;
|
|
size_t mChunkedMessageRemaining = 0;
|
|
|
|
EditCallback mEditCallback = nullptr;
|
|
QueryCallback mQueryCallback = nullptr;
|
|
|
|
class FileRequestHandler* mFileHandler = nullptr;
|
|
class ApiHandler* mApiHandler = nullptr;
|
|
|
|
friend class FileRequestHandler;
|
|
friend class ApiHandler;
|
|
};
|
|
|
|
} // namespace filament::matdbg
|
|
|
|
#endif // MATDBG_DEBUGSERVER_H
|