#define __DALI_FRAME_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.
namespace RenderBuffer
{
/**
- * @brief Render Buffer formats
+ * @brief Enumeration for rendering buffer formats.
*
* The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
- * COLOR_DEPTH instead
+ * COLOR_DEPTH instead.
* @SINCE_1_0.0
*/
enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
}
/**
+ * @DEPRECATED_1_2.41
+ *
* @brief FrameBufferImage represents an Open GL ES Frame Buffer Object and contains the result
* of an 'off screen' render pass of a RenderTask.
*
* The FrameBufferImage can then be used for rendering to the screen.
* @SINCE_1_0.0
*/
-class DALI_IMPORT_API FrameBufferImage : public Image
+class DALI_CORE_API FrameBufferImage : public Image
{
public:
- /**
- * @brief Constructor which creates an uninitialized FrameBufferImage object.
- *
- * Use @ref FrameBufferImage::New to create an initialised object.
- * @SINCE_1_0.0
- */
- FrameBufferImage();
/**
- * @brief Create a new FrameBufferImage.
+ * @DEPRECATED_1_2.41
*
- * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
+ * @brief Constructor which creates an uninitialized FrameBufferImage object.
*
+ * Use @ref FrameBufferImage::New to create an initialized object.
* @SINCE_1_0.0
- * @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.
- * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
- * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
- * @return A handle to a new instance of a FrameBufferImage.
- * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
*/
- static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
- RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
+ FrameBufferImage() DALI_DEPRECATED_API;
/**
- * @DEPRECATED_1_1.3. Use New() instead.
+ * @DEPRECATED_1_2.41
*
- * @brief Create a new FrameBufferImage.
+ * @brief Creates a new FrameBufferImage.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
- * @SINCE_1_0.0
- * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
- * We do recommend not to use this method.
- * Please refer the Remarks of ReleasePolicy for more information.
- * @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.
- * @param [in] pixelFormat The pixel format.
- * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
- * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
- *
- * @return A handle to a new instance of a FrameBufferImage.
- * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
- */
- static FrameBufferImage New(unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy,
- RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
-
- /**
- * @brief Create a new FrameBufferImage.
*
- * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @SINCE_1_0.0
- * @param [in] image The native image.
- *
- * @return A handle to a new instance of a FrameBufferImage.
- * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
+ * @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
+ * @param[in] pixelFormat The pixel format (rgba 32 bit by default)
+ * @param[in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
+ * @return A handle to a new instance of a FrameBufferImage
+ * @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
*/
- static FrameBufferImage New(NativeImageInterface& image);
+ static FrameBufferImage New(uint32_t width = 0, uint32_t height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
+ RenderBuffer::Format bufferFormat = RenderBuffer::COLOR) DALI_DEPRECATED_API;
/**
- * @DEPRECATED_1_1.3. Use New( NativeImageInterface& ) instead.
+ * @DEPRECATED_1_2.41
*
- * @brief Create a new FrameBufferImage.
+ * @brief Creates a new FrameBufferImage.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @SINCE_1_0.0
- * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
- * We do recommend not to use this method.
- * Please refer the remarks of ReleasePolicy for more information.
- * @param [in] image The native image.
- * @param [in] releasePolicy The releasePolicy to apply to the FrameBufferImage.
+ * @param[in] image The native image
*
- * @return A handle to a new instance of a FrameBufferImage.
+ * @return A handle to a new instance of a FrameBufferImage
* @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
*/
- static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy);
+ static FrameBufferImage New(NativeImageInterface& image) DALI_DEPRECATED_API;
/**
- * @brief Downcast a handle to FrameBufferImage handle.
+ * @DEPRECATED_1_2.41
+ *
+ * @brief Downcasts a handle to FrameBufferImage handle.
*
- * If handle points to a FrameBufferImage object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a FrameBufferImage object, 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 FrameBufferImage object or an uninitialized handle
*/
- static FrameBufferImage DownCast( BaseHandle handle );
+ static FrameBufferImage 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
*/
- ~FrameBufferImage();
+ ~FrameBufferImage() DALI_DEPRECATED_API;
/**
+ * @DEPRECATED_1_2.41
+ *
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
- FrameBufferImage(const FrameBufferImage& handle);
+ FrameBufferImage(const FrameBufferImage& handle) DALI_DEPRECATED_API;
/**
+ * @DEPRECATED_1_2.41
+ *
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
- FrameBufferImage& operator=(const FrameBufferImage& rhs);
+ FrameBufferImage& operator=(const FrameBufferImage& rhs) DALI_DEPRECATED_API;
public: // Not intended for application developers
projects / platform / core / uifw / dali-core.git / blobdiff