/**
* Decodes an image file into the decoded bitmap container. @n
- * The currently supported decoding formats are JPEG, GIF, PNG, BMP, TIFF, and WBMP.
+ * 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>
* @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 can be returned if there is no available memory when 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 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.
+ * 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 an image.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @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.
+ * @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 an image data into the decoded bitmap container after resizing it as per a 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 A 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_OUT_OF_MEMORY The memory is insufficient.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - This method retains the aspect ratio of the original image.
- * - 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.
- * - 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.
+ * - 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 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 an image file into the decoded bitmap container after resizing it as per a 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 A 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_DATA The specified input instance has invalid data.
* @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.
- * - This method retains the aspect ratio of the original image.
- * - 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.
- * - 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.
+ * - 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 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.
+ * 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 an image.
*
* @since 2.0
*
* @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.
+ * @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.
+ * 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
*
* @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 the memory is not available when 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 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.
+ * 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 an image.
*
* @since 2.0
*
* @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.
+ * @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;
* @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 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.
*/
Tizen::Base::ByteBuffer* EncodeToBufferN(const Tizen::Graphics::Bitmap& srcBitmap, ImageFormat destImageFormat) const;
* @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 Tizen::Content::ContentManager::CreateContent() to register the created file into the Contents database.
+ * - 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.
*/
result EncodeToFile(const Tizen::Graphics::Bitmap& srcBitmap, ImageFormat destImageFormat, const Tizen::Base::String& destImagePath, bool overwrite) const;
* @exception E_INVALID_DATA A source image data in the buffer is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P. @n
- * The conversion is possible between: @n
+ * @remarks
+ * - The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P. @n
+ * The conversion is possible between: @n
* - @c MEDIA_PIXEL_FORMAT_YUV420P and @c MEDIA_PIXEL_FORMAT_RGB565LE. @n
* - @c MEDIA_PIXEL_FORMAT_YUV420P and @c MEDIA_PIXEL_FORMAT_BGRA8888. @n
- * The position and limit of @c destBuf are set along with the size of the converted data.
+ * - The position and limit of @c destBuf are set along with the size of the converted data.
*/
static result ConvertPixelFormat(const Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& destBuf, MediaPixelFormat srcPixelFormat, MediaPixelFormat destPixelFormat, const Tizen::Graphics::Dimension& dim);
* @exception E_INVALID_DATA A source image data in the buffer is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P. @n
- * The position and limit of @c destBuf are set along with the size of the resized data. @n
- * The minimum resolution is 16x16.
+ * @remarks
+ * - The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P.
+ * - The position and limit of @c destBuf are set along with the size of the resized data. @n
+ * The minimum resolution is 16x16.
*/
static result Resize(const Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& destBuf, const Tizen::Graphics::Dimension& srcDim, const Tizen::Graphics::Dimension& destDim, MediaPixelFormat pixelFormat);
* @exception E_INVALID_DATA A source image data in the buffer is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P. @n
- * The position and limit of @c destBuf are set along with the size of the rotated data. @n
- * The dimension of the destination buffer must be calculated by an application.
+ * @remarks
+ * - The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P.
+ * - The position and limit of @c destBuf are set along with the size of the rotated data. @n
+ * The dimension of the destination buffer must be calculated by an application.
* @see ImageRotationType
*/
static result Rotate(const Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& destBuf, const Tizen::Graphics::Dimension& dim, ImageRotationType rotate, MediaPixelFormat pixelFormat);
* @exception E_INVALID_DATA A source image data in the buffer is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P. @n
- * The position and limit of @c destBuf are set along with the size of the flipped data.
+ * @remarks
+ * - The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, @c MEDIA_PIXEL_FORMAT_BGRA8888, and @c MEDIA_PIXEL_FORMAT_YUV420P.
+ * - The position and limit of @c destBuf are set along with the size of the flipped data.
* @see ImageFlipType
*/
static result Flip(const Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& destBuf, const Tizen::Graphics::Dimension& dim, ImageFlipType flip, MediaPixelFormat pixelFormat);
projects / platform / framework / native / image.git / commitdiff