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 <ui/mat4.h>
27 #include <Transform.h>
28 
29 #define EGL_NO_CONFIG ((EGLConfig)0)
30 
31 // ---------------------------------------------------------------------------
32 namespace android {
33 // ---------------------------------------------------------------------------
34 
35 class String8;
36 class Rect;
37 class Region;
38 class Mesh;
39 class Texture;
40 
41 class 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 
57 protected:
58     RenderEngine();
59     virtual ~RenderEngine() = 0;
60 
61 public:
62     static RenderEngine* create(EGLDisplay display, int hwcFormat);
63 
64     static EGLConfig chooseEglConfig(EGLDisplay display, int format);
65 
66     // dump the extension strings. always call the base class.
67     virtual void dump(String8& result);
68 
69     // helpers
70     void flush();
71     void clearWithColor(float red, float green, float blue, float alpha);
72     void fillRegionWithColor(const Region& region, uint32_t height,
73             float red, float green, float blue, float alpha);
74 
75     // common to all GL versions
76     void setScissor(uint32_t left, uint32_t bottom, uint32_t right, uint32_t top);
77     void disableScissor();
78     void genTextures(size_t count, uint32_t* names);
79     void deleteTextures(size_t count, uint32_t const* names);
80     void readPixels(size_t l, size_t b, size_t w, size_t h, uint32_t* pixels);
81 
82     class BindImageAsFramebuffer {
83         RenderEngine& mEngine;
84         uint32_t mTexName, mFbName;
85         uint32_t mStatus;
86     public:
87         BindImageAsFramebuffer(RenderEngine& engine, EGLImageKHR image);
88         ~BindImageAsFramebuffer();
89         int getStatus() const;
90     };
91 
92     // set-up
93     virtual void checkErrors() const;
94     virtual void setViewportAndProjection(size_t vpw, size_t vph,
95             Rect sourceCrop, size_t hwh, bool yswap, Transform::orientation_flags rotation) = 0;
96     virtual void setupLayerBlending(bool premultipliedAlpha, bool opaque, int alpha) = 0;
97     virtual void setupDimLayerBlending(int alpha) = 0;
98     virtual void setupLayerTexturing(const Texture& texture) = 0;
99     virtual void setupLayerBlackedOut() = 0;
100     virtual void setupFillWithColor(float r, float g, float b, float a) = 0;
101 
102     virtual void disableTexturing() = 0;
103     virtual void disableBlending() = 0;
104 
105     // drawing
106     virtual void drawMesh(const Mesh& mesh) = 0;
107 
108     // grouping
109     // creates a color-transform group, everything drawn in the group will be
110     // transformed by the given color transform when endGroup() is called.
111     virtual void beginGroup(const mat4& colorTransform) = 0;
112     virtual void endGroup() = 0;
113 
114     // queries
115     virtual size_t getMaxTextureSize() const = 0;
116     virtual size_t getMaxViewportDims() const = 0;
117 
118     EGLConfig getEGLConfig() const;
119     EGLContext getEGLContext() const;
120 };
121 
122 // ---------------------------------------------------------------------------
123 }; // namespace android
124 // ---------------------------------------------------------------------------
125 
126 #endif /* SF_RENDERENGINE_H_ */
127