From 6062f470d3656d2f744ea0425f4b074672a80ec9 Mon Sep 17 00:00:00 2001 From: "hoonik.lee" Date: Thu, 28 Mar 2013 14:33:59 +0900 Subject: [PATCH] Modify public header files about GL and Video Texture Change-Id: Ic2add2c262cf265646956ab50227c202746532b7 Signed-off-by: hoonik.lee --- inc/FGrpGlPlayer.h | 18 +++++----- inc/FGrpIGlRenderer.h | 63 +++++++++++++++++++---------------- inc/FGrpIVideoTextureUpdateListener.h | 12 ++++--- inc/FGrpVideoTexture.h | 6 ++-- 4 files changed, 53 insertions(+), 46 deletions(-) diff --git a/inc/FGrpGlPlayer.h b/inc/FGrpGlPlayer.h index 2526b33..59d6456 100644 --- a/inc/FGrpGlPlayer.h +++ b/inc/FGrpGlPlayer.h @@ -114,7 +114,7 @@ public: result Construct(EglContextClientVersion version, Tizen::Ui::Control* pControl); /** - * Start the %GlPlayer, and initialzie EGL status. + * Starts the %GlPlayer, and initializes EGL status. * * @since 2.0 * @return An error code @@ -135,7 +135,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM Player cannot be paused properly due to a severe system error. - * @exception E_INVALID_OPERATION Fail to perform IGlRenderer::Pause function which is implemented by developers. + * @exception E_INVALID_OPERATION Fail to perform the IGlRenderer::Pause() method which is implemented by developers. * @exception E_INVALID_STATE The state of player is not suitable for pause. For example, it is not allowable to pause player when it does not start after the initialization yet. * */ @@ -148,7 +148,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM Player cannot be resumed properly due to a severe system error. - * @exception E_INVALID_OPERATION Fail to perform IGlRenderer::Resume function which is implemented by developers. + * @exception E_INVALID_OPERATION Fail to perform the IGlRenderer::Resume() method which is implemented by developers. * @exception E_INVALID_STATE The state of player is not suitable for resume. For example, it is not allowable to resume player when its state is stop. * */ @@ -161,9 +161,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM Player cannot be stopped properly due to a severe system error. - * @exception E_INVALID_OPERATION Fail to perform IGlRenderer::Pause function which is implemented by developers. + * @exception E_INVALID_OPERATION Fail to perform the IGlRenderer::Pause() method which is implemented by developers. * - * @remarks Before starting to reset the EGL status, this function calls IGlRenderer::Pause() to prevent unexpected behavior. + * @remarks Before starting to reset the EGL status, this method calls IGlRenderer::Pause() to prevent unexpected behavior. * */ result Stop(void); @@ -198,12 +198,12 @@ public: * * @since 2.0 * @return An error code - * @param[in] eglConfigList a list of EGL attributes and their values. + * @param[in] eglConfigList A list of EGL attributes and their values * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * * @remarks %GlPlayer initializes the EGL status with the given EGL attributes, which means that system does not guarantees to set EGL configurations with the given attributes but prefers them. - * @remarks The format of eglConfigList is the same with the attribute list as the second input parameter of eglChooseConfig function. To know about the detailed description, refer the reference page of eglChooseConfig: http://www.khronos.org/opengles/documentation/opengles1_0/html/eglChooseConfig.html + * @remarks The format of eglConfigList is the same with the attribute list as the second input parameter of eglChooseConfig function. For detailed description, refer here. * */ result SetEglAttributeList(const EGLint* pEglConfigList); @@ -244,12 +244,12 @@ public: * @return An error code * @param[in] renderer %IGlRenderer defines how to render the scene. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Fail to perform IGlRenderer::InitializeGl function which is implemented by developers. + * @exception E_INVALID_OPERATION Fail to perform the IGlRenderer::InitializeGl() method which is implemented by developers. * @see %IGlRenderer * * @remarks If %GlPlayer already has a renderer, then the previous renderer is replaced by the new one. * @remarks If input parameter is null, then the current renderer of %GlPlayer is detached and %GlPlayer does nothing. - * @remarks When the %IGlRenderer is replaced with the input, the GL status have to be initialized for the input %IGlRenderer. For such purpose, when the input %IGlRenderer is attached, the overrided IGlRenderer::InitializedGl() function is called. On the other hands, the previous %IGlRenderer of %GlPlayer is detached after calling the overrided %IGlRenderer::TerminateGL() function. + * @remarks When the %IGlRenderer is replaced with the input, the GL status have to be initialized for the input %IGlRenderer. For such purpose, when the input %IGlRenderer is attached, the overrided IGlRenderer::InitializedGl() method is called. On the other hand, the previous %IGlRenderer of %GlPlayer is detached after calling the overrided %IGlRenderer::TerminateGL() method. * */ result SetIGlRenderer(IGlRenderer* pRenderer); diff --git a/inc/FGrpIGlRenderer.h b/inc/FGrpIGlRenderer.h index 96d6353..ff50867 100644 --- a/inc/FGrpIGlRenderer.h +++ b/inc/FGrpIGlRenderer.h @@ -34,8 +34,10 @@ namespace Tizen { namespace Graphics { namespace Opengl /** * @class IGlRenderer * @brief This virtual class defines the interface for GlPlayer to draw 3D scene. + * * @since 2.0 * + * The %IGlRenderer virtual class defines the interface for GlPlayer to draw 3D scene. */ class _OSP_EXPORT_ IGlRenderer { @@ -52,90 +54,93 @@ public: * Initializes GL status and allocates necessary resources for the current Renderer such as shader, texture and so on. * * @since 2.0 - * @return Return true when this function successfully initialize the GL status and allocate resources, such as shader and textures. Otherwise, when this function meets some errors or exceptions, then return false. + * @return @c true if this method successfully initializes the GL status and allocate resources, such as shader and textures, @n + else @c false if this method meets some errors or exceptions * */ virtual bool InitializeGl(void) = 0; /** - * Terminate the Renderer to unload shader and release allocated resources. + * Terminates the Renderer to unload shader and release allocated resources. * * @since 2.0 - * @return Return true when this function successfully terminate the GL status and release all the resources, such as shader and textures. Otherwise, when this function meets some errors or exceptions, then return false. + * @return @c true if this method successfully terminates the GL status and releases all the resources, such as shader and textures, @n + else @c false if this method meets some errors or exceptions * */ virtual bool TerminateGl(void) = 0; /** - * This function is called when GlPlayer draws a scene. - * Users overload this function and calls necessary operations for drawing a scene in this system. + * Draws a scene. @n + * Users overload the %Draw() method and calls necessary operations for drawing a scene in this system. * * @since 2.0 - * @return Return true when this function successfully draws a scene with gl functions. Otherwise, when this function meets some errors or exceptions, then return false. + * @return @c true if this method successfully draws a scene with gl functions, @n + else @c false if this method meets some errors or exceptions * */ virtual bool Draw(void) = 0; /** - * This function is called when GlPlayer is paused. - * Users overload this function and calls necessary operations for the pause of the system, including release resources. + * Pauses the GlPlayer instance. @n + * Users overload the %Pause() method and calls necessary operations for the pause of the system, including release of resources. * * @since 2.0 - * @return Return true when this function successfully does intended operations for Pause state. Otherwise, when this function meets some errors or exceptions, then return false. + * @return @c true if this method successfully does intended operations for pause state, @n else @c false if this method meets some errors or exceptions * */ virtual bool Pause(void) = 0; - /** - * This function is called when GlPlayer is resumed. - * Users overload this function and calls necessary operations for the resume of the system, including allocation resources. - * - * @since 2.0 - * @return Return true when this function successfully does intended operations for Resume state. Otherwise, when this function meets some errors or exceptions, then return false. - * - */ + /** + * Resumes the GlPlayer instance. @n + * Users overload the %Resume method and calls necessary operations for the resume of the system, including allocation of resources. + * + * @since 2.0 + * @return @c true if this method successfully does intended operations for resume state, @n else @c false if this method meets some errors or exceptions + * + */ virtual bool Resume(void) = 0; /** - * Get the target control width. + * Gets the target control width. * * @since 2.0 * - * @return Return the width of Target control. - * @remarks The control width is determined when you register %IGlRenderer to %GlPlayer with GlPlayer::SetIGlRenderer() function. Therefore, developers have to declare a integer variable for control width to implement this function. + * @return The width of target control + * @remarks The control width is determined when you register %IGlRenderer to %GlPlayer with the GlPlayer::SetIGlRenderer() method. Therefore, developers have to declare an integer variable for control width to implement this method. * */ virtual int GetTargetControlWidth(void) = 0; /** - * Get the target control height. + * Gets the target control height. * * @since 2.0 * - * @return Return the height of Target control. - * @remarks The control height is determined when you register %IGlRenderer to %GlPlayer with GlPlayer::SetIGlRenderer() function. Therefore, developers have to declare a integer variable for control height to implement this function. + * @return The height of target control + * @remarks The control height is determined when you register %IGlRenderer to %GlPlayer with the GlPlayer::SetIGlRenderer() method. Therefore, developers have to declare an integer variable for control height to implement this method. * */ virtual int GetTargetControlHeight(void) = 0; /** - * Set the target control width. + * Sets the target control width. * * @since 2.0 * - * @param[in] width Width of Target control. - * @remarks The control width is determined when you register %IGlRenderer to %GlPlayer with GlPlayer::SetIGlRenderer() function. Therefore, this function is used in GlPlayer::SetIGlRenderer function, and developers have to declare a integer variable for control width to implement this function. + * @param[in] width The width of target control + * @remarks The control width is determined when you register %IGlRenderer to %GlPlayer with the GlPlayer::SetIGlRenderer() method. Therefore, developers have to declare an integer variable for control width to implement this method. * */ virtual void SetTargetControlWidth(int width) = 0; /** - * Get the target control height. + * Gets the target control height. * * @since 2.0 * - * @param[in] height Height of Target control. - * @remarks The control height is determined when you register %IGlRenderer to %GlPlayer with GlPlayer::SetIGlRenderer() function. Therefore, this function is used in GlPlayer::SetIGlRenderer function, and developers have to declare a integer variable for control height to implement this function. + * @param[in] height The height of target control + * @remarks The control height is determined when you register %IGlRenderer to %GlPlayer with the GlPlayer::SetIGlRenderer() method. Therefore, developers have to declare an integer variable for control height to implement this method. * */ virtual void SetTargetControlHeight(int height) = 0; diff --git a/inc/FGrpIVideoTextureUpdateListener.h b/inc/FGrpIVideoTextureUpdateListener.h index 85e4049..50815c3 100644 --- a/inc/FGrpIVideoTextureUpdateListener.h +++ b/inc/FGrpIVideoTextureUpdateListener.h @@ -17,9 +17,9 @@ /** * @file FGrpIVideoTextureUpdateListener.h - * @brief This is the header file for the %IVideoTextureUpdateListener class. + * @brief This is the header file for the %IVideoTextureUpdateListener interface. * - * This header file contains the declarations of the %IVideoTextureUpdateListener class. + * This header file contains the declarations of the %IVideoTextureUpdateListener interface. * */ @@ -32,10 +32,12 @@ namespace Tizen { namespace Graphics { namespace Opengl class VideoTexture; /** - * @class IVideoTextureUpdateListener - * @brief This virtual class defines the interface for VideoTexture to register a listener. + * @interface IVideoTextureUpdateListener + * @brief This interface is used to register a listener for the VideoTexture class. + * * @since 2.0 * + * The %IVideoTextureUpdateListener interface is used to register a listener for the VideoTexture class. */ class _OSP_EXPORT_ IVideoTextureUpdateListener { @@ -53,7 +55,7 @@ public: * * @since 2.0 * - * @param[in] pVideoTexture The VideoTexture class. + * @param[in] pVideoTexture The VideoTexture class */ virtual void OnTextureUpdated(VideoTexture* pVideoTexture) = 0; diff --git a/inc/FGrpVideoTexture.h b/inc/FGrpVideoTexture.h index ccdb704..6fa5876 100644 --- a/inc/FGrpVideoTexture.h +++ b/inc/FGrpVideoTexture.h @@ -70,14 +70,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] textureId Texture ID which points to the texture associated with the video frame. The testure ID must be generated from glGenTextures(). + * @param[in] textureId Texture ID which points to the texture associated with the video frame @n The texture ID must be generated from glGenTextures(). * @param[in] width The width of the input texture. The width must be greater than @c 32, and smaller or equal than GL_MAX_TEXTURE_SIZE. * @param[in] height The height of the input texture. The height must be greater than @c 32, and smaller or equal than GL_MAX_TEXTURE_SIZE * @exception E_SUCCESS Construction is successfully done. * @exception E_OUT_OF_RANGE The width or height is bigger than GL_MAX_TEXTURE_SIZE You can get max size of current device to call glGetIntegerv(GL_MAX_TEXTURE_SIZE, &maxSize). * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_UNSUPPORTED_OPERATION The target device does not support full features for %VideoTexture. - * @exception E_INVALID_STATE Getting egl information failed. It is necessary to bind egl context by using eglMakeCurrent funtion. + * @exception E_INVALID_STATE Getting egl information failed. It is necessary to bind egl context by using the eglMakeCurrent() method. * @remarks There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here. */ result Construct(int textureId, int width, int height); @@ -108,7 +108,7 @@ public: * * @since 2.0 * - * @param[in] listener The listener to be removed. + * @param[in] listener The listener to remove @see AddVideoTextureUpdateListener() */ void RemoveVideoTextureUpdateListener(IVideoTextureUpdateListener& listener); -- 2.7.4