SetTrimmingParams

nn::camera::CTR::SetTrimmingParams Function

Syntax

void SetTrimmingParams(
     Port port,
     s16 xStart,
     s16 yStart,
     s16 xEnd,
     s16 yEnd
);

Parameters

Name Description
in port Specifies which port to change settings for.
in xStart Starting position for trimming (x-coordinate)
in yStart Starting position for trimming (y-coordinate)
in xEnd Ending position for trimming (x-coordinate)
in yEnd Ending position for trimming (y-coordinate)

Return Values

None.

Description

Sets the positions to which to trim.

The following restrictions apply to the values that can be set:
• The trimming range is from (xStart, yStart) to (xEnd-1, yEnd-1).
• The values of (xEnd - xStart) and (yEnd - yStart) must both be even numbers.
• The values of xStart and yStart must also be even numbers.

To use this function, you must first enable trimming with the nn::camera::CTR::SetTrimming function.

This function does not set any value if it is called during image capture (while the nn::camera::CTR::IsBusy function returns true). If you wish to change the setting, do not call this function until you have used the nn::camera::CTR::StopCapture function to stop capturing and then waited for the nn::camera::CTR::IsBusy function's return value to change to false.

Revision History

2010/06/18
Explained that settings cannot be applied while capturing.
2010/04/09
Added description text.
2010/01/07
Initial version.

CONFIDENTIAL