formZ SDK | 5.0 API Reference | Project | Modeling | Rendering | Render Manager

fz_rndr_get_image_resolution

Description

Returns the width, height and dots per inch (dpi) at which the current image is rendered. The dpi setting is not important for the image resolution (width and height), as those values already contain the final number of pixels of the image. The dpi setting may be of interest, if printing information will be incorporated in the rendering. For example, if a rendering needs to create a line, which will print at 1mm thickness, the dpi setting is needed.

Plugin Prototype

fzrt_error_td fz_rndr_get_image_resolution(

fzrt_int

windex,

fzrt_int *

width,

fzrt_int *

height,

fzrt_int *

dpi )

Parameters

windex [Input]

project window index

width [Result, Optional]

The image width in pixels

height [Result, Optional]

The image height in pixels

dpi [Result, Optional]

The dots per inch setting of the image.

Returns

Error codes.

Availability

5.0.0.0

Function Set

fz_rndr_mngr_fset


Defined in

fz_rndr_api.h