BakedOpRenderer.cpp revision 74af6e282f8a8f75928a071e8200039517cf5c12 
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#include "BakedOpRenderer.h"
18
19#include "Caches.h"
20#include "Glop.h"
21#include "GlopBuilder.h"
22#include "renderstate/OffscreenBufferPool.h"
23#include "renderstate/RenderState.h"
24#include "utils/GLUtils.h"
25#include "VertexBuffer.h"
26
27#include <algorithm>
28
29namespace android {
30namespace uirenderer {
31
32OffscreenBuffer* BakedOpRenderer::startTemporaryLayer(uint32_t width, uint32_t height) {
33    LOG_ALWAYS_FATAL_IF(mRenderTarget.offscreenBuffer, "already has layer...");
34
35    OffscreenBuffer* buffer = mRenderState.layerPool().get(mRenderState, width, height);
36    startRepaintLayer(buffer, Rect(width, height));
37    return buffer;
38}
39
40void BakedOpRenderer::recycleTemporaryLayer(OffscreenBuffer* offscreenBuffer) {
41    mRenderState.layerPool().putOrDelete(offscreenBuffer);
42}
43
44void BakedOpRenderer::startRepaintLayer(OffscreenBuffer* offscreenBuffer, const Rect& repaintRect) {
45    LOG_ALWAYS_FATAL_IF(mRenderTarget.offscreenBuffer, "already has layer...");
46
47    // subtract repaintRect from region, since it will be regenerated
48    if (repaintRect.contains(0, 0,
49                offscreenBuffer->viewportWidth, offscreenBuffer->viewportHeight)) {
50        // repaint full layer, so throw away entire region
51        offscreenBuffer->region.clear();
52    } else {
53        offscreenBuffer->region.subtractSelf(android::Rect(repaintRect.left, repaintRect.top,
54                repaintRect.right, repaintRect.bottom));
55    }
56
57    mRenderTarget.offscreenBuffer = offscreenBuffer;
58
59    // create and bind framebuffer
60    mRenderTarget.frameBufferId = mRenderState.createFramebuffer();
61    mRenderState.bindFramebuffer(mRenderTarget.frameBufferId);
62
63    // attach the texture to the FBO
64    glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D,
65            offscreenBuffer->texture.id(), 0);
66    GL_CHECKPOINT(LOW);
67
68    LOG_ALWAYS_FATAL_IF(glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE,
69            "framebuffer incomplete!");
70
71    // Change the viewport & ortho projection
72    setViewport(offscreenBuffer->viewportWidth, offscreenBuffer->viewportHeight);
73
74    clearColorBuffer(repaintRect);
75}
76
77void BakedOpRenderer::endLayer() {
78    if (mRenderTarget.stencil) {
79        // if stencil was used for clipping, detach it and return it to pool
80        glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT, GL_RENDERBUFFER, 0);
81        GL_CHECKPOINT(MODERATE);
82        mCaches.renderBufferCache.put(mRenderTarget.stencil);
83        mRenderTarget.stencil = nullptr;
84    }
85    mRenderTarget.lastStencilClip = nullptr;
86
87    mRenderTarget.offscreenBuffer->updateMeshFromRegion();
88    mRenderTarget.offscreenBuffer = nullptr; // It's in drawLayerOp's hands now.
89
90    // Detach the texture from the FBO
91    glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, 0, 0);
92    GL_CHECKPOINT(LOW);
93    mRenderState.deleteFramebuffer(mRenderTarget.frameBufferId);
94    mRenderTarget.frameBufferId = 0;
95}
96
97OffscreenBuffer* BakedOpRenderer::copyToLayer(const Rect& area) {
98    OffscreenBuffer* buffer = mRenderState.layerPool().get(mRenderState,
99            area.getWidth(), area.getHeight());
100    if (!area.isEmpty()) {
101        mCaches.textureState().activateTexture(0);
102        mCaches.textureState().bindTexture(buffer->texture.id());
103
104        glCopyTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0,
105                area.left, mRenderTarget.viewportHeight - area.bottom,
106                area.getWidth(), area.getHeight());
107    }
108    return buffer;
109}
110
111void BakedOpRenderer::startFrame(uint32_t width, uint32_t height, const Rect& repaintRect) {
112    LOG_ALWAYS_FATAL_IF(mRenderTarget.frameBufferId != 0, "primary framebufferId must be 0");
113    mRenderState.bindFramebuffer(0);
114    setViewport(width, height);
115
116    if (!mOpaque) {
117        clearColorBuffer(repaintRect);
118    }
119
120    mRenderState.debugOverdraw(true, true);
121}
122
123void BakedOpRenderer::endFrame(const Rect& repaintRect) {
124    if (CC_UNLIKELY(Properties::debugOverdraw)) {
125        ClipRect overdrawClip(repaintRect);
126        Rect viewportRect(mRenderTarget.viewportWidth, mRenderTarget.viewportHeight);
127        // overdraw visualization
128        for (int i = 1; i <= 4; i++) {
129            if (i < 4) {
130                // nth level of overdraw tests for n+1 draws per pixel
131                mRenderState.stencil().enableDebugTest(i + 1, false);
132            } else {
133                // 4th level tests for 4 or higher draws per pixel
134                mRenderState.stencil().enableDebugTest(4, true);
135            }
136
137            SkPaint paint;
138            paint.setColor(mCaches.getOverdrawColor(i));
139            Glop glop;
140            GlopBuilder(mRenderState, mCaches, &glop)
141                    .setRoundRectClipState(nullptr)
142                    .setMeshUnitQuad()
143                    .setFillPaint(paint, 1.0f)
144                    .setTransform(Matrix4::identity(), TransformFlags::None)
145                    .setModelViewMapUnitToRect(viewportRect)
146                    .build();
147            renderGlop(nullptr, &overdrawClip, glop);
148        }
149        mRenderState.stencil().disable();
150    }
151
152    // Note: we leave FBO 0 renderable here, for post-frame-content decoration
153}
154
155void BakedOpRenderer::setViewport(uint32_t width, uint32_t height) {
156    mRenderTarget.viewportWidth = width;
157    mRenderTarget.viewportHeight = height;
158    mRenderTarget.orthoMatrix.loadOrtho(width, height);
159
160    mRenderState.setViewport(width, height);
161    mRenderState.blend().syncEnabled();
162}
163
164void BakedOpRenderer::clearColorBuffer(const Rect& rect) {
165    if (rect.contains(Rect(mRenderTarget.viewportWidth, mRenderTarget.viewportHeight))) {
166        // Full viewport is being cleared - disable scissor
167        mRenderState.scissor().setEnabled(false);
168    } else {
169        // Requested rect is subset of viewport - scissor to it to avoid over-clearing
170        mRenderState.scissor().setEnabled(true);
171        mRenderState.scissor().set(rect.left, mRenderTarget.viewportHeight - rect.bottom,
172                rect.getWidth(), rect.getHeight());
173    }
174    glClear(GL_COLOR_BUFFER_BIT);
175    if (!mRenderTarget.frameBufferId) mHasDrawn = true;
176}
177
178Texture* BakedOpRenderer::getTexture(const SkBitmap* bitmap) {
179    Texture* texture = mRenderState.assetAtlas().getEntryTexture(bitmap->pixelRef());
180    if (!texture) {
181        return mCaches.textureCache.get(bitmap);
182    }
183    return texture;
184}
185
186void BakedOpRenderer::drawRects(const float* rects, int count, const SkPaint* paint) {
187    std::vector<Vertex> vertices;
188    vertices.reserve(count);
189    Vertex* vertex = vertices.data();
190
191    for (int index = 0; index < count; index += 4) {
192        float l = rects[index + 0];
193        float t = rects[index + 1];
194        float r = rects[index + 2];
195        float b = rects[index + 3];
196
197        Vertex::set(vertex++, l, t);
198        Vertex::set(vertex++, r, t);
199        Vertex::set(vertex++, l, b);
200        Vertex::set(vertex++, r, b);
201    }
202
203    LOG_ALWAYS_FATAL_IF(mRenderTarget.frameBufferId != 0, "decoration only supported for FBO 0");
204    // TODO: Currently assume full FBO damage, due to FrameInfoVisualizer::unionDirty.
205    // Should should scissor/set mHasDrawn safely.
206    mRenderState.scissor().setEnabled(false);
207    mHasDrawn = true;
208    Glop glop;
209    GlopBuilder(mRenderState, mCaches, &glop)
210            .setRoundRectClipState(nullptr)
211            .setMeshIndexedQuads(vertices.data(), count / 4)
212            .setFillPaint(*paint, 1.0f)
213            .setTransform(Matrix4::identity(), TransformFlags::None)
214            .setModelViewIdentityEmptyBounds()
215            .build();
216    mRenderState.render(glop, mRenderTarget.orthoMatrix);
217}
218
219// clears and re-fills stencil with provided rendertarget space quads,
220// and then put stencil into test mode
221void BakedOpRenderer::setupStencilQuads(std::vector<Vertex>& quadVertices,
222        int incrementThreshold) {
223    mRenderState.stencil().enableWrite(incrementThreshold);
224    mRenderState.stencil().clear();
225    Glop glop;
226    GlopBuilder(mRenderState, mCaches, &glop)
227            .setRoundRectClipState(nullptr)
228            .setMeshIndexedQuads(quadVertices.data(), quadVertices.size() / 4)
229            .setFillBlack()
230            .setTransform(Matrix4::identity(), TransformFlags::None)
231            .setModelViewIdentityEmptyBounds()
232            .build();
233    mRenderState.render(glop, mRenderTarget.orthoMatrix);
234    mRenderState.stencil().enableTest(incrementThreshold);
235}
236
237void BakedOpRenderer::setupStencilRectList(const ClipBase* clip) {
238    LOG_ALWAYS_FATAL_IF(clip->mode != ClipMode::RectangleList, "can't rectlist clip without rectlist");
239    auto&& rectList = reinterpret_cast<const ClipRectList*>(clip)->rectList;
240    int quadCount = rectList.getTransformedRectanglesCount();
241    std::vector<Vertex> rectangleVertices;
242    rectangleVertices.reserve(quadCount * 4);
243    for (int i = 0; i < quadCount; i++) {
244        const TransformedRectangle& tr(rectList.getTransformedRectangle(i));
245        const Matrix4& transform = tr.getTransform();
246        Rect bounds = tr.getBounds();
247        if (transform.rectToRect()) {
248            // If rectToRect, can simply map bounds before storing verts
249            transform.mapRect(bounds);
250            bounds.doIntersect(clip->rect);
251            if (bounds.isEmpty()) {
252                continue; // will be outside of scissor, skip
253            }
254        }
255
256        rectangleVertices.push_back(Vertex{bounds.left, bounds.top});
257        rectangleVertices.push_back(Vertex{bounds.right, bounds.top});
258        rectangleVertices.push_back(Vertex{bounds.left, bounds.bottom});
259        rectangleVertices.push_back(Vertex{bounds.right, bounds.bottom});
260
261        if (!transform.rectToRect()) {
262            // If not rectToRect, must map each point individually
263            for (auto cur = rectangleVertices.end() - 4; cur < rectangleVertices.end(); cur++) {
264                transform.mapPoint(cur->x, cur->y);
265            }
266        }
267    }
268    setupStencilQuads(rectangleVertices, rectList.getTransformedRectanglesCount());
269}
270
271void BakedOpRenderer::setupStencilRegion(const ClipBase* clip) {
272    LOG_ALWAYS_FATAL_IF(clip->mode != ClipMode::Region, "can't region clip without region");
273    auto&& region = reinterpret_cast<const ClipRegion*>(clip)->region;
274
275    std::vector<Vertex> regionVertices;
276    SkRegion::Cliperator it(region, clip->rect.toSkIRect());
277    while (!it.done()) {
278        const SkIRect& r = it.rect();
279        regionVertices.push_back(Vertex{(float)r.fLeft, (float)r.fTop});
280        regionVertices.push_back(Vertex{(float)r.fRight, (float)r.fTop});
281        regionVertices.push_back(Vertex{(float)r.fLeft, (float)r.fBottom});
282        regionVertices.push_back(Vertex{(float)r.fRight, (float)r.fBottom});
283        it.next();
284    }
285    setupStencilQuads(regionVertices, 0);
286}
287
288void BakedOpRenderer::prepareRender(const Rect* dirtyBounds, const ClipBase* clip) {
289    // Prepare scissor (done before stencil, to simplify filling stencil)
290    mRenderState.scissor().setEnabled(clip != nullptr);
291    if (clip) {
292        mRenderState.scissor().set(mRenderTarget.viewportHeight, clip->rect);
293    }
294
295    // If stencil may be used for clipping, enable it, fill it, or disable it as appropriate
296    if (CC_LIKELY(!Properties::debugOverdraw)) {
297        // only modify stencil mode and content when it's not used for overdraw visualization
298        if (CC_UNLIKELY(clip && clip->mode != ClipMode::Rectangle)) {
299            // NOTE: this pointer check is only safe for non-rect clips,
300            // since rect clips may be created on the stack
301            if (mRenderTarget.lastStencilClip != clip) {
302                // Stencil needed, but current stencil isn't up to date
303                mRenderTarget.lastStencilClip = clip;
304
305                if (mRenderTarget.frameBufferId != 0 && !mRenderTarget.stencil) {
306                    OffscreenBuffer* layer = mRenderTarget.offscreenBuffer;
307                    mRenderTarget.stencil = mCaches.renderBufferCache.get(
308                            Stencil::getLayerStencilFormat(),
309                            layer->texture.width(), layer->texture.height());
310                    // stencil is bound + allocated - associate it with current FBO
311                    glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_STENCIL_ATTACHMENT,
312                            GL_RENDERBUFFER, mRenderTarget.stencil->getName());
313                }
314
315                if (clip->mode == ClipMode::RectangleList) {
316                    setupStencilRectList(clip);
317                } else {
318                    setupStencilRegion(clip);
319                }
320            } else {
321                // stencil is up to date - just need to ensure it's enabled (since an unclipped
322                // or scissor-only clipped op may have been drawn, disabling the stencil)
323                int incrementThreshold = 0;
324                if (CC_LIKELY(clip->mode == ClipMode::RectangleList)) {
325                    auto&& rectList = reinterpret_cast<const ClipRectList*>(clip)->rectList;
326                    incrementThreshold = rectList.getTransformedRectanglesCount();
327                }
328                mRenderState.stencil().enableTest(incrementThreshold);
329            }
330        } else {
331            // either scissor or no clip, so disable stencil test
332            mRenderState.stencil().disable();
333        }
334    }
335
336    if (dirtyBounds) {
337        // dirty offscreenbuffer if present
338        dirtyRenderTarget(*dirtyBounds);
339    }
340}
341
342void BakedOpRenderer::renderGlopImpl(const Rect* dirtyBounds, const ClipBase* clip,
343        const Glop& glop) {
344    prepareRender(dirtyBounds, clip);
345    mRenderState.render(glop, mRenderTarget.orthoMatrix);
346    if (!mRenderTarget.frameBufferId) mHasDrawn = true;
347}
348
349void BakedOpRenderer::renderFunctor(const FunctorOp& op, const BakedOpState& state) {
350    prepareRender(&state.computedState.clippedBounds, state.computedState.getClipIfNeeded());
351
352    DrawGlInfo info;
353    auto&& clip = state.computedState.clipRect();
354    info.clipLeft = clip.left;
355    info.clipTop = clip.top;
356    info.clipRight = clip.right;
357    info.clipBottom = clip.bottom;
358    info.isLayer = offscreenRenderTarget();
359    info.width = mRenderTarget.viewportWidth;
360    info.height = mRenderTarget.viewportHeight;
361    state.computedState.transform.copyTo(&info.transform[0]);
362
363    mRenderState.invokeFunctor(op.functor, DrawGlInfo::kModeDraw, &info);
364}
365
366void BakedOpRenderer::dirtyRenderTarget(const Rect& uiDirty) {
367    if (mRenderTarget.offscreenBuffer) {
368        mRenderTarget.offscreenBuffer->dirty(uiDirty);
369    }
370}
371
372} // namespace uirenderer
373} // namespace android
374