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

#include "BLI_rect.h"

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 (const 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, const 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_crop_viewplane (rctf viewplane, int winx, int winy, const rcti region)

void	BKE_camera_params_compute_matrix (CameraParams *params)

void	BKE_camera_view_frame_ex (const struct Scene scene, const struct Camera camera, float drawsize, 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, float r_clip_start, float r_clip_end)

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, 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)

struct CameraBGImage *	BKE_camera_background_image_copy (const struct CameraBGImage *bgpic_src, int flag)

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 78 of file BKE_camera.h.

Referenced by BKE_camera_params_from_view3d(), and ED_view3d_radius_to_dist().

◆ CAMERA_PARAM_ZOOM_INIT_PERSP

#define CAMERA_PARAM_ZOOM_INIT_PERSP 2.0f

Definition at line 79 of file BKE_camera.h.

Referenced by BKE_camera_params_from_view3d(), and ED_view3d_radius_to_dist().

Typedef Documentation

◆ CameraParams

typedef struct CameraParams CameraParams

Camera Parameters:

Intermediate struct for storing camera parameters from various sources, to unify computation of view-plane, window matrix, ... etc.

Function Documentation

◆ BKE_camera_add()

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

Definition at line 263 of file blenkernel/intern/camera.cc.

References BKE_id_new(), and ID_CA.

Referenced by BKE_object_obdata_add_from_type(), blender::io::usd::USDCameraReader::create_object(), 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 1254 of file blenkernel/intern/camera.cc.

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

◆ BKE_camera_background_image_copy()

struct CameraBGImage * BKE_camera_background_image_copy	(	const struct CameraBGImage *	bgpic_src,
		int	flag )

Duplicate a background image, in a ID management compatible way.

Parameters

copy_flag The usual ID copying flags, see LIB_ID_CREATE_/LIB_ID_COPY_ enums in BKE_lib_id.hh.

◆ BKE_camera_background_image_new()

struct CameraBGImage * BKE_camera_background_image_new ( struct Camera * cam )

Definition at line 1214 of file blenkernel/intern/camera.cc.

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

Referenced by camera_background_image_add_exec().

◆ BKE_camera_background_image_remove()

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

Definition at line 1247 of file blenkernel/intern/camera.cc.

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

Referenced by BKE_camera_background_image_clear(), and camera_background_image_remove_exec().

◆ 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(), blender::draw::overlay::Cameras::object_sync(), 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 )

Returns the camera to be used for render.

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(), 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,
		bool	is_left,
		float	r_viewmat[4][4] )

The view matrix is used by the viewport drawing, it is basically the inverted model matrix.

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 ( const struct Object * ob )

Get the camera's DOF value, takes the DOF object into account.

Referenced by blender::nodes::node_composite_defocus_cc::DefocusOperation::compute_focus_distance(), blender::io::usd::USDCameraWriter::do_write(), GPENCIL_cache_init(), blender::workbench::DofPass::init(), blender::draw::overlay::Cameras::object_sync(), OVERLAY_camera_cache_populate(), and blender::eevee::DepthOfField::sync().

◆ BKE_camera_params_compute_matrix()

void BKE_camera_params_compute_matrix ( CameraParams * params )

View-plane is assumed to be already computed.

Definition at line 500 of file blenkernel/intern/camera.cc.

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::grease_pencil::persmat_from_camera_object(), proj_paint_state_viewport_init(), RE_GetWindowMatrixWithOverscan(), 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 )

◆ BKE_camera_params_crop_viewplane()

void BKE_camera_params_crop_viewplane	(	rctf *	viewplane,
		int	winx,
		int	winy,
		const rcti *	region )

Crop viewplane given the current resolution and a pixel region inside the view plane.

Definition at line 488 of file blenkernel/intern/camera.cc.

References BLI_rctf_size_x(), BLI_rctf_size_y(), BLI_rcti_size_x(), BLI_rcti_size_y(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by blender::eevee::Camera::sync().

◆ 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::render::hydra::gf_camera(), blender::io::grease_pencil::persmat_from_camera_object(), proj_paint_state_viewport_init(), RE_SetCamera(), blender::eevee::Camera::sync(), uvprojectModifier_do(), and view3d_camera_border().

◆ BKE_camera_params_from_view3d()

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

Referenced by ED_view3d_clip_range_get(), ED_view3d_viewplane_get(), blender::render::hydra::gf_camera(), blender::eevee::Camera::sync(), and view3d_camera_border().

◆ BKE_camera_params_init()

void BKE_camera_params_init ( CameraParams * params )

◆ BKE_camera_sensor_fit()

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

Definition at line 308 of file blenkernel/intern/camera.cc.

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(), blender::render::hydra::gf_camera(), lineart_create_render_buffer_v3(), 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 298 of file blenkernel/intern/camera.cc.

References CAMERA_SENSOR_FIT_VERT.

Referenced by BKE_camera_params_compute_viewplane(), BKE_camera_params_from_view3d(), camera_frame_fit_calc_from_data(), blender::io::usd::camera_sensor_size_for_render(), ED_view3d_radius_to_dist(), blender::render::hydra::gf_camera(), GPENCIL_cache_init(), blender::workbench::DofPass::init(), lineart_main_load_geometries(), and WIDGETGROUP_camera_refresh().

◆ 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(), and blender::render::hydra::ViewSettings::ViewSettings().

◆ BKE_camera_view_frame_ex()

void BKE_camera_view_frame_ex	(	const struct Scene *	scene,
		const struct Camera *	camera,
		float	drawsize,
		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 blender::draw::overlay::Cameras::object_sync(), and 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,
		float *	r_clip_start,
		float *	r_clip_end )