* @file FMediaImage.h
* @brief This is the header file for the %Image class.
*
-* This header file contains the declarations of the %Tizen::Media::Image class.
+* This header file contains the declarations of the %Image class.
*/
#ifndef _FMEDIA_IMAGE_H_
* @brief This class is used for handling images.
*
* @since 2.0
+ * @remarks The minimum dimension is 16x16 for JPEG encoding and 8x8 for PNG encoding.
*
* The %Image class is used for handling images, including image decoding, encoding, conversion, and JPEG compression. @n
- * @remarks The minimum dimension is 16x16 for JPEG encoding and 8x8 for PNG encoding.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/viewing_processing_still_images.htm">Viewing and Processing Still Images</a>. @n
* The following example demonstrates how to use the %Image class for image decoding and encoding.
* @remarks This method retains the aspect ratio of the original image. @n
* @c E_OUT_OF_MEMORY can be returned if there is no available memory when decoding a large image. @n
* The specific error code can be accessed using the GetLastResult() method. @n
- * This method returns auto-scaled bitmap, @n
- * so the dimension can be different from the dimension of source image when the returned bitmap is locked.
+ * This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the dimension of source image if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::String& srcImagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
* @remarks This method retains the aspect ratio of the original image. @n
* It supports only the downscaling of an image. @n
* The specific error code can be accessed using the GetLastResult() method. @n
- * This method returns auto-scaled bitmap, @n
- * so the dimension can be different from the requested dimension when the returned bitmap is locked.
+ * This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the requested dimension if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::String& srcImagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat, int destWidth, int destHeight) const;
* @exception E_MAX_EXCEEDED The number of concurrent accesses to the URLs has reached the maximum limit.
* @remarks This method retains the aspect ratio of the original image. @n
* It supports only the downscaling of an image. @n
- * The maximum limit for downscaling is 3. @n
+ * The maximum limit for downloading is @c 3. @n
* The supported protocol is HTTP.
*/
result DecodeUrl(const Tizen::Base::Utility::Uri& srcImageUrl, Tizen::Graphics::BitmapPixelFormat pixelFormat, int destWidth, int destHeight, RequestId& reqId, const IImageDecodeUrlEventListener& listener, long timeout) const;
* @remarks This method retains the aspect ratio of the original image. @n
* @c E_OUT_OF_MEMORY is returned if the memory is not available when decoding a large image. @n
* The specific error code can be accessed using the GetLastResult() method. @n
- * This method returns auto-scaled bitmap, @n
- * so the dimension can be different from the dimension of source image when the returned bitmap is locked.
+ * This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the dimension of source image if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::ByteBuffer& srcImageBuf, ImageFormat srcImageFormat, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
* @remarks This method retains the aspect ratio of the original image. @n
* It supports only the downscaling of an image. @n
* The specific error code can be accessed using the GetLastResult() method. @n
- * This method returns auto-scaled bitmap, @n
- * so the dimension can be different from the requested dimension when the returned bitmap is locked.
+ * This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the requested dimension if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::ByteBuffer& srcImageBuf, ImageFormat srcImageFormat, Tizen::Graphics::BitmapPixelFormat pixelFormat, int destWidth, int destHeight) const;
*
* @if OSPCOMPAT
* @brief <i> [Deprecated] [Compatibility] </i>
- * @endif
* @deprecated This method is deprecated.
+ * @endif
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* Compresses an encoded image data to the byte buffer to reduce its data size as per the specified limit. @n
* The only supported compression format is JPEG.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated.
* @since 2.0
*
/**
* Checks whether the specified image file has alpha channels. @n
- * Currently, only 32-bit PNG images are supported.
+ * Currently only 32-bit PNG images are supported.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @brief This class is used for handling decoded image data.
*
* @since 2.0
+ * @remarks The minimum dimension is 16x16 for JPEG encoding and 8x8 for PNG encoding.
*
* The %ImageBuffer class is used for handling decoded image data, including image decoding and encoding.
- * @remarks The minimum dimension is 16x16 for JPEG encoding and 8x8 for PNG encoding.
*
* The following example demonstrates how to use the %ImageBuffer class to decode and encode image.
*
* @since 2.0
*
* @return An error code
- * @param[in] width The width of image
- * @param[in] height The height of image
- * @param[in] pixelFormat The pixel format of image should be one of values returned from GetSupportedPixelFormatListN()
- * @param[in] data The raw pixel data of image @n If @c data is not @c null then it will be copied into internal buffer of this instance.
- * If @c null then default color data will be filled.
- * @param[in] length The size of data
+ * @param[in] width The width of the image
+ * @param[in] height The height of the image
+ * @param[in] pixelFormat The pixel format of the image should be one of the values returned by GetSupportedPixelFormatListN()
+ * @param[in] pData The raw pixel data of the image @n If @c pData is not @c null, then it is copied into the internal buffer of this instance.
+ * If @c null, then the default color data is filled.
+ * @param[in] length The size of the data
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The specified @c pixelFormat is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @see GetSupportedPixelFormatListN()
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
*/
result Construct(int width, int height, MediaPixelFormat pixelFormat, const byte* pData = null, int length = 0);
*
* @return An error code
* @param[in] srcImagePath The source image path
- * @param[in] pDecodingRegion The region that will be decoded @n If this is @c null, then the whole image will be decoded.
- * @param[in] autoRotate If @c true then the image will be rotated automatically based on EXIF orientation tag
- * If @c false then the image will be decoded without rotation.
+ * @param[in] pDecodingRegion The region that is decoded @n If this is @c null, then the whole image is decoded.
+ * @param[in] autoRotate If @c true the image is rotated automatically based on the EXIF orientation tag before decoding @n
+ * If @c false the image is decoded without rotation.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OVERFLOW The specified input instance exceeds the supported maximum file size or dimension.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
result Construct(const Tizen::Base::String &srcImagePath, const Tizen::Graphics::Rectangle *pDecodingRegion = null, bool autoRotate = true);
* @since 2.0
*
* @return An error code
- * @param[in] srcImageBuf The buffer that contains compressed image data
- * @param[in] pDecodingRegion The region that will be decoded @n If this is @c null, then the whole image will be decoded.
- * @param[in] autoRotate If @c true then the image will be rotated automatically based on EXIF orientation tag
- * If @c false then the image will be decoded without rotation.
+ * @param[in] srcImageBuf The buffer that contains the compressed image data
+ * @param[in] pDecodingRegion The region that is decoded @n If this is @c null, then the whole image is decoded.
+ * @param[in] autoRotate If @c true the image is rotated automatically based on the EXIF orientation tag before decoding @n
+ * If @c false the image is decoded without rotation.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OVERFLOW The specified input instance exceeds the supported maximum file size or dimension.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
result Construct(const Tizen::Base::ByteBuffer &srcImageBuf, const Tizen::Graphics::Rectangle *pDecodingRegion = null, bool autoRotate = true);
result Construct(const Tizen::Graphics::Bitmap &srcBitmap);
/**
- * Initializes this instance of %ImageBuffer with the decoded data of the given image path with the specified parameters.
+ * Initializes this instance of %ImageBuffer that is decoded with the data of the given image path with the specified parameters.
*
* @since 2.1
*
* @return An error code
* @param[in] srcImagePath The source image path
- * @param[in] destWidth The intended width of the image.
- * @param[in] destHeight The intended height of the image.
- * @param[in] scalingMethod The scaling method.
+ * @param[in] destWidth The intended width of the image
+ * @param[in] destHeight The intended height of the image
+ * @param[in] scalingMethod The scaling method
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @remarks There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n
- * For more information on how to handle the out-of-memory exception, refer to
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.html>Exception Check</a>
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @remarks This method does not retain the aspect ratio of the original image.
*/
result Construct(const Tizen::Base::String &srcImagePath, int destWidth, int destHeight, ImageScalingMethod scalingMethod);
/**
- * Initializes this instance of %ImageBuffer with the decoded data of the given image buffer with the specified parameters.
+ * Initializes this instance of %ImageBuffer that is decoded with the data of the given image buffer with the specified parameters.
*
* @since 2.1
*
* @return An error code
- * @param[in] srcImageBuf The buffer that contains compressed image data
- * @param[in] destWidth The intended width of the image.
- * @param[in] destHeight The intended height of the image.
- * @param[in] scalingMethod The scaling method.
+ * @param[in] srcImageBuf The buffer that contains the compressed image data
+ * @param[in] destWidth The intended width of the image
+ * @param[in] destHeight The intended height of the image
+ * @param[in] scalingMethod The scaling method
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks There is a high probability for an occurrence of an out-of-memory exception.
* If possible, check whether the exception is E_OUT_OF_MEMORY or not. @n
- * For more information on how to handle the out-of-memory exception, refer to
- * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.html>Exception Check</a>
+ * For more information on how to handle the out-of-memory exception, refer
+ * <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
* @remarks This method does not retain the aspect ratio of the original image.
*/
result Construct(const Tizen::Base::ByteBuffer &srcImageBuf, int destWidth, int destHeight, ImageScalingMethod scalingMethod);
/**
- * Gets the current exif orientation of image data. @n
- * If automatic rotation is enabled during Construct() then the orientation will be reset to default value.
+ * Gets the current exif orientation of the image data. @n
+ * If automatic rotation is enabled during Construct() then the orientation is reset to the default value.
*
* @since 2.1
*
- * @return Orientation information of the current image data.
+ * @return The orientation information of the current image data
*/
ExifOrientation GetExifOrientation(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] destImagePath The intended name of encoded image file
+ * @param[in] destImagePath The intended name of the encoded image file
* @param[in] destImageFormat The intended image format
* @param[in] overwrite Set to @c true to overwrite the file, @n
* else @c false
*
* @since 2.0
*
- * @return A pointer to the %ImageBuffer instance containing the converted %ImageBuffer by specified MediaPixelFormat
+ * @return A pointer to the %ImageBuffer instance containing the converted %ImageBuffer by the specified MediaPixelFormat
* @param[in] pixelFormat The pixel format for returned %ImageBuffer
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_INVALID_DATA The current data is invalid for this operation. @n
* This will happen when the width or height is not even value,
- * and the requested pixel format is sub-sampled pixel format like MEDIA_PIXEL_FORMAT_YUV420P.
+ * and the requested pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
ImageBuffer* ConvertPixelFormatN(MediaPixelFormat pixelFormat) const;
* This will happen when the current pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P
* and the requested @c width or @c height is not even value.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
ImageBuffer* ResizeN(int width, int height) const;
/**
- * Gets a horizontally or vertically flipped image from current instance.
+ * Gets a horizontally or vertically flipped image from the current instance.
*
* @since 2.0
*
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
ImageBuffer* FlipN(ImageFlipType flipType) const;
/**
- * Gets a rotated image in clockwise direction from current image.
+ * Gets a rotated image in clockwise direction from the current image.
*
* @since 2.0
*
* and the height is odd value and the requested rotation type is @c IMAGE_ROTATION_90 or @c IMAGE_ROTATION_270.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- * Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
ImageBuffer* RotateN(ImageRotationType rotateType) const;
/**
- * Crops the region of the current %ImageBuffer.
+ * Crops the region of the current %ImageBuffer instance.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE A specified input parameter is out of range.
* @exception E_INVALID_DATA The current data is invalid for this operation. @n
- * This will happen when the current pixel format is sub-sampled pixel format like MEDIA_PIXEL_FORMAT_YUV420P
- * and the requested x, y, width, or height is not even value.
+ * This will happen when the current pixel format is sub-sampled pixel format like @c MEDIA_PIXEL_FORMAT_YUV420P
+ * and the requested @c x, @c y, @c width, or @c height is not even value.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks It’s a high probability that the out-of-memory exception occurs. Check the exception as possible if it is E_OUT_OF_MEMORY.
- Refer to <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">Exception Check</a> and handle the out-of-memory.
+ * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not.
+ * For more information on how to handle the out-of-memory exception, refer <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
*/
ImageBuffer* CropN(int x, int y, int width, int height) const;
*
* @return An error code
* @param[in] srcImagePath The source image path
- * @param[out] imageFormat The format of image
- * @param[out] width The width of image
- * @param[out] height The height of image
+ * @param[out] imageFormat The format of the image
+ * @param[out] width The width of the image
+ * @param[out] height The height of the image
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @since 2.0
*
* @return An error code
- * @param[in] srcImageBuf The buffer that contains compressed image data
- * @param[out] imageFormat The format of image
- * @param[out] width The width of image
- * @param[out] height The height of image
+ * @param[in] srcImageBuf The buffer that contains the compressed image data
+ * @param[out] imageFormat The format of the image
+ * @param[out] width The width of the image
+ * @param[out] height The height of the image
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
projects / platform / framework / native / image.git / commitdiff