Save 4 hours! We auto-setup your workflow! Free!

Drop your workflow.json — we handle every dependency, custom node, and model. Just open the link and run.

Auto-Setup Workflow Json (Free) Now!
ComfyUI > Nodes > comfyui-lucid-vrp > VRP Canvas Image Loader

ComfyUI Node: VRP Canvas Image Loader

Class Name

VRPCanvasUI

Category
LuCiD VRP
Author
EBEBEEBE (Account age: 68days)
Extension
comfyui-lucid-vrp
Latest Updated
2026-11-05
Github Stars
0.04K

How to Install comfyui-lucid-vrp

Install this extension via the ComfyUI Manager by searching for comfyui-lucid-vrp
  • 1. Click the Manager button in the main menu
  • 2. Select Custom Nodes Manager button
  • 3. Enter comfyui-lucid-vrp in the search bar
After installation, click the Restart button to restart ComfyUI. Then, manually refresh your browser to clear the cache and access the updated list of nodes.

Visit ComfyUI Online for ready-to-use ComfyUI environment

  • Free trial available
  • 16GB VRAM to 80GB VRAM GPU machines
  • 400+ preloaded models/nodes
  • Freedom to upload custom models/nodes
  • 200+ ready-to-run workflows
  • 100% private workspace with up to 200GB storage
  • Dedicated Support

Run ComfyUI Online

VRP Canvas Image Loader Description

Creates a shared canvas document to keep artwork and regional instructions aligned in VRP workflows.

VRP Canvas Image Loader:

VRPCanvasUI establishes a shared canvas document for a LuCiD VRP workflow, giving your artwork and its regional instructions a consistent reference. It supports documents originating from a blank canvas or an image and records the working canvas dimensions, image reference, alignment information, and revision. This helps keep region-based work attached to the correct artwork: downstream VRP tools can detect when regions belong to a different document or were created before the canvas changed, rather than silently applying them to the wrong composition. The node uses the document loader’s resolution process to prepare the working document and its associated image-generation data, then packages the canvas metadata for other VRP nodes. Its main benefit is maintaining consistency between the artwork you are preparing and the regions you subsequently author or process.

VRP Canvas Image Loader Input Parameters:

preset

Required selection parameter of type COMBO[STRING]. The available choices and default are not included in the supplied interface or class source. Although this parameter appears in the node’s build signature, the shown implementation does not read it or pass it to the document-resolution process, so it does not directly determine the result within this method. Any role it has in updating the canvas through the interactive interface is not shown; do not assume that changing this selection alone overrides the active document’s dimensions.

width

Required integer parameter. No minimum, maximum, or default value is provided in the supplied interface or class source. The shown build method accepts this value but does not directly use it to construct the canvas or prepare the returned data; the canvas width is taken from the resolved working view instead. Consequently, the visible width setting and the final working width should not be assumed to be identical solely because this parameter exists. For downstream connections, use the returned width value and canvas metadata as the authoritative working dimensions.

height

Required integer parameter. No minimum, maximum, or default value is provided in the supplied interface or class source. Like width, this value is accepted by the build method but is not directly used in the shown execution path. The canvas height is obtained from the resolved working view, making the active document and its resolution process responsible for the effective working height. Check the returned height when you need to coordinate other nodes with the canvas rather than assuming that this input directly controls the final result.

step

Required selection parameter of type COMBO[INT]. The available integer choices and default are not shown. This value is accepted but not referenced by the supplied build implementation, so the source does not establish a direct effect on the generated canvas or associated data. In particular, there is no evidence that it controls diffusion sampling steps or sampling quality; any interface-specific role would require the inherited loader or frontend implementation to verify.

latent_mode

Required selection parameter of type COMBO[STRING]. The available choices and default are not supplied. This value is passed to the inherited document-resolution process, where its exact behavior is defined; it is the mode selector associated with preparing the latent data returned by the node. The provided code does not show which modes create an empty latent, encode an image, or require a VAE, so those behaviors cannot be assigned to particular option names here. Choose from the options actually displayed in your installation and consult the loader’s documentation for their precise differences.

document_state

Required STRING parameter containing the document state used by the inherited resolution process. No default value or accepted serialization format is included in the supplied source. Resolution produces the active document, working image reference, working view, and revision information used to assemble the canvas descriptor. This makes document_state central to identifying which artwork and canvas state the node processes. Treat it as document data maintained by the canvas interface rather than ordinary prompt text; manually editing it without knowing the expected format risks making the document unreadable or inconsistent.

alignment_method

Required selection parameter of type COMBO[STRING], with a build-method default of Pad. The complete list of choices is not supplied. This setting is passed to the inherited resolution process, and the resulting working view provides the dimensions and alignment metadata recorded in the canvas. It therefore participates in how the document is prepared for the working canvas, but the supplied code does not define padding placement, fill appearance, or alternative alignment algorithms. Keep this setting consistent while authoring regions, because the resulting alignment state contributes to the canvas revision used for compatibility checks.

apply_to_image

Required BOOLEAN parameter, with a build-method default of True. It is passed to the inherited resolution process alongside alignment_method. The supplied implementation does not show the exact difference between enabled and disabled behavior, so it does not establish whether disabling this option preserves the original image dimensions or changes only part of the preparation process. When evaluating this setting, inspect the resulting image and working dimensions together rather than assuming that the canvas and image must be transformed identically.

vae

Optional VAE connection, with a build-method default of None. A VAE is the component commonly used to translate between visible images and the compressed representation used during image generation. This node forwards the connection to the document-resolution process together with latent_mode, allowing that process to use it where needed. The supplied source does not identify which modes require a VAE or what happens when one is absent. If your selected mode performs image encoding, use the VAE appropriate for your generation model and check the installed loader’s requirements.

VRP Canvas Image Loader Output Parameters:

canvas

A VRP_CANVAS descriptor containing metadata about the resolved working canvas rather than image pixels. The node explicitly records descriptor version 1, the working view’s width and height, a revision equal to the document revision plus the alignment revision, whether the document originated as blank or image-based content, a working image reference, and the alignment view. Downstream VRP nodes use this information to bind regions to the correct document and check compatibility. This connection is especially important after document or alignment changes, because matching dimensions alone do not guarantee that existing regions still belong to the current canvas.

image

An IMAGE output returned by the inherited document-resolution process. It provides the image data associated with the resolved document for compatible image-processing connections. The shown class passes it through rather than constructing its pixels directly, so the exact treatment of blank documents, image alignment, color channels, and batches is not specified here. Inspect this output when checking whether the prepared artwork matches the composition you intend to use for regional work.

latent

A LATENT output returned by the inherited document-resolution process. Latent data is a compressed working representation used by compatible generation nodes, rather than a directly viewable picture. Its preparation is governed by the inherited implementation receiving latent_mode and the optional VAE connection. The supplied code does not establish whether a particular mode produces empty or image-encoded latent data, nor does it specify its internal contents or batch size.

width

An INT output representing the width supplied by the document-resolution process. It is intended to expose the working width for connections that need a numerical canvas size, avoiding the need to copy dimensions manually. The canvas descriptor separately records the resolved view width, while this output is passed through from the resolver; the supplied class does not show the resolver’s internal calculation. Check it alongside the image and canvas metadata when verifying alignment or coordinating downstream size settings.

height

An INT output representing the height supplied by the document-resolution process. It provides a numerical height for compatible downstream nodes and helps keep the workflow’s size-dependent operations coordinated with the resolved document. As with width, the value is passed through from the resolver rather than calculated directly in the shown build method. Use the resolved dimensions when checking canvas consistency instead of relying only on the original height input.

mask

A MASK output returned by the inherited document-resolution process. It makes the document’s associated mask data available to compatible mask-processing nodes. The provided class does not show how this mask is created, whether it comes from transparency or editing operations, or which areas it marks, so it should not automatically be interpreted as an inpainting mask, a padding mask, or a region-selection mask. Preview it before connecting it to an operation whose result depends on which areas are selected.

VRP Canvas Image Loader Usage Tips:

  • Establish the document and alignment before authoring regions. The canvas revision includes both document and alignment revisions, and downstream VRP checks reject regions whose stored revision no longer matches.
  • Connect canvas to region-authoring nodes and carry the same canvas through the regional workflow. This preserves the document reference needed to distinguish your artwork from another canvas with identical dimensions.
  • When supplying external VRP_REGIONS to the downstream processor, also connect the corresponding VRP_CANVAS. The supplied validation code explicitly requires this connection for document and revision checks.
  • Use the returned width and height to coordinate downstream size-dependent nodes. In the shown implementation, the width and height inputs are not directly used during the build, while the canvas dimensions come from the resolved working view.
  • Begin alignment testing with the documented build default, Pad, and inspect the resulting image and dimensions. The supplied source does not document the other alignment choices or their behavior.
  • If your selected latent_mode requires image encoding, connect a model-compatible VAE. The supplied code does not identify the mode-specific requirements, so verify the options available in your installed interface rather than assuming all modes work without one.
  • Preview mask before using it for selective editing. Its exact origin and selected-area meaning are not defined in the supplied class.
  • Let the canvas interface manage document_state where possible. Avoid manually changing document references, revisions, or serialized state to bypass compatibility checks; these checks help prevent regions from being applied to the wrong artwork.

VRP Canvas Image Loader Common Errors and Solutions:

Unsupported VRP_CANVAS descriptor

  • Explanation: A downstream canvas validator received something other than a supported canvas dictionary, or its version was not the integer 1. This is a canvas-validation message from the supplied supporting code, not an explicitly raised error in this node’s build method.
  • Solution: Connect canvas directly from a compatible VRPCanvasUI node. Remove hand-built or outdated descriptors and regenerate the canvas using the installed node version.

VRP_CANVAS must contain canvas metadata only

  • Explanation: The canvas descriptor contains missing or unexpected fields. The supplied validator accepts only its defined metadata fields, with alignment as an optional addition.
  • Solution: Use the original canvas output without inserting image data, prompts, or custom fields into it. Keep image and region data on their separate connections.

Canvas dimensions disagree with working image view

  • Explanation: The descriptor’s width or height differs from the dimensions recorded in its alignment view. The canvas metadata is therefore internally inconsistent.
  • Solution: Resolve the document again through VRPCanvasUI and reconnect the freshly generated canvas. Avoid manually changing descriptor dimensions without regenerating the associated working view.

Invalid canvas revision

  • Explanation: The revision is not a nonnegative integer. Revisions identify document and alignment states, so an invalid value prevents reliable region compatibility checks.
  • Solution: Regenerate the canvas from the document interface instead of editing its revision manually. If the problem persists, check whether another node is modifying the descriptor.

Invalid canvas source

  • Explanation: The descriptor’s source is neither blank nor image, the two values accepted by the supplied validator.
  • Solution: Use the canvas generated directly by VRPCanvasUI. Do not replace its source with a file path, a prompt, or a custom label.

Invalid canvas image reference

  • Explanation: The image reference is neither a string nor None, which are the accepted forms in the supplied validation code.
  • Solution: Reload or resolve the document through the node rather than manually inserting an image object or other data into the descriptor’s image reference.

External VRP_REGIONS require a connected VRP_CANVAS for canvas/revision validation

  • Explanation: A downstream processor received external regions without the canvas needed to confirm their document and revision. This error occurs in the regional processing workflow, not directly in VRPCanvasUI.
  • Solution: Connect the matching canvas output to the processor’s canvas input along with your external regions.

VRP region '…' canvas dimensions …x… do not match current canvas …x…

  • Explanation: A downstream compatibility check found that a region was created for different canvas dimensions.
  • Solution: Use the canvas that originally belongs to those regions, or update and re-author the regions for the current resolved canvas size.

VRP region '…' is stale: revision … does not match current canvas revision …

  • Explanation: A region belongs to an earlier document or alignment revision. Even if the visible dimensions remain unchanged, the stored region no longer matches the current canvas state.
  • Solution: Re-run the region-authoring chain against the current canvas and review the region placement. Do not simply edit the revision number to suppress the warning.

VRP region '…' belongs to another canvas document

  • Explanation: A downstream check found a mismatch in the document identity or image reference associated with a region. Matching width and height is not enough to establish that two canvases are the same document.
  • Solution: Keep regions connected to the canvas document from which they were authored. For a different image or independently created document, author a matching set of regions instead of reusing an unrelated region bundle.

VRP Canvas Image Loader Related Nodes

Go back to the extension to check out more related nodes.
comfyui-lucid-vrp
RunComfy
Copyright 2025 RunComfy. All Rights Reserved.

RunComfy is the premier ComfyUI platform, offering ComfyUI online environment and services, along with ComfyUI workflows featuring stunning visuals. RunComfy also provides AI Models, enabling artists to harness the latest AI tools to create incredible art.

VRP Canvas Image Loader