BackgroundImage(bpy_struct)¶

base class — bpy_struct

class bpy.types.BackgroundImage(bpy_struct)¶

Image and settings for display in the 3d View background

image¶

Image displayed and edited in this space

Type :	`Image`

image_user¶

Parameters defining which layer, pass and frame of the image is displayed

Type :	`ImageUser`, (readonly, never None)

offset_x¶

Offsets image horizontally from the world origin

Type :	float in [-inf, inf], default 0.0

offset_y¶

Offsets image vertically from the world origin

Type :	float in [-inf, inf], default 0.0

opacity¶

Image opacity to blend the image against the background color

Type :	float in [0, 1], default 0.0

show_expanded¶

Show the expanded in the user interface

Type :	boolean, default False

size¶

Scaling factor for the background image

Type :	float in [0, inf], default 0.0

view_axis¶

The axis to display the image on

Type :	enum in [‘LEFT’, ‘RIGHT’, ‘BACK’, ‘FRONT’, ‘BOTTOM’, ‘TOP’, ‘ALL’, ‘CAMERA’], default ‘ALL’

Inherited Properties

Inherited Functions

References