BakedOpRenderer.h revision 7db5ffb7dbd30202468459e2ef4426e91d4fcbb3 
1/*
2 * Copyright (C) 2015 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_HWUI_BAKED_OP_RENDERER_H
18#define ANDROID_HWUI_BAKED_OP_RENDERER_H
19
20#include "BakedOpState.h"
21#include "Matrix.h"
22#include "utils/Macros.h"
23
24namespace android {
25namespace uirenderer {
26
27class Caches;
28struct Glop;
29class Layer;
30class RenderState;
31struct ClipBase;
32
33/**
34 * Main rendering manager for a collection of work - one frame + any contained FBOs.
35 *
36 * Manages frame and FBO lifecycle, binding the GL framebuffer as appropriate. This is the only
37 * place where FBOs are bound, created, and destroyed.
38 *
39 * All rendering operations will be sent by the Dispatcher, a collection of static methods,
40 * which has intentionally limited access to the renderer functionality.
41 */
42class BakedOpRenderer {
43public:
44    /**
45     * Position agnostic shadow lighting info. Used with all shadow ops in scene.
46     */
47    struct LightInfo {
48        LightInfo() : LightInfo(0, 0, 0) {}
49        LightInfo(float lightRadius, uint8_t ambientShadowAlpha,
50                uint8_t spotShadowAlpha)
51                : lightRadius(lightRadius)
52                , ambientShadowAlpha(ambientShadowAlpha)
53                , spotShadowAlpha(spotShadowAlpha) {}
54        float lightRadius;
55        uint8_t ambientShadowAlpha;
56        uint8_t spotShadowAlpha;
57    };
58
59    BakedOpRenderer(Caches& caches, RenderState& renderState, bool opaque, const LightInfo& lightInfo)
60            : mRenderState(renderState)
61            , mCaches(caches)
62            , mOpaque(opaque)
63            , mLightInfo(lightInfo) {
64    }
65
66    RenderState& renderState() { return mRenderState; }
67    Caches& caches() { return mCaches; }
68
69    void startFrame(uint32_t width, uint32_t height, const Rect& repaintRect);
70    void endFrame(const Rect& repaintRect);
71    WARN_UNUSED_RESULT OffscreenBuffer* startTemporaryLayer(uint32_t width, uint32_t height);
72    void startRepaintLayer(OffscreenBuffer* offscreenBuffer, const Rect& repaintRect);
73    void endLayer();
74    WARN_UNUSED_RESULT OffscreenBuffer* copyToLayer(const Rect& area);
75
76    Texture* getTexture(const SkBitmap* bitmap);
77    const LightInfo& getLightInfo() const { return mLightInfo; }
78
79    void renderGlop(const BakedOpState& state, const Glop& glop) {
80        renderGlop(&state.computedState.clippedBounds,
81                state.computedState.getClipIfNeeded(),
82                glop);
83    }
84    void renderFunctor(const FunctorOp& op, const BakedOpState& state);
85
86    void renderGlop(const Rect* dirtyBounds, const ClipBase* clip, const Glop& glop);
87    bool offscreenRenderTarget() { return mRenderTarget.offscreenBuffer != nullptr; }
88    void dirtyRenderTarget(const Rect& dirtyRect);
89    bool didDraw() const { return mHasDrawn; }
90private:
91    void setViewport(uint32_t width, uint32_t height);
92    void clearColorBuffer(const Rect& clearRect);
93    void prepareRender(const Rect* dirtyBounds, const ClipBase* clip);
94    void setupStencilRectList(const ClipBase* clip);
95    void setupStencilRegion(const ClipBase* clip);
96    void setupStencilQuads(std::vector<Vertex>& quadVertices, int incrementThreshold);
97
98    RenderState& mRenderState;
99    Caches& mCaches;
100    bool mOpaque;
101    bool mHasDrawn = false;
102
103    // render target state - setup by start/end layer/frame
104    // only valid to use in between start/end pairs.
105    struct {
106        // If not drawing to a layer: fbo = 0, offscreenBuffer = null,
107        // Otherwise these refer to currently painting layer's state
108        GLuint frameBufferId = 0;
109        OffscreenBuffer* offscreenBuffer = nullptr;
110
111        // Used when drawing to a layer and using stencil clipping. otherwise null.
112        RenderBuffer* stencil = nullptr;
113
114        // value representing the ClipRectList* or ClipRegion* currently stored in
115        // the stencil of the current render target
116        const ClipBase* lastStencilClip = nullptr;
117
118        // Size of renderable region in current render target - for layers, may not match actual
119        // bounds of FBO texture. offscreenBuffer->texture has this information.
120        uint32_t viewportWidth = 0;
121        uint32_t viewportHeight = 0;
122
123        Matrix4 orthoMatrix;
124    } mRenderTarget;
125
126    const LightInfo mLightInfo;
127};
128
129}; // namespace uirenderer
130}; // namespace android
131
132#endif // ANDROID_HWUI_BAKED_OP_RENDERER_H
133