BlendDataImages(bpy_struct)¶

base class — bpy_struct

class bpy.types.BlendDataImages(bpy_struct)¶

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 (string, (never None)) – New name for the data-block
width (int in [1, inf]) – Width of the image
height (int in [1, inf]) – Height of the image
alpha (boolean, (optional)) – Alpha, Use alpha channel
float_buffer (boolean, (optional)) – Float Buffer, Create an image with floating-point color
stereo3d (boolean, (optional)) – Stereo 3D, Create left and right views
is_data (boolean, (optional)) – Is Data, Create image with non-color data color space
tiled (boolean, (optional)) – Tiled, Create a tiled image

Returns:

New image data-block

Return type:

Image

load(filepath, *, check_existing=False)¶

Load a new image into the main database

Parameters:

filepath (string, (never None)) – Path of the file to load
check_existing (boolean, (optional)) – Using existing data-block if this file is already loaded

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, (never None)) – Image to remove
do_unlink (boolean, (optional)) – Unlink all usages of this image before deleting it
do_id_user (boolean, (optional)) – Decrement user counter of all datablocks used by this image
do_ui_user (boolean, (optional)) – Make sure interface does not reference this image

tag(value)¶

tag

classmethod bl_rna_get_subclass(id, default=None)¶

classmethod bl_rna_get_subclass_py(id, default=None)¶

Inherited Properties¶