2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.
|
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "Macros.h"
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "base/Ref.h"
|
|
|
|
#include "platform/PlatformMacros.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
#include "Types.h"
|
|
|
|
#include "ShaderCache.h"
|
|
|
|
|
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
|
|
|
#include <unordered_map>
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BACKEND_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class ShaderModule;
|
2022-09-23 22:41:30 +08:00
|
|
|
class VertexLayout;
|
2022-10-12 19:44:31 +08:00
|
|
|
class ProgramManager;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup _backend
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A program.
|
|
|
|
*/
|
2022-07-16 10:43:05 +08:00
|
|
|
class AX_DLL Program : public Ref
|
2019-11-23 20:27:39 +08:00
|
|
|
{
|
|
|
|
public:
|
2022-09-23 22:41:30 +08:00
|
|
|
~Program();
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get engine built-in program.
|
|
|
|
* @param type Specifies the built-in program type.
|
|
|
|
*/
|
2020-10-16 16:23:14 +08:00
|
|
|
static Program* getBuiltinProgram(uint32_t type);
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get uniform location by name.
|
|
|
|
* @param uniform Specifies the uniform name.
|
|
|
|
* @return The uniform location.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
virtual UniformLocation getUniformLocation(std::string_view uniform) const = 0;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get uniform location by engine built-in uniform enum name.
|
|
|
|
* @param name Specifies the engine built-in uniform enum name.
|
|
|
|
* @return The uniform location.
|
|
|
|
*/
|
|
|
|
virtual UniformLocation getUniformLocation(backend::Uniform name) const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get attribute location by attribute name.
|
|
|
|
* @param name Specifies the attribute name.
|
|
|
|
* @return The attribute location.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
virtual int getAttributeLocation(std::string_view name) const = 0;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get attribute location by engine built-in attribute enum name.
|
|
|
|
* @param name Specifies the engine built-in attribute enum name.
|
|
|
|
* @return The attribute location.
|
|
|
|
*/
|
2021-12-25 10:04:45 +08:00
|
|
|
virtual int getAttributeLocation(backend::Attribute name) const = 0;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get maximum vertex location.
|
|
|
|
* @return Maximum vertex locaiton.
|
|
|
|
*/
|
|
|
|
virtual int getMaxVertexLocation() const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get maximum fragment location.
|
|
|
|
* @return Maximum fragment location.
|
|
|
|
*/
|
|
|
|
virtual int getMaxFragmentLocation() const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get active vertex attributes.
|
|
|
|
* @return Active vertex attributes. key is active attribute name, Value is corresponding attribute info.
|
|
|
|
*/
|
2022-09-24 11:38:41 +08:00
|
|
|
virtual const hlookup::string_map<AttributeBindInfo>& getActiveAttributes() const = 0;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get vertex shader.
|
|
|
|
* @return Vertex shader.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
std::string_view getVertexShader() const { return _vertexShader; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get fragment shader.
|
|
|
|
* @ Fragment shader.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
std::string_view getFragmentShader() const { return _fragmentShader; }
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get engine built-in program type.
|
|
|
|
* @return The built-in program type.
|
|
|
|
*/
|
2020-10-16 16:23:14 +08:00
|
|
|
uint32_t getProgramType() const { return _programType; }
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2023-09-01 16:09:27 +08:00
|
|
|
/**
|
2023-09-01 16:09:58 +08:00
|
|
|
* Get uniform buffer size in bytes that can hold all the uniforms.
|
2023-09-01 16:09:27 +08:00
|
|
|
* @param stage Specifies the shader stage. The symbolic constant can be either VERTEX or FRAGMENT.
|
2023-09-01 16:09:58 +08:00
|
|
|
* @return The uniform buffer size in bytes.
|
2023-09-01 16:09:27 +08:00
|
|
|
*/
|
2023-09-01 16:09:58 +08:00
|
|
|
virtual std::size_t getUniformBufferSize(ShaderStage stage) const = 0;
|
2023-09-01 16:09:27 +08:00
|
|
|
|
2023-09-01 16:28:34 +08:00
|
|
|
/**
|
|
|
|
* Get a uniformInfo in given location from the specific shader stage.
|
|
|
|
* @param stage Specifies the shader stage. The symbolic constant can be either VERTEX or FRAGMENT.
|
|
|
|
* @param location Specifies the uniform locaion.
|
|
|
|
* @return The uniformInfo.
|
|
|
|
*/
|
|
|
|
virtual const UniformInfo& getActiveUniformInfo(ShaderStage stage, int location) const = 0;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Get all uniformInfos.
|
|
|
|
* @return The uniformInfos.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
virtual const hlookup::string_map<UniformInfo>& getAllActiveUniformInfo(ShaderStage stage) const = 0;
|
2021-04-22 22:01:47 +08:00
|
|
|
|
2023-09-01 16:28:34 +08:00
|
|
|
/**
|
|
|
|
* Set engin built-in program type.
|
|
|
|
* @param type Specifies the program type.
|
|
|
|
*/
|
|
|
|
void setProgramType(uint32_t type);
|
|
|
|
|
2022-09-23 22:41:30 +08:00
|
|
|
inline VertexLayout* getVertexLayout() const { return _vertexLayout; }
|
|
|
|
|
2021-04-22 22:01:47 +08:00
|
|
|
protected:
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* @param vs Specifes the vertex shader source.
|
|
|
|
* @param fs Specifes the fragment shader source.
|
|
|
|
*/
|
2021-12-31 12:12:40 +08:00
|
|
|
Program(std::string_view vs, std::string_view fs);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_CACHE_TEXTURE_DATA
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* In case of EGL context lost, the engine will reload shaders. Thus location of uniform may changed.
|
2021-12-25 10:04:45 +08:00
|
|
|
* The engine will maintain the relationship between the original uniform location and the current active uniform
|
|
|
|
* location.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param location Specifies original location.
|
|
|
|
* @return Current active uniform location.
|
|
|
|
* @see `int getOriginalLocation(int location) const`
|
|
|
|
*/
|
|
|
|
virtual int getMappedLocation(int location) const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* In case of EGL context lost, the engine will reload shaders. Thus location of uniform may changed.
|
2021-12-25 10:04:45 +08:00
|
|
|
* The engine will maintain the relationship between the original uniform location and the current active uniform
|
|
|
|
* location.
|
2019-11-23 20:27:39 +08:00
|
|
|
* @param location Specifies the current active uniform location.
|
|
|
|
* @return The original uniform location.
|
|
|
|
* @see `int getMappedLocation(int location) const`
|
|
|
|
*/
|
|
|
|
virtual int getOriginalLocation(int location) const = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get all uniform locations.
|
|
|
|
* @return All uniform locations.
|
|
|
|
*/
|
|
|
|
virtual const std::unordered_map<std::string, int> getAllUniformsLocation() const = 0;
|
|
|
|
friend class ProgramState;
|
|
|
|
#endif
|
2022-10-12 19:44:31 +08:00
|
|
|
friend class ProgramManager;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
|
|
|
std::string _vertexShader; ///< Vertex shader.
|
|
|
|
std::string _fragmentShader; ///< Fragment shader.
|
2022-09-23 22:41:30 +08:00
|
|
|
VertexLayout* _vertexLayout = nullptr;
|
2021-12-25 10:04:45 +08:00
|
|
|
uint32_t _programType = ProgramType::CUSTOM_PROGRAM; ///< built-in program type, initial value is CUSTOM_PROGRAM.
|
2019-11-23 20:27:39 +08:00
|
|
|
};
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
// end of _backend group
|
2019-11-23 20:27:39 +08:00
|
|
|
/// @}
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BACKEND_END
|