X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fimages%2Fencoded-buffer-image.h;h=49893c5adf0b788df632da49d8884a50b8c4b985;hb=646f736e77b085c86e982c0d1d4b895c2a431330;hp=3044870ebe0014137d15745b76d484d100ad3e66;hpb=ec504b1da39973d10fc6374d8ce7384e7b9fa0ef;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/images/encoded-buffer-image.h b/dali/public-api/images/encoded-buffer-image.h index 3044870..49893c5 100644 --- a/dali/public-api/images/encoded-buffer-image.h +++ b/dali/public-api/images/encoded-buffer-image.h @@ -2,7 +2,7 @@ #define __DALI_ENCODED_BUFFER_IMAGE_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,16 +18,17 @@ * */ -// EXTERNAL INCLUDES -#include - // INTERNAL INCLUDES #include -#include +#include #include namespace Dali { +/** + * @addtogroup dali_core_images + * @{ + */ namespace Internal DALI_INTERNAL { @@ -38,8 +39,9 @@ typedef Uint16Pair ImageDimensions; /** - * @brief EncodedBufferImage represents an image resource that can be added to - * ImageActors. + * @DEPRECATED_1_2.41 + * + * @brief EncodedBufferImage represents an image resource as a buffer of encoded pixel data. * * A memory buffer of encoded image data is provided by the application and * decoded asynchronously on a background thread to fill the image's @@ -61,95 +63,114 @@ typedef Uint16Pair ImageDimensions; * * Image::UploadedSignal is emitted when the decoded image data gets * uploaded to the OpenGL ES implementation. + * @SINCE_1_0.0 */ -class DALI_IMPORT_API EncodedBufferImage : public Image +class DALI_CORE_API EncodedBufferImage : public Image { public: + /** + * @DEPRECATED_1_2.41 + * * @brief Constructor which creates an uninitialized EncodedBufferImage object. * - * Use Image::New(...) to create an initialised object. + * Use @ref EncodedBufferImage::New to create an initialised object. + * @SINCE_1_0.0 */ - EncodedBufferImage(); + EncodedBufferImage() DALI_DEPRECATED_API; /** - * @brief Create an initialised image object from an encoded image buffer in memory. + * @DEPRECATED_1_2.41 + * + * @brief Creates an initialized image object from an encoded image buffer in memory. * - * The image will be created eagerly using LoadPolicy::Immediate. - * The function is non-blocking and returns immediately while the image - * decoding happens on a background thread. - * @param [in] encodedImage The encoded bytes of an image, in a supported + * @SINCE_1_0.0 + * @param[in] encodedImage The encoded bytes of an image, in a supported * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised * exactly as it would be as a file in the filesystem. * The caller retains ownership of this buffer and is free to modify or - * discard it as soon as the function returns. - * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to + * discard it as soon as the function returns + * @param[in] encodedImageByteCount The size in bytes of the buffer pointed to * by encodedImage. - * @param [in] size The width and height to fit the loaded image to. - * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter. - * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size. - * @param [in] releasePol The ReleasePolicy to apply to Image. If the Unused - * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header. - * policy is set, a reload will not be possible, so the Image should never be - * used once all actors using it have gone off-stage. - * @return A handle to a newly allocated object. + * @return A handle to a newly allocated object */ - static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, ReleasePolicy releasePol = Image::NEVER, bool orientationCorrection = true ); + static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount ) DALI_DEPRECATED_API; /** - * @brief Create an initialised image object from an encoded image buffer in memory. + * @DEPRECATED_1_2.41 + * + * @brief Creates an initialized image object from an encoded image buffer in memory. * - * The image will be created eagerly using LoadPolicy::Immediate. - * The function is non-blocking and returns immediately while the image - * decoding happens on a background thread. - * @param [in] encodedImage The encoded bytes of an image, in a supported + * @SINCE_1_1.4 + * @param[in] encodedImage The encoded bytes of an image, in a supported * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised * exactly as it would be as a file in the filesystem. * The caller retains ownership of this buffer and is free to modify or - * discard it as soon as the function returns. - * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to - * by encodedImage. - * @return A handle to a newly allocated object. + * discard it as soon as the function returns + * @param[in] encodedImageByteCount The size in bytes of the buffer pointed to + * by encodedImage + * @param[in] size The width and height to fit the loaded image to + * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter + * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size + * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header + * policy is set, a reload will not be possible, so the Image should never be + * used once all actors using it have gone off-stage + * @return A handle to a newly allocated object */ - static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount ); + static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true ) DALI_DEPRECATED_API; /** - * @brief Downcast an Object handle to EncodedBufferImage. + * @DEPRECATED_1_2.41 * - * If handle points to a EncodedBufferImage the - * downcast produces valid handle. If not the returned handle is left uninitialized. - * @param[in] handle to An object - * @return handle to a EncodedBufferImage or an uninitialized handle + * @brief Downcasts a handle to EncodedBufferImage handle. + * + * If handle points to a EncodedBufferImage, the + * downcast produces valid handle. If not, the returned handle is left uninitialized. + * @SINCE_1_0.0 + * @param[in] handle Handle to an object + * @return Handle to a EncodedBufferImage or an uninitialized handle */ - static EncodedBufferImage DownCast( BaseHandle handle ); + static EncodedBufferImage DownCast( BaseHandle handle ) DALI_DEPRECATED_API; /** - * @brief Destructor + * @DEPRECATED_1_2.41 + * + * @brief Destructor. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ - ~EncodedBufferImage(); + ~EncodedBufferImage() DALI_DEPRECATED_API; /** + * @DEPRECATED_1_2.41 + * * @brief This copy constructor is required for (smart) pointer semantics. * - * @param [in] handle A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] handle A reference to the copied handle */ - EncodedBufferImage(const EncodedBufferImage& handle); + EncodedBufferImage(const EncodedBufferImage& handle) DALI_DEPRECATED_API; /** + * @DEPRECATED_1_2.41 + * * @brief This assignment operator is required for (smart) pointer semantics. * - * @param [in] rhs A reference to the copied handle + * @SINCE_1_0.0 + * @param[in] rhs A reference to the copied handle * @return A reference to this */ - EncodedBufferImage& operator=(const EncodedBufferImage& rhs); + EncodedBufferImage& operator=(const EncodedBufferImage& rhs) DALI_DEPRECATED_API; public: // Not intended for application developers explicit DALI_INTERNAL EncodedBufferImage(Internal::EncodedBufferImage*); }; +/** + * @} + */ } // namespace Dali #endif // __DALI_ENCODED_BUFFER_IMAGE_H__