[PBR][IBL] Upgrade the cubemap #1412

bigbike · 2021-07-29T00:58:02Z

Motivation and Context

Refactor the cubemap so that it can be used in the PBR IBL.

Allow the developer to compute and customize the mipmap of each level by herself.
Enable multiple drawable groups (with different names as index) in the scene graph.
Upgrade the sensor, the CubeMapCamera accordingly.

How Has This Been Tested

Types of changes

Docs change / refactoring / dependency upgrade
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have completed my CLA (see CONTRIBUTING)
I have added tests to cover my changes.
All new and existing tests passed.

… new_cubemap

Skylion007 · 2021-08-02T15:59:18Z

src/esp/scene/SceneGraph.h

-  // TODO: remove this
-  gfx::DrawableGroup& getDrawables() {
-    return drawableGroups_.at(std::string{});
+  gfx::DrawableGroup& getDrawables(const char* groupName = "") {


Why char pointers as args instead of std::string?

I am passing a string literal to this function, so I use const char* here. It would be faster if std::string can be avoided.
But here it will be converted to the std::string anyway, so I guess you are right, I can just use string directly.

@bigbike Couldn't you use corrade::stringview or something to avoid a copy?

corrade::stringview

@Skylion007 : No, that is exactly for the C string literals. To avoid the copy then the data structure should not use std::string as the key which I doubt.

Skylion007 · 2021-08-02T18:01:58Z

src/esp/scene/SceneGraph.h

  }
-  const gfx::DrawableGroup& getDrawables(const char* groupName = "") const {
-    return drawableGroups_.at(std::string{groupName});
+  const gfx::DrawableGroup& getDrawables(std::string groupName = "") const {


Actually, shoudln't these be const refs?

I do not think so since reference is rvalue.

Wait, it is const string& so it would work (compile).
But it will not help since it will construct a string anyway (because the input parameter is a string literal.)

mosra

Sorry If I'm going too overboard with those microoptimizations, spending a lot of time in low-level code lately and it shows 😅

mosra · 2021-08-03T15:17:41Z

src/esp/gfx/CubeMap.cpp

-void textureTypeSanityCheck(CubeMap::Flags& flag,
-                            CubeMap::TextureType type,
-                            const std::string& functionNameStr) {
+void textureTypeSanityCheck(const std::string& functionNameStr,


I might be overdoing the optimizations, but since the string is used only for assertions and thus should be as zero-overhead as possible, maybe go with just

Suggested change

void textureTypeSanityCheck(const std::string& functionNameStr,

void textureTypeSanityCheck(const char* functionNameStr,

instead?

Ha, thanks! Good suggestions.

mosra · 2021-08-03T15:18:02Z

src/esp/gfx/CubeMap.cpp

    case CubeMap::TextureType::Count:
      break;
  }
  CORRADE_INTERNAL_ASSERT_UNREACHABLE();
 }

+/** @brief do a couple of sanity checks based on mipLevel value */
+void mipLevelSanityCheck(const std::string& msgPrefix,


Same as above, maybe this instead?

Suggested change

void mipLevelSanityCheck(const std::string& msgPrefix,

void mipLevelSanityCheck(const char* msgPrefix,

src/esp/gfx/CubeMap.cpp

mosra · 2021-08-03T15:26:24Z

src/esp/gfx/CubeMap.cpp

+  Mn::Vector2i viewportSize{int(framebufferSize),
+                            int(framebufferSize)};  // at mip level 0


Code golf -- the single-argument constructor is there exactly for this:

Suggested change

Mn::Vector2i viewportSize{int(framebufferSize),

int(framebufferSize)}; // at mip level 0

Mn::Vector2i viewportSize{int(framebufferSize)}; // at mip level 0

About the casts, I ended up using Vector2i instead of Vector2ui for sizes because the extra annoyance with unsigned types wasn't worth it. So maybe here just int framebufferSize could be fine as well.

mosra · 2021-08-03T15:28:06Z

src/esp/gfx/CubeMap.cpp

+                      mipmapLevels_);
+
+  if ((flags_ & Flag::ManuallyBuildMipmap) && (flags_ & Flag::ColorTexture)) {
+    int size = imageSize_ / pow(2, mipLevel);


Suggested change

int size = imageSize_ / pow(2, mipLevel);

int size = imageSize_ / (1 << mipLevel);

(I used to have Math::pow2(n) for this but ... it felt weird to have that wrapping just a bit shift, so it's no longer there.)

mosra · 2021-08-03T15:29:16Z

src/esp/gfx/CubeMap.cpp

-        0,                      // color attachment
-        Mn::Color4{0, 0, 0, 1}  // clear color
+        0,                              // color attachment
+        Mn::Color4{0.0, 0.0, 0.0, 1.0}  // clear color


If you go the extra way, why not extra extra :D

Suggested change

Mn::Color4{0.0, 0.0, 0.0, 1.0} // clear color

Mn::Color4{0.0f, 0.0f, 0.0f, 1.0f} // clear color

(I wonder, did the compiler warn here? My assumption is that it shouldn't have for the integer literals, but it should for the double literals?)

mosra · 2021-08-03T15:30:17Z

src/esp/gfx/CubeMap.cpp

+  int size = imageSize_ / pow(2, mipLevel);
+
+#ifndef MAGNUM_TARGET_WEBGL
+  CORRADE_ASSERT(texture.imageSize(0) == Mn::Vector2i(size, size),


FYI, the single-argument constructor does exactly this:

Suggested change

CORRADE_ASSERT(texture.imageSize(0) == Mn::Vector2i(size, size),

CORRADE_ASSERT(texture.imageSize(0) == Mn::Vector2i{size},

mosra · 2021-08-03T15:42:40Z

src/esp/scene/SceneGraph.h

-  // TODO: remove this
-  gfx::DrawableGroup& getDrawables() {
-    return drawableGroups_.at(std::string{});
+  gfx::DrawableGroup& getDrawables(const std::string& groupName = "") {


Suggested change

gfx::DrawableGroup& getDrawables(const std::string& groupName = "") {

gfx::DrawableGroup& getDrawables(const std::string& groupName = {}) {

std::string initialization from an empty C string literal involves a lot of nasty code including a strlen(), calling the default constructor not.

Same below.

Yeah, good to know.
I was thinking the empty string was OK, since strlen() returned 0.

bigbike added 2 commits July 28, 2021 17:19

minor

effddb7

minor

b64cba5

bigbike requested a review from erikwijmans July 29, 2021 00:58

facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jul 29, 2021

bigbike requested review from aclegg3, jturner65, eundersander and mosra July 29, 2021 00:58

bigbike added 2 commits July 28, 2021 20:41

minor

0aaae45

minor

6cfb755

mosra mentioned this pull request Jul 29, 2021

Migrate from glog to ESP's logging #1411

Merged

bigbike added 2 commits August 1, 2021 16:36

Merge branch 'master' of github.com:facebookresearch/habitat-sim into…

0276139

… new_cubemap

minor

960098f

Skylion007 reviewed Aug 2, 2021

View reviewed changes

bigbike added 2 commits August 2, 2021 09:57

minor

6e92464

minor

9d5468a

Skylion007 reviewed Aug 2, 2021

View reviewed changes

bigbike added 2 commits August 2, 2021 11:18

minor

1ac713d

minor

012f45b

mosra reviewed Aug 3, 2021

View reviewed changes

bigbike added 2 commits August 3, 2021 11:33

minor

4f47d60

minor

3909bfd

mosra approved these changes Aug 4, 2021

View reviewed changes

bigbike merged commit 4ceb312 into master Aug 4, 2021

bigbike deleted the new_cubemap branch August 4, 2021 17:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PBR][IBL] Upgrade the cubemap #1412

[PBR][IBL] Upgrade the cubemap #1412

bigbike commented Jul 29, 2021

Skylion007 Aug 2, 2021

bigbike Aug 2, 2021

Skylion007 Aug 2, 2021

bigbike Aug 2, 2021

Skylion007 Aug 2, 2021

bigbike Aug 2, 2021

bigbike Aug 2, 2021

mosra left a comment

mosra Aug 3, 2021

bigbike Aug 3, 2021

mosra Aug 3, 2021

mosra Aug 3, 2021

mosra Aug 3, 2021

mosra Aug 3, 2021

mosra Aug 3, 2021

mosra Aug 3, 2021

bigbike Aug 3, 2021

	void textureTypeSanityCheck(const std::string& functionNameStr,
	void textureTypeSanityCheck(const char* functionNameStr,

	void mipLevelSanityCheck(const std::string& msgPrefix,
	void mipLevelSanityCheck(const char* msgPrefix,

		Mn::Vector2i viewportSize{int(framebufferSize),
		int(framebufferSize)}; // at mip level 0

	int size = imageSize_ / pow(2, mipLevel);
	int size = imageSize_ / (1 << mipLevel);

	Mn::Color4{0.0, 0.0, 0.0, 1.0} // clear color
	Mn::Color4{0.0f, 0.0f, 0.0f, 1.0f} // clear color

	CORRADE_ASSERT(texture.imageSize(0) == Mn::Vector2i(size, size),
	CORRADE_ASSERT(texture.imageSize(0) == Mn::Vector2i{size},

	gfx::DrawableGroup& getDrawables(const std::string& groupName = "") {
	gfx::DrawableGroup& getDrawables(const std::string& groupName = {}) {

[PBR][IBL] Upgrade the cubemap #1412

[PBR][IBL] Upgrade the cubemap #1412

Conversation

bigbike commented Jul 29, 2021

Motivation and Context

How Has This Been Tested

Types of changes

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mosra left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment