From d15657616a7b3dbb80a4ee2e7f1c4adeda09a627 Mon Sep 17 00:00:00 2001
From: howard-stearns <howard.stearns@gmail.com>
Date: Thu, 8 Jun 2017 10:40:20 -0700
Subject: [PATCH] comments

---
 .../src/display-plugins/OpenGLDisplayPlugin.cpp           | 8 +++++---
 .../src/display-plugins/hmd/HmdDisplayPlugin.cpp          | 1 +
 2 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.cpp b/libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.cpp
index 84724a22d8..ba8842c2ec 100644
--- a/libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.cpp
+++ b/libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.cpp
@@ -616,6 +616,7 @@ void OpenGLDisplayPlugin::compositeLayers() {
 
 void OpenGLDisplayPlugin::internalPresent() {
     render([&](gpu::Batch& batch) {
+        // Note: _displayTexture must currently be the same size as the display.
         uvec2 dims = _displayTexture ? uvec2(_displayTexture->getDimensions()) : getSurfacePixels();
         auto viewport = ivec4(uvec2(0),  dims);
         renderFromTexture(batch, _displayTexture ? _displayTexture : _compositeFramebuffer->getRenderBuffer(0), viewport, viewport);
@@ -702,16 +703,17 @@ void OpenGLDisplayPlugin::withMainThreadContext(std::function<void()> f) const {
 }
 
 bool OpenGLDisplayPlugin::setDisplayTexture(const QString& name) {
+    // Note: it is the caller's responsibility to keep the network texture in cache.
     if (name.isEmpty()) {
         _displayTexture.reset();
         return true;
     }
     auto textureCache = DependencyManager::get<TextureCache>();
-    auto networkTexture = textureCache->getTexture(name);
-    if (!networkTexture) {
+    auto displayNetworkTexture = textureCache->getTexture(name);
+    if (!displayNetworkTexture) {
         return false;
     }
-    _displayTexture = networkTexture->getGPUTexture();
+    _displayTexture = displayNetworkTexture->getGPUTexture();
     return !!_displayTexture;
 }
 
diff --git a/libraries/display-plugins/src/display-plugins/hmd/HmdDisplayPlugin.cpp b/libraries/display-plugins/src/display-plugins/hmd/HmdDisplayPlugin.cpp
index 96d12a7f70..b3797853f0 100644
--- a/libraries/display-plugins/src/display-plugins/hmd/HmdDisplayPlugin.cpp
+++ b/libraries/display-plugins/src/display-plugins/hmd/HmdDisplayPlugin.cpp
@@ -213,6 +213,7 @@ void HmdDisplayPlugin::internalPresent() {
     hmdPresent();
 
     if (_displayTexture) {
+        // Note: _displayTexture must currently be the same size as the display.
         uvec2 dims = uvec2(_displayTexture->getDimensions());
         auto viewport = ivec4(uvec2(0), dims);
         render([&](gpu::Batch& batch) {