X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Fimages%2Fframe-buffer-image.h;h=a7c999cb100a4ed9e0a43cb254ec69c04efbf4bc;hb=refs%2Fchanges%2F90%2F87990%2F6;hp=dbb97886751449098220b50355c63a639ada5e89;hpb=07d00b695a47b884599de3a9aaf36eba21a3f827;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/images/frame-buffer-image.h b/dali/public-api/images/frame-buffer-image.h index dbb9788..a7c999c 100644 --- a/dali/public-api/images/frame-buffer-image.h +++ b/dali/public-api/images/frame-buffer-image.h @@ -39,22 +39,26 @@ namespace RenderBuffer { /** * @brief Render Buffer formats + * * The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use * COLOR_DEPTH instead + * @SINCE_1_0.0 */ -enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha +enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0 { - COLOR, ///< Framebuffer will be created with color buffer. - COLOR_DEPTH, ///< Framebuffer will be created with color and depth buffer - COLOR_STENCIL, ///< Framebuffer will be created with color and stencil buffer - COLOR_DEPTH_STENCIL ///< Framebuffer will be created with color, depth and stencil buffer. NOTE: May be not supported in all devices + COLOR, ///< Framebuffer will be created with color buffer. @SINCE_1_0.0 + COLOR_DEPTH, ///< Framebuffer will be created with color and depth buffer @SINCE_1_0.0 + COLOR_STENCIL, ///< Framebuffer will be created with color and stencil buffer @SINCE_1_0.0 + COLOR_DEPTH_STENCIL ///< Framebuffer will be created with color, depth and stencil buffer. @note May be not supported in all devices @SINCE_1_0.0 }; } /** - * @brief FrameBufferImage represents a Open GL ES Frame Buffer Object - * It contains the result of an 'off screen' render pass of a RenderTask. + * @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 { @@ -62,7 +66,8 @@ public: /** * @brief Constructor which creates an uninitialized FrameBufferImage object. * - * Use Image::New(...) to create an initialised object. + * Use @ref FrameBufferImage::New to create an initialised object. + * @SINCE_1_0.0 */ FrameBufferImage(); @@ -71,66 +76,37 @@ public: * * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE. * + * @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) - * @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. * @return A handle to a new instance of a FrameBufferImage. - */ - static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888, - RenderBuffer::Format bufferFormat = RenderBuffer::COLOR); - - /** - * @brief Create a new FrameBufferImage. - * - * @deprecated DALi 1.1.3 use New() instead. - * - * 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. - * @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) - * * @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. - * @return A handle to a new instance of a FrameBufferImage. */ - static FrameBufferImage New(unsigned int width, unsigned int height, Pixel::Format pixelFormat, ReleasePolicy releasePolicy, + static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888, 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. * - * @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. * @return A handle to a new instance of a FrameBufferImage. - */ - static FrameBufferImage New(NativeImageInterface& image); - - /** - * @brief Create a new FrameBufferImage. - * - * @deprecated DALi 1.1.3 use New( NativeImageInterface& ) instead. - * - * 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. - * * @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. - * @return A handle to a new instance of a FrameBufferImage. */ - static FrameBufferImage New(NativeImageInterface& image, ReleasePolicy releasePolicy); + static FrameBufferImage New(NativeImageInterface& image); /** - * @brief Downcast an Object handle to FrameBufferImage handle. + * @brief Downcast 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. - * @param[in] handle to An object - * @return handle to a FrameBufferImage object or an uninitialized handle + * @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 ); @@ -138,12 +114,14 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~FrameBufferImage(); /** * @brief This copy constructor is required for (smart) pointer semantics. * + * @SINCE_1_0.0 * @param [in] handle A reference to the copied handle */ FrameBufferImage(const FrameBufferImage& handle); @@ -151,6 +129,7 @@ public: /** * @brief This assignment operator is required for (smart) pointer semantics. * + * @SINCE_1_0.0 * @param [in] rhs A reference to the copied handle * @return A reference to this */