IRenderer/CBooRenderer: Add parameter names to function prototypes

Makes the interface more self-documenting and allows IDEs to perform
better parameter introspection
This commit is contained in:
Lioncash 2020-03-30 00:34:35 -04:00
parent 111f0c3d3a
commit 6ae935924b
3 changed files with 53 additions and 51 deletions

View File

@ -1056,9 +1056,9 @@ std::pair<zeus::CVector2f, zeus::CVector2f> CBooRenderer::SetViewportOrtho(bool
void CBooRenderer::SetClippingPlanes(const zeus::CFrustum& frustum) { x44_frustumPlanes = frustum; } void CBooRenderer::SetClippingPlanes(const zeus::CFrustum& frustum) { x44_frustumPlanes = frustum; }
void CBooRenderer::SetViewport(int l, int b, int w, int h) { void CBooRenderer::SetViewport(int left, int bottom, int width, int height) {
CGraphics::SetViewport(l, b, w, h); CGraphics::SetViewport(left, bottom, width, height);
CGraphics::SetScissor(l, b, w, h); CGraphics::SetScissor(left, bottom, width, height);
} }
void CBooRenderer::SetDebugOption(EDebugOption, int) {} void CBooRenderer::SetDebugOption(EDebugOption, int) {}

View File

@ -198,9 +198,9 @@ public:
void AddWorldSurfaces(CBooModel& model); void AddWorldSurfaces(CBooModel& model);
std::list<CAreaListItem>::iterator FindStaticGeometry(const std::vector<CMetroidModelInstance>*); std::list<CAreaListItem>::iterator FindStaticGeometry(const std::vector<CMetroidModelInstance>*);
void AddStaticGeometry(const std::vector<CMetroidModelInstance>*, const CAreaRenderOctTree*, int areaIdx, void AddStaticGeometry(const std::vector<CMetroidModelInstance>* geometry, const CAreaRenderOctTree* octTree,
const SShader* shaderSet) override; int areaIdx, const SShader* shaderSet) override;
void EnablePVS(const CPVSVisSet&, u32) override; void EnablePVS(const CPVSVisSet& set, u32 areaIdx) override;
void DisablePVS() override; void DisablePVS() override;
void UpdateAreaUniforms(int areaIdx, EWorldShadowMode shadowMode = EWorldShadowMode::None, void UpdateAreaUniforms(int areaIdx, EWorldShadowMode shadowMode = EWorldShadowMode::None,
bool activateLights = true, int cubeFace = -1, const CModelFlags* ballShadowFlags = nullptr); bool activateLights = true, int cubeFace = -1, const CModelFlags* ballShadowFlags = nullptr);
@ -212,17 +212,18 @@ public:
void DrawModelFlat(const CModel& model, const CModelFlags& flags, bool unsortedOnly) override; void DrawModelFlat(const CModel& model, const CModelFlags& flags, bool unsortedOnly) override;
void PostRenderFogs() override; void PostRenderFogs() override;
void SetModelMatrix(const zeus::CTransform& xf) override; void SetModelMatrix(const zeus::CTransform& xf) override;
void AddParticleGen(const CParticleGen&) override; void AddParticleGen(const CParticleGen& gen) override;
void AddParticleGen(const CParticleGen&, const zeus::CVector3f&, const zeus::CAABox&) override; void AddParticleGen(const CParticleGen& gen, const zeus::CVector3f& pos, const zeus::CAABox& bounds) override;
void AddPlaneObject(const void*, const zeus::CAABox&, const zeus::CPlane&, int) override; void AddPlaneObject(const void* obj, const zeus::CAABox& aabb, const zeus::CPlane& plane, int type) override;
void AddDrawable(void const*, const zeus::CVector3f&, const zeus::CAABox&, int, EDrawableSorting) override; void AddDrawable(const void* obj, const zeus::CVector3f& pos, const zeus::CAABox& aabb, int mode,
void SetDrawableCallback(TDrawableCallback, const void*) override; EDrawableSorting sorting) override;
void SetWorldViewpoint(const zeus::CTransform&) override; void SetDrawableCallback(TDrawableCallback cb, const void* ctx) override;
void SetPerspective(float, float, float, float, float) override; void SetWorldViewpoint(const zeus::CTransform& xf) override;
void SetPerspective(float, float, float, float) override; void SetPerspective(float fovy, float width, float height, float znear, float zfar) override;
std::pair<zeus::CVector2f, zeus::CVector2f> SetViewportOrtho(bool, float, float) override; void SetPerspective(float fovy, float aspect, float znear, float zfar) override;
std::pair<zeus::CVector2f, zeus::CVector2f> SetViewportOrtho(bool centered, float znear, float zfar) override;
void SetClippingPlanes(const zeus::CFrustum& frustum) override; void SetClippingPlanes(const zeus::CFrustum& frustum) override;
void SetViewport(int, int, int, int) override; void SetViewport(int left, int bottom, int width, int height) override;
// void SetDepthReadWrite(bool, bool); // void SetDepthReadWrite(bool, bool);
// void SetBlendMode_AdditiveAlpha(); // void SetBlendMode_AdditiveAlpha();
// void SetBlendMode_AlphaBlended(); // void SetBlendMode_AlphaBlended();
@ -246,18 +247,18 @@ public:
// void PrimColor(float, float, float, float); // void PrimColor(float, float, float, float);
// void PrimColor(const zeus::CColor&); // void PrimColor(const zeus::CColor&);
// void EndPrimitive(); // void EndPrimitive();
void SetAmbientColor(const zeus::CColor&) override; void SetAmbientColor(const zeus::CColor& color) override;
void DrawString(const char*, int, int) override; void DrawString(const char* string, int, int) override;
u32 GetFPS() override; u32 GetFPS() override;
void CacheReflection(TReflectionCallback, void*, bool) override; void CacheReflection(TReflectionCallback cb, void* ctx, bool clearAfter) override;
void DrawSpaceWarp(const zeus::CVector3f&, float) override; void DrawSpaceWarp(const zeus::CVector3f& pt, float strength) override;
void DrawThermalModel(const CModel& model, const zeus::CColor& multCol, const zeus::CColor& addCol) override; void DrawThermalModel(const CModel& model, const zeus::CColor& multCol, const zeus::CColor& addCol) override;
void DrawXRayOutline(const zeus::CAABox&) override; void DrawXRayOutline(const zeus::CAABox&) override;
void SetWireframeFlags(int) override; void SetWireframeFlags(int flags) override;
void SetWorldFog(ERglFogMode, float, float, const zeus::CColor&) override; void SetWorldFog(ERglFogMode mode, float startz, float endz, const zeus::CColor& color) override;
void RenderFogVolume(const zeus::CColor&, const zeus::CAABox&, const TLockedToken<CModel>*, void RenderFogVolume(const zeus::CColor& color, const zeus::CAABox& aabb, const TLockedToken<CModel>* model,
const CSkinnedModel*) override; const CSkinnedModel* sModel) override;
void SetThermal(bool, float, const zeus::CColor&) override; void SetThermal(bool thermal, float level, const zeus::CColor& color) override;
void SetThermalColdScale(float scale) override; void SetThermalColdScale(float scale) override;
void DoThermalBlendCold() override; void DoThermalBlendCold() override;
void DoThermalBlendHot() override; void DoThermalBlendHot() override;

View File

@ -35,11 +35,11 @@ public:
enum class EPrimitiveType {}; enum class EPrimitiveType {};
virtual ~IRenderer() = default; virtual ~IRenderer() = default;
virtual void AddStaticGeometry(const std::vector<CMetroidModelInstance>*, const CAreaRenderOctTree*, int, virtual void AddStaticGeometry(const std::vector<CMetroidModelInstance>* geometry, const CAreaRenderOctTree* octTree,
const SShader*) = 0; int areaIdx, const SShader* shaderSet) = 0;
virtual void EnablePVS(const CPVSVisSet&, u32) = 0; virtual void EnablePVS(const CPVSVisSet& set, u32 areaIdx) = 0;
virtual void DisablePVS() = 0; virtual void DisablePVS() = 0;
virtual void RemoveStaticGeometry(const std::vector<CMetroidModelInstance>*) = 0; virtual void RemoveStaticGeometry(const std::vector<CMetroidModelInstance>* geometry) = 0;
virtual void DrawAreaGeometry(int areaIdx, int mask, int targetMask) = 0; virtual void DrawAreaGeometry(int areaIdx, int mask, int targetMask) = 0;
virtual void DrawUnsortedGeometry(int areaIdx, int mask, int targetMask, bool shadowRender = false) = 0; virtual void DrawUnsortedGeometry(int areaIdx, int mask, int targetMask, bool shadowRender = false) = 0;
virtual void DrawSortedGeometry(int areaIdx, int mask, int targetMask) = 0; virtual void DrawSortedGeometry(int areaIdx, int mask, int targetMask) = 0;
@ -47,17 +47,18 @@ public:
virtual void DrawModelFlat(const CModel& model, const CModelFlags& flags, bool unsortedOnly) = 0; virtual void DrawModelFlat(const CModel& model, const CModelFlags& flags, bool unsortedOnly) = 0;
virtual void PostRenderFogs() = 0; virtual void PostRenderFogs() = 0;
virtual void SetModelMatrix(const zeus::CTransform& xf) = 0; virtual void SetModelMatrix(const zeus::CTransform& xf) = 0;
virtual void AddParticleGen(const CParticleGen&) = 0; virtual void AddParticleGen(const CParticleGen& gen) = 0;
virtual void AddParticleGen(const CParticleGen&, const zeus::CVector3f&, const zeus::CAABox&) = 0; virtual void AddParticleGen(const CParticleGen& gen, const zeus::CVector3f& pos, const zeus::CAABox& bounds) = 0;
virtual void AddPlaneObject(const void*, const zeus::CAABox&, const zeus::CPlane&, int) = 0; virtual void AddPlaneObject(const void* obj, const zeus::CAABox& aabb, const zeus::CPlane& plane, int type) = 0;
virtual void AddDrawable(void const*, const zeus::CVector3f&, const zeus::CAABox&, int, EDrawableSorting) = 0; virtual void AddDrawable(const void* obj, const zeus::CVector3f& pos, const zeus::CAABox& aabb, int mode,
virtual void SetDrawableCallback(TDrawableCallback, const void*) = 0; EDrawableSorting sorting) = 0;
virtual void SetWorldViewpoint(const zeus::CTransform&) = 0; virtual void SetDrawableCallback(TDrawableCallback cb, const void* ctx) = 0;
virtual void SetPerspective(float, float, float, float, float) = 0; virtual void SetWorldViewpoint(const zeus::CTransform& xf) = 0;
virtual void SetPerspective(float, float, float, float) = 0; virtual void SetPerspective(float fovy, float width, float height, float znear, float zfar) = 0;
virtual std::pair<zeus::CVector2f, zeus::CVector2f> SetViewportOrtho(bool, float, float) = 0; virtual void SetPerspective(float fovy, float aspect, float znear, float zfar) = 0;
virtual void SetClippingPlanes(const zeus::CFrustum&) = 0; virtual std::pair<zeus::CVector2f, zeus::CVector2f> SetViewportOrtho(bool centered, float znear, float zfar) = 0;
virtual void SetViewport(int, int, int, int) = 0; virtual void SetClippingPlanes(const zeus::CFrustum& frustum) = 0;
virtual void SetViewport(int left, int bottom, int width, int height) = 0;
// virtual void SetDepthReadWrite(bool, bool)=0; // virtual void SetDepthReadWrite(bool, bool)=0;
// virtual void SetBlendMode_AdditiveAlpha()=0; // virtual void SetBlendMode_AdditiveAlpha()=0;
// virtual void SetBlendMode_AlphaBlended()=0; // virtual void SetBlendMode_AlphaBlended()=0;
@ -81,18 +82,18 @@ public:
// virtual void PrimColor(float, float, float, float)=0; // virtual void PrimColor(float, float, float, float)=0;
// virtual void PrimColor(const zeus::CColor&)=0; // virtual void PrimColor(const zeus::CColor&)=0;
// virtual void EndPrimitive()=0; // virtual void EndPrimitive()=0;
virtual void SetAmbientColor(const zeus::CColor&) = 0; virtual void SetAmbientColor(const zeus::CColor& color) = 0;
virtual void DrawString(const char*, int, int) = 0; virtual void DrawString(const char* string, int, int) = 0;
virtual u32 GetFPS() = 0; virtual u32 GetFPS() = 0;
virtual void CacheReflection(TReflectionCallback, void*, bool) = 0; virtual void CacheReflection(TReflectionCallback cb, void* ctx, bool clearAfter) = 0;
virtual void DrawSpaceWarp(const zeus::CVector3f&, float) = 0; virtual void DrawSpaceWarp(const zeus::CVector3f& pt, float strength) = 0;
virtual void DrawThermalModel(const CModel&, const zeus::CColor&, const zeus::CColor&) = 0; virtual void DrawThermalModel(const CModel& model, const zeus::CColor& multCol, const zeus::CColor& addCol) = 0;
virtual void DrawXRayOutline(const zeus::CAABox&) = 0; virtual void DrawXRayOutline(const zeus::CAABox& aabb) = 0;
virtual void SetWireframeFlags(int) = 0; virtual void SetWireframeFlags(int flags) = 0;
virtual void SetWorldFog(ERglFogMode, float, float, const zeus::CColor&) = 0; virtual void SetWorldFog(ERglFogMode mode, float startz, float endz, const zeus::CColor& color) = 0;
virtual void RenderFogVolume(const zeus::CColor&, const zeus::CAABox&, const TLockedToken<CModel>*, virtual void RenderFogVolume(const zeus::CColor& color, const zeus::CAABox& aabb, const TLockedToken<CModel>* model,
const CSkinnedModel*) = 0; const CSkinnedModel* sModel) = 0;
virtual void SetThermal(bool, float, const zeus::CColor&) = 0; virtual void SetThermal(bool thermal, float level, const zeus::CColor& color) = 0;
virtual void SetThermalColdScale(float scale) = 0; virtual void SetThermalColdScale(float scale) = 0;
virtual void DoThermalBlendCold() = 0; virtual void DoThermalBlendCold() = 0;
virtual void DoThermalBlendHot() = 0; virtual void DoThermalBlendHot() = 0;