- generate sphinx docs for bpy_extras module
[blender.git] / release / scripts / modules / bpy_extras / image_utils.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 __all__ = (
22     "image_load",
23 )
24
25
26 def image_load(filepath, dirpath, place_holder=False, recursive=False, convert_callback=None):
27     import bpy
28     import os
29
30     try:
31         return bpy.data.images.load(filepath)
32     except RuntimeError:
33         if place_holder:
34             image = bpy.data.images.new(os.path.basename(filepath), 128, 128)
35             # allow the path to be resolved later
36             image.filepath = filepath
37             return image