SCI32: Remove dead code related to priority map handling

The priority map is not used at all in SCI32 at the engine level by
design, so all the relevant code that handles picture priority is
pretty much dead

4 files changed, 38 insertions, 154 deletions

diff --git a/engines/sci/graphics/celobj32.cpp b/engines/sci/graphics/celobj32.cpp
index eb71a45734..34ae15578f 100644
--- a/engines/sci/graphics/celobj32.cpp
+++ b/engines/sci/graphics/celobj32.cpp
@@ -335,152 +335,87 @@ struct MAPPER_NoMDNoSkip {
 };
 
 void CelObj::draw(Buffer &target, const ScreenItem &screenItem, const Common::Rect &targetRect) const {
-	const Buffer &priorityMap = g_sci->_gfxFrameout->getPriorityMap();
 	const Common::Point &scaledPosition = screenItem._scaledPosition;
 	const Ratio &scaleX = screenItem._ratioX;
 	const Ratio &scaleY = screenItem._ratioY;
 
 	if (_remap) {
-		if (g_sci->_gfxFrameout->_hasRemappedScreenItem) {
-			const uint8 priority = MAX((int16)0, MIN((int16)255, screenItem._priority));
-
-			// NOTE: In the original engine code, there was a second branch for
-			// _remap here that would then call the following functions if _remap was false:
-			//
-			// drawHzFlip(Buffer &, Buffer &, Common::Rect &, Common::Point &, uint8)
-			// drawNoFlip(Buffer &, Buffer &, Common::Rect &, Common::Point &, uint8)
-			// drawUncompHzFlip(Buffer &, Buffer &, Common::Rect &, Common::Point &, uint8)
-			// drawUncompNoFlip(Buffer &, Buffer &, Common::Rect &, Common::Point &, uint8)
-			// scaleDraw(Buffer &, Buffer &, Ratio &, Ratio &, Common::Rect &, Common::Point &, uint8)
-			// scaleDrawUncomp(Buffer &, Buffer &, Ratio &, Ratio &, Common::Rect &, Common::Point &, uint8)
-			//
-			// However, obviously, _remap cannot be false here. This dead code branch existed in
-			// at least SCI2/GK1 and SCI2.1/SQ6.
-
+		// NOTE: In the original code this check was `g_Remap_numActiveRemaps && _remap`,
+		// but since we are already in a `_remap` branch, there is no reason to check it
+		// again
+		if (g_sci->_gfxRemap32->getRemapCount()) {
 			if (scaleX.isOne() && scaleY.isOne()) {
 				if (_compressionType == kCelCompressionNone) {
 					if (_drawMirrored) {
-						drawUncompHzFlipMap(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompHzFlipMap(target, targetRect, scaledPosition);
 					} else {
-						drawUncompNoFlipMap(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompNoFlipMap(target, targetRect, scaledPosition);
 					}
 				} else {
 					if (_drawMirrored) {
-						drawHzFlipMap(target, priorityMap, targetRect, scaledPosition, priority);
+						drawHzFlipMap(target, targetRect, scaledPosition);
 					} else {
-						drawNoFlipMap(target, priorityMap, targetRect, scaledPosition, priority);
+						drawNoFlipMap(target, targetRect, scaledPosition);
 					}
 				}
 			} else {
 				if (_compressionType == kCelCompressionNone) {
-					scaleDrawUncompMap(target, priorityMap, scaleX, scaleY, targetRect, scaledPosition, priority);
+					scaleDrawUncompMap(target, scaleX, scaleY, targetRect, scaledPosition);
 				} else {
-					scaleDrawMap(target, priorityMap, scaleX, scaleY, targetRect, scaledPosition, priority);
+					scaleDrawMap(target, scaleX, scaleY, targetRect, scaledPosition);
 				}
 			}
 		} else {
-			// NOTE: In the original code this check was `g_Remap_numActiveRemaps && _remap`,
-			// but since we are already in a `_remap` branch, there is no reason to check it
-			// again
-			if (g_sci->_gfxRemap32->getRemapCount()) {
-				if (scaleX.isOne() && scaleY.isOne()) {
-					if (_compressionType == kCelCompressionNone) {
-						if (_drawMirrored) {
-							drawUncompHzFlipMap(target, targetRect, scaledPosition);
-						} else {
-							drawUncompNoFlipMap(target, targetRect, scaledPosition);
-						}
+			if (scaleX.isOne() && scaleY.isOne()) {
+				if (_compressionType == kCelCompressionNone) {
+					if (_drawMirrored) {
+						drawUncompHzFlip(target, targetRect, scaledPosition);
 					} else {
-						if (_drawMirrored) {
-							drawHzFlipMap(target, targetRect, scaledPosition);
-						} else {
-							drawNoFlipMap(target, targetRect, scaledPosition);
-						}
+						drawUncompNoFlip(target, targetRect, scaledPosition);
 					}
 				} else {
-					if (_compressionType == kCelCompressionNone) {
-						scaleDrawUncompMap(target, scaleX, scaleY, targetRect, scaledPosition);
+					if (_drawMirrored) {
+						drawHzFlip(target, targetRect, scaledPosition);
 					} else {
-						scaleDrawMap(target, scaleX, scaleY, targetRect, scaledPosition);
+						drawNoFlip(target, targetRect, scaledPosition);
 					}
 				}
 			} else {
-				if (scaleX.isOne() && scaleY.isOne()) {
-					if (_compressionType == kCelCompressionNone) {
-						if (_drawMirrored) {
-							drawUncompHzFlip(target, targetRect, scaledPosition);
-						} else {
-							drawUncompNoFlip(target, targetRect, scaledPosition);
-						}
-					} else {
-						if (_drawMirrored) {
-							drawHzFlip(target, targetRect, scaledPosition);
-						} else {
-							drawNoFlip(target, targetRect, scaledPosition);
-						}
-					}
+				if (_compressionType == kCelCompressionNone) {
+					scaleDrawUncomp(target, scaleX, scaleY, targetRect, scaledPosition);
 				} else {
-					if (_compressionType == kCelCompressionNone) {
-						scaleDrawUncomp(target, scaleX, scaleY, targetRect, scaledPosition);
-					} else {
-						scaleDraw(target, scaleX, scaleY, targetRect, scaledPosition);
-					}
+					scaleDraw(target, scaleX, scaleY, targetRect, scaledPosition);
 				}
 			}
 		}
 	} else {
-		if (g_sci->_gfxFrameout->_hasRemappedScreenItem) {
-			const uint8 priority = MAX((int16)0, MIN((int16)255, screenItem._priority));
-			if (scaleX.isOne() && scaleY.isOne()) {
-				if (_compressionType == kCelCompressionNone) {
+		if (scaleX.isOne() && scaleY.isOne()) {
+			if (_compressionType == kCelCompressionNone) {
+				if (_transparent) {
 					if (_drawMirrored) {
-						drawUncompHzFlipNoMD(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompHzFlipNoMD(target, targetRect, scaledPosition);
 					} else {
-						drawUncompNoFlipNoMD(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompNoFlipNoMD(target, targetRect, scaledPosition);
 					}
 				} else {
 					if (_drawMirrored) {
-						drawHzFlipNoMD(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompHzFlipNoMDNoSkip(target, targetRect, scaledPosition);
 					} else {
-						drawNoFlipNoMD(target, priorityMap, targetRect, scaledPosition, priority);
+						drawUncompNoFlipNoMDNoSkip(target, targetRect, scaledPosition);
 					}
 				}
 			} else {
-				if (_compressionType == kCelCompressionNone) {
-					scaleDrawUncompNoMD(target, priorityMap, scaleX, scaleY, targetRect, scaledPosition, priority);
+				if (_drawMirrored) {
+					drawHzFlipNoMD(target, targetRect, scaledPosition);
 				} else {
-					scaleDrawNoMD(target, priorityMap, scaleX, scaleY, targetRect, scaledPosition, priority);
+					drawNoFlipNoMD(target, targetRect, scaledPosition);
 				}
 			}
 		} else {
-			if (scaleX.isOne() && scaleY.isOne()) {
-				if (_compressionType == kCelCompressionNone) {
-					if (_transparent) {
-						if (_drawMirrored) {
-							drawUncompHzFlipNoMD(target, targetRect, scaledPosition);
-						} else {
-							drawUncompNoFlipNoMD(target, targetRect, scaledPosition);
-						}
-					} else {
-						if (_drawMirrored) {
-							drawUncompHzFlipNoMDNoSkip(target, targetRect, scaledPosition);
-						} else {
-							drawUncompNoFlipNoMDNoSkip(target, targetRect, scaledPosition);
-						}
-					}
-				} else {
-					if (_drawMirrored) {
-						drawHzFlipNoMD(target, targetRect, scaledPosition);
-					} else {
-						drawNoFlipNoMD(target, targetRect, scaledPosition);
-					}
-				}
+			if (_compressionType == kCelCompressionNone) {
+				scaleDrawUncompNoMD(target, scaleX, scaleY, targetRect, scaledPosition);
 			} else {
-				if (_compressionType == kCelCompressionNone) {
-					scaleDrawUncompNoMD(target, scaleX, scaleY, targetRect, scaledPosition);
-				} else {
-					scaleDrawNoMD(target, scaleX, scaleY, targetRect, scaledPosition);
-				}
+				scaleDrawNoMD(target, scaleX, scaleY, targetRect, scaledPosition);
 			}
 		}
 	}
@@ -760,20 +695,6 @@ void CelObj::scaleDrawUncompNoMD(Buffer &target, const Ratio &scaleX, const Rati
 	}
 }
 
-// TODO: These functions may all be vestigial.
-void CelObj::drawHzFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawNoFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawUncompNoFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawUncompHzFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::scaleDrawMap(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::scaleDrawUncompMap(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawHzFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawNoFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawUncompNoFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::drawUncompHzFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::scaleDrawNoMD(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-void CelObj::scaleDrawUncompNoMD(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const {}
-
 #pragma mark -
 #pragma mark CelObjView
 CelObjView::CelObjView(const GuiResourceId viewId, const int16 loopNo, const int16 celNo) {
diff --git a/engines/sci/graphics/celobj32.h b/engines/sci/graphics/celobj32.h
index 14d9fa3d87..600ae82d32 100644
--- a/engines/sci/graphics/celobj32.h
+++ b/engines/sci/graphics/celobj32.h
@@ -394,18 +394,15 @@ private:
 	void drawUncompHzFlip(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDraw(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDrawUncomp(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
+
 	void drawHzFlipMap(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void drawNoFlipMap(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void drawUncompNoFlipMap(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void drawUncompHzFlipMap(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDrawMap(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDrawUncompMap(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
-	void drawHzFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawNoFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawUncompNoFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawUncompHzFlipMap(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void scaleDrawMap(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void scaleDrawUncompMap(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
+	// NOTE: The original includes versions of the above functions with priority parameters, which were not actually used in SCI32
+
 	void drawHzFlipNoMD(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void drawNoFlipNoMD(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void drawUncompNoFlipNoMD(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
@@ -414,12 +411,7 @@ private:
 	void drawUncompHzFlipNoMDNoSkip(Buffer &target, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDrawNoMD(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
 	void scaleDrawUncompNoMD(Buffer &target, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition) const;
-	void drawHzFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawNoFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawUncompNoFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void drawUncompHzFlipNoMD(Buffer &target, const Buffer &priorityMap, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void scaleDrawNoMD(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
-	void scaleDrawUncompNoMD(Buffer &target, const Buffer &priorityMap, const Ratio &scaleX, const Ratio &scaleY, const Common::Rect &targetRect, const Common::Point &scaledPosition, const uint8 priority) const;
+	// NOTE: The original includes versions of the above functions with priority parameters, which were not actually used in SCI32
 
 #pragma mark -
 #pragma mark CelObj - Caching
diff --git a/engines/sci/graphics/frameout.cpp b/engines/sci/graphics/frameout.cpp
index 308a3a1da2..fc9f5d8299 100644
--- a/engines/sci/graphics/frameout.cpp
+++ b/engines/sci/graphics/frameout.cpp
@@ -82,7 +82,6 @@ GfxFrameout::GfxFrameout(SegManager *segMan, ResourceManager *resMan, GfxCoordAd
 	_showStyles(nullptr),
 	// TODO: Stop using _gfxScreen
 	_currentBuffer(screen->getDisplayWidth(), screen->getDisplayHeight(), nullptr),
-	_priorityMap(screen->getDisplayWidth(), screen->getDisplayHeight(), nullptr),
 	_remapOccurred(false),
 	_frameNowVisible(false),
 	_screenRect(screen->getDisplayWidth(), screen->getDisplayHeight()),
@@ -772,16 +771,6 @@ void GfxFrameout::drawEraseList(const RectList &eraseList, const Plane &plane) {
 }
 
 void GfxFrameout::drawScreenItemList(const DrawList &screenItemList) {
-	_hasRemappedScreenItem = false;
-	if (/* TODO: g_Remap_UnknownCounter2 */ false && !_priorityMap.isNull()) {
-		for (DrawList::const_iterator it = screenItemList.begin(); it != screenItemList.end(); ++it) {
-			if ((*it)->screenItem->getCelObj()._remap) {
-				_hasRemappedScreenItem = true;
-				break;
-			}
-		}
-	}
-
 	for (DrawList::const_iterator it = screenItemList.begin(); it != screenItemList.end(); ++it) {
 		DrawItem &drawItem = **it;
 		mergeToShowList(drawItem.rect, _showList, _overdrawThreshold);
diff --git a/engines/sci/graphics/frameout.h b/engines/sci/graphics/frameout.h
index a820696dde..aef215356d 100644
--- a/engines/sci/graphics/frameout.h
+++ b/engines/sci/graphics/frameout.h
@@ -352,13 +352,6 @@ private:
 	 */
 	Buffer _currentBuffer;
 
-	// TODO: In SCI2.1/SQ6, priority map pixels are not allocated
-	// by default. In SCI2/GK1, pixels are allocated, but not used
-	// anywhere except within CelObj::Draw in seemingly the same
-	// way they are used in SCI2.1/SQ6: that is, never read, only
-	// written.
-	Buffer _priorityMap;
-
 	/**
 	 * TODO: Documentation
 	 */
@@ -457,12 +450,6 @@ private:
 
 public:
 	/**
-	 * TODO: Document
-	 * This is used by CelObj::Draw.
-	 */
-	bool _hasRemappedScreenItem;
-
-	/**
 	 * Whether palMorphFrameOut should be used instead of
 	 * frameOut for rendering. Used by kMorphOn to
 	 * explicitly enable palMorphFrameOut for one frame.
@@ -488,11 +475,6 @@ public:
 	 */
 	void alterVmap(const Palette &palette1, const Palette &palette2, const int8 style, const int8 *const styleRanges);
 
-	// TODO: SCI2 engine never uses priority map?
-	inline Buffer &getPriorityMap() {
-		return _priorityMap;
-	}
-
 	// NOTE: This function is used within ScreenItem subsystem and assigned
 	// to various booleanish fields that seem to represent the state of the
 	// screen item (created, updated, deleted). In GK1/DOS, Phant1/m68k,