* @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.
+ * @remarks The minimum dimension for JPEG encoding is 16x16 and for PNG encoding is 8x8.
*
- * The %Image class is used for handling images, including image decoding, encoding, conversion, and JPEG compression. @n
+ * The %Image class is used for handling images, including image decoding, encoding, and conversion. @n
*
* 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.
result Construct(void);
/**
- * Decodes an image file into the decoded bitmap container. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
+ * Decodes the image file into the decoded bitmap container. @n
+ * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
+ * The %DecodeN() method retains the aspect ratio of the original image.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @return A decoded bitmap that is not resized
+ * @return The decoded bitmap that is not resized
* @param[in] srcImagePath The local file path of the image file to open
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_INVALID_DATA The specified input instance has invalid data.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @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 an auto-scaled bitmap, @n
- * so the dimension can be different from the dimension of source image if the returned bitmap is locked.
+ * @remarks
+ * - @c E_OUT_OF_MEMORY is returned if there is no available memory for decoding a large image.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the dimension of the source image, if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::String& srcImagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
/**
- * Decodes an image file into the decoded bitmap container after resizing it as per the specified width and height. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
+ * Decodes the image file into the decoded bitmap container after resizing it as per the specified width and height. @n
+ * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
+ * The %DecodeN() method retains the aspect ratio of the original image. @n
+ * It supports only the downscaling of the image.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @return A decoded bitmap data with the specified destination width and height
+ * @return The decoded bitmap data with the specified destination width and height
* @param[in] srcImagePath The local file path of the image file to open
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
* @param[in] destWidth The intended width of the image @n
* @param[in] destHeight The intended height of the image @n
* An exception is returned if the value is less than @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_INVALID_DATA The specified input instance has invalid data.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @exception E_OUT_OF_RANGE The specified size is out of range.
- * @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 an auto-scaled bitmap, @n
- * so the dimension can be different from the requested dimension if the returned bitmap is locked.
+ * @exception E_OUT_OF_RANGE The specified size is out of the valid range.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - 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;
/**
- * Decodes an image data into the decoded bitmap container after resizing it as per the specified width and height. @n
+ * Decodes the image data into the decoded bitmap container after resizing it as per the specified width and height. @n
* The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
* The %DecodeN() method retains the aspect ratio of the original image.
*
* @since 2.1
*
- * @return A decoded bitmap data with the specified destination width and height.
+ * @return The decoded bitmap data with the specified destination width and height
* @param[in] srcImageBuf The data to decode
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
- * @param[in] destWidth The intended width of the image.
- * @param[in] destHeight The intended height of the image.
+ * @param[in] destWidth The intended width of the image
+ * @param[in] destHeight The intended height of the image
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_DATA The specified input instance has invalid data.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method retains the aspect ratio of the original image.
- * @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 This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - 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>.
+ * - This method returns an auto-scaled bitmap to support the logical coordinate system, so the actual dimension of the returned bitmap can
+ * vary depending on the physical dimension of the target device.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::ByteBuffer& srcImageBuf, Tizen::Graphics::BitmapPixelFormat pixelFormat, float destWidth, float destHeight) const;
/**
- * Decodes an image file into the decoded bitmap container after resizing it as per the specified width and height. @n
+ * Decodes the image file into the decoded bitmap container after resizing it as per the specified width and height. @n
* The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
* The %DecodeN() method retains the aspect ratio of the original image.
*
* @since 2.1
*
- * @return A decoded bitmap data with the specified destination width and height.
+ * @return The decoded bitmap data with the specified destination width and height
* @param[in] srcImagePath The local file path of the image file to open
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
- * @param[in] destWidth The intended width of the image.
- * @param[in] destHeight The intended height of the image.
+ * @param[in] destWidth The intended width of the image
+ * @param[in] destHeight The intended height of the image
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_INVALID_DATA The specified input instance has invalid data.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This method retains the aspect ratio of the original image.
- * @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 This method returns auto scaled bitmap to support logical coordinate system, so the actual dimension of the returned bitmap can be vary depending on the physical dimension of target device.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - 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>.
+ * - This method returns an auto-scaled bitmap to support the logical coordinate system, so the actual dimension of the returned bitmap can
+ * vary depending on the physical dimension of the target device.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::String& srcImagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat, float destWidth, float destHeight) const;
/**
- * Decodes an image data into the decoded bitmap as per the specified width and height. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
+ * Decodes the image data into the decoded bitmap as per the specified width and height. @n
+ * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
+ * The %DecodeUrl() method retains the aspect ratio of the original image. @n
+ * It supports only the downscaling of the image.
*
* @since 2.0
*
* Set to @c TIMEOUT_INFINITE to make the @c timeout period infinite.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_DATA The specified input instance has invalid data.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
- * @exception E_OUT_OF_RANGE The specified size is out of range.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
+ * @exception E_OUT_OF_RANGE The specified size is out of the valid range.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_NETWORK_FAILED The network is unavailable.
- * @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 downloading is @c 3. @n
- * The supported protocol is HTTP.
+ * @exception E_MAX_EXCEEDED The number of concurrent accesses to the URLs have reached the maximum limit.
+ * @remarks
+ * - The maximum limit for downloading is @c 3.
+ * - 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;
/**
- * Decodes an image data into the decoded bitmap container without resizing. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. The %DecodeN() method retains the
- * aspect ratio of the original image.
+ * Decodes the image data into the decoded bitmap container without resizing. @n
+ * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
+ * The %DecodeN() method retains the aspect ratio of the original image.
*
* @since 2.0
*
- * @return A decoded bitmap data that has not been resized
+ * @return The decoded bitmap data that has not been resized
* @param[in] srcImageBuf The data to decode
* @param[in] srcImageFormat The image format of the input file
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_DATA The specified input instance has invalid data.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @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 an auto-scaled bitmap, @n
- * so the dimension can be different from the dimension of source image if the returned bitmap is locked.
+ * @remarks
+ * - @c E_OUT_OF_MEMORY is returned if there is no available memory for decoding a large image.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - This method returns an auto-scaled bitmap, @n
+ * so the dimension can be different from the dimension of the source image if the returned bitmap is locked.
*/
Tizen::Graphics::Bitmap* DecodeN(const Tizen::Base::ByteBuffer& srcImageBuf, ImageFormat srcImageFormat, Tizen::Graphics::BitmapPixelFormat pixelFormat) const;
/**
- * Decodes an image data into the decoded bitmap container after resizing it as per the specified width and height. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
+ * Decodes the image data into the decoded bitmap container after resizing it as per the specified width and height. @n
+ * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP. @n
+ * The %DecodeN() method retains the aspect ratio of the original image. @n
+ * It supports only the downscaling of the image.
*
* @since 2.0
*
- * @return A decoded bitmap data with the specified destination width and height
+ * @return The decoded bitmap data with the specified destination width and height
* @param[in] srcImageBuf The data to decode
* @param[in] srcImageFormat The image format of the input file
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
* @param[in] destHeight The intended height of the image @n
* An exception is returned if the value is less than @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified pixel format is not supported.
+ * @exception E_INVALID_ARG The specified @c pixelFormat is not supported.
* @exception E_INVALID_DATA The specified input instance has invalid data.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
- * @exception E_OUT_OF_RANGE The specified size is out of range.
- * @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 an auto-scaled bitmap, @n
- * so the dimension can be different from the requested dimension if the returned bitmap is locked.
+ * @exception E_OUT_OF_RANGE The specified size is out of the valid range.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - 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;
/**
- * Encodes the specified bitmap data into a byte buffer. @n
+ * Encodes the specified bitmap data into the byte buffer. @n
* The currently supported encoding formats are JPEG, BMP, and PNG.
*
* @since 2.0
*
- * @return A byte buffer containing encoded image data
+ * @return The byte buffer that contains the encoded image data
* @param[in] srcBitmap The bitmap data to encode
* @param[in] destImageFormat The intended image format
* @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.
* @exception E_OBJ_NOT_FOUND The specified bitmap data cannot be found.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * This method uses raw RGB data from locked bitmap, @n
- * so the dimension of encoded data can be different from the dimension of source bitmap if the bitmap is auto-scaled.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - This method uses the raw RGB data from the locked bitmap, @n
+ * so the dimension of the encoded data can be different from the dimension of the source bitmap if the bitmap is auto-scaled.
*/
Tizen::Base::ByteBuffer* EncodeToBufferN(const Tizen::Graphics::Bitmap& srcBitmap, ImageFormat destImageFormat) const;
* The currently supported encoding formats are JPEG, BMP, and PNG.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @return An error code
* @param[in] srcBitmap The bitmap data to encode
* @param[in] destImageFormat The intended image format
- * @param[in] destImagePath The intended name of encoded image file @n
- * The available paths start with prefixes retrieved from the functions such as: @n
- * Tizen::App::App::GetInstance()->GetAppRootPath() @n
- * Tizen::System::Environment::GetMediaPath() @n
- * Tizen::System::Environment::GetExternalStoragePath()
+ * @param[in] destImagePath The intended name of the encoded image file @n
+ * The available paths start with the prefixes retrieved from the functions such as: @n
+ * Tizen::App::App::GetInstance()->GetAppRootPath() @n
+ * Tizen::System::Environment::GetMediaPath() @n
+ * Tizen::System::Environment::GetExternalStoragePath().
* @param[in] overwrite Set to @c true to overwrite the file, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_FILE_ALREADY_EXIST The specified file already exists.
* @exception E_SYSTEM A system error has occurred.
* @exception E_STORAGE_FULL The storage is full.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * The application should use Tizen::Content::ContentManager::CreateContent() to register the created file into the Contents database. @n
- * This method uses raw RGB data from locked bitmap, @n
- * so the dimension of encoded data can be different from the dimension of source bitmap if the bitmap is auto-scaled.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The application should use the Tizen::Content::ContentManager::CreateContent() method to register the created file into the Contents database.
+ * - This method uses the raw RGB data from the locked bitmap, @n
+ * so the dimension of the encoded data can be different from the dimension of the source bitmap if the bitmap is auto-scaled.
*/
result EncodeToFile(const Tizen::Graphics::Bitmap& srcBitmap, ImageFormat destImageFormat, const Tizen::Base::String& destImagePath, bool overwrite) const;
/**
* Converts the image file to the specified image format. @n
- * This is a synchronous method. The converting formats currently supported are JPEG, BMP, and PNG.
+ * This is a synchronous method. The currently supported converting formats are JPEG, BMP, and PNG.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @return The byte buffer containing image data
+ * @return The byte buffer that contains the image data
* @param[in] srcImagePath The local file path of the image file to open
* @param[in] destImageFormat The intended image format
* @exception E_SUCCESS The method is successful.
Tizen::Base::ByteBuffer* ConvertN(const Tizen::Base::String& srcImagePath, ImageFormat destImageFormat) const;
/**
- * @if OSPDEPREC
- * @{
- * Compresses an encoded image file to reduce its size as per the specified limit. @n
+ * @cond OSPDEPREC
+ * Compresses the encoded image file to reduce its size as per the specified limit. @n
* The only supported compression format is JPEG.
*
* @if OSPCOMPAT
- * @brief <i> [Deprecated] [Compatibility] </i>
+ * @brief <i> [Deprecated] [Compatibility] </i>
* @deprecated This method is deprecated.
* @endif
* @since 2.0
* @return An error code
* @param[in] srcImagePath The local file path of the image file to open
* @param[in] destImagePath The destination file path @n
- * If the file already exists, it is overwritten. @n
- * The available paths start with prefix such as: @n
+ * If the file already exists, it is overwritten @n
+ * The available paths start with the prefixes retrieved from the functions such as: @n
* Tizen::App::App::GetInstance()->GetAppRootPath() @n
* Tizen::System::Environment::GetMediaPath() @n
- * Tizen::System::Environment::GetExternalStoragePath()
+ * Tizen::System::Environment::GetExternalStoragePath().
* @param[in] limitSize The maximum compressed data size in bytes @n
- * If the data size is too small, the width and height of the original
- * image can be reduced. @n The size must be less than the original size
- * and greater than @c 1024 byte.
+ * If the data size is too small, the width and the height of the original image can be reduced @n
+ * The size must be less than the original size and greater than @c 1024 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_STORAGE_FULL The file cannot be created because the file has reached its size limit.
- * @exception E_OUT_OF_RANGE The specified size is out of range.
- * @}
- * @endif
+ * @exception E_STORAGE_FULL The file cannot be created as it has reached the maximum size limit.
+ * @exception E_OUT_OF_RANGE The specified size is out of the valid range.
+ * @endcond
*/
result CompressJpeg(const Tizen::Base::String& srcImagePath, const Tizen::Base::String& destImagePath, int limitSize) const;
/**
* @if OSPDEPREC
- * Compresses an encoded image data to the byte buffer to reduce its data size as per the specified limit. @n
+ * Compresses the encoded image data into 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
*
- * @return A byte buffer containing the compressed image data as per the specified size
+ * @return The byte buffer that contains the compressed image data as per the specified size
* @param[in] srcImageBuf The encoded image source in the byte buffer
- * @param[in] limitSize The limit size to compress in bytes @n
+ * @param[in] limitSize The size limit within which to compress in bytes @n
* The size must be less than the original size and greater than @c 1024 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_OVERFLOW The specified input instance has overflowed.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_RANGE The specified size is out of range.
+ * @exception E_OUT_OF_RANGE The specified size is out of the valid range.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @endif
*/
Tizen::Base::ByteBuffer* CompressJpegN(const Tizen::Base::ByteBuffer& srcImageBuf, int limitSize) const;
/**
- * Decodes an image data into the decoded byte buffer container without resizing. @n
+ * Decodes the image data into the decoded byte buffer container without resizing. @n
* The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
*
* @since 2.0
*
- * @return A decoded byte data that is not resized, @n
+ * @return The decoded byte data that is not resized, @n
* else @c null if an exception occurs
* @param[in] srcImageBuf The data to decode
* @param[in] srcImageFormat The image format of the input data
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
- * @param[out] imageWidth The original width of the image @n
+ * @param[out] imageWidth The original width of the image @n
* An exception is returned if the value is less than @c 0.
- * @param[out] imageHeight The original height of the image @n
+ * @param[out] imageHeight The original height of the image @n
* An exception is returned if the value is less than @c 0.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified color format is not supported.
Tizen::Base::ByteBuffer* DecodeToBufferN(const Tizen::Base::ByteBuffer& srcImageBuf, ImageFormat srcImageFormat, Tizen::Graphics::BitmapPixelFormat pixelFormat, int& imageWidth, int& imageHeight) const;
/**
- * Decodes an image file into the decoded byte buffer container without resizing. @n
+ * Decodes the image file into the decoded byte buffer container without resizing. @n
* The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @return A decoded byte data that is not resized, @n
+ * @return The decoded byte data that is not resized, @n
* else @c null if an exception occurs
* @param[in] srcImagePath The local file path of the image file to decode
* @param[in] pixelFormat The output pixel format defined by Tizen::Graphics::BitmapPixelFormat
- * @param[out] imageWidth The original width of the image @n
+ * @param[out] imageWidth The original width of the image @n
* An exception is returned if the value is less than @c 0.
- * @param[out] imageHeight The original height of the image @n
+ * @param[out] imageHeight The original height of the image @n
* An exception is returned if the value is less than @c 0.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified color format is not supported.
* Gets the format of the image in the specified file.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
Tizen::Media::ImageFormat GetImageFormat(const Tizen::Base::String& srcImagePath) const;
/**
- * Gets the image format from an image buffer.
+ * Gets the image format from the image buffer.
*
* @since 2.0
*
* @return The format of the image
- * @param[in] srcImageBuf The Tizen::Base::ByteBuffer containing the image data
+ * @param[in] srcImageBuf The Tizen::Base::ByteBuffer that contains the image data
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
* Currently only 32-bit PNG images are supported.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
*
* @return @c true if the image has alpha channels, @n
* else @c false
- * @param[in] srcImageBuf The Tizen::Base::ByteBuffer containing the image data
+ * @param[in] srcImageBuf The Tizen::Base::ByteBuffer that contains the image data
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @exception E_OBJ_NOT_FOUND The specified image buffer cannot be found.
projects / platform / framework / native / image.git / blobdiff