graphicscomposition/openwfcompositionengine/adaptation/include/owfnotifications.h
changeset 0 5d03bc08d59c
child 152 9f1c3fea0f87
equal deleted inserted replaced
-1:000000000000 0:5d03bc08d59c
       
     1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // Symbian notifications
       
    15 // 
       
    16 //
       
    17 
       
    18 #ifdef __cplusplus
       
    19 extern "C" {
       
    20 #endif
       
    21 
       
    22 /*!
       
    23  *  \brief Initialises the Symbian specific device data, including
       
    24  *  the SUS observers
       
    25  *
       
    26  *  \param source the source to be initialised
       
    27  *  \return OWF_TRUE id successfull
       
    28  */
       
    29 OWF_API_CALL OWFboolean
       
    30 owfSymDeviceInitialise(WFC_IMAGE_PROVIDER* source);
       
    31 
       
    32 /*!
       
    33  *  \brief Destroys the Symbian specific device data, including
       
    34  *  the SUS observers
       
    35  *
       
    36  *  \param device the device to be destroyed
       
    37  *  \param source the source to be initialised
       
    38  *  \param position in the device list
       
    39  */
       
    40 OWF_API_CALL void
       
    41 owfSymDeviceDestroy(WFC_DEVICE* device, WFC_IMAGE_PROVIDER* source, WFCint position);
       
    42 
       
    43 /*!
       
    44  *  \brief Notifies the stream associated with element that the read buffer has been aquired
       
    45  *
       
    46  *  Used to solve the initial availabilty request
       
    47  *
       
    48  *  \param context The context corresponding to the ongoing composition
       
    49  *  \param element The element that composition has just started for
       
    50  *
       
    51  *  \return OWF_TRUE id successfull
       
    52  */
       
    53 OWF_API_CALL OWFboolean
       
    54 owfSymElementNotifications(WFC_CONTEXT* context, WFC_ELEMENT* element);
       
    55 
       
    56 /*!
       
    57  *  \brief Resets the visibility state associated with each source
       
    58  *
       
    59  *  Used after each commit
       
    60  *
       
    61  *  \param context The context
       
    62  */
       
    63 OWF_API_CALL void
       
    64 owfSymDeviceResetVisibilityState(WFC_CONTEXT* context);
       
    65 
       
    66 /*!
       
    67  *  \brief Processes all notifications for a context immediately after the context has been composed 
       
    68  *
       
    69  *  \param context The context coresponding to the caller composer
       
    70  */
       
    71 OWF_API_CALL WFCint
       
    72 owfSymProcessAllNotifications(WFC_CONTEXT* context);
       
    73 
       
    74 #ifdef __cplusplus
       
    75 }
       
    76 #endif