os/graphics/graphicscomposition/openwfcompositionengine/adaptation/include/owfnotifications.h
1 /* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
3 * Permission is hereby granted, free of charge, to any person obtaining a
4 * copy of this software and/or associated documentation files (the
5 * "Materials"), to deal in the Materials without restriction, including
6 * without limitation the rights to use, copy, modify, merge, publish,
7 * distribute, sublicense, and/or sell copies of the Materials, and to
8 * permit persons to whom the Materials are furnished to do so, subject to
9 * the following conditions:
11 * The above copyright notice and this permission notice shall be included
12 * in all copies or substantial portions of the Materials.
14 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
23 * Symbian notifications
32 * \brief Initialises the Symbian specific device data, including
35 * \param source the source to be initialised
36 * \return OWF_TRUE id successfull
38 OWF_API_CALL OWFboolean
39 owfSymDeviceInitialise(WFC_IMAGE_PROVIDER* source);
42 * \brief Destroys the Symbian specific device data, including
45 * \param device the device to be destroyed
46 * \param source the source to be initialised
47 * \param position in the device list
50 owfSymDeviceDestroy(WFC_DEVICE* device, WFC_IMAGE_PROVIDER* source, WFCint position);
53 * \brief Notifies the stream associated with element that the read buffer has been aquired
55 * Used to solve the initial availabilty request
57 * \param context The context corresponding to the ongoing composition
58 * \param element The element that composition has just started for
60 * \return OWF_TRUE id successfull
62 OWF_API_CALL OWFboolean
63 owfSymElementNotifications(WFC_CONTEXT* context, WFC_ELEMENT* element);
66 * \brief Resets the visibility state associated with each source
68 * Used after each commit
70 * \param context The context
73 owfSymDeviceResetVisibilityState(WFC_CONTEXT* context);
76 * \brief Processes all notifications for a context immediately after the context has been composed
78 * \param context The context coresponding to the caller composer
81 owfSymProcessAllNotifications(WFC_CONTEXT* context);