Package bpy :: Module types :: Class Image

[frames] | no frames]

Class Image

The Image Object

Image datablock referencing an external or packed image.

References

Instance Methods

[hide private]

string

get_export_path(dest_dir, get_rel_path)
Produce image export path.

string

get_abs_filename()
Get absolute filename.

animation_data_clear()
Clear animation on this this ID. (Inherited from bpy.types.ID)

AnimData

animation_data_create()
Create animation data to this ID, note that not all ID types support this. (Inherited from bpy.types.ID)

copy()
Create a copy of this datablock (not supported for all datablocks). (Inherited from bpy.types.ID)

Instance Variables

[hide private]

boolean

animated
Use as animated texture in the game engine.

int in [0, 128]

animation_end
End frame of an animated texture.

int in [1, 100]

animation_speed
Speed of the animation in frames per second.

int in [0, 128]

animation_start
Start frame of an animated texture.

boolean

antialias
Toggles image anti-aliasing, only works with solid colors

boolean

clamp_x
Disable texture repeating horizontally.

boolean

clamp_y
Disable texture repeating vertically.

int (readonly) in [-inf, inf]

depth
Image bit depth.

boolean (readonly)

dirty
Image has changed and is not saved.

float array of 2 items in [0.1, 5000]

display_aspect
Display Aspect for this image, does not affect rendering.

boolean

fake_user
Saves this datablock even if it has no users (Inherited from bpy.types.ID)

enum

field_order
Order of video fields.

boolean

fields
Use fields of the image.

string

filename
Image/Movie file name.

int in [1, 16384]

generated_height
Generated image height.

enum

generated_type
Generated image type.

int in [1, 16384]

generated_width
Generated image width.

boolean (readonly)

has_data
True if this image has data.

Library (readonly)

library
Library file the datablock is linked from. (Inherited from bpy.types.ID)

enum

mapping
Mapping type to use for this image in the game engine.

string

name
Unique datablock ID name. (Inherited from bpy.types.ID)

PackedFile (readonly)

packed_file
Packed File

boolean

premultiply
Convert RGB from key alpha to premultiplied alpha.

enum

source
Where the image comes from.

boolean

tag
Tools can use this to tag data, (initial state is undefined). (Inherited from bpy.types.ID)

boolean

tiles
Use of tilemode for faces (default shift-LMB to pick the tile for selected faces).

int in [1, 16]

tiles_x
Degree of repetition in the X direction.

int in [1, 16]

tiles_y
Degree of repetition in the Y direction.

enum (readonly)

type
How to generate the image.

int (readonly) in [0, 32767]

users
Number of times this datablock is referenced. (Inherited from bpy.types.ID)

Method Details

[hide private]

get_export_path(dest_dir, get_rel_path)

Produce image export path.

Parameters:

dest_dir (string)
get_rel_path (boolean)

Returns: string

Absolute export path.

get_abs_filename()

Get absolute filename.

Returns: string: Image/movie absolute filename.

Instance Variable Details

[hide private]

field_order

Order of video fields. Select which lines are displayed first. in...

EVEN
ODD

Type:: enum

filename

Image/Movie file name. (maximum length of 240)

Type:: string

generated_type

Generated image type. in...

BLANK
UVGRID

Type:: enum

mapping

Mapping type to use for this image in the game engine. in...

UV
REFLECTION

Type:: enum

source

Where the image comes from. in...

FILE
SEQUENCE
MOVIE
GENERATED
VIEWER

Type:: enum

type

How to generate the image. in...

IMAGE
MULTILAYER
UV_TEST
RENDER_RESULT
COMPOSITING

Type:: enum (readonly)