Home -> IFrameBufferOutput -> GetCroppedImageDimensions

Description

The GetCroppedImageDimensions method returns the resulting image size if the specified offset and maximum region size are applied to the actual image data in the output buffer. This can be used to appropriately size a buffer to pass into the ReadBufferData method.

Usage

V2UInt32 GetCroppedImageDimensions(const V2UInt32& imageOffsetInPixels, const V2UInt32& imageRegionInPixels) const;

Argument list

imageOffsetInPixels [const V2UInt32]
The top-left pixel offset of the requested crop region.
imageRegionInPixels [const V2UInt32]
The pixel dimensions of the requested crop region. A zero value requests the remaining captured image from the offset.

Return value

[V2UInt32]
The dimensions of the requested cropped region, in pixels, after clamping to the captured image.

See also