BlendDataImages(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.BlendDataImages(bpy_prop_collection)

Collection of images

new(name, width, height, *, alpha=False, float_buffer=False, stereo3d=False, is_data=False, tiled=False)

Add a new image to the main database

Parameters:

  • name (str) – New name for the data-block (never None)

  • width (int) – Width of the image (in [1, inf])

  • height (int) – Height of the image (in [1, inf])

  • alpha (bool) – Alpha, Use alpha channel (optional)

  • float_buffer (bool) – Float Buffer, Create an image with floating-point color (optional)

  • stereo3d (bool) – Stereo 3D, Create left and right views (optional)

  • is_data (bool) – Is Data, Create image with non-color data color space (optional)

  • tiled (bool) – Tiled, Create a tiled image (optional)

Returns:

New image data-block

Return type:

Image

load(filepath, *, check_existing=False)

Load a new image into the main database

Parameters:

  • filepath (str) – Path of the file to load (never None, blend relative // prefix supported)

  • check_existing (bool) – Using existing data-block if this file is already loaded (optional)

Returns:

New image data-block

Return type:

Image

remove(image, *, do_unlink=True, do_id_user=True, do_ui_user=True)

Remove an image from the current blendfile

Parameters:

  • image (Image) – Image to remove (never None)

  • do_unlink (bool) – Unlink all usages of this image before deleting it (optional)

  • do_id_user (bool) – Decrement user counter of all data-blocks used by this image (optional)

  • do_ui_user (bool) – Make sure interface does not reference this image (optional)

tag(value)

tag

Parameters:

value (bool) – Value

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References