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
-
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
-
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 removedo_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
- Parameters
value (boolean) – Value
-
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
Inherited Functions
References