Blender V5.3
BKE_camera.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
8
9#include "DNA_vec_types.h"
10
11namespace blender {
12
17
18struct Camera;
19struct Depsgraph;
20struct Main;
21struct Object;
22struct RegionView3D;
23struct RenderData;
24struct Scene;
25struct View3D;
26
27/* Camera Data-block */
28
29struct Camera *BKE_camera_add(struct Main *bmain, const char *name);
30
31/* Camera Usage */
32
36float BKE_camera_object_dof_distance(const struct Object *ob);
37
38int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey);
39float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y);
40
45float2 BKE_camera_frame_size(float winx, float winy, float frame_aspect);
46
54 /* lens */
55 bool is_ortho = false;
56 bool is_flipped_x = false;
57 float lens = 0.0f;
58 float ortho_scale = 1.0f;
59 float zoom = 1.0f;
60 float roll = 0.0f;
61
62 float shiftx = 0.0f;
63 float shifty = 0.0f;
64 float offsetx = 0.0f;
65 float offsety = 0.0f;
66
67 /* sensor */
68 float sensor_x = 0.0f;
69 float sensor_y = 0.0f;
70 int sensor_fit = 0;
71
81 bool use_aspect_override = false;
82 float aspect_override = 0.0f;
83
84 /* clipping */
85 float clip_start = 0.1f;
86 float clip_end = 100.0f;
87
88 /* computed viewplane */
89 float ycor = 0.0f;
90 float viewdx = 0.0f;
91 float viewdy = 0.0f;
93
94 /* computed matrix */
95 float winmat[4][4] = {};
96};
97
98/* Values for CameraParams.zoom, need to be taken into account for some operations. */
99#define CAMERA_PARAM_ZOOM_INIT_CAMOB 1.0f
100#define CAMERA_PARAM_ZOOM_INIT_PERSP 2.0f
101
102void BKE_camera_params_init(CameraParams *params);
103void BKE_camera_params_from_object(CameraParams *params, const struct Object *cam_ob);
105 const struct Depsgraph *depsgraph,
106 const struct View3D *v3d,
107 const struct RegionView3D *rv3d);
108
110 CameraParams *params, int winx, int winy, float aspx, float aspy);
114void BKE_camera_params_crop_viewplane(rctf *viewplane, int winx, int winy, const rcti *region);
118float2 BKE_camera_viewplane_offset_transform(float roll, bool is_flipped_x, float2 offset);
123
124/* Camera Border in Viewport */
125
128 const struct Depsgraph *depsgraph,
129 const struct View3D *v3d,
130 const struct RegionView3D *rv3d,
131 int winx,
132 int winy,
133 bool no_shift,
134 bool no_zoom,
135 bool no_roll);
136
138bool BKE_camera_view_render_border(const struct Scene *scene,
139 const struct Depsgraph *depsgraph,
140 const struct View3D *v3d,
141 const struct RegionView3D *rv3d,
142 int winx,
143 int winy,
144 rctf *r_border,
145 rctf *r_unrolled_border);
146
147/* Camera View Frame */
148
149void BKE_camera_view_frame_ex(const struct Scene *scene,
150 const struct Camera *camera,
151 float drawsize,
152 bool do_clip,
153 const float scale[3],
154 float r_asp[2],
155 float r_shift[2],
156 float *r_drawsize,
157 float r_vec[4][3]);
158void BKE_camera_view_frame(const struct Scene *scene,
159 const struct Camera *camera,
160 float r_vec[4][3]);
161
167bool BKE_camera_view_frame_fit_to_scene(struct Depsgraph *depsgraph,
168 const struct Scene *scene,
169 struct Object *camera_ob,
170 float r_co[3],
171 float *r_scale,
172 float *r_clip_start,
173 float *r_clip_end);
174bool BKE_camera_view_frame_fit_to_coords(const struct Depsgraph *depsgraph,
175 const float (*cos)[3],
176 int num_cos,
177 struct Object *camera_ob,
178 float r_co[3],
179 float *r_scale);
180
181/* Camera multi-view API */
182
187 const struct Scene *scene,
188 struct Object *camera,
189 const char *viewname);
194 const struct Object *camera,
195 bool is_left,
196 float r_viewmat[4][4]);
198 const struct Object *camera,
199 const char *viewname,
200 float r_modelmat[4][4]);
202 const struct Object *camera,
203 const char *viewname,
204 float r_modelmat[4][4]);
206 const struct Object *camera,
207 const char *viewname,
208 float r_winmat[4][4]);
210 const struct Object *camera,
211 const char *viewname);
213 struct CameraParams *params,
214 const struct Object *camera,
215 const char *viewname);
217 const struct Object *camera);
218
219/* Camera background image API */
220
222
230 int flag);
231void BKE_camera_background_image_remove(struct Camera *cam, struct CameraBGImage *bgpic);
233
234} // namespace blender
#define cos
void camera(KernelGlobals &kg, const ShadingData &sd, float3 &outview, float &outdepth, float &outdist)
float3x3 scale(float3x3 mat, float2 scale)
BMesh Iterators.
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_multiview_view_matrix(const struct RenderData *rd, const struct Object *camera, bool is_left, float r_viewmat[4][4])
void BKE_camera_view_frame(const struct Scene *scene, const struct Camera *camera, float r_vec[4][3])
bool BKE_camera_view_render_border(const struct Scene *scene, const struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d, int winx, int winy, rctf *r_border, rctf *r_unrolled_border)
float2 BKE_camera_viewplane_offset_transform(float roll, bool is_flipped_x, float2 offset)
void BKE_camera_params_compute_viewplane(CameraParams *params, int winx, int winy, float aspx, float aspy)
void BKE_camera_multiview_model_matrix(const struct RenderData *rd, const struct Object *camera, const char *viewname, float r_modelmat[4][4])
float2 BKE_camera_frame_size(float winx, float winy, float frame_aspect)
void BKE_camera_multiview_params(const struct RenderData *rd, struct CameraParams *params, const struct Object *camera, const char *viewname)
void BKE_camera_params_compute_matrix(CameraParams *params)
float BKE_camera_multiview_shift_x(const struct RenderData *rd, const struct Object *camera, const char *viewname)
float BKE_camera_object_dof_distance(const struct Object *ob)
void BKE_camera_background_image_clear(struct Camera *cam)
VecBase< float, 2 > float2
void BKE_camera_params_from_view3d(CameraParams *params, const struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d)
struct Object * BKE_camera_multiview_render(const Main &bmain, const struct Scene *scene, struct Object *camera, const char *viewname)
void BKE_camera_multiview_window_matrix(const struct RenderData *rd, const struct Object *camera, const char *viewname, float r_winmat[4][4])
struct Camera * BKE_camera_add(struct Main *bmain, const char *name)
void BKE_camera_params_from_object(CameraParams *params, const struct Object *cam_ob)
rctf BKE_camera_view_border(const struct Scene *scene, const struct Depsgraph *depsgraph, const struct View3D *v3d, const struct RegionView3D *rv3d, int winx, int winy, bool no_shift, bool no_zoom, bool no_roll)
bool BKE_camera_multiview_spherical_stereo(const struct RenderData *rd, const struct Object *camera)
int BKE_camera_sensor_fit(int sensor_fit, float sizex, float sizey)
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)
float BKE_camera_sensor_size(int sensor_fit, float sensor_x, float sensor_y)
struct CameraBGImage * BKE_camera_background_image_new(struct Camera *cam)
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_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])
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)
void BKE_camera_params_init(CameraParams *params)
void BKE_camera_params_crop_viewplane(rctf *viewplane, int winx, int winy, const rcti *region)