Game Accessibility Library logo SourceForge.net Logo
Game Accessibility Suite: CATImage::CopyOver
CATResult CATImage::CopyOver ( const CATImage srcImg,
CATInt32  dstOffsetX,
CATInt32  dstOffsetY,
CATInt32  srcOffsetX,
CATInt32  srcOffsetY,
CATInt32  width = 0,
CATInt32  height = 0 
)

CopyOver() copies from another image over the current image at the specified offsets for the specified width and height.

If no width/height parameters are given, the entire width and/or height are used.

Clipping is not performed. However, if the copy would go out of bounds, an error will be returned and the copy will not be performed.

Parameters:
srcImg - source image to copy from
dstOffsetX - x offset in dest image to copy to
dstOffsetY - y offset in dest image to copy to
srcOffsetX - x offset in src image to copy from
srcOffsetY - y offset in src image to copy from
width - width to copy in
height - height to copy in
Returns:
CATResult - CAT_SUCCESS on success.

Definition at line 954 of file CATImage.cpp.

References AbsWidth(), CAT_ERR_IMAGE_MUST_INITIALIZE, CAT_ERR_IMAGE_NULL, CAT_ERR_IMAGE_OVERLAY_OUT_OF_BOUNDS, CAT_SUCCESS, CATASSERT, CATRESULT, fData, fHeight, fWidth, Height(), kBytesPerPixel, Width(), XOffsetAbs(), and YOffsetAbs().

Referenced by CATWindow::CleanBackground(), and CATWindow::ResetBackground().


Generated on Mon Feb 11 04:10:34 2008 for Game Accessibility Suite by doxygen 1.5.4