user: Show practical ways to work with Bpy.Types.Image in a Blender add-on or script – include code.

assistant: er_slots ¶ Render slots of the image Type : RenderSlots bpy_prop_collection of RenderSlot , (readonly) resolution ¶ X/Y pixels per meter, for the image buffer Type : mathutils.Vector of 2 items in [-inf, inf], default (0.0, 0.0) seam_margin ¶ Margin to take into account when fixing UV seams during painting. Higher number would improve seam-fixes for mipmaps, but decreases performance. Type : int in [-32768, 32767], default 8 size ¶ Width and height of the image buffer in pixels, zero when image data cannot 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 16 bits per channel to lower the memory usage during rendering Type : boolean, default True 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 Type : enum in Views Format Items , default 'INDIVIDUAL' save_render ( filepath , * , scene = None , quality = 0 ) ¶ Save image to a specific path using a scenes render settings Parameters : filepath ( string , ( never None ) ) – Output path scene ( Scene , (optional)) – Scene to take image parameters from quality ( int in [ 0 , 100 ] , ( optional ) ) – Quality, Quality for image formats that support lossy compression, uses default quality if not specified save ( * , filepath = '' , quality = 0 , save_copy = False ) ¶ Save image Parameters : filepath ( string , ( optional , never None ) ) – Output path, uses image data-block filepath if not specified quality ( int in [ 0 , 100 ] , ( optional ) ) – Quality, Quality for image formats that support lossy compression, uses default quality if not specified save_copy ( boolean , ( optional ) ) – Save Copy, Save the image as a copy, without updating current image’s filepath pack ( * , data = '' , data_len = 0 ) ¶ Pack an image as embedded data into the .blend file Parameters : data ( byte 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 Unpack Method Items , (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 , * , frame = 0 , tile_index = 0 ) ¶ Scale the buffer of the image, in pixels Parameters : width ( int in [ 1 , inf ] ) – Width height ( int in [ 1 , inf ] ) – Height frame ( int in [ 0 , inf ] , ( optional ) ) – Frame, Frame (for image sequences) tile_index ( int in [ 0 , inf ] , ( optional ) ) – Tile, Tile index (for tiled images) gl_touch ( * , frame = 0 , layer_index = 0 , pass_index = 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 layer_index ( int in [ 0 , inf ] , ( optional ) ) – Layer, Index of layer that should be loaded pass_index ( int in [ 0 , inf ] , ( optional ) ) – Pass, Index of pass that should be loaded Returns : Error, OpenGL error value Return type : int in [-inf, inf] gl_load ( * , frame = 0 , layer_index = 0 , pass_index = 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 layer_index ( int in [ 0 , inf ] , ( optional ) ) – Layer, Index of layer that should be loaded pass_index ( int in [ 0 , inf ] , ( optional ) ) – Pass, Index of pass that should be loaded 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 its user Return type : string, (never None) buffers_free ( ) ¶ Free the image buffers from memory classmethod bl_rna_get_subclass ( id , default = None , / ) ¶ Parameters : id ( str ) – 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 ( str ) – 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.id_type ID.session_uid ID.is_evaluated ID.original ID.users ID.use_fake_user ID.use_extra_user ID.is_embedded_data ID.is_linked_packed ID.is_missing ID.is_runtime_data ID.is_editable ID.tag ID.is_library_indirect ID.library ID.library_weak_reference ID.asset_data ID.override_library ID.preview Inherited Functions ¶ bpy_struct.as_pointer bpy_struct.driver_add bpy_struct.driver_remove bpy_struct.get bpy_struct.id_properties_clear bpy_struct.id_properties_ensure bpy_struct.id_properties_ui 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_from_module bpy_struct.path_resolve bpy_struct.pop bpy_struct.property_overridable_library_set bpy_struct.property_unset bpy_struct.rna_ancestors bpy_struct.type_recast bpy_struct.values ID.bl_system_properties_get ID.rename ID.evaluated_get ID.copy ID.asset_mark ID.asset_clear ID.asset_generate_preview ID.override_create ID.override_hierarchy_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.preview_ensure ID.bl_rna_get_subclass ID.bl_rna_get_subclass_py References ¶ bpy.context.edit_image BlendData.images BlendDataImages.load BlendDataImages.new BlendDataImages.remove CameraBackgroundImage.image CompositorNodeCryptomatteV2.image CompositorNodeImage.image GeometryNodeInputImage.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 NodeTreeInterfaceSocketImage.default_value PaintModeSettings.canvas_image ShaderNodeTexEnvironment.image ShaderNodeTexImage.image SpaceImageEditor.image TextureNodeImage.image UILayout.template_image_layers Next ImageFormatSettings(bpy_struct) Previous IO_FH_svg_as_curves(FileHandler) Copyright &#169; Blender Authors Made with Furo Report issue on this page On this page Image(ID) Image Data Image Image.alpha_mode Image.channels Image.colorspace_settings Image.depth Image.display_aspect Image.file_format Image.filepath Image.filepath_raw Image.frame_duration Image.generated_color Image.generated_height Image.generated_type Image.generated_width Image.has_data Image.is_dirty Image.is_float Image.is_multiview Image.is_stereo_3d Image.packed_file Image.packed_files Image.pixels Image.render_slots Image.resolution Image.seam_margin Image.size Image.source Image.stereo_3d_format Image.tiles Image.type Image.use_deinterlace Image.use_generated_float Image.use_half_precision Image.use_multiview Image.use_view_as_render Image.views_format Image.save_render() Image.save() Image.pack() Image.unpack() Image.reload() Image.update() Image.scale() Image.gl_touch() Image.gl_load() Image.gl_free() Image.filepath_from_user() Image.buffers_free() Image.bl_rna_get_subclass() Image.bl_rna_get_subclass_py() Inherited Properties Inherited Functions References