Merge pull request #804 from CesiumGS/image-size-bytes

Track image data size independently of the `pixelData` array size

Cesium3DTilesSelection/src/Tile.cpp

@@ -173,7 +173,10 @@ int64_t Tile::computeByteSize() const noexcept {
         bytes -= bufferViews[size_t(bufferView)].byteLength;
       }
 
-      bytes += int64_t(image.cesium.pixelData.size());
+      // lastKnownSizeInBytes is set in
+      // TilesetContentManager::ContentKindSetter, if not sooner (e.g., by the
+      // renderer implementation).
+      bytes += image.cesium.lastKnownSizeInBytes;
     }
   }
 

Cesium3DTilesSelection/src/TilesetContentManager.cpp

@@ -48,6 +48,17 @@ struct ContentKindSetter {
   }
 
   void operator()(CesiumGltf::Model&& model) {
+    for (CesiumGltf::Image& image : model.images) {
+      // If the image size hasn't been overridden, store the pixelData
+      // size now. We'll be adding this number to our total memory usage soon,
+      // and remove it when the tile is later unloaded, and we must use
+      // the same size in each case.
+      if (image.cesium.lastKnownSizeInBytes < 0) {
+        image.cesium.lastKnownSizeInBytes =
+            int64_t(image.cesium.pixelData.size());
+      }
+    }
+
     auto pRenderContent = std::make_unique<TileRenderContent>(std::move(model));
     pRenderContent->setRenderResources(pRenderResources);
     if (rasterOverlayDetails) {

CesiumGltf/include/CesiumGltf/ImageCesium.h

@@ -74,7 +74,7 @@ struct CESIUMGLTF_API ImageCesium final {
    * Otherwise, this buffer will store the compressed pixel data in the
    * specified format.
    *
-   * If mipOffsets is not empty, this buffer will contains multiple mips
+   * If mipPositions is not empty, this buffer will contains multiple mips
    * back-to-back.
    *
    * When this is an uncompressed texture:
@@ -95,5 +95,20 @@ struct CESIUMGLTF_API ImageCesium final {
    * | 4                  | red, green, blue, alpha   |
    */
   std::vector<std::byte> pixelData;
+
+  /**
+   * @brief The effective size of this image, in bytes, for estimating resource
+   * usage for caching purposes.
+   *
+   * When this value is less than zero (the default), the size of this image
+   * should be assumed to equal the size of the {@link pixelData} array. When
+   * it is greater than or equal to zero, the specified size should be used
+   * instead. For example, the overridden size may account for:
+   *   * The `pixelData` being cleared during the load process in order to save
+   * memory.
+   *   * The cost of any renderer resources (e.g., GPU textures) created for
+   * this image.
+   */
+  int64_t lastKnownSizeInBytes = -1;
 };
 } // namespace CesiumGltf

CesiumRasterOverlays/src/RasterOverlayTileProvider.cpp

@@ -91,7 +91,7 @@ RasterOverlayTileProvider::getTile(
 void RasterOverlayTileProvider::removeTile(RasterOverlayTile* pTile) noexcept {
   assert(pTile->getReferenceCount() == 0);
 
-  this->_tileDataBytes -= int64_t(pTile->getImage().pixelData.size());
+  this->_tileDataBytes -= pTile->getImage().lastKnownSizeInBytes;
 }
 
 CesiumAsync::Future<TileProviderAndTile>
@@ -343,7 +343,18 @@ CesiumAsync::Future<TileProviderAndTile> RasterOverlayTileProvider::doLoad(
                     : RasterOverlayTile::MoreDetailAvailable::No;
             pTile->setState(result.state);
 
-            thiz->_tileDataBytes += int64_t(pTile->getImage().pixelData.size());
+            ImageCesium& imageCesium = pTile->getImage();
+
+            // If the image size hasn't been overridden, store the pixelData
+            // size now. We'll add this number to our total memory usage now,
+            // and remove it when the tile is later unloaded, and we must use
+            // the same size in each case.
+            if (imageCesium.lastKnownSizeInBytes < 0) {
+              imageCesium.lastKnownSizeInBytes =
+                  int64_t(imageCesium.pixelData.size());
+            }
+
+            thiz->_tileDataBytes += imageCesium.lastKnownSizeInBytes;
 
             thiz->finalizeTileLoad(isThrottledLoad);