gui_image_studio.get_image

gui_image_studio.get_image(image_name, framework='tkinter', size=(32, 32), theme='default', grayscale=False, rotate=0, transparency=1.0, format_override=None, animated=False, frame_delay=100, tint_color=None, tint_intensity=0.0, contrast=1.0, saturation=1.0)[source]

Retrieve an embedded image with dynamic transformations and optional animated GIF support.

Parameters:

  • image_name (str) – Name of the image file (e.g., ‘icon.png’).

  • framework (str) – “tkinter” or “customtkinter”.

  • size (tuple) – Desired dimensions; used for resizing. For animated GIFs, each frame is resized.

  • theme (str) – Theme name (e.g., “dark”, “light”); falls back to “default” if not matched.

  • grayscale (bool) – Convert image to grayscale.

  • rotate (int) – Rotate image (or each frame) by the given degrees.

  • transparency (float) – Adjust brightness/opacity (0.0 to 1.0).

  • format_override (str) – Convert image to this format on the fly (“PNG”, “JPEG”, etc.).

  • animated (bool) – If True and image is an animated GIF, process all its frames.

  • frame_delay (int) – Delay (milliseconds) between frames for animated GIFs.

  • tint_color (tuple or None) – A tuple (R, G, B) for a tint overlay.

  • tint_intensity (float) – Blending factor (0.0 to 1.0) for tint; 0 means no tint.

  • contrast (float) – Contrast adjustment factor (1.0 means no change).

  • saturation (float) – Saturation adjustment factor (1.0 means no change).

Returns:

  • A Tkinter PhotoImage or a CustomTkinter CTkImage.

For animated GIFs:

  • A dictionary with keys “animated_frames” (a list of image objects) and “frame_delay”. Use these frames in an animation loop.

Return type:

For static images