Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAYA106075 - Introducing color cache to improve performance #2059

Merged
merged 2 commits into from
Feb 2, 2022
Merged

MAYA106075 - Introducing color cache to improve performance #2059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00abf6f
Introducing color cache to improve performance of ProxyRenderDelegate…
vlasovi Feb 2, 2022
e22e7cc
Adding a cache test before entering the mutex to reduce the number o…
vlasovi Feb 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 69 additions & 35 deletions lib/mayaUsd/render/vp2RenderDelegate/proxyRenderDelegate.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -732,6 +732,7 @@ void ProxyRenderDelegate::_Execute(const MHWRender::MFrameContext& frameContext)
MProfilingScope profilingScope(
HdVP2RenderDelegate::sProfilerCategory, MProfiler::kColorC_L1, "Execute");

++_frameCounter;
_UpdateRenderTags();

// If update for selection is enabled, the draw data for the "points" repr
Expand Down Expand Up @@ -1484,21 +1485,33 @@ const MColor& ProxyRenderDelegate::GetWireframeColor() const { return _wireframe

GfVec3f ProxyRenderDelegate::GetCurveDefaultColor()
{
MDoubleArray curveColorResult;
{
std::lock_guard<std::mutex> mutexGuard(_mayaCommandEngineMutex);
MGlobal::executeCommand(
"int $index = `displayColor -q -dormant \"curve\"`; colorIndex -q $index;",
curveColorResult);
// Check the cache. It is safe since _dormantCurveColorCache.second is atomic
if (_dormantCurveColorCache.second == _frameCounter) {
return _dormantCurveColorCache.first;
}

// Enter the mutex and check the cache again
std::lock_guard<std::mutex> mutexGuard(_mayaCommandEngineMutex);
if (_dormantCurveColorCache.second == _frameCounter) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if we make _dormantCurveColorCache.second a std::atomic<uint64_t> then we could move acquiring the mutex to be after this check to see if we already have already read the value this frame. That would prevent lots of mutex acquires which might be faster.

In the case where the test fails we'd have to acquire the mutex and re-test to avoid reading the value two or more times, but that is okay.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The std::atomic<uint64_t> approach may be faster but not necessarily. We can try it if we still need to after this change.

return _dormantCurveColorCache.first;
}

if (curveColorResult.length() == 3) {
return GfVec3f(curveColorResult[0], curveColorResult[1], curveColorResult[2]);
// Execute Maya command engine to fetch the color
MDoubleArray colorResult;
MGlobal::executeCommand(
"int $index = `displayColor -q -dormant \"curve\"`; colorIndex -q $index;", colorResult);

if (colorResult.length() == 3) {
_dormantCurveColorCache.first = GfVec3f(colorResult[0], colorResult[1], colorResult[2]);
} else {
TF_WARN("Failed to obtain curve default color");
// In case of an error, return the default navy-blue color
return GfVec3f(0.000f, 0.016f, 0.376f);
_dormantCurveColorCache.first = GfVec3f(0.000f, 0.016f, 0.376f);
}

// Update the cache and return
_dormantCurveColorCache.second = _frameCounter;
return _dormantCurveColorCache.first;
}

//! \brief
Expand All @@ -1508,16 +1521,36 @@ MColor ProxyRenderDelegate::GetSelectionHighlightColor(const TfToken& className)
static const MColor kDefaultActiveColor(1.0f, 1.0f, 1.0f, 1.0f);

// Prepare to construct the query command.
bool fromPalette = true;
const char* queryName = "unsupported";
bool fromPalette = true;
const char* queryName = "unsupported";
MColorCache* colorCache = nullptr;
if (className.IsEmpty()) {
colorCache = &_leadColorCache;
fromPalette = false;
queryName = "lead";
} else if (className == HdPrimTypeTokens->mesh) {
colorCache = &_activeMeshColorCache;
fromPalette = false;
queryName = "polymeshActive";
} else if (className == HdPrimTypeTokens->basisCurves) {
colorCache = &_activeCurveColorCache;
queryName = "curve";
} else {
TF_WARN(
"ProxyRenderDelegate::GetSelectionHighlightColor - unsupported class: '%s'",
className.GetString().c_str());
return kDefaultActiveColor;
}

// Check the cache. It is safe since colorCache->second is atomic
if (colorCache->second == _frameCounter) {
return colorCache->first;
}

// Enter the mutex and check the cache again
std::lock_guard<std::mutex> mutexGuard(_mayaCommandEngineMutex);
if (colorCache->second == _frameCounter) {
return colorCache->first;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could use a similar lock-free pattern here.

}

// Construct the query command string.
Expand All @@ -1533,37 +1566,38 @@ MColor ProxyRenderDelegate::GetSelectionHighlightColor(const TfToken& className)
}

// Query and return the selection color.
{
MDoubleArray colorResult;
std::lock_guard<std::mutex> mutexGuard(_mayaCommandEngineMutex);
MGlobal::executeCommand(queryCommand, colorResult);

if (colorResult.length() == 3) {
MColor color(colorResult[0], colorResult[1], colorResult[2]);

if (className.IsEmpty()) {
// The 'lead' color is returned in display space, so we need to convert it to
// rendering space. However, function MColorPickerUtilities::applyViewTransform
// is supported only starting from Maya 2023, so in opposite case we just return
// the default lead color.
MDoubleArray colorResult;
MGlobal::executeCommand(queryCommand, colorResult);

if (colorResult.length() == 3) {
MColor color(colorResult[0], colorResult[1], colorResult[2]);

if (className.IsEmpty()) {
// The 'lead' color is returned in display space, so we need to convert it to
// rendering space. However, function MColorPickerUtilities::applyViewTransform
// is supported only starting from Maya 2023, so in opposite case we just return
// the default lead color.
#if MAYA_API_VERSION >= 20230000
return MColorPickerUtilities::applyViewTransform(
color, MColorPickerUtilities::kInverse);
colorCache->first
= MColorPickerUtilities::applyViewTransform(color, MColorPickerUtilities::kInverse);
#else
return kDefaultLeadColor;
colorCache->first = kDefaultLeadColor;
#endif
} else {
return color;
}
} else {
TF_WARN(
"Failed to obtain selection highlight color for '%s' objects",
className.IsEmpty() ? "lead" : className.GetString().c_str());
colorCache->first = color;
}
} else {
TF_WARN(
"Failed to obtain selection highlight color for '%s' objects",
className.IsEmpty() ? "lead" : className.GetString().c_str());

// In case of any failure, return the default color
colorCache->first = className.IsEmpty() ? kDefaultLeadColor : kDefaultActiveColor;
}

// In case of any failure, return the default color
return className.IsEmpty() ? kDefaultLeadColor : kDefaultActiveColor;
// Update the cache and return
colorCache->second = _frameCounter;
return colorCache->first;
}

bool ProxyRenderDelegate::DrawRenderTag(const TfToken& renderTag) const
Expand Down
9 changes: 9 additions & 0 deletions lib/mayaUsd/render/vp2RenderDelegate/proxyRenderDelegate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,15 @@ class ProxyRenderDelegate : public MHWRender::MPxSubSceneOverride
MColor _wireframeColor; //!< Wireframe color assigned to the proxy shape

std::mutex _mayaCommandEngineMutex;
uint64_t _frameCounter { 0 };

typedef std::pair<MColor, std::atomic<uint64_t>> MColorCache;
typedef std::pair<GfVec3f, std::atomic<uint64_t>> GfVec3fCache;

MColorCache _activeMeshColorCache { MColor(), 0 };
MColorCache _activeCurveColorCache { MColor(), 0 };
MColorCache _leadColorCache { MColor(), 0 };
GfVec3fCache _dormantCurveColorCache { GfVec3f(), 0 };

//! A collection of Rprims to prepare render data for specified reprs
std::unique_ptr<HdRprimCollection> _defaultCollection;
Expand Down