Image(ID)

base classes — bpy_struct, ID

class bpy.types.Image.Image(ID)

Image data-block referencing an external or packed image

alpha_mode

Representation of alpha in the image file, to convert to and from when saving and loading the image

  • STRAIGHT Straight, Store RGB and alpha channels separately with alpha acting as a mask, also known as unassociated alpha. Commonly used by image editing applications and file formats like PNG.

  • PREMUL Premultiplied, Store RGB channels with alpha multiplied in, also known as associated alpha. The natural format for renders and used by file formats like OpenEXR.

  • CHANNEL_PACKED Channel Packed, Different images are packed in the RGB and alpha channels, and they should not affect each other. Channel packing is commonly used by game engines to save memory.

  • NONE None, Ignore alpha channel from the file and make image fully opaque.

Type

enum in [‘STRAIGHT’, ‘PREMUL’, ‘CHANNEL_PACKED’, ‘NONE’], default ‘STRAIGHT’

bindcode

OpenGL bindcode

Type

int in [0, inf], default 0, (readonly)

channels

Number of channels in pixels buffer

Type

int in [0, inf], default 0, (readonly)

colorspace_settings

Input color space settings

Type

ColorManagedInputColorspaceSettings, (readonly)

depth

Image bit depth

Type

int in [0, inf], default 0, (readonly)

display_aspect

Display Aspect for this image, does not affect rendering

Type

float array of 2 items in [0.1, inf], default (1.0, 1.0)

file_format

Format used for re-saving this file

  • BMP BMP, Output image in bitmap format.

  • IRIS Iris, Output image in (old!) SGI IRIS format.

  • PNG PNG, Output image in PNG format.

  • JPEG JPEG, Output image in JPEG format.

  • JPEG2000 JPEG 2000, Output image in JPEG 2000 format.

  • TARGA Targa, Output image in Targa format.

  • TARGA_RAW Targa Raw, Output image in uncompressed Targa format.

  • CINEON Cineon, Output image in Cineon format.

  • DPX DPX, Output image in DPX format.

  • OPEN_EXR_MULTILAYER OpenEXR MultiLayer, Output image in multilayer OpenEXR format.

  • OPEN_EXR OpenEXR, Output image in OpenEXR format.

  • HDR Radiance HDR, Output image in Radiance HDR format.

  • TIFF TIFF, Output image in TIFF format.

  • AVI_JPEG AVI JPEG, Output video in AVI JPEG format.

  • AVI_RAW AVI Raw, Output video in AVI Raw format.

  • FFMPEG FFmpeg video, The most versatile way to output video files.

Type

enum in [‘BMP’, ‘IRIS’, ‘PNG’, ‘JPEG’, ‘JPEG2000’, ‘TARGA’, ‘TARGA_RAW’, ‘CINEON’, ‘DPX’, ‘OPEN_EXR_MULTILAYER’, ‘OPEN_EXR’, ‘HDR’, ‘TIFF’, ‘AVI_JPEG’, ‘AVI_RAW’, ‘FFMPEG’], default ‘TARGA’

filepath

Image/Movie file name

Type

string, default “”, (never None)

filepath_raw

Image/Movie file name (without data refreshing)

Type

string, default “”, (never None)

frame_duration

Duration (in frames) of the image (1 when not a video/sequence)

Type

int in [0, inf], default 0, (readonly)

generated_color

Fill color for the generated image

Type

float array of 4 items in [0, inf], default (0.0, 0.0, 0.0, 0.0)

generated_height

Generated image height

Type

int in [1, 65536], default 1024

generated_type

Generated image type

  • BLANK Blank, Generate a blank image.

  • UV_GRID UV Grid, Generated grid to test UV mappings.

  • COLOR_GRID Color Grid, Generated improved UV grid to test UV mappings.

Type

enum in [‘BLANK’, ‘UV_GRID’, ‘COLOR_GRID’], default ‘UV_GRID’

generated_width

Generated image width

Type

int in [1, 65536], default 1024

has_data

True if the image data is loaded into memory

Type

boolean, default False, (readonly)

is_dirty

Image has changed and is not saved

Type

boolean, default False, (readonly)

is_float

True if this image is stored in float buffer

Type

boolean, default False, (readonly)

is_multiview

Image has more than one view

Type

boolean, default False, (readonly)

is_stereo_3d

Image has left and right views

Type

boolean, default False, (readonly)

packed_file

First packed file of the image

Type

PackedFile, (readonly)

packed_files

Collection of packed images

Type

bpy_prop_collection of ImagePackedFile, (readonly)

pixels

Image pixels in floating point values

Type

float in [-inf, inf], default 0.0

render_slots

Render slots of the image

Type

RenderSlots bpy_prop_collection of RenderSlot, (readonly)

resolution

X/Y pixels per meter

Type

float array of 2 items in [-inf, inf], default (0.0, 0.0)

size

Width and height in pixels, zero when image data cant be loaded

Type

int array of 2 items in [-inf, inf], default (0, 0), (readonly)

source

Where the image comes from

  • FILE Single Image, Single image file.

  • SEQUENCE Image Sequence, Multiple image files, as a sequence.

  • MOVIE Movie, Movie file.

  • GENERATED Generated, Generated image.

  • VIEWER Viewer, Compositing node viewer.

  • TILED UDIM Tiles, Tiled UDIM image texture.

Type

enum in [‘FILE’, ‘SEQUENCE’, ‘MOVIE’, ‘GENERATED’, ‘VIEWER’, ‘TILED’], default ‘FILE’

stereo_3d_format

Settings for stereo 3d

Type

Stereo3dFormat, (readonly, never None)

tiles

Tiles of the image

Type

UDIMTiles bpy_prop_collection of UDIMTile, (readonly)

type

How to generate the image

Type

enum in [‘IMAGE’, ‘MULTILAYER’, ‘UV_TEST’, ‘RENDER_RESULT’, ‘COMPOSITING’], default ‘IMAGE’, (readonly)

use_deinterlace

Deinterlace movie file on load

Type

boolean, default False

use_generated_float

Generate floating point buffer

Type

boolean, default False

use_half_precision

Use 16bits per channel to lower the memory usage during rendering

Type

boolean, default False

use_multiview

Use Multiple Views (when available)

Type

boolean, default False

use_view_as_render

Apply render part of display transformation when displaying this image on the screen

Type

boolean, default False

views_format

Mode to load image views

  • INDIVIDUAL Individual, Individual files for each view with the prefix as defined by the scene views.

  • STEREO_3D Stereo 3D, Single file with an encoded stereo pair.

Type

enum in [‘INDIVIDUAL’, ‘STEREO_3D’], default ‘INDIVIDUAL’

save_render(filepath, scene=None)

Save image to a specific path using a scenes render settings

Parameters
  • filepath (string, (never None)) – Save path

  • scene (Scene, (optional)) – Scene to take image parameters from

save()

Save image to its source path

pack(data="", data_len=0)

Pack an image as embedded data into the .blend file

Parameters
  • data (string, (optional, never None)) – data, Raw data (bytes, exact content of the embedded file)

  • data_len (int in [0, inf], (optional)) – data_len, length of given data (mandatory if data is provided)

unpack(method='USE_LOCAL')

Save an image packed in the .blend file to disk

Parameters

method (enum in ['REMOVE', 'USE_LOCAL', 'WRITE_LOCAL', 'USE_ORIGINAL', 'WRITE_ORIGINAL'], (optional)) – method, How to unpack

reload()

Reload the image from its source path

update()

Update the display image from the floating point buffer

scale(width, height)

Scale the image in pixels

Parameters
  • width (int in [1, 10000]) – Width

  • height (int in [1, 10000]) – Height

gl_touch(frame=0)

Delay the image from being cleaned from the cache due inactivity

Parameters

frame (int in [0, inf], (optional)) – Frame, Frame of image sequence or movie

Returns

Error, OpenGL error value

Return type

int in [-inf, inf]

gl_load(frame=0)

Load the image into an OpenGL texture. On success, image.bindcode will contain the OpenGL texture bindcode. Colors read from the texture will be in scene linear color space and have premultiplied or straight alpha matching the image alpha mode

Parameters

frame (int in [0, inf], (optional)) – Frame, Frame of image sequence or movie

Returns

Error, OpenGL error value

Return type

int in [-inf, inf]

gl_free()

Free the image from OpenGL graphics memory

filepath_from_user(image_user=None)

Return the absolute path to the filepath of an image frame specified by the image user

Parameters

image_user (ImageUser, (optional)) – Image user of the image to get filepath for

Returns

File Path, The resulting filepath from the image and it’s user

Return type

string, (never None)

buffers_free()

Free the image buffers from memory

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

  • bpy_struct.id_data

  • ID.name

  • ID.name_full

  • ID.is_evaluated

  • ID.original

  • ID.users

  • ID.use_fake_user

  • ID.is_embedded_data

  • ID.tag

  • ID.is_library_indirect

  • ID.library

  • ID.override_library

  • ID.preview

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

  • ID.evaluated_get

  • ID.copy

  • ID.override_create

  • ID.user_clear

  • ID.user_remap

  • ID.make_local

  • ID.user_of_id

  • ID.animation_data_create

  • ID.animation_data_clear

  • ID.update_tag

  • ID.bl_rna_get_subclass

  • ID.bl_rna_get_subclass_py

References

  • bpy.context.edit_image

  • BlendData.images

  • BlendDataImages.load

  • BlendDataImages.new

  • BlendDataImages.remove

  • Brush.clone_image

  • CameraBackgroundImage.image

  • CompositorNodeImage.image

  • ImagePaint.canvas

  • ImagePaint.clone_image

  • ImagePaint.stencil_image

  • ImageTexture.image

  • Material.texture_paint_images

  • MaterialGPencilStyle.fill_image

  • MaterialGPencilStyle.stroke_image

  • MovieTrackingPlaneTrack.image

  • NodeSocketImage.default_value

  • NodeSocketInterfaceImage.default_value

  • ShaderNodeTexEnvironment.image

  • ShaderNodeTexImage.image

  • SpaceImageEditor.image

  • TextureNodeImage.image

  • UILayout.template_image_layers