inc/FGrpIVideoTextureUpdateListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0/
  10 //
  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.
  16 //
  17
  18 /**
  19  * @file        FGrpIVideoTextureUpdateListener.h
  20  * @brief       This is the header file for the %IVideoTextureUpdateListener interface.
  21  *
  22  * This header file contains the declarations of the %IVideoTextureUpdateListener interface.
  23  *
  24  */
  25
  26 #ifndef _FGRP_IVIDEO_TEXTURE_UPDATE_LISTENER_H_
  27 #define _FGRP_IVIDEO_TEXTURE_UPDATE_LISTENER_H_
  28
  29 namespace Tizen { namespace Graphics { namespace Opengl
  30 {
  31
  32 class VideoTexture;
  33
  34 /**
  35  * @interface   IVideoTextureUpdateListener
  36  * @brief       This interface is used to register a listener for the %VideoTexture class.
  37  *
  38  * @since 2.0
  39  *
  40  * The %IVideoTextureUpdateListener interface is used to register a listener for the VideoTexture class.
  41  */
  42 class _OSP_EXPORT_ IVideoTextureUpdateListener
  43 {
  44 public:
  45         /**
  46          * This polymorphic destructor should be overridden if required.
  47          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  48          *
  49          * @since 2.0
  50          */
  51         virtual ~IVideoTextureUpdateListener(void) {}
  52
  53         /**
  54          * Called when a video frame on the texture is ready.
  55          *
  56          * @since 2.0
  57          *
  58          * @param[in]   pVideoTexture   The VideoTexture class
  59          */
  60         virtual void OnTextureUpdated(VideoTexture* pVideoTexture) = 0;
  61
  62 protected:
  63         //
  64         // This method is for internal use only. Using this method can cause behavioral, security-related,
  65         // and consistency-related issues in the application.
  66         //
  67         // This method is reserved and may change its name at any time without
  68         // prior notice.
  69         //
  70         // @since 2.0
  71         //
  72         virtual void IVideoTextureUpdateListener_Reserved1(void) {}
  73         //
  74         // This method is for internal use only. Using this method can cause behavioral, security-related,
  75         // and consistency-related issues in the application.
  76         //
  77         // This method is reserved and may change its name at any time without
  78         // prior notice.
  79         //
  80         // @since 2.0
  81         //
  82         virtual void IVideoTextureUpdateListener_Reserved2(void) {}
  83         //
  84         // This method is for internal use only. Using this method can cause behavioral, security-related,
  85         // and consistency-related issues in the application.
  86         //
  87         // This method is reserved and may change its name at any time without
  88         // prior notice.
  89         //
  90         // @since 2.0
  91         //
  92         virtual void IVideoTextureUpdateListener_Reserved3(void) {}
  93 }; // IVideoTextureUpdateListener
  94
  95 }}} // Tizen::Graphics
  96
  97 #endif //_FGRP_IVIDEO_TEXTURE_UPDATE_LISTENER_H_