Skip to content

Commit e764ffb

Browse files
committed
Update Readme
1 parent 68662f4 commit e764ffb

1 file changed

Lines changed: 92 additions & 9 deletions

File tree

README.md

Lines changed: 92 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ https://github.com/user-attachments/assets/587ea664-32b1-410b-bfa1-fba013f8e700
2727

2828
### 🎯 Core Functionality
2929
- **Interactive 2D Canvas Control**: Visually select resolution with real-time preview
30+
- **Normal Drag**: Standard behavior with snap to canvas grid (controlled by `canvas_step_x/y`)
3031
- **Shift + Drag**: Preserves aspect ratio while dragging (with snap enabled)
3132
- **Ctrl + Drag**: Disables snap for fine-tuning without grid constraints
3233
- **Ctrl + Shift + Drag**: Preserves aspect ratio with 1px precision (no snap)
33-
- **Normal Drag**: Standard behavior with snap to grid
3434
- **Smart Rescaling**: Automatic calculation of rescale factors for upscaling workflows
35-
- **Snap to Grid**: Align dimensions to customizable grid increments (16px to 256px)
35+
- **Snap Button**: Round current dimensions to the snap value (NOT related to 2D canvas grid)
3636
- **Real-time Info Display**: Shows current resolution, megapixels, p-value and aspect ratio
37-
- **Visual Output Values**: Color-coded values at output slots (blue/pink/green)
37+
- **Visual Output Values**: Color-coded clickable values at output slots (blue/pink/green)
3838

3939
### 📐 Advanced Scaling Options
4040
- **Manual Scale**: Direct multiplier control (ex. 2.0x)
@@ -99,9 +99,81 @@ Extensive preset library organized by use case:
9999

100100
1. Add the "Resolution Master" node to your workflow
101101
2. Connect the outputs to your image generation nodes:
102-
- `width`: Current width value
103-
- `height`: Current height value
104-
- `rescale_factor`: Calculated scale factor for upscaling
102+
- `width`: Current width value (click the blue number to set custom width)
103+
- `height`: Current height value (click the pink number to set custom height)
104+
- `rescale_factor`: Calculated scale factor for upscaling (green number)
105+
106+
## 🎮 Understanding the Controls
107+
108+
### Actions Section
109+
- **⇄ Swap Button**: Swaps width and height values
110+
- **⊞ Snap Button**: Rounds the current width/height to the nearest snap value (e.g., if snap=64 and width=520, clicking Snap makes it 512)
111+
- **Snap Value Slider**: Sets the value used by the Snap button (16-256px). **Important**: This does NOT change the 2D canvas grid behavior!
112+
113+
### 2D Canvas
114+
- **White Dot**: Drag to set resolution visually
115+
- **Grid Dots**: Visual guides controlled by `canvas_step_x/y` properties (NOT by the snap slider)
116+
- **Blue Rectangle**: Shows current resolution selection
117+
118+
### Scaling Section
119+
- **⬆ Manual Scale Button**: Applies the manual scale factor to current dimensions
120+
- **📺 Resolution Button**: Scales to target resolution (e.g., 1080p)
121+
- **📷 Megapixels Button**: Scales to target megapixel count
122+
- **Radio Buttons**: Select which scaling mode affects the `rescale_factor` output
123+
124+
### Auto-Detect Section
125+
- **Auto-detect Toggle**: ON/OFF switch for automatic dimension detection from connected images
126+
- **🎯 Auto-fit Button**: Finds best matching preset for current dimensions
127+
- **Auto Checkbox**: When checked, automatically applies Auto-fit when new image is detected
128+
- **Detected Text (green)**: Click to apply the detected image's original dimensions
129+
- **⚡ Auto-calc Button**: Applies model-specific calculations to current dimensions
130+
- **Calc Checkbox**: Enables automatic model-specific optimizations
131+
132+
### Presets Section
133+
- **Category Dropdown**: Select preset category (Standard, SDXL, Flux, etc.)
134+
- **Preset Dropdown**: Choose specific preset from selected category
135+
136+
## 🔧 Node Properties Configuration
137+
138+
You can customize various parameters by accessing the node's Properties panel in ComfyUI. Here's a complete list of all configurable properties:
139+
140+
### Canvas Properties
141+
- **`canvas_min_x`** / **`canvas_min_y`**: Minimum values for X and Y axes (default: 0)
142+
- **`canvas_max_x`** / **`canvas_max_y`**: Maximum values for X and Y axes (default: 2048, max: 32768)
143+
- Increase these for working with higher resolutions (e.g., 8192 for 8K)
144+
- **`canvas_step_x`** / **`canvas_step_y`**: Grid snap increments for the 2D canvas (default: 64)
145+
- This controls the grid dots and snap behavior when dragging on the 2D canvas
146+
- **NOT** controlled by the snap slider in the Actions section
147+
- **`canvas_decimals_x`** / **`canvas_decimals_y`**: Decimal precision for X/Y values (default: 0)
148+
- **`canvas_snap`**: Enable/disable grid snapping on 2D canvas (default: true)
149+
- **`canvas_dots`**: Show/hide grid dots on 2D canvas (default: true)
150+
- **`canvas_frame`**: Show/hide the blue selection frame (default: true)
151+
152+
### Action Sliders Range
153+
- **`action_slider_snap_min`**: Minimum value for snap slider (default: 16)
154+
- **`action_slider_snap_max`**: Maximum value for snap slider (default: 256)
155+
- **`action_slider_snap_step`**: Step increment for snap slider (default: 16)
156+
157+
### Scaling Sliders Range
158+
- **`scaling_slider_min`**: Minimum manual scale factor (default: 0.1)
159+
- **`scaling_slider_max`**: Maximum manual scale factor (default: 4.0)
160+
- **`scaling_slider_step`**: Step increment for scale slider (default: 0.1)
161+
- **`megapixels_slider_min`**: Minimum megapixels target (default: 0.5)
162+
- **`megapixels_slider_max`**: Maximum megapixels target (default: 6.0)
163+
- **`megapixels_slider_step`**: Step increment for megapixels slider (default: 0.1)
164+
165+
### Section Collapse States
166+
- **`section_actions_collapsed`**: Actions section collapsed state (default: false)
167+
- **`section_scaling_collapsed`**: Scaling section collapsed state (default: false)
168+
- **`section_autoDetect_collapsed`**: Auto-Detect section collapsed state (default: false)
169+
- **`section_presets_collapsed`**: Presets section collapsed state (default: false)
170+
171+
### Example: Customizing for 8K Workflow
172+
1. Right-click on the ResolutionMaster node
173+
2. Select "Properties"
174+
3. Set `canvas_max_x` and `canvas_max_y` to 8192
175+
4. Set `canvas_step_x` and `canvas_step_y` to 128 for larger grid increments
176+
5. Set `manual_slider_max_w` and `manual_slider_max_h` to 8192
105177
106178
### Working with Presets
107179
@@ -238,19 +310,30 @@ The rescale_factor **always reflects your active scaling mode**, not the drag op
238310

239311
## Examples
240312

241-
### Example 1: SDXL Portrait Generation
313+
### Example 1: Understanding Snap Button vs Canvas Grid
314+
**Snap Button (Actions Section)**:
315+
- Current resolution: 520×380
316+
- Snap value slider: 64
317+
- Click Snap button → Resolution becomes 512×384 (rounded to nearest 64)
318+
319+
**2D Canvas Grid** (controlled by properties):
320+
- `canvas_step_x` = 32, `canvas_step_y` = 32
321+
- When dragging on canvas, resolution snaps to 32px increments
322+
- The snap slider does NOT affect this - only `canvas_step_x/y` properties do!
323+
324+
### Example 2: SDXL Portrait Generation
242325
1. Select "SDXL" category
243326
2. Choose "3:4 Portrait (768×1024)"
244327
3. Enable "Custom Calc" for SDXL optimization
245328
4. Connect to your SDXL workflow
246329

247-
### Example 2: Social Media Content
330+
### Example 3: Social Media Content
248331
1. Select "Social Media" category
249332
2. Choose "Instagram Square (1080×1080)"
250333
3. Use resolution scaling to target 2160p for high quality
251334
4. Apply rescale factor in upscaling node
252335

253-
### Example 3: Flux Model Generation
336+
### Example 4: Flux Model Generation
254337
1. Select "Flux" category
255338
2. Enable "Custom Calc" for automatic constraints
256339
3. Choose any preset - dimensions auto-adjust to Flux requirements

0 commit comments

Comments
 (0)