Home       Trees       Index       Help   

Blender

Module Image :: Class Image
[frames | no frames]

Class Image

The Image object

This object gives access to Images in Blender.
Method Summary
int getBindCode()
Get the Image's bindcode.
int getDepth()
Get the pixel depth of this image.
int getEnd()
Get the Image's end frame.
string getFilename()
Get the filename of the image file loaded into this Image object.
list of 2 ints getMaxXY()
Get the x & y size for the image.
list of 2 ints getMinXY()
Get the x & y origin for the image.
string getName()
Get the name of this Image object.
list of 4 floats getPixelF(x, y)
Get the the colors of the current pixel in the form [r,g,b,a].
list of 4 ints getPixelI(x, y)
Get the the colors of the current pixel in the form [r,g,b,a].
list of 2 ints getSize()
Get the [width, height] dimensions (in pixels) of this image.
int getSpeed()
Get the Image's speed (fps).
int getStart()
Get the Image's start frame.
int getXRep()
Get the number of repetitions in the x (horizontal) axis for this Image.
int getYRep()
Get the number of repetitions in the y (vertical) axis for this Image.
  glFree()
Delete this image's data from OpenGL texture memory, only (the image itself is not removed from Blender's memory).
int glLoad()
Load this image's data into OpenGL texture memory, if it is not already loaded (image.bindcode is 0 if it is not loaded yet).
bool makeCurrent()
Set the currently displayed Image from Blenders UV/Image window.
none pack()
Packs the image into the current blend file.
  reload()
Reloads this image from the filesystem.
none save()
Saves the current image.
  setEnd(end)
Set the Image's end frame.
  setFilename(name)
Change the filename of this Image object.
  setName(name)
Set the name of this Image object.
none setPixelF(x, y, (r, g, b, a))
Set the the colors of the current pixel in the form [r,g,b,a].
none setPixelI(x, y, (r, g, b, a))
Set the the colors of the current pixel in the form [r,g,b,a].
  setSpeed(speed)
Set the Image's speed (fps).
  setStart(start)
Get the Image's start frame.
  setXRep(xrep)
Texture tiling: set the number of x repetitions for this Image.
  setYRep(yrep)
Texture tiling: set the number of y repetitions for this Image.
none unpack(mode)
Unpacks the image to the images filename.

Instance Variable Summary
boolean antialias: enable or disable the antialias option for this image.
int bindcode: Texture's bind code (readonly).
bool clampX: When true the image will not tile horizontally.
bool clampY: When true the image will not tile vertically.
int depth: The pixel depth of the image.
int end: Texture's animation end frame [0, 128].
bool fakeUser: When set to True, this datablock wont be removed, even if nothing is using it.
boolean fields: enable or disable the fields option for this image.
boolean fields_odd: enable or disable the odd fields option for this image.
string filename: The filename (path) to the image file loaded into this Image object.
boolean has_data: True when the image has pixel data (readonly).
string or None lib: path to the blend file this datablock is stored in (readonly).
string name: unique name within each blend file.
boolean packed: True when the Texture is packed (readonly).
IDGroup properties: Returns an IDGroup reference to this datablocks's ID Properties.
list size: The [width, height] dimensions of the image (in pixels).
int source: Image source type.
int speed: Texture's animation speed [1, 100].
int start: Texture's animation start frame [0, 128].
bool tag: A temporary tag that to flag data as being used within a loop.
int users: The number of users this datablock has.
int xrep: Texture tiling: the number of repetitions in the x (horizontal) axis.
int yrep: Texture tiling: the number of repetitions in the y (vertical) axis [1, 16].

Method Details

getBindCode()

Get the Image's bindcode. This is for texture loading using BGL calls. See, for example, BGL.glBindTexture and glLoad.
Returns:
int

getDepth()

Get the pixel depth of this image.
Returns:
int

getEnd()

Get the Image's end frame. Used for animated textures.
Returns:
int

getFilename()

Get the filename of the image file loaded into this Image object.
Returns:
string

getMaxXY()

Get the x & y size for the image. Image coordinates range from 0 to size-1.
Returns:
[x, y]
           (type=list of 2 ints)

getMinXY()

Get the x & y origin for the image. Image coordinates range from 0 to size-1.
Returns:
[x, y]
           (type=list of 2 ints)

getName()

Get the name of this Image object.
Returns:
string

getPixelF(x, y)

Get the the colors of the current pixel in the form [r,g,b,a]. Returned values are floats normalized to 0.0 - 1.0. Pixel coordinates are in the range from 0 to N-1. See getMaxXY
Parameters:
x - the x coordinate of pixel.
           (type=int)
y - the y coordinate of pixel.
           (type=int)
Returns:
[ r, g, b, a]
           (type=list of 4 floats)

getPixelI(x, y)

Get the the colors of the current pixel in the form [r,g,b,a]. Returned values are ints normalized to 0 - 255. Pixel coordinates are in the range from 0 to N-1. See getMaxXY
Parameters:
x - the x coordinate of pixel.
           (type=int)
y - the y coordinate of pixel.
           (type=int)
Returns:
[ r, g, b, a]
           (type=list of 4 ints)

getSize()

Get the [width, height] dimensions (in pixels) of this image.
Returns:
list of 2 ints

getSpeed()

Get the Image's speed (fps). Used for animated textures.
Returns:
int

getStart()

Get the Image's start frame. Used for animated textures.
Returns:
int

getXRep()

Get the number of repetitions in the x (horizontal) axis for this Image. This is for texture tiling.
Returns:
int

getYRep()

Get the number of repetitions in the y (vertical) axis for this Image. This is for texture tiling.
Returns:
int

glFree()

Delete this image's data from OpenGL texture memory, only (the image itself is not removed from Blender's memory). Internally, glDeleteTextures (see BGL.glDeleteTextures) is used, but this method also updates Blender's Image object so that its bind code is set to 0. See also Image.glLoad, Image.getBindCode.

glLoad()

Load this image's data into OpenGL texture memory, if it is not already loaded (image.bindcode is 0 if it is not loaded yet).
Returns:
the texture's bind code.
           (type=int)

Note: Usually you don't need to call this method. It is only necessary if you want to draw textured objects in the Scripts window and the image's bind code is zero at that moment, otherwise Blender itself can take care of binding / unbinding textures. Calling this method for an image with nonzero bind code simply returns the image's bind code value (see getBindCode).

makeCurrent()

Set the currently displayed Image from Blenders UV/Image window. When multiple images are displayed, the last active UV/Image windows image is used.
Returns:
True if the current image could be set, if no window was available, return False.
           (type=bool)

pack()

Packs the image into the current blend file.

Since 2.44 new images without valid filenames can be packed.

If the image is alredy packed, it will be repacked.
Returns:
nothing
           (type=none)

reload()

Reloads this image from the filesystem. If used within a loop you need to redraw the Window to see the change in the image, e.g. with Window.RedrawAll().
Returns:
None

Warning: if the image file is corrupt or still being written, it will be replaced by a blank image in Blender, but no error will be returned.

save()

Saves the current image.
Returns:
nothing
           (type=none)

setEnd(end)

Set the Image's end frame. Used for animated textures.
Parameters:
end - The new value in [0, 128].
           (type=int)

setFilename(name)

Change the filename of this Image object.
Parameters:
name - The new full filename.
           (type=string)

Warning: use this with caution and note that the filename is truncated if larger than 160 characters.

setName(name)

Set the name of this Image object.
Parameters:
name - The new name.
           (type=string)

setPixelF(x, y, (r, g, b, a))

Set the the colors of the current pixel in the form [r,g,b,a]. Color values must be floats in the range 0.0 - 1.0. Pixel coordinates are in the range from 0 to N-1. See getMaxXY
Parameters:
x
           (type=int)
y
           (type=int)
r
           (type=float)
g
           (type=float)
b
           (type=float)
a
           (type=float)
Returns:
nothing
           (type=none)

setPixelI(x, y, (r, g, b, a))

Set the the colors of the current pixel in the form [r,g,b,a]. Color values must be ints in the range 0 - 255. Pixel coordinates are in the range from 0 to N-1. See getMaxXY
Parameters:
x
           (type=int)
y
           (type=int)
r
           (type=int)
g
           (type=int)
b
           (type=int)
a
           (type=int)
Returns:
nothing
           (type=none)

setSpeed(speed)

Set the Image's speed (fps). Used for animated textures.
Parameters:
speed - The new value in [1, 100].
           (type=int)

setStart(start)

Get the Image's start frame. Used for animated textures.
Parameters:
start - The new value in [0, 128].
           (type=int)

setXRep(xrep)

Texture tiling: set the number of x repetitions for this Image.
Parameters:
xrep - The new value in [1, 16].
           (type=int)

setYRep(yrep)

Texture tiling: set the number of y repetitions for this Image.
Parameters:
yrep - The new value in [1, 16].
           (type=int)

unpack(mode)

Unpacks the image to the images filename.
Parameters:
mode - One of the values in Blender.Unpackmodes dict.
           (type=int)
Returns:
nothing
           (type=none)

Note: An error will be raised if the image is not packed or the filename path does not exist.


Instance Variable Details

antialias

enable or disable the antialias option for this image.
Type:
boolean

bindcode

Texture's bind code (readonly).
Type:
int

clampX

When true the image will not tile horizontally.
Type:
bool

clampY

When true the image will not tile vertically.
Type:
bool

depth

The pixel depth of the image. [8, 16, 18, 24, 32]
Type:
int

end

Texture's animation end frame [0, 128].
Type:
int

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.
Type:
bool

fields

enable or disable the fields option for this image.
Type:
boolean

fields_odd

enable or disable the odd fields option for this image.
Type:
boolean

filename

The filename (path) to the image file loaded into this Image object.
Type:
string

has_data

True when the image has pixel data (readonly).
Type:
boolean

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath
Type:
string or None

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened
Type:
string

packed

True when the Texture is packed (readonly).
Type:
boolean

properties

Returns an IDGroup reference to this datablocks's ID Properties.
Type:
IDGroup

size

The [width, height] dimensions of the image (in pixels).
Type:
list

source

Image source type. See the Sources dictionary .
Type:
int

speed

Texture's animation speed [1, 100].
Type:
int

start

Texture's animation start frame [0, 128].
Type:
int

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.
Type:
int

xrep

Texture tiling: the number of repetitions in the x (horizontal) axis. [1, 16].
Type:
int

yrep

Texture tiling: the number of repetitions in the y (vertical) axis [1, 16].
Type:
int

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Thu May 10 20:32:00 2007 http://epydoc.sf.net