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
18#ifndef SF_RENDERENGINE_H_
19#define SF_RENDERENGINE_H_
20
21#include <stdint.h>
22#include <sys/types.h>
23
24#include <EGL/egl.h>
25#include <EGL/eglext.h>
26#include <math/mat4.h>
27#include <Transform.h>
28
29#define EGL_NO_CONFIG ((EGLConfig)0)
30
31// ---------------------------------------------------------------------------
32namespace android {
33// ---------------------------------------------------------------------------
34
35class String8;
36class Rect;
37class Region;
38class Mesh;
39class Texture;
40
41class RenderEngine {
42    enum GlesVersion {
43        GLES_VERSION_1_0    = 0x10000,
44        GLES_VERSION_1_1    = 0x10001,
45        GLES_VERSION_2_0    = 0x20000,
46        GLES_VERSION_3_0    = 0x30000,
47    };
48    static GlesVersion parseGlesVersion(const char* str);
49
50    EGLConfig mEGLConfig;
51    EGLContext mEGLContext;
52    void setEGLHandles(EGLConfig config, EGLContext ctxt);
53
54    virtual void bindImageAsFramebuffer(EGLImageKHR image, uint32_t* texName, uint32_t* fbName, uint32_t* status) = 0;
55    virtual void unbindFramebuffer(uint32_t texName, uint32_t fbName) = 0;
56
57protected:
58    RenderEngine();
59    virtual ~RenderEngine() = 0;
60
61public:
62    enum FeatureFlag {
63        WIDE_COLOR_SUPPORT = 1 << 0 // Platform has a wide color display
64    };
65    static RenderEngine* create(EGLDisplay display, int hwcFormat, uint32_t featureFlags);
66
67    static EGLConfig chooseEglConfig(EGLDisplay display, int format, bool logConfig);
68
69    void primeCache() const;
70
71    // dump the extension strings. always call the base class.
72    virtual void dump(String8& result);
73
74    // helpers
75    void flush();
76    void clearWithColor(float red, float green, float blue, float alpha);
77    void fillRegionWithColor(const Region& region, uint32_t height,
78            float red, float green, float blue, float alpha);
79
80    // common to all GL versions
81    void setScissor(uint32_t left, uint32_t bottom, uint32_t right, uint32_t top);
82    void disableScissor();
83    void genTextures(size_t count, uint32_t* names);
84    void deleteTextures(size_t count, uint32_t const* names);
85    void readPixels(size_t l, size_t b, size_t w, size_t h, uint32_t* pixels);
86
87    class BindImageAsFramebuffer {
88        RenderEngine& mEngine;
89        uint32_t mTexName, mFbName;
90        uint32_t mStatus;
91    public:
92        BindImageAsFramebuffer(RenderEngine& engine, EGLImageKHR image);
93        ~BindImageAsFramebuffer();
94        int getStatus() const;
95    };
96
97    // set-up
98    virtual void checkErrors() const;
99    virtual void setViewportAndProjection(size_t vpw, size_t vph,
100            Rect sourceCrop, size_t hwh, bool yswap, Transform::orientation_flags rotation) = 0;
101#ifdef USE_HWC2
102    virtual void setupLayerBlending(bool premultipliedAlpha, bool opaque, float alpha) = 0;
103    virtual void setupDimLayerBlending(float alpha) = 0;
104    virtual void setColorMode(android_color_mode mode) = 0;
105    virtual void setSourceDataSpace(android_dataspace source) = 0;
106    virtual void setWideColor(bool hasWideColor) = 0;
107    virtual bool usesWideColor() = 0;
108#else
109    virtual void setupLayerBlending(bool premultipliedAlpha, bool opaque, int alpha) = 0;
110    virtual void setupDimLayerBlending(int alpha) = 0;
111#endif
112    virtual void setupLayerTexturing(const Texture& texture) = 0;
113    virtual void setupLayerBlackedOut() = 0;
114    virtual void setupFillWithColor(float r, float g, float b, float a) = 0;
115
116    virtual mat4 setupColorTransform(const mat4& /* colorTransform */) {
117        return mat4();
118    }
119
120    virtual void disableTexturing() = 0;
121    virtual void disableBlending() = 0;
122
123    // drawing
124    virtual void drawMesh(const Mesh& mesh) = 0;
125
126    // queries
127    virtual size_t getMaxTextureSize() const = 0;
128    virtual size_t getMaxViewportDims() const = 0;
129
130    EGLConfig getEGLConfig() const;
131    EGLContext getEGLContext() const;
132};
133
134// ---------------------------------------------------------------------------
135}; // namespace android
136// ---------------------------------------------------------------------------
137
138#endif /* SF_RENDERENGINE_H_ */
139