Image Operators

bpy.ops.image.curves_point_set(point='BLACK_POINT')

Undocumented (contribute)

Parameters:point (enum in [‘BLACK_POINT’, ‘WHITE_POINT’], (optional)) – Point, Set black point or white point for curves.

bpy.ops.image.cycle_render_slot(reverse=False)

Undocumented (contribute)

Parameters:reverse (boolean, (optional)) – Cycle in Reverse

bpy.ops.image.external_edit(filepath="")

Edit image in an external application

Parameters:filepath (string, (optional)) – File Path, Path to an image file File :startup/bl_operators/image.py:61

bpy.ops.image.invert(invert_r=False, invert_g=False, invert_b=False, invert_a=False)

Undocumented (contribute)

Parameters:

• invert_r (boolean, (optional)) – Red, Invert Red Channel
• invert_g (boolean, (optional)) – Green, Invert Green Channel
• invert_b (boolean, (optional)) – Blue, Invert Blue Channel
• invert_a (boolean, (optional)) – Alpha, Invert Alpha Channel

bpy.ops.image.new(name="untitled", width=1024, height=1024, color=(0.0, 0.0, 0.0, 1.0), alpha=True, uv_test_grid=False, float=False)

Create a new image

Parameters:

• name (string, (optional)) – Name, Image datablock name.
• width (int in [1, inf], (optional)) – Width, Image width.
• height (int in [1, inf], (optional)) – Height, Image height.
• color (float array of 4 items in [0, inf], (optional)) – Color, Default fill color.
• alpha (boolean, (optional)) – Alpha, Create an image with an alpha channel.
• uv_test_grid (boolean, (optional)) – UV Test Grid, Fill the image with a grid for UV map testing.
• float (boolean, (optional)) – 32 bit Float, Create image with 32 bit floating point bit depth.

bpy.ops.image.open(filepath="", filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, relative_path=False)

Open image

Parameters:

• filepath (string, (optional)) – File Path, Path to file
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_folder (boolean, (optional)) – Filter folders
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

bpy.ops.image.pack(as_png=False)

Pack an image as embedded data into the .blend file

Parameters:as_png (boolean, (optional)) – Pack As PNG, Pack image as lossless PNG.

bpy.ops.image.project_apply()

Project edited image back onto the object

File :startup/bl_operators/image.py:199

bpy.ops.image.project_edit()

Edit a snapshot of the viewport in an external image editor

File :startup/bl_operators/image.py:134

bpy.ops.image.properties()

Toggle display properties panel

bpy.ops.image.record_composite()

Undocumented (contribute)

bpy.ops.image.reload()

Undocumented (contribute)

bpy.ops.image.replace(filepath="", filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, relative_path=False)

Undocumented (contribute)

Parameters:

• filepath (string, (optional)) – File Path, Path to file
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_folder (boolean, (optional)) – Filter folders
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file

bpy.ops.image.sample()

Undocumented (contribute)

bpy.ops.image.sample_line(xstart=0, xend=0, ystart=0, yend=0, cursor=1002)

Undocumented (contribute)

Parameters:

• xstart (int in [-inf, inf], (optional)) – X Start
• xend (int in [-inf, inf], (optional)) – X End
• ystart (int in [-inf, inf], (optional)) – Y Start
• yend (int in [-inf, inf], (optional)) – Y End
• cursor (int in [0, inf], (optional)) – Cursor, Mouse cursor style to use during the modal operator

bpy.ops.image.save()

Undocumented (contribute)

bpy.ops.image.save_as(file_type='PNG', filepath="", check_existing=True, filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_btx=False, filter_collada=False, filter_folder=True, filemode=9, relative_path=False, copy=False)

Undocumented (contribute)

Parameters:

• file_type (enum in [‘TARGA’, ‘TARGA RAW’, ‘PNG’, ‘BMP’, ‘JPEG’, ‘IRIS’], (optional)) – File Type, File type to save image as.
• filepath (string, (optional)) – File Path, Path to file
• check_existing (boolean, (optional)) – Check Existing, Check and warn on overwriting existing files
• filter_blender (boolean, (optional)) – Filter .blend files
• filter_image (boolean, (optional)) – Filter image files
• filter_movie (boolean, (optional)) – Filter movie files
• filter_python (boolean, (optional)) – Filter python files
• filter_font (boolean, (optional)) – Filter font files
• filter_sound (boolean, (optional)) – Filter sound files
• filter_text (boolean, (optional)) – Filter text files
• filter_btx (boolean, (optional)) – Filter btx files
• filter_collada (boolean, (optional)) – Filter COLLADA files
• filter_folder (boolean, (optional)) – Filter folders
• filemode (int in [1, 9], (optional)) – File Browser Mode, The setting for the file browser mode to load a .blend file, a library or a special file
• relative_path (boolean, (optional)) – Relative Path, Select the file relative to the blend file
• copy (boolean, (optional)) – Copy, Create a new image file without modifying the current image in blender

bpy.ops.image.save_dirty()

Save all modified textures

File :startup/bl_operators/image.py:109

bpy.ops.image.save_sequence()

Undocumented (contribute)

bpy.ops.image.scopes()

Toggle display scopes panel

bpy.ops.image.unpack(method='USE_LOCAL', id="")

Save an image packed in the .blend file to disk

Parameters:

• method (enum in [‘USE_LOCAL’, ‘WRITE_LOCAL’, ‘USE_ORIGINAL’, ‘WRITE_ORIGINAL’], (optional)) – Method, How to unpack.
• id (string, (optional)) – Image Name, Image datablock name to unpack.

bpy.ops.image.view_all()

Undocumented (contribute)

bpy.ops.image.view_pan(offset=(0.0, 0.0))

Undocumented (contribute)

Parameters:offset (float array of 2 items in [-inf, inf], (optional)) – Offset, Offset in floating point units, 1.0 is the width and height of the image.

bpy.ops.image.view_selected()

Undocumented (contribute)

bpy.ops.image.view_zoom(factor=0.0)

Undocumented (contribute)

Parameters:factor (float in [0, inf], (optional)) – Factor, Zoom factor, values higher than 1.0 zoom in, lower values zoom out.

bpy.ops.image.view_zoom_in()

Undocumented (contribute)

bpy.ops.image.view_zoom_out()

Undocumented (contribute)

bpy.ops.image.view_zoom_ratio(ratio=0.0)

Undocumented (contribute)

Parameters:ratio (float in [0, inf], (optional)) – Ratio, Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out.