formZ SDK | 5.0 API Reference | Project | Modeling | View Manager

# fz_view_parm_camera_enum

Description

View parameters used by camera views.

enum fz_view_parm_camera_enum {

FZ_VIEW_PARM_CAMR_STD,

FZ_VIEW_PARM_CAMR_STD_TYPE,

FZ_VIEW_PARM_CAMR_WIDTH,

FZ_VIEW_PARM_CAMR_HEIGHT,

FZ_VIEW_PARM_CAMR_ASPECT,

FZ_VIEW_PARM_CAMR_ASPECT_LOCK,

FZ_VIEW_PARM_CAMR_PIXEL_ASPECT };

Members

FZ_VIEW_PARM_CAMR_STD

Whether or not the camera view has standard pre-set dimensions. FALSE means use custom dimensions.

Type: fzrt_boolean

Default Value: TRUE

FZ_VIEW_PARM_CAMR_STD_TYPE

Type of standard camera dimensions to use for the camera view.

Type: fz_view_camera_std_enum

Default Value: FZ_VIEW_CAMR_STD_FULL

FZ_VIEW_PARM_CAMR_WIDTH

Width of camera view in pixels.

Type: short

Default Value: 640

Range: 1 <= value <= 32767

FZ_VIEW_PARM_CAMR_HEIGHT

Height of camera view in pixels.

Type: short

Default Value: 480

Range: 1 <= value <= 32767

FZ_VIEW_PARM_CAMR_ASPECT

Aspect ratio of the entire camera view. Related to FZ_VIEW_PARM_CAMR_WIDTH and FZ_VIEW_PARM_CAMR_HEIGHT.

Type: float

Default Value: 1.333

Range: 0.0 < value <= 1000000000.0 such that 1 <= FZ_VIEW_PARM_CAMR_HEIGHT <= 32767 when ( FZ_VIEW_PARM_CAMR_WIDTH* FZ_VIEW_PARM_CAMR_PIXEL_ASPECT) / value.

FZ_VIEW_PARM_CAMR_ASPECT_LOCK

Whether or not the aspect ratio is locked. If locked, changes to FZ_VIEW_PARM_CAMR_WIDTH will change FZ_VIEW_PARM_CAMR_HEIGHT to maintain the current aspect ratio, and vice versa.

Type: fzrt_boolean

Default Value: TRUE

FZ_VIEW_PARM_CAMR_PIXEL_ASPECT

Aspect ratio of a single pixel in the camera view.

Type: float

Default Value: 1.0

Range: 0.001 <= value <= 1000000000.0

Availability

5.0.0.0

Defined in

fz_view_api.h