# BackgroundImage(bpy_struct)

base class — `bpy_struct`

class `bpy.types.``BackgroundImage`(bpy_struct)

  Image and settings for display in the 3D View background

  `clip`

    Movie clip displayed and edited in this space

    Type: | `MovieClip`

  `clip_user`

    Parameters defining which frame of the movie clip is displayed

    Type: | `MovieClipUser`, (readonly, never None)

  `draw_depth`

    Draw under or over everything

    Type: | enum in [‘BACK’, ‘FRONT’], default ‘BACK’

  `frame_method`

    How the image fits in the camera frame

    Type: | enum in [‘STRETCH’, ‘FIT’, ‘CROP’], default ‘STRETCH’

  `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`

    Offset image horizontally from the world origin

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

  `offset_y`

    Offset 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

  `rotation`

    Rotation for the background image (ortho view only)

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

  `show_background_image`

    Show this image as background

    Type: | boolean, default False

  `show_expanded`

    Show the expanded in the user interface

    Type: | boolean, default False

  `show_on_foreground`

    Show this image in front of objects in viewport

    Type: | boolean, default False

  `size`

    Size of the background image (ortho view only)

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

  `source`

    Data source used for background

    Type: | enum in [‘IMAGE’, ‘MOVIE_CLIP’], default ‘IMAGE’

  `use_camera_clip`

    Use movie clip from active scene camera

    Type: | boolean, default False

  `use_flip_x`

    Flip the background image horizontally

    Type: | boolean, default False

  `use_flip_y`

    Flip the background image vertically

    Type: | boolean, default False

  `view_axis`

    The axis to display the image on

    - `LEFT` Left, Show background image while looking to the left.
    - `RIGHT` Right, Show background image while looking to the right.
    - `BACK` Back, Show background image in back view.
    - `FRONT` Front, Show background image in front view.
    - `BOTTOM` Bottom, Show background image in bottom view.
    - `TOP` Top, Show background image in top view.
    - `ALL` All Views, Show background image in all views.
    - `CAMERA` Camera, Show background image in camera view.

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

Inherited Properties

`bpy_struct.id_data` |

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` | `bpy_struct.keyframe_delete` `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values`

References

`BackgroundImages.new` `BackgroundImages.remove` | `SpaceView3D.background_images`