[4.0] PixelBuffer::Rotate() amendments.

[platform/core/uifw/dali-adaptor.git] / platform-abstractions / portable / image-operations.h

diff --git a/platform-abstractions/portable/image-operations.h b/platform-abstractions/portable/image-operations.h
index b83cca1..540b9e0 100644 (file)
--- a/platform-abstractions/portable/image-operations.h
+++ b/platform-abstractions/portable/image-operations.h
@@ -390,6 +390,11 @@ void Resample( const unsigned char * __restrict__ inPixels,
 /**
  * @brief Rotates the input image with an implementation of the 'Rotate by Shear' algorithm.
  *
+ * @pre @p pixelsIn must not alias @p pixelsOut. The input image should be a totally
+ * separate buffer from the output buffer.
+ *
+ * @note This function allocates memory in @p pixelsOut which has to be released by calling @e free()
+ *
  * @param[in] pixelsIn The input buffer.
  * @param[in] widthIn The width of the input buffer.
  * @param[in] heightIn The height of the input buffer.