IDisplayEventConnection.h revision 478ae5eb5a0047e1b2988c896cff6363b455ee50 
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_GUI_IDISPLAY_EVENT_CONNECTION_H
18#define ANDROID_GUI_IDISPLAY_EVENT_CONNECTION_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <utils/Errors.h>
24#include <utils/RefBase.h>
25
26#include <binder/IInterface.h>
27
28namespace android {
29// ----------------------------------------------------------------------------
30
31class BitTube;
32
33class IDisplayEventConnection : public IInterface
34{
35public:
36
37    DECLARE_META_INTERFACE(DisplayEventConnection);
38
39    /*
40     * getDataChannel() returns a BitTube where to receive the events from
41     */
42    virtual sp<BitTube> getDataChannel() const = 0;
43
44    /*
45     * setVsyncRate() sets the vsync event delivery rate. A value of
46     * 1 returns every vsync events. A value of 2 returns every other events,
47     * etc... a value of 0 returns no event unless  requestNextVsync() has
48     * been called.
49     */
50    virtual void setVsyncRate(uint32_t count) = 0;
51
52    /*
53     * requestNextVsync() schedules the next vsync event. It has no effect
54     * if the vsync rate is > 0.
55     */
56    virtual void requestNextVsync() = 0;    // asynchronous
57};
58
59// ----------------------------------------------------------------------------
60
61class BnDisplayEventConnection : public BnInterface<IDisplayEventConnection>
62{
63public:
64    virtual status_t    onTransact( uint32_t code,
65                                    const Parcel& data,
66                                    Parcel* reply,
67                                    uint32_t flags = 0);
68};
69
70// ----------------------------------------------------------------------------
71}; // namespace android
72
73#endif // ANDROID_GUI_IDISPLAY_EVENT_CONNECTION_H
74