Camera(ID)

base classes — bpy_struct, ID

class bpy.types.Camera(ID)

Camera data-block for storing camera settings

angle

Camera lens field of view

Type: float in [0.00640536, 3.01675], default 0.0

angle_x

Camera lens horizontal field of view

Type: float in [0.00640536, 3.01675], default 0.0

angle_y

Camera lens vertical field of view

Type: float in [0.00640536, 3.01675], default 0.0

animation_data

Animation data for this data-block

Type: AnimData, (readonly)

background_images

List of background images

Type: CameraBackgroundImages bpy_prop_collection of CameraBackgroundImage, (readonly)

clip_end

Camera far clipping distance

Type: float in [1e-06, inf], default 1000.0

clip_start

Camera near clipping distance

Type: float in [1e-06, inf], default 0.1

display_size

Apparent size of the Camera object in the 3D View

Type: float in [0.01, 1000], default 1.0

dof

Type: CameraDOFSettings, (readonly)

lens

Perspective Camera lens value in millimeters

Type: float in [1, inf], default 50.0

lens_unit

Unit to edit lens in for the user interface

MILLIMETERS Millimeters – Specify the lens in millimeters.
FOV Field of View – Specify the lens as the field of view’s angle.

Type: enum in [‘MILLIMETERS’, ‘FOV’], default ‘MILLIMETERS’

lod_factor

The factor applied to distance computed in Lod

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

ortho_scale

Orthographic Camera scale (similar to zoom)

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

overlay_disable_ao

Disable AO in Overlay Pass

Type: boolean, default False

overlay_disable_bloom

Disable Bloom in Overlay Pass

Type: boolean, default False

overlay_disable_ssr

Disable SSR in Overlay Pass

Type: boolean, default False

overlay_disable_world_volumes

Disable World Volumes in Overlay Pass

Type: boolean, default False

passepartout_alpha

Opacity (alpha) of the darkened overlay in Camera view

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

sensor_fit

Method to fit image and field of view angle inside the sensor

AUTO Auto – Fit to the sensor width or height depending on image resolution.
HORIZONTAL Horizontal – Fit to the sensor width.
VERTICAL Vertical – Fit to the sensor height.

Type: enum in [‘AUTO’, ‘HORIZONTAL’, ‘VERTICAL’], default ‘AUTO’

sensor_height

Vertical size of the image sensor area in millimeters

Type: float in [1, inf], default 24.0

sensor_width

Horizontal size of the image sensor area in millimeters

Type: float in [1, inf], default 36.0

shift_x

Camera horizontal shift

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

shift_y

Camera vertical shift

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

show_background_images

Display reference images behind objects in the 3D View

Type: boolean, default False

show_composition_center

Display center composition guide inside the camera view

Type: boolean, default False

show_composition_center_diagonal

Display diagonal center composition guide inside the camera view

Type: boolean, default False

show_composition_golden

Display golden ratio composition guide inside the camera view

Type: boolean, default False

show_composition_golden_tria_a

Display golden triangle A composition guide inside the camera view

Type: boolean, default False

show_composition_golden_tria_b

Display golden triangle B composition guide inside the camera view

Type: boolean, default False

show_composition_harmony_tri_a

Display harmony A composition guide inside the camera view

Type: boolean, default False

show_composition_harmony_tri_b

Display harmony B composition guide inside the camera view

Type: boolean, default False

show_composition_thirds

Display rule of thirds composition guide inside the camera view

Type: boolean, default False

show_limits

Display the clipping range and focus point on the camera

Type: boolean, default False

show_mist

Display a line from the Camera to indicate the mist area

Type: boolean, default False

show_name

Show the active Camera’s name in Camera view

Type: boolean, default False

show_passepartout

Show a darkened overlay outside the image area in Camera view

Type: boolean, default True

show_safe_areas

Show TV title safe and action safe areas in Camera view

Type: boolean, default False

show_safe_center

Show safe areas to fit content in a different aspect ratio

Type: boolean, default False

show_sensor

Show sensor size (film gate) in Camera view

Type: boolean, default False

stereo

Type: CameraStereoData, (readonly, never None)

type

Camera types

Type: enum in [‘PERSP’, ‘ORTHO’, ‘PANO’], default ‘PERSP’

use_object_activity_culling

Enable object activity culling with this camera

Type: boolean, default True

use_overlay_mouse_control

If enabled and if the cam is an overlay cam, mouse events will be handled in this camera space

Type: boolean, default False

view_frame(scene=None)

Return 4 points for the cameras frame (before object transformation)

Parameters

scene (Scene, (optional)) – Scene to use for aspect calculation, when omitted 1:1 aspect is used

Return (result_1, result_2, result_3, result_4)

result_1, Result, float array of 3 items in [-inf, inf]

result_2, Result, float array of 3 items in [-inf, inf]

result_3, Result, float array of 3 items in [-inf, inf]

result_4, Result, float array of 3 items in [-inf, inf]

classmethod bl_rna_get_subclass(id, default=None)

Parameters: id (string) – The RNA type identifier.
Returns: The RNA type or default when not found.
Return type: bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)

Parameters: id (string) – The RNA type identifier.
Returns: The class or default when not found.
Return type: type

Inherited Properties

Inherited Functions

References