os/graphics/graphicscomposition/openwfcompositionengine/adaptation/include/owfnotifications.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
 * 
sl@0
     3
 * Permission is hereby granted, free of charge, to any person obtaining a
sl@0
     4
 * copy of this software and/or associated documentation files (the
sl@0
     5
 * "Materials"), to deal in the Materials without restriction, including
sl@0
     6
 * without limitation the rights to use, copy, modify, merge, publish,
sl@0
     7
 * distribute, sublicense, and/or sell copies of the Materials, and to
sl@0
     8
 * permit persons to whom the Materials are furnished to do so, subject to
sl@0
     9
 * the following conditions:
sl@0
    10
 * 
sl@0
    11
 * The above copyright notice and this permission notice shall be included
sl@0
    12
 * in all copies or substantial portions of the Materials.
sl@0
    13
 * 
sl@0
    14
 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
sl@0
    15
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
sl@0
    16
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
sl@0
    17
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
sl@0
    18
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
sl@0
    19
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
sl@0
    20
 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
sl@0
    21
 * 
sl@0
    22
 * Description:
sl@0
    23
 * Symbian notifications
sl@0
    24
 */
sl@0
    25
sl@0
    26
sl@0
    27
#ifdef __cplusplus
sl@0
    28
extern "C" {
sl@0
    29
#endif
sl@0
    30
sl@0
    31
/*!
sl@0
    32
 *  \brief Initialises the Symbian specific device data, including
sl@0
    33
 *  the SUS observers
sl@0
    34
 *
sl@0
    35
 *  \param source the source to be initialised
sl@0
    36
 *  \return OWF_TRUE id successfull
sl@0
    37
 */
sl@0
    38
OWF_API_CALL OWFboolean
sl@0
    39
owfSymDeviceInitialise(WFC_IMAGE_PROVIDER* source);
sl@0
    40
sl@0
    41
/*!
sl@0
    42
 *  \brief Destroys the Symbian specific device data, including
sl@0
    43
 *  the SUS observers
sl@0
    44
 *
sl@0
    45
 *  \param device the device to be destroyed
sl@0
    46
 *  \param source the source to be initialised
sl@0
    47
 *  \param position in the device list
sl@0
    48
 */
sl@0
    49
OWF_API_CALL void
sl@0
    50
owfSymDeviceDestroy(WFC_DEVICE* device, WFC_IMAGE_PROVIDER* source, WFCint position);
sl@0
    51
sl@0
    52
/*!
sl@0
    53
 *  \brief Notifies the stream associated with element that the read buffer has been aquired
sl@0
    54
 *
sl@0
    55
 *  Used to solve the initial availabilty request
sl@0
    56
 *
sl@0
    57
 *  \param context The context corresponding to the ongoing composition
sl@0
    58
 *  \param element The element that composition has just started for
sl@0
    59
 *
sl@0
    60
 *  \return OWF_TRUE id successfull
sl@0
    61
 */
sl@0
    62
OWF_API_CALL OWFboolean
sl@0
    63
owfSymElementNotifications(WFC_CONTEXT* context, WFC_ELEMENT* element);
sl@0
    64
sl@0
    65
/*!
sl@0
    66
 *  \brief Resets the visibility state associated with each source
sl@0
    67
 *
sl@0
    68
 *  Used after each commit
sl@0
    69
 *
sl@0
    70
 *  \param context The context
sl@0
    71
 */
sl@0
    72
OWF_API_CALL void
sl@0
    73
owfSymDeviceResetVisibilityState(WFC_CONTEXT* context);
sl@0
    74
sl@0
    75
/*!
sl@0
    76
 *  \brief Processes all notifications for a context immediately after the context has been composed 
sl@0
    77
 *
sl@0
    78
 *  \param context The context coresponding to the caller composer
sl@0
    79
 */
sl@0
    80
OWF_API_CALL WFCint
sl@0
    81
owfSymProcessAllNotifications(WFC_CONTEXT* context);
sl@0
    82
sl@0
    83
#ifdef __cplusplus
sl@0
    84
}
sl@0
    85
#endif