Skip to content

Commit 46b14f2

Browse files
Guantol-LematGuantol-Lemat
committed
Add detailed error messages to LoadShader
1 parent 6594c2f commit 46b14f2

File tree

5 files changed

+113
-34
lines changed

5 files changed

+113
-34
lines changed

‎repentogon/LuaInterfaces/LuaRender.cpp‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2929,19 +2929,13 @@ LUA_FUNCTION(Lua_Renderer_LoadShader)
29292929

29302930
auto& terminator = descriptor.emplace_back();
29312931

2932-
KAGE_Graphics_Shader* shader = ShaderLoader::LoadShader(path, descriptor.data());
2933-
if (!shader)
2932+
auto shader = ShaderLoader::LoadShader(path, descriptor.data());
2933+
if (shader.is_err())
29342934
{
2935-
luaL_error(L, "Unable to load shader \"%s\"", path.c_str());
2935+
luaL_error(L, "Unable to load shader \"%s\": %s", path.c_str(), shader.unwrap_err().c_str());
29362936
}
29372937

2938-
// confirm correct vertex descriptor
2939-
if (!ShaderUtils::UsesVertexDescriptor(*shader, descriptor.data(), descriptor.size() - 1))
2940-
{
2941-
luaL_error(L, "Incorrect VertexDescriptor for \"%s\"", path.c_str());
2942-
}
2943-
2944-
LuaShader::NewUserdata(L, shader);
2938+
LuaShader::NewUserdata(L, shader.unwrap());
29452939

29462940
return 1;
29472941
}

‎repentogon/MiscFunctions.h‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,74 @@
1313

1414
extern std::string GetUserPath();
1515

16+
namespace REPENTOGON {
17+
template <typename T>
18+
struct Ok
19+
{
20+
T value;
21+
};
22+
23+
template <typename E>
24+
struct Err
25+
{
26+
E error;
27+
};
28+
29+
template <typename T>
30+
Ok<T> ok(T v)
31+
{
32+
return Ok<T>{v};
33+
}
34+
35+
template <typename E>
36+
Err<E> err(E e)
37+
{
38+
return Err<E>{e};
39+
}
40+
41+
template<typename T, typename E>
42+
class Result
43+
{
44+
std::variant<Ok<T>, Err<E>> data;
45+
46+
public:
47+
48+
Result(Ok<T> v) : data(v) {}
49+
Result(Err<E> e) : data(e) {}
50+
51+
bool is_ok() const
52+
{
53+
return std::holds_alternative<Ok<T>>(data);
54+
}
55+
56+
bool is_err() const
57+
{
58+
return std::holds_alternative<Err<E>>(data);
59+
}
60+
61+
const T& unwrap() const
62+
{
63+
return std::get<Ok<T>>(data).value;
64+
}
65+
66+
T& unwrap()
67+
{
68+
return std::get<Ok<T>>(data).value;
69+
}
70+
71+
const E& unwrap_err() const
72+
{
73+
return std::get<Err<E>>(data).error;
74+
}
75+
76+
E& unwrap_err()
77+
{
78+
return std::get<Err<E>>(data).error;
79+
}
80+
81+
};
82+
}
83+
1684
namespace REPENTOGON {
1785
static auto gameStartTime = std::chrono::high_resolution_clock::now();
1886
static std::string optionsPath(GetUserPath() + "/Documents/My Games/Binding of Isaac Repentance+/Repentogon/");

‎repentogon/Patches/Anm2Extras.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,14 +157,14 @@ KAGE_Graphics_Shader* GetCustomShaderForLayer(LayerState* layer, const bool cham
157157
KAGE_Graphics_Shader* GetCustomShader(const std::string& input_path, const bool champion) {
158158
const KAGE_Graphics_VertexAttributeDescriptor* desc = champion ? &g_ColorOffset_Champion_VertexAttributes : &g_ColorOffset_VertexAttributes;
159159
size_t numAttributes = champion ? ShaderUtils::ColorOffsetChampion::NUM_ATTRIBUTES : ShaderUtils::ColorOffset::NUM_ATTRIBUTES;
160-
KAGE_Graphics_Shader* shader = ShaderLoader::LoadShader(input_path, desc);
160+
auto shader = ShaderLoader::LoadShader(input_path, desc);
161161

162-
if (!shader || !shader->_initialized || !ShaderUtils::UsesVertexDescriptor(*shader, desc, numAttributes))
162+
if (shader.is_err())
163163
{
164164
return nullptr;
165165
}
166166

167-
return shader;
167+
return shader.unwrap();
168168
}
169169

170170
bool SetCustomShader(ANM2* anm2, const std::string& path, const bool champion) {

‎repentogon/ShaderLoader.cpp‎

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ static bool is_vertex_descriptor_compatible(const KAGE_Graphics_Shader& shader,
120120
}
121121

122122
size_t count = shaderAttributes.size();
123-
// use indirect sorting to not copy and to not modify buffer.
123+
// use indirect sorting to avoid copying or modifying the vertexDesc.
124124
std::vector<size_t> sortIndices(count);
125125
std::iota(sortIndices.begin(), sortIndices.end(), 0);
126126

@@ -148,61 +148,77 @@ static bool is_vertex_descriptor_compatible(const KAGE_Graphics_Shader& shader,
148148
return true;
149149
}
150150

151-
static bool load_shader(Shader& shader, const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc)
151+
static REPENTOGON::Result<KAGE_Graphics_Shader*, std::string> load_shader(Shader& shader, const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc)
152152
{
153153
const std::string modPath = find_shader(path);
154154
if (modPath.empty())
155155
{
156-
return false;
156+
return REPENTOGON::err(std::string("No shader exists for the specified path"));
157157
}
158158

159+
assert(!shader.shader._initialized);
159160
KAGE_Graphics_Manager_GL::LoadShader(&shader.shader, vertexDesc, modPath.c_str());
160161
if (!shader.shader._initialized)
161162
{
162-
return false;
163+
return REPENTOGON::err(std::string("Shader failed to compile"));
163164
}
164165

165166
if (!is_vertex_descriptor_compatible(shader.shader, vertexDesc))
166167
{
167-
return false;
168+
return REPENTOGON::err(std::string("Vertex Descriptor is incompatible with shader attributes"));
168169
}
169170

170-
return true;
171+
return REPENTOGON::ok(&shader.shader);
171172
}
172173

173-
KAGE_Graphics_Shader* ShaderLoader::LoadShader(const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc)
174+
REPENTOGON::Result<KAGE_Graphics_Shader*, std::string> ShaderLoader::LoadShader(const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc)
174175
{
175176
const std::string key = normalize_shader_path(path);
176177
auto [it, inserted] = s_shaderMap.try_emplace(key);
177178
Shader& shader = it->second;
178179

179180
if (inserted)
180181
{
181-
bool success = load_shader(shader, path, vertexDesc);
182-
if (!success)
182+
auto result = load_shader(shader, path, vertexDesc);
183+
if (result.is_err())
183184
{
184185
s_shaderMap.erase(it);
185-
return nullptr;
186186
}
187-
shader.SetMetadata(path, vertexDesc);
187+
else
188+
{
189+
shader.SetMetadata(path, vertexDesc);
190+
}
191+
192+
return result;
188193
}
189-
else if (shader.metadata.forceReload)
194+
195+
if (shader.metadata.forceReload)
190196
{
191-
bool success = load_shader(shader, path, vertexDesc);
192-
if (!success)
197+
auto result = load_shader(shader, path, vertexDesc);
198+
if (result.is_err())
193199
{
194200
shader.shader.HardReset();
195-
return nullptr;
196201
}
197-
shader.SetMetadata(path, vertexDesc);
198-
shader.metadata.forceReload = false;
202+
else
203+
{
204+
shader.SetMetadata(path, vertexDesc);
205+
shader.metadata.forceReload = false;
206+
}
207+
208+
return result;
199209
}
200-
else if (!shader.shader._initialized || !ShaderUtils::UsesVertexDescriptor(shader.shader, vertexDesc, ShaderUtils::GetNumVertexAttributes(vertexDesc)))
210+
211+
if (!shader.shader._initialized)
212+
{
213+
return REPENTOGON::err(std::string("Shader failed to compile"));
214+
}
215+
216+
if (!ShaderUtils::UsesVertexDescriptor(shader.shader, vertexDesc, ShaderUtils::GetNumVertexAttributes(vertexDesc)))
201217
{
202-
return nullptr;
218+
return REPENTOGON::err(std::string("Incorrect Vertex Descriptor"));
203219
}
204220

205-
return &shader.shader;
221+
return REPENTOGON::ok(&shader.shader);
206222
}
207223

208224
void ShaderLoader::detail::ReloadShaders()

‎repentogon/ShaderLoader.h‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
#pragma once
22

33
#include "IsaacRepentance.h"
4+
#include "MiscFunctions.h"
45

56
namespace ShaderLoader
67
{
7-
KAGE_Graphics_Shader* LoadShader(const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc);
8+
REPENTOGON::Result<KAGE_Graphics_Shader*, std::string> LoadShader(const std::string& path, const KAGE_Graphics_VertexAttributeDescriptor* vertexDesc);
89
}
910

1011
namespace ShaderLoader::detail

0 commit comments

Comments
 (0)