2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Flora License, Version 1.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://floralicense.org/license/
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an AS IS BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FGrpVideoTexture.h
20 * @brief This is the header file for the %VideoTexture class.
22 * This header file contains the declarations of the %VideoTexture class.
26 #ifndef _FGRP_VIDEO_TEXTURE_H_
27 #define _FGRP_VIDEO_TEXTURE_H_
29 #include <FBaseObject.h>
31 namespace Tizen { namespace Graphics { namespace Opengl
34 class IVideoTextureUpdateListener;
38 * @brief This class provides a method to bind a video frame to OpenGL-ES Texture.
39 * With this feature, you can easily draw a video frame on OpenGL-ES Textures with consistency.
43 * @final This class is not intended for extension.
45 * The %VideoTexture class provides a texture by which you can draw a video frame on OpenGL-ES texture.
48 class _OSP_EXPORT_ VideoTexture
49 : public Tizen::Base::Object
53 * The object is not fully constructed after this constructor is called. For full construction, the Construct() method be called right after calling this constructor.
61 * This destructor overrides Tizen::Base::Object::~Object().
65 virtual ~VideoTexture(void);
68 * Initializes this instance of %VideoTexture with the specified parameters.
72 * @return An error code
73 * @param[in] textureId Texture ID which points to the texture associated with the video frame. The testure ID must be generated from glGenTextures().
74 * @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.
75 * @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
76 * @exception E_SUCCESS Construction is successfully done.
77 * @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).
78 * @exception E_INVALID_ARG A specified input parameter is invalid.
79 * @exception E_UNSUPPORTED_OPERATION The target device does not support full features for %VideoTexture.
80 * @exception E_INVALID_STATE Getting egl information failed. It is necessary to bind egl context by using eglMakeCurrent funtion.
81 * @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 <a href="../org.tizen.native.appprogramming/html/basics_tizen_programming/exception_check.htm">here</a>.
83 result Construct(int textureId, int width, int height);
86 * Binds the most recent frame to the texture.
90 * @return An error code
91 * @exception E_SUCCESS Binding is successfully done.
92 * @exception E_INVALID_STATE Any video frames are not ready in the texture. If IVideoTextureUpdateListener is already registered, please check whether the functions have been called.
94 result BindTexture(void);
97 * Adds a listener invoked when a video frame is ready.
101 * @param[in] listener The listener invoked.
102 * @see RemoveVideoTextureUpdateListener()
104 void AddVideoTextureUpdateListener(IVideoTextureUpdateListener& listener);
107 * Removes the specified listener.
111 * @param[in] listener The listener to be removed.
112 @see AddVideoTextureUpdateListener()
114 void RemoveVideoTextureUpdateListener(IVideoTextureUpdateListener& listener);
118 // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
120 // @param[in] rhs The source from which this instance is copied
122 VideoTexture(const VideoTexture& rhs);
125 // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
127 // @param[in] rhs An instance of %VideoTexture
129 VideoTexture& operator =(const VideoTexture& rhs);
132 friend class _VideoTextureImpl;
134 class _VideoTextureImpl* __pImpl;
137 }}} // Tizen::Graphics
139 #endif //_FGRP_VIDEO_TEXTURE_H_