rprCameraSetFStop

Sets an F-stop (as it is called in the UI) value for a camera.

F-stop is the aperture value for the camera, the size of the opening through which light enters the device. It is commonly used as a measure of lens speed. Any floating point value is allowable but AMD Radeon ProRender cameras emulate real-world devices, so it makes sense to use real-world type values for camera’s F-stop.

A greater F-stop value means a smaller aperture, which requires a longer exposure to allow the same amount of light in. A smaller F-stop value implies a larger aperture (more light) and, therefore, a greater shutter speed. A smaller aperture (greater F-stop) gives a larger depth of field. A larger aperture (smaller F-stop) gives a smaller depth of field.

rpr_status rprCameraSetFStop(

rpr_camera camera,

rpr_float fstop);

Parameters

Parameter

Description

camera

The camera to set F-stop for.

fdist

F-stop value in 1/mm, default is FLT_MAX.

Notes

Setting an F-stop turns on the Depth of Field effect (DOF).

Return

Returns RPR_SUCCESS in case of success, or RPR_ERROR code if a problem was encountered.

To learn how to handle errors in AMD Radeon ProRender SDK, see Error Handling.