How do I load an image?

[hoffstadt]

Answer

Loading an image into Dear PyGui is 3 step process:

1. Load image data into an array.
2. Create a texture with the image data.
3. Add an image to your application.

Example

import dearpygui.dearpygui as dpg

dpg.create_context()
dpg.create_viewport()
dpg.setup_dearpygui()

width, height, channels, data = dpg.load_image("path/to/Somefile.png")

with dpg.texture_registry():
    texture_id = dpg.add_static_texture(width, height, data)

with dpg.window(label="Tutorial"):
    dpg.add_image(texture_id)

# main loop
dpg.show_viewport()
while dpg.is_dearpygui_running():
    dpg.render_dearpygui_frame()  

dpg.destroy_context()

Resources

• Textures

Notes

• texture can be static, dynamic, or raw.

Reusable Code

def add_and_load_image(image_path, parent=None):
    width, height, channels, data = dpg.load_image(image_path)

    with dpg.texture_registry() as reg_id:
        texture_id = dpg.add_static_texture(width, height, data, parent=reg_id)

    if parent is None:
        return dpg.add_image(texture_id)
    else:
        return dpg.add_image(texture_id, parent=parent)