DisplaySurface.h revision 38efe86d9459cf5c96a24a34cc5cbf31fdba7e19 
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    // prepareFrame is called after the composition configuration is known but
36    // before composition takes place. The DisplaySurface can use the
37    // composition type to decide how to manage the flow of buffers between
38    // GLES and HWC for this frame.
39    enum CompositionType {
40        COMPOSITION_UNKNOWN = 0,
41        COMPOSITION_GLES    = 1,
42        COMPOSITION_HWC     = 2,
43        COMPOSITION_MIXED   = COMPOSITION_GLES | COMPOSITION_HWC
44    };
45    virtual status_t prepareFrame(CompositionType compositionType) = 0;
46
47    // Should be called when composition rendering is complete for a frame (but
48    // eglSwapBuffers hasn't necessarily been called). Required by certain
49    // older drivers for synchronization.
50    // TODO: Remove this when we drop support for HWC 1.0.
51    virtual status_t compositionComplete() = 0;
52
53    // Inform the surface that GLES composition is complete for this frame, and
54    // the surface should make sure that HWComposer has the correct buffer for
55    // this frame. Some implementations may only push a new buffer to
56    // HWComposer if GLES composition took place, others need to push a new
57    // buffer on every frame.
58    //
59    // advanceFrame must be followed by a call to  onFrameCommitted before
60    // advanceFrame may be called again.
61    virtual status_t advanceFrame() = 0;
62
63    // onFrameCommitted is called after the frame has been committed to the
64    // hardware composer. The surface collects the release fence for this
65    // frame's buffer.
66    virtual void onFrameCommitted() = 0;
67
68    virtual void dump(String8& result) const = 0;
69
70protected:
71    DisplaySurface() {}
72    virtual ~DisplaySurface() {}
73};
74
75// ---------------------------------------------------------------------------
76} // namespace android
77// ---------------------------------------------------------------------------
78
79#endif // ANDROID_SF_DISPLAY_SURFACE_H
80
81