more docs

Author: FredHappyface

blendmodes/blend.py

@@ -467,7 +467,7 @@ def blend(background: np.ndarray, foreground: np.ndarray, blendType: BlendType)
 def blendLayers(
 	background: Image.Image,
 	foreground: Image.Image,
-	blendType: BlendType | tuple[str, ...],
+	blendType: BlendType,
 	opacity: float = 1.0,
 	offsets: tuple[int, int] = (0, 0),
 ) -> Image.Image:
@@ -629,7 +629,7 @@ def alpha_comp_shell(
 	upper_alpha: np.ndarray,
 	lower_rgb: np.ndarray,
 	upper_rgb: np.ndarray,
-	blendType: BlendType | tuple[str, ...],
+	blendType: BlendType,
 ) -> tuple[np.ndarray, np.ndarray]:
 	"""
 	Implement common transformations occurring in any blend or composite mode.

circle_silhouette.png

@@ -146,10 +146,14 @@ def alpha_comp_shell(
     upper_alpha: np.ndarray,
     lower_rgb: np.ndarray,
     upper_rgb: np.ndarray,
-    blendType: BlendType | tuple[str, ...],
+    blendType: BlendType,
 ) -> tuple[np.ndarray, np.ndarray]: ...
 ```
 
+#### See also
+
+- [BlendType](./blendtype.md#blendtype)
+
 
 
 ## blend
@@ -253,12 +257,16 @@ Blend two layers with custom opacity and offsets
 def blendLayers(
     background: Image.Image,
     foreground: Image.Image,
-    blendType: BlendType | tuple[str, ...],
+    blendType: BlendType,
     opacity: float = 1.0,
     offsets: tuple[int, int] = (0, 0),
 ) -> Image.Image: ...
 ```
 
+#### See also
+
+- [BlendType](./blendtype.md#blendtype)
+
 
 
 ## blendLayersArray

documentation/reference/blendmodes/blend.md

@@ -1,24 +1,39 @@
 # Getting Started - Examples
 
-Be sure to include the following for the functions below
+Below, you'll find practical examples to help you get started with blending/compositing
+images with the `blendmodes` library. Whether you're experimenting with simple overlays
+or crafting intricate compositions, these examples will guide you through the process.
+
+To begin, let’s take a look at our two source images:
 
 ![Rainbow](../../tests/data/src/rainbow.png)
 ![Duck](../../tests/data/src/duck.png)
 
+We'll use these images as our **background** and **foreground** in the examples below.
+
+To blend two images together, use the `blendLayers` function with your chosen blend mode:
+
 ```python
 from blendmodes.blend import blendLayers, BlendType
 
 background = Image.open(THISDIR + "/rainbow.png")
 foreground = Image.open(THISDIR + "/duck.png")
 ```
 
-## Normal
+Blend modes define how the **foreground** interacts with the **background**. Let’s start with the most fundamental mode:
+
+## **Normal**
+
+The **Normal** blend mode places the foreground image on top of the background without
+any additional blending effects.
 
 ```python
 blendLayers(background, foreground, BlendType.NORMAL)
 ```
 
-![Normal](../../tests/data/case1/normal_expected.png)
+Further examples of different blend types using `rainbow.png` and `duck.png` are as below
+
+Note: for other composition examples (without code snippets), check out the [extended blend mode examples](blend_examples.md).
 
 ## Multiply
 

documentation/tutorials/README.md

@@ -55,9 +55,9 @@ def create_silhouette(shape:str="circle") -> Image.Image:
 	img = Image.new("RGBA", size=(400, 400), color=(255, 255, 255, 0))
 	draw = ImageDraw.Draw(img)
 	if shape == "circle":
-		draw.ellipse((100, 100, 300, 300), fill=(0, 0, 0, 255))
+		draw.ellipse((100, 100, 300, 300), fill=(50, 0, 50, 255))
 	elif shape == "rectangle":
-		draw.rectangle((100, 150, 300, 350), fill=(0, 0, 0, 255))
+		draw.rectangle((100, 150, 300, 350), fill=(50, 0, 50, 255))
 	img.save(f"{shape}_silhouette.png")
 	return img
 

documentation/tutorials/blend_examples.md

@@ -90,3 +90,20 @@ def test_non_rgba() -> None:
 	background = Image.open(THISDIR / "data/src/rainbow.jpg")
 	foreground = Image.open(THISDIR / "data/src/duck.jpg")
 	blendLayers(background, foreground, BlendType.NORMAL)
+
+
+if __name__ == "__main__":
+	for dest_filename, _ in BLEND_TESTS:
+		blend_mode = dest_filename.split("_")[0]
+		blend_mode = blend_mode[0].upper() + blend_mode[1:]
+
+		print(f"""
+## {blend_mode}
+
+| Case | Background | Foreground | Output |
+|------|---------|------|--------|
+| Case 1 | ![img](../../tests/data/src/rainbow.png) | ![img](../../tests/data/src/duck.png) | ![img](../../tests/data/case1/{dest_filename}) |
+| Case 2 | ![img](../../tests/data/src/noise_texture.png) | ![img](../../tests/data/src/red_soft_mask.png) | ![img](../../tests/data/case2/{dest_filename}) |
+| Case 2 | ![img](../../tests/data/src/red_soft_mask.png) | ![img](../../tests/data/src/rectangle_silhouette.png) | ![img](../../tests/data/case3/{dest_filename}) |
+
+		""")  # noqa: T201, E501