LayerUtility: SimpleTextImage¶
Documentation¶
- Class name:
LayerUtility: SimpleTextImage - Category:
😺dzNodes/LayerUtility - Output node:
False
This node is designed to generate images with text overlay, allowing for the creation of simple text-based images. It utilizes text wrapping and font customization to place text onto images, making it suitable for creating labels, annotations, or decorative text elements within a graphical context.
Input types¶
Required¶
text- Specifies the text to be overlaid on the image. It plays a crucial role in determining the content of the generated image.
- Comfy dtype:
STRING - Python dtype:
str
font_file- Determines the font used for the text, affecting the visual appearance of the text in the image.
- Comfy dtype:
COMBO[STRING] - Python dtype:
str
align- Specifies the alignment of the text within the image, such as 'center', 'left', or 'right'.
- Comfy dtype:
COMBO[STRING] - Python dtype:
List[str]
char_per_line- Controls the number of characters per line, influencing text wrapping and layout.
- Comfy dtype:
INT - Python dtype:
int
leading- Adjusts the space between lines of text, impacting the readability and aesthetic of the text.
- Comfy dtype:
INT - Python dtype:
int
font_size- Sets the size of the font, directly affecting how the text appears on the image.
- Comfy dtype:
INT - Python dtype:
int
text_color- Specifies the color of the text, allowing for customization of the text's visual style.
- Comfy dtype:
STRING - Python dtype:
str
stroke_width- Defines the width of the text's stroke, enhancing text legibility or stylistic appearance.
- Comfy dtype:
INT - Python dtype:
int
stroke_color- Determines the color of the text's stroke, used to add contrast or decorative effects to the text.
- Comfy dtype:
STRING - Python dtype:
str
x_offset- Adjusts the horizontal position of the text within the image, enabling precise placement.
- Comfy dtype:
INT - Python dtype:
int
y_offset- Adjusts the vertical position of the text within the image, enabling precise placement.
- Comfy dtype:
INT - Python dtype:
int
width- Sets the width of the generated image.
- Comfy dtype:
INT - Python dtype:
int
height- Sets the height of the generated image.
- Comfy dtype:
INT - Python dtype:
int
Optional¶
size_as- unknown
- Comfy dtype:
* - Python dtype:
unknown
Output types¶
image- Comfy dtype:
IMAGE - The generated image with the specified text overlaid.
- Python dtype:
torch.Tensor
- Comfy dtype:
mask- Comfy dtype:
MASK - A mask image indicating areas affected by the text overlay, useful for further image processing steps.
- Python dtype:
torch.Tensor
- Comfy dtype:
Usage tips¶
- Infra type:
CPU - Common nodes: unknown
Source code¶
class SimpleTextImage:
def __init__(self):
pass
@classmethod
def INPUT_TYPES(self):
return {
"required": {
"text": ("STRING",{"default": "text", "multiline": True},
),
"font_file": (FONT_LIST,),
"align": (["center", "left", "right"],),
"char_per_line": ("INT", {"default": 80, "min": 1, "max": 8096, "step": 1},),
"leading": ("INT",{"default": 8, "min": 0, "max": 8096, "step": 1},),
"font_size": ("INT",{"default": 72, "min": 1, "max": 2500, "step": 1},),
"text_color": ("STRING", {"default": "#FFFFFF"},),
"stroke_width": ("INT",{"default": 0, "min": 0, "max": 8096, "step": 1},),
"stroke_color": ("STRING",{"default": "#FF8000"},),
"x_offset": ("INT", {"default": 0, "min": 0, "max": 8096, "step": 1},),
"y_offset": ("INT", {"default": 0, "min": 0, "max": 8096, "step": 1},),
"width": ("INT", {"default": 512, "min": 1, "max": 8096, "step": 1},),
"height": ("INT", {"default": 512, "min": 1, "max": 8096, "step": 1},),
},
"optional": {
"size_as": (any, {}),
}
}
RETURN_TYPES = ("IMAGE", "MASK",)
RETURN_NAMES = ("image", "mask",)
FUNCTION = 'simple_text_image'
CATEGORY = '😺dzNodes/LayerUtility'
def simple_text_image(self, text, font_file, align, char_per_line,
leading, font_size, text_color,
stroke_width, stroke_color, x_offset, y_offset,
width, height, size_as=None
):
ret_images = []
ret_masks = []
if size_as is not None:
if size_as.dim() == 2:
size_as_image = torch.unsqueeze(mask, 0)
if size_as.shape[0] > 0:
size_as_image = torch.unsqueeze(size_as[0], 0)
else:
size_as_image = copy.deepcopy(size_as)
width, height = tensor2pil(size_as_image).size
font_path = FONT_DICT.get(font_file)
(_, top, _, _) = ImageFont.truetype(font=font_path, size=font_size, encoding='unic').getbbox(text)
font = cast(ImageFont.FreeTypeFont, ImageFont.truetype(font_path, font_size))
if char_per_line == 0:
char_per_line = int(width / font_size)
paragraphs = text.split('\n')
img_height = height # line_height * len(lines)
img_width = width # max(font.getsize(line)[0] for line in lines)
img = Image.new("RGBA", size=(img_width, img_height), color=(0, 0, 0, 0))
draw = ImageDraw.Draw(img)
y_text = y_offset + stroke_width
for paragraph in paragraphs:
lines = textwrap.wrap(paragraph, width=char_per_line, expand_tabs=False,
replace_whitespace=False, drop_whitespace=False)
for line in lines:
width = font.getbbox(line)[2] - font.getbbox(line)[0]
height = font.getbbox(line)[3] - font.getbbox(line)[1]
# 根据 align 参数重新计算 x 坐标
if align == "left":
x_text = x_offset
elif align == "center":
x_text = (img_width - width) // 2
elif align == "right":
x_text = img_width - width - x_offset
else:
x_text = x_offset # 默认为左对齐
draw.text(
xy=(x_text, y_text),
text=line,
fill=text_color,
font=font,
stroke_width=stroke_width,
stroke_fill=stroke_color,
)
y_text += height + leading
y_text += leading * 2
if size_as is not None:
for i in size_as:
ret_images.append(pil2tensor(img))
ret_masks.append(image2mask(img.split()[3]))
else:
ret_images.append(pil2tensor(img))
ret_masks.append(image2mask(img.split()[3]))
log(f"{NODE_NAME} Processed.", message_type='finish')
return (torch.cat(ret_images, dim=0),torch.cat(ret_masks, dim=0),)