Package bpy :: Package ops :: Module image
[hide private]
[frames] | no frames]

Module image

Functions [hide private]
 
curves_point_set(point='BLACK_POINT')
(undocumented operator)
 
new(name='Untitled', width=1024, height=1024, color=(0.0, 0.0, 0.0), alpha=1.0, uv_test_grid=False, float=False)
(undocumented operator)
 
open(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)
(undocumented operator)
 
pack(as_png=False)
(undocumented operator)
 
properties()
(undocumented operator)
 
record_composite()
(undocumented operator)
 
reload()
(undocumented operator)
 
replace(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)
(undocumented operator)
 
sample()
(undocumented operator)
 
save()
(undocumented operator)
 
save_as(file_type='PNG', path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)
(undocumented operator)
 
save_sequence()
(undocumented operator)
 
toolbox()
(undocumented operator)
 
unpack(method='USE_LOCAL')
(undocumented operator)
 
view_all()
(undocumented operator)
 
view_pan(offset=(0.0, 0.0))
(undocumented operator)
 
view_selected()
(undocumented operator)
 
view_zoom(factor=0.0)
(undocumented operator)
 
view_zoom_in()
(undocumented operator)
 
view_zoom_out()
(undocumented operator)
 
view_zoom_ratio(ratio=0.0)
(undocumented operator)
Function Details [hide private]

curves_point_set(point='BLACK_POINT')

 

(undocumented operator)

Parameters:
  • point (enum) - Set black point or white point for curves. in (BLACK_POINT, WHITE_POINT)

new(name='Untitled', width=1024, height=1024, color=(0.0, 0.0, 0.0), alpha=1.0, uv_test_grid=False, float=False)

 

(undocumented operator)

Parameters:
  • width (int) - Image width. in (1, inf)
  • height (int) - Image height. in (1, inf)
  • color (float array of 3 items) - Default fill color. in (0, inf)
  • alpha (float) - Default fill alpha. in (0, 1)
  • name (string)
  • uv_test_grid (boolean)
  • float (boolean)

open(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)

 

(undocumented operator)

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

pack(as_png=False)

 

(undocumented operator)

Parameters:
  • as_png (boolean)

replace(path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)

 

(undocumented operator)

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

save_as(file_type='PNG', path='', filename='', directory='', filter_blender=False, filter_image=True, filter_movie=True, filter_python=False, filter_font=False, filter_sound=False, filter_text=False, filter_folder=True, filemode=9)

 

(undocumented operator)

Parameters:
  • file_type (enum) - File type to save image as. in (TARGA, TARGA RAW, PNG, BMP, JPEG, IRIS, TIFF, RADIANCE_HDR, CINEON, DPX, OPENEXR, MULTILAYER)
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_font (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_image (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

unpack(method='USE_LOCAL')

 

(undocumented operator)

Parameters:
  • method (enum) - How to unpack. in (USE_LOCAL, WRITE_LOCAL, USE_ORIGINAL, WRITE_ORIGINAL)

view_pan(offset=(0.0, 0.0))

 

(undocumented operator)

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

view_zoom(factor=0.0)

 

(undocumented operator)

Parameters:
  • factor (float) - Zoom factor, values higher than 1.0 zoom in, lower values zoom out. in (0, inf)

view_zoom_ratio(ratio=0.0)

 

(undocumented operator)

Parameters:
  • ratio (float) - Zoom ratio, 1.0 is 1:1, higher is zoomed in, lower is zoomed out. in (0, inf)