docs: Add resolution calculator documentation

2025-06-14 07:58:29 -07:00
parent 547c8cbc4b
commit 268bdc5334
2 changed files with 148 additions and 0 deletions
@@ -0,0 +1,101 @@
+# Resolution Calculator Tool
+
+## Overview
+The Resolution Calculator is a ComfyUI node that calculates upscaled dimensions from image or latent inputs with proper scaling factors optimized for SDXL and FLUX models.
+
+## Inputs
+
+### Required
+- **scale_factor** (FLOAT): Scaling factor from 1.0 to 8.0
+  - Default: 2.0
+  - Common values: 1.2, 1.5, 2.0, 2.5, 3.0, 4.0
+  - Optimized for typical upscaling workflows
+
+### Optional (one required)
+- **image** (IMAGE): Input image tensor to calculate dimensions from
+- **latent** (LATENT): Input latent tensor to calculate dimensions from
+
+## Outputs
+- **width** (INT): Calculated target width
+- **height** (INT): Calculated target height
+
+## Features
+
+### Model Optimization
+- **SDXL**: Optimized for ~1 megapixel base resolution (1024×1024)
+- **FLUX**: Supports flexible resolutions from 0.2-2 megapixels
+
+### Automatic Constraints
+- Ensures all outputs are divisible by 8 (ComfyUI requirement)
+- Preserves aspect ratio during scaling
+- Rounds to nearest valid dimensions
+
+## Use Cases
+
+### 1. Upscaler Preparation
+Connect the width/height outputs to upscaler nodes to ensure proper target dimensions.
+
+```
+Image Loader → Resolution Calculator → Upscaler
+             ↘ scale_factor: 2.0    ↗
+```
+
+### 2. Latent Upscaling
+Calculate target dimensions from generated latents before upscaling.
+
+```
+VAE Encode → Resolution Calculator → Latent Upscaler
+           ↘ scale_factor: 1.5    ↗
+```
+
+### 3. Memory Planning
+Preview final dimensions to estimate memory usage before expensive operations.
+
+## Example Scenarios
+
+### SDXL Portrait Upscaling
+- **Input**: 832×1216 (SDXL portrait format)
+- **Scale**: 1.5x
+- **Output**: 1248×1824
+- **Use**: Perfect for 1.5x upscaling while maintaining SDXL ratios
+
+### FLUX Square Generation
+- **Input**: 1024×1024 (FLUX square format)
+- **Scale**: 2.0x
+- **Output**: 2048×2048
+- **Use**: Standard 2x upscaling for square outputs
+
+### Variable Scale Factors
+The node supports any scale factor from 1.0 to 8.0, allowing for:
+- **1.2x**: Subtle enhancement
+- **1.5x**: Moderate upscaling
+- **2.0x**: Standard doubling
+- **4.0x**: Aggressive upscaling
+
+## Technical Details
+
+### Dimension Extraction
+- **IMAGE tensors**: `[batch, height, width, channels]` format
+- **LATENT tensors**: `{"samples": [batch, channels, height/8, width/8]}` format
+- Automatic detection and conversion between formats
+
+### Calculation Process
+1. Extract original dimensions from input tensor
+2. Apply scale factor: `new_size = original_size * scale_factor`
+3. Round to nearest multiple of 8: `((size + 4) // 8) * 8`
+4. Return integer width and height
+
+### Error Handling
+- Validates that at least one input (image or latent) is provided
+- Ensures scale factor is within valid range (1.0-8.0)
+- Graceful error messages for invalid inputs
+
+## Category
+All Resolution Calculator nodes appear under **ComfyAssets** in the ComfyUI node browser.
+
+## Integration
+The Resolution Calculator integrates seamlessly with:
+- Standard ComfyUI image loaders
+- VAE encode/decode operations
+- Upscaler nodes (ESRGAN, Real-ESRGAN, etc.)
+- Custom latent processing workflows
@@ -0,0 +1,47 @@
+{
+  "last_node_id": 3,
+  "last_link_id": 2,
+  "nodes": [
+    {
+      "id": 1,
+      "type": "ResolutionCalculator",
+      "pos": [100, 100],
+      "size": {"0": 315, "1": 126},
+      "flags": {},
+      "order": 0,
+      "mode": 0,
+      "inputs": [
+        {"name": "image", "type": "IMAGE", "link": null},
+        {"name": "latent", "type": "LATENT", "link": null}
+      ],
+      "outputs": [
+        {"name": "width", "type": "INT", "links": [1], "slot_index": 0},
+        {"name": "height", "type": "INT", "links": [2], "slot_index": 1}
+      ],
+      "properties": {},
+      "widgets_values": [2.0],
+      "category": "ComfyAssets"
+    },
+    {
+      "id": 2,
+      "type": "Note",
+      "pos": [450, 100],
+      "size": {"0": 400, "1": 200},
+      "flags": {},
+      "order": 1,
+      "mode": 0,
+      "inputs": [],
+      "outputs": [],
+      "properties": {"text": "Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models."},
+      "widgets_values": ["Resolution Calculator Example\n\nThis node calculates upscaled dimensions from:\n- IMAGE tensors (connect from image loaders)\n- LATENT tensors (connect from VAE encode/generation)\n\nUse cases:\n- Calculate target dimensions for upscalers\n- Plan memory usage for large generations\n- Ensure dimensions are divisible by 8\n\nScale factors optimized for SDXL and FLUX models."]
+    }
+  ],
+  "links": [
+    [1, 1, 0, 3, 0, "INT"],
+    [2, 1, 1, 3, 1, "INT"]
+  ],
+  "groups": [],
+  "config": {},
+  "extra": {},
+  "version": 0.4
+}