BKE_camera.h File Reference

Camera data-block and utility functions. More...

Go to the source code of this file.

Classes
struct	CameraParams

Macros
#define	CAMERA_PARAM_ZOOM_INIT_CAMOB   1.0f
#define	CAMERA_PARAM_ZOOM_INIT_PERSP   2.0f

Typedefs
typedef struct CameraParams	CameraParams

Functions
void *	BKE_camera_add (struct Main *bmain, const char *name)
float	BKE_camera_object_dof_distance (struct Object *ob)
int	BKE_camera_sensor_fit (int sensor_fit, float sizex, float sizey)
float	BKE_camera_sensor_size (int sensor_fit, float sensor_x, float sensor_y)
void	BKE_camera_params_init (CameraParams *params)
void	BKE_camera_params_from_object (CameraParams *params, const struct Object *cam_ob)
void	BKE_camera_params_from_view3d (CameraParams *params, struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d)
void	BKE_camera_params_compute_viewplane (CameraParams *params, int winx, int winy, float aspx, float aspy)
void	BKE_camera_params_compute_matrix (CameraParams *params)
void	BKE_camera_view_frame_ex (const struct Scene *scene, const struct Camera *camera, const float drawsize, const bool do_clip, const float scale[3], float r_asp[2], float r_shift[2], float *r_drawsize, float r_vec[4][3])
void	BKE_camera_view_frame (const struct Scene *scene, const struct Camera *camera, float r_vec[4][3])
bool	BKE_camera_view_frame_fit_to_scene (struct Depsgraph *depsgraph, const struct Scene *scene, struct Object *camera_ob, float r_co[3], float *r_scale)
bool	BKE_camera_view_frame_fit_to_coords (const struct Depsgraph *depsgraph, const float(*cos)[3], int num_cos, struct Object *camera_ob, float r_co[3], float *r_scale)
struct Object *	BKE_camera_multiview_render (const struct Scene *scene, struct Object *camera, const char *viewname)
void	BKE_camera_multiview_view_matrix (const struct RenderData *rd, const struct Object *camera, const bool is_left, float r_viewmat[4][4])
void	BKE_camera_multiview_model_matrix (const struct RenderData *rd, const struct Object *camera, const char *viewname, float r_modelmat[4][4])
void	BKE_camera_multiview_model_matrix_scaled (const struct RenderData *rd, const struct Object *camera, const char *viewname, float r_modelmat[4][4])
void	BKE_camera_multiview_window_matrix (const struct RenderData *rd, const struct Object *camera, const char *viewname, float r_winmat[4][4])
float	BKE_camera_multiview_shift_x (const struct RenderData *rd, const struct Object *camera, const char *viewname)
void	BKE_camera_multiview_params (const struct RenderData *rd, struct CameraParams *params, const struct Object *camera, const char *viewname)
bool	BKE_camera_multiview_spherical_stereo (const struct RenderData *rd, const struct Object *camera)
struct CameraBGImage *	BKE_camera_background_image_new (struct Camera *cam)
void	BKE_camera_background_image_remove (struct Camera *cam, struct CameraBGImage *bgpic)
void	BKE_camera_background_image_clear (struct Camera *cam)

Detailed Description

Camera data-block and utility functions.

Definition in file BKE_camera.h.

Macro Definition Documentation

CAMERA_PARAM_ZOOM_INIT_CAMOB

#define CAMERA_PARAM_ZOOM_INIT_CAMOB   1.0f

Definition at line 88 of file BKE_camera.h.

CAMERA_PARAM_ZOOM_INIT_PERSP

#define CAMERA_PARAM_ZOOM_INIT_PERSP   2.0f

Definition at line 89 of file BKE_camera.h.

Typedef Documentation

CameraParams

typedef struct CameraParams CameraParams

Function Documentation

BKE_camera_add()

void* BKE_camera_add	(	struct Main *	bmain,
		const char *	name
	)

Definition at line 217 of file camera.c.

References BKE_id_new(), and ID_CA.

Referenced by BKE_object_obdata_add_from_type(), blender::io::alembic::AbcCameraReader::readObjectData(), and DocumentImporter::writeCamera().

BKE_camera_background_image_clear()

void BKE_camera_background_image_clear

(

struct Camera *

cam

)

Definition at line 1153 of file camera.c.

References Camera::bg_images, BKE_camera_background_image_remove(), ListBase::first, and CameraBGImage::next.

BKE_camera_background_image_new()

struct CameraBGImage* BKE_camera_background_image_new

(

struct Camera *

cam

)

Definition at line 1131 of file camera.c.

References CameraBGImage::alpha, Camera::bg_images, BLI_addtail(), CAM_BGIMG_FLAG_EXPANDED, CameraBGImage::flag, ImageUser::flag, IMA_ANIM_ALWAYS, CameraBGImage::iuser, MEM_callocN, ImageUser::ok, and CameraBGImage::scale.

Referenced by background_image_add_exec(), and background_image_add_invoke().

BKE_camera_background_image_remove()

void BKE_camera_background_image_remove	(	struct Camera *	cam,
		struct CameraBGImage *	bgpic
	)

Definition at line 1146 of file camera.c.

References Camera::bg_images, BLI_remlink(), and MEM_freeN.

Referenced by background_image_remove_exec(), and BKE_camera_background_image_clear().

BKE_camera_multiview_model_matrix()

void BKE_camera_multiview_model_matrix	(	const struct RenderData *	rd,
		const struct Object *	camera,
		const char *	viewname,
		float	r_modelmat[4][4]
	)

Referenced by camera_stereoscopy_extra(), OVERLAY_camera_cache_populate(), OVERLAY_image_camera_cache_populate(), RE_engine_get_camera_model_matrix(), and RE_GetCameraModelMatrix().

BKE_camera_multiview_model_matrix_scaled()

void BKE_camera_multiview_model_matrix_scaled	(	const struct RenderData *	rd,
		const struct Object *	camera,
		const char *	viewname,
		float	r_modelmat[4][4]
	)

Referenced by camera_stereoscopy_extra().

BKE_camera_multiview_params()

void BKE_camera_multiview_params	(	const struct RenderData *	rd,
		struct CameraParams *	params,
		const struct Object *	camera,
		const char *	viewname
	)

Referenced by ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), and RE_SetCamera().

BKE_camera_multiview_render()

struct Object* BKE_camera_multiview_render	(	const struct Scene *	scene,
		struct Object *	camera,
		const char *	viewname
	)

Referenced by camera_stereoscopy_extra(), check_valid_camera_multiview(), ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), RE_GetCamera(), screen_opengl_render_doit(), screen_opengl_views_setup(), view3d_stereo3d_setup(), and view3d_stereo3d_setup_offscreen().

BKE_camera_multiview_shift_x()

float BKE_camera_multiview_shift_x	(	const struct RenderData *	rd,
		const struct Object *	camera,
		const char *	viewname
	)

Referenced by camera_offaxis_shiftx_get(), RE_engine_get_camera_shift_x(), and view3d_stereo3d_setup().

BKE_camera_multiview_spherical_stereo()

bool BKE_camera_multiview_spherical_stereo	(	const struct RenderData *	rd,
		const struct Object *	camera
	)

Referenced by RE_engine_get_spherical_stereo().

BKE_camera_multiview_view_matrix()

void BKE_camera_multiview_view_matrix	(	const struct RenderData *	rd,
		const struct Object *	camera,
		const bool	is_left,
		float	r_viewmat[4][4]
	)

Referenced by view3d_stereo3d_setup(), and view3d_stereo3d_setup_offscreen().

BKE_camera_multiview_window_matrix()

void BKE_camera_multiview_window_matrix	(	const struct RenderData *	rd,
		const struct Object *	camera,
		const char *	viewname,
		float	r_winmat[4][4]
	)

BKE_camera_object_dof_distance()

float BKE_camera_object_dof_distance

(

struct Object *

ob

)

Definition at line 227 of file camera.c.

References Object::data, Camera::dof, dot_v3v3(), fabsf, CameraDOFSettings::focus_distance, CameraDOFSettings::focus_object, if(), normalize_v3_v3(), OB_CAMERA, Object::obmat, sub_v3_v3v3(), and Object::type.

Referenced by blender::compositor::ConvertDepthToRadiusOperation::determineFocalDistance(), blender::io::usd::USDCameraWriter::do_write(), EEVEE_depth_of_field_init(), GPENCIL_cache_init(), OVERLAY_camera_cache_populate(), and workbench_dof_engine_init().

BKE_camera_params_compute_matrix()

void BKE_camera_params_compute_matrix

(

CameraParams *

params

)

Definition at line 436 of file camera.c.

References orthographic_m4(), params, perspective_m4(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by BKE_camera_multiview_window_matrix(), camera_frame_fit_data_init(), ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), blender::io::gpencil::GpencilIO::prepare_camera_params(), proj_paint_state_viewport_init(), RE_GetCameraWindowWithOverscan(), RE_SetCamera(), and uvprojectModifier_do().

BKE_camera_params_compute_viewplane()

void BKE_camera_params_compute_viewplane	(	CameraParams *	params,
		int	winx,
		int	winy,
		float	aspx,
		float	aspy
	)

Definition at line 370 of file camera.c.

References BKE_camera_sensor_fit(), BKE_camera_sensor_size(), CAMERA_SENSOR_FIT_HOR, float(), params, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by BKE_camera_multiview_window_matrix(), camera_frame_fit_data_init(), ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), ED_view3d_viewplane_get(), blender::io::gpencil::GpencilIO::prepare_camera_params(), proj_paint_state_viewport_init(), RE_SetCamera(), uvprojectModifier_do(), and view3d_camera_border().

BKE_camera_params_from_object()

void BKE_camera_params_from_object	(	CameraParams *	params,
		const struct Object *	cam_ob
	)

Referenced by ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), ED_view3d_from_object(), ED_view3d_radius_to_dist(), followtrack_evaluate_using_2d_position(), blender::io::gpencil::GpencilIO::prepare_camera_params(), proj_paint_state_viewport_init(), RE_SetCamera(), uvprojectModifier_do(), and view3d_camera_border().

BKE_camera_params_from_view3d()

void BKE_camera_params_from_view3d	(	CameraParams *	params,
		struct Depsgraph *	depsgraph,
		const struct View3D *	v3d,
		const struct RegionView3D *	rv3d
	)

Referenced by ED_view3d_clip_range_get(), ED_view3d_viewplane_get(), and view3d_camera_border().

BKE_camera_params_init()

void BKE_camera_params_init

(

CameraParams *

params

)

Definition at line 271 of file camera.c.

References CAMERA_SENSOR_FIT_AUTO, DEFAULT_SENSOR_HEIGHT, DEFAULT_SENSOR_WIDTH, and params.

Referenced by BKE_camera_multiview_window_matrix(), camera_frame_fit_data_init(), ED_view3d_clip_range_get(), ED_view3d_draw_offscreen_imbuf(), ED_view3d_draw_offscreen_imbuf_simple(), ED_view3d_from_object(), ED_view3d_radius_to_dist(), ED_view3d_viewplane_get(), followtrack_evaluate_using_2d_position(), blender::io::gpencil::GpencilIO::prepare_camera_params(), proj_paint_state_viewport_init(), RE_SetCamera(), uvprojectModifier_do(), and view3d_camera_border().

BKE_camera_sensor_fit()

int BKE_camera_sensor_fit	(	int	sensor_fit,
		float	sizex,
		float	sizey
	)

Definition at line 252 of file camera.c.

References CAMERA_SENSOR_FIT_AUTO, CAMERA_SENSOR_FIT_HOR, and CAMERA_SENSOR_FIT_VERT.

Referenced by BKE_camera_params_compute_viewplane(), BKE_camera_view_frame_ex(), blender::io::usd::camera_sensor_size_for_render(), drawviewborder(), ED_view3d_win_to_3d(), lineart_create_render_buffer(), lineart_main_load_geometries(), and WIDGETGROUP_camera_refresh().

BKE_camera_sensor_size()

float BKE_camera_sensor_size	(	int	sensor_fit,
		float	sensor_x,
		float	sensor_y
	)

Definition at line 242 of file camera.c.

References CAMERA_SENSOR_FIT_VERT.

Referenced by BKE_camera_params_compute_viewplane(), BKE_camera_params_from_view3d(), camera_frame_fit_calc_from_data(), ED_view3d_radius_to_dist(), EEVEE_depth_of_field_init(), GPENCIL_cache_init(), blender::compositor::ConvertDepthToRadiusOperation::initExecution(), lineart_main_load_geometries(), WIDGETGROUP_camera_refresh(), and workbench_dof_engine_init().

BKE_camera_view_frame()

void BKE_camera_view_frame	(	const struct Scene *	scene,
		const struct Camera *	camera,
		float	r_vec[4][3]
	)

Referenced by image_camera_background_matrix_get().

BKE_camera_view_frame_ex()

void BKE_camera_view_frame_ex	(	const struct Scene *	scene,
		const struct Camera *	camera,
		const float	drawsize,
		const bool	do_clip,
		const float	scale[3],
		float	r_asp[2],
		float	r_shift[2],
		float *	r_drawsize,
		float	r_vec[4][3]
	)

Referenced by OVERLAY_camera_cache_populate().

BKE_camera_view_frame_fit_to_coords()

bool BKE_camera_view_frame_fit_to_coords	(	const struct Depsgraph *	depsgraph,
		const float(*)	cos[3],
		int	num_cos,
		struct Object *	camera_ob,
		float	r_co[3],
		float *	r_scale
	)

BKE_camera_view_frame_fit_to_scene()

bool BKE_camera_view_frame_fit_to_scene	(	struct Depsgraph *	depsgraph,
		const struct Scene *	scene,
		struct Object *	camera_ob,
		float	r_co[3],
		float *	r_scale
	)

Referenced by ED_view3d_camera_to_view_selected().