CameraBackgroundImage(bpy_struct)

base class — bpy_struct

class bpy.types.CameraBackgroundImage(bpy_struct)

Image and settings for display in the 3D View background

alpha

Image opacity to blend the image against the background color (in [0, 1], default 0.0)

Type:

float

clip

Movie clip displayed and edited in this space

Type:

MovieClip

clip_user

Parameters defining which frame of the movie clip is displayed (readonly, never None)

Type:

MovieClipUser

display_depth

Display under or over everything (default 'BACK')

Type:

Literal[‘BACK’, ‘FRONT’]

frame_method

How the image fits in the camera frame (default 'FIT')

Type:

Literal[‘STRETCH’, ‘FIT’, ‘CROP’]

image

Image displayed and edited in this space

Type:

Image

image_user

Parameters defining which layer, pass and frame of the image is displayed (readonly, never None)

Type:

ImageUser

is_override_data

In a local override camera, whether this background image comes from the linked reference camera, or is local to the override (default True, readonly)

Type:

bool

offset

(array of 2 items, in [-inf, inf], default (0.0, 0.0))

Type:

mathutils.Vector

rotation

Rotation for the background image (ortho view only) (in [-inf, inf], default 0.0)

Type:

float

scale

Scale the background image (in [0, inf], default 0.0)

Type:

float

show_background_image

Show this image as background (default True)

Type:

bool

show_expanded

Show the details in the user interface (default False)

Type:

bool

show_on_foreground

Show this image in front of objects in viewport (default False)

Type:

bool

source

Data source used for background (default 'IMAGE')

Type:

Literal[‘IMAGE’, ‘MOVIE_CLIP’]

use_camera_clip

Use movie clip from active scene camera (default False)

Type:

bool

use_flip_x

Flip the background image horizontally (default False)

Type:

bool

use_flip_y

Flip the background image vertically (default False)

Type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References