FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kStatus kCameraState_WriteRamImage ( kCameraState  state,
kSize  index,
kImage  image 
)

Writes an image into FPGA RAM (used for testing/simulation).

This function writes an image into FPGA RAM. The location of the image in FPGA RAM is determined by the size and count of images defined for every camera state used with this sensor. Accordingly, when image size (based on Width/Height/Subsmapling properties) or count (based on RamImageCount property) change for any camera state, the contents of FPGA RAM may be inconsistent with the updated settings. As a result, image sizes and counts should be set before writing RAM images, to ensure that images are written/read in the correct locations. If settings are changed after writing RAM images, the content of the images emitted by each camera state may be different than expected.

Note: If settings have been changed, kNode_Apply should be called prior to calling kCameraState_WriteRamImage, to ensure that uncommitted settings are successfully applied before writing the image to the sensor. This ensures that the sensor has updated camera state properites, which are required to determine the correct location at which to write the image.

Parameters
stateState object.
indexIndex of image within simulated image sequence.
imageImage to be written; should be same size as image produced by camera state.
Returns
Operation status.