ReleasePolicy releasePol = IMAGE_RELEASE_POLICY_DEFAULT );
/**
- * Create a new BufferImage, which uses external data source.
+ * @deprecated Support for externally owned Pixel Buffers is due to be removed TBA. It is recommended that a BufferImage owned Buffer be used instead.
+ *
+ * @brief Create a new BufferImage, which uses external data source.
+ *
* Pixel buffer has to be allocated by application.
* An internal copy is made of the Pixel Buffer, which can then be freed by the Application, unless if there will be a call to Update() later.
* The buffer should only be freed when there is no chance of an Update() being called again.
* For better performance and portability use power of two dimensions.
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
*
- * @deprecated Support for externally owned Pixel Buffers is due to be removed TBA.
- * It is recommended that a BufferImage owned Buffer be used instead.
-
* @param [in] pixBuf pixel buffer. has to be allocated by application.
* @param [in] width image width in pixels
* @param [in] height image height in pixels
Pixel::Format pixelformat=Pixel::RGBA8888);
/**
- * @brief Create a new BufferImage.
- *
* @deprecated DALi 1.1.3, use New( unsigned int width, unsigned int height ) instead.
*
+ * @brief Create a new BufferImage.
+ *
* Also a pixel buffer for image data is allocated.
* Dali has ownership of the buffer.
* For better performance and portability use power of two dimensions.
unsigned int stride=0);
/**
- * @brief Create a new BufferImage, which uses an external data source.
- *
* @deprecated DALi 1.1.3, use New( PixelBuffer* pixelBuffer, unsigned int width, unsigned int height ) instead.
*
+ * @brief Create a new BufferImage, which uses an external data source.
+ *
* The PixelBuffer has to be allocated by application.
*
* The application holds ownership of the buffer. It must not
EncodedBufferImage();
/**
- * @brief Create an initialised image object from an encoded image buffer in memory.
- *
* @deprecated DALi 1.1.3 use New(const uint8_t* const, std::size_t,ImageDimensions,FittingMode::Type,SamplingMode::Type,bool) instead.
*
+ * @brief Create an initialised image object from an encoded image buffer in memory.
+ *
* @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.
/**
* @brief Create an initialised image object from an encoded image buffer in memory.
*
+ * @since DALi 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.
* 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.
- *
- * @since DALi 1.1.4
*/
static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true );
RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
/**
- * @brief Create a new FrameBufferImage.
- *
* @deprecated DALi 1.1.3 use New() instead.
*
+ * @brief Create a new FrameBufferImage.
+ *
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @param [in] width The width in pixels. Setting to zero will use the width of the stage.
* @param [in] height The height in pixels. Setting to zero will use the height of the stage.
static FrameBufferImage New(NativeImageInterface& image);
/**
- * @brief Create a new FrameBufferImage.
- *
* @deprecated DALi 1.1.3 use New( NativeImageInterface& ) instead.
*
+ * @brief Create a new FrameBufferImage.
+ *
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @param [in] image The native image.
* @param [in] releasePolicy The ReleasePolicy to apply to the FrameBufferImage.
public:
/**
+ * @deprecated DALi 1.1.3 Image resource is released as soon as last handle is released
* @brief ReleasePolicy controls the way images are deleted from memory.
- * @deprecated DALi 1.1.3 Image resource is relased as soon as last handle is released
*/
enum ReleasePolicy
{
static Image DownCast( BaseHandle handle );
/**
- * @brief Return resource release policy.
* @deprecated DALi 1.1.3
*
+ * @brief Return resource release policy.
+ *
* @return resource release policy
*/
ReleasePolicy GetReleasePolicy() const;
/**
* @deprecated DALi 1.1.4 use GetStretchPixelsX and GetStretchPixelsY instead
- * Get the stretch borders
+ *
+ * @brief Get the stretch borders
+ *
* @return The border in pixels from the left, top, right, and bottom of the image respectively.
*/
Vector4 GetStretchBorders();
/**
* @brief Retrieves the horizontal stretch pixel ranges in the cropped image space
*
- * @return the horizontal stretch pixel ranges in the cropped image space
- *
* @since DALi 1.1.4
+ *
+ * @return the horizontal stretch pixel ranges in the cropped image space
*/
const StretchRanges& GetStretchPixelsX();
/**
* @brief Retrieves the vertical stretch pixel ranges in the cropped image space
*
- * @return the vertical stretch pixel ranges in the cropped image space
- *
* @since DALi 1.1.4
+ *
+ * @return the vertical stretch pixel ranges in the cropped image space
*/
const StretchRanges& GetStretchPixelsY();
/**
* @brief Helper method to determine if the filename indicates that the image has a 9 patch or n patch border.
*
+ * @since DALi 1.1.4
+ *
* @param [in] url The URL of the image file.
* @return true if it is a 9 patch or n patch image
- *
- * @since DALi 1.1.4
*/
static bool IsNinePatchUrl( const std::string& url );
public:
/**
- * @brief LoadPolicy controls the way images are loaded into memory.
* @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
+ *
+ * @brief LoadPolicy controls the way images are loaded into memory.
*/
enum LoadPolicy
{
static ResourceImage New( const std::string& url, bool orientationCorrection = true );
/**
- * @brief Create an initialised ResourceImage object.
- *
* @deprecated DALi 1.1.3 use New( const std::string& url ) instead.
*
+ * @brief Create an initialised ResourceImage object.
+ *
* @param [in] url The URL of the image file to use.
* @param [in] loadPol The LoadPolicy to apply when loading the image resource.
* @param [in] releasePol The ReleasePolicy to apply to Image.
bool orientationCorrection = true );
/**
- * @brief Create an initialised ResourceImage object.
- *
* @deprecated DALi 1.1.3 use New( const std::string& url, ImageDimensions size ) instead.
*
+ * @brief Create an initialised ResourceImage object.
+ *
* @param [in] url The URL of the image file to use.
* @param [in] loadPol The LoadPolicy to apply when loading the image resource.
* @param [in] releasePol The ReleasePolicy to apply to Image.
static ResourceImage DownCast( BaseHandle handle );
/**
- * @brief Return load policy.
* @deprecated DALi 1.1.3
*
+ * @brief Return load policy.
+ *
* @return resource load policy
*/
LoadPolicy GetLoadPolicy() const;
}
/**
- * @brief Shader effects provide a visual effect for image actors.
- *
* @deprecated DALi 1.0.47
*
+ * @brief Shader effects provide a visual effect for image actors.
+ *
* For a Custom shader you can provide the vertex and fragment shader code as strings.
* These shader snippets get concatenated with the default attributes and uniforms.
* For a vertex shader this part contains the following code:
projects / platform / core / uifw / dali-core.git / commitdiff