DisplaySurface.h revision 7414965606f82ac2bcace5d3e2c8a4810517bf1e 
1/*
2 * Copyright 2013 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_SF_DISPLAY_SURFACE_H
18#define ANDROID_SF_DISPLAY_SURFACE_H
19
20#include <utils/Errors.h>
21#include <utils/RefBase.h>
22#include <utils/StrongPointer.h>
23
24// ---------------------------------------------------------------------------
25namespace android {
26// ---------------------------------------------------------------------------
27
28class IGraphicBufferProducer;
29class String8;
30
31class DisplaySurface : public virtual RefBase {
32public:
33    virtual sp<IGraphicBufferProducer> getIGraphicBufferProducer() const = 0;
34
35    // Should be called when composition rendering is complete for a frame (but
36    // eglSwapBuffers hasn't necessarily been called). Required by certain
37    // older drivers for synchronization.
38    // TODO: Remove this when we drop support for HWC 1.0.
39    virtual status_t compositionComplete() = 0;
40
41    // Inform the surface that GLES composition is complete for this frame, and
42    // the surface should make sure that HWComposer has the correct buffer for
43    // this frame. Some implementations may only push a new buffer to
44    // HWComposer if GLES composition took place, others need to push a new
45    // buffer on every frame.
46    //
47    // advanceFrame must be followed by a call to  onFrameCommitted before
48    // advanceFrame may be called again.
49    virtual status_t advanceFrame() = 0;
50
51    // onFrameCommitted is called after the frame has been committed to the
52    // hardware composer and a release fence is available for the buffer.
53    // Further operations on the buffer can be queued as long as they wait for
54    // the fence to signal.
55    virtual void onFrameCommitted(int fenceFd) = 0;
56
57    virtual void dump(String8& result) const = 0;
58
59protected:
60    DisplaySurface() {}
61    virtual ~DisplaySurface() {}
62};
63
64// ---------------------------------------------------------------------------
65} // namespace android
66// ---------------------------------------------------------------------------
67
68#endif // ANDROID_SF_DISPLAY_SURFACE_H
69
70