Initial revision
[blender.git] / intern / python / modules / Blender / Image.py
1 """The Blender Image module
2
3   This module provides (yet) basic support for Blender *Image* data blocks
4
5   Example::
6
7     from Blender import Image
8     im = Image.Load('dead-parrot.jpg')
9 """
10
11 import _Blender.Image as _Image
12 import shadow
13
14 class Image(shadow.shadow):
15         """Image DataBlock object
16
17     See above example on how to create instances of Image objects.
18
19   Attributes
20
21     xrep  -- Texture image tiling factor (subdivision) in X
22
23     yrep  -- Texture image tiling factor (subdivision) in Y
24
25     LATER:
26
27     * Image buffer access
28
29     * better loading / saving of images
30 """
31         pass
32
33 def get(name):
34         """If 'name' given, the Image 'name' is returned if existing, 'None' otherwise.
35 If no name is given, a list of all Images is returned"""
36         pass
37
38 def Load(filename):
39         """Returns image from file 'filename' as Image object if found, 'None' else."""
40         pass
41         
42 def New(name):
43         """This function is currently not implemented"""
44         pass
45
46 # override all functions again, the above classes are just made
47 # for documentation
48
49 get = _Image.get
50 Get = get
51 Load = _Image.Load
52