Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2014 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_STATEFUL_BASE_RENDERER_H |
| 18 | #define ANDROID_HWUI_STATEFUL_BASE_RENDERER_H |
| 19 | |
| 20 | #include <utils/RefBase.h> |
| 21 | |
| 22 | #include "Renderer.h" |
| 23 | #include "Snapshot.h" |
| 24 | |
| 25 | namespace android { |
| 26 | namespace uirenderer { |
| 27 | |
| 28 | /** |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 29 | * Abstract Renderer subclass, which implements Canvas state methods. |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 30 | * |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 31 | * Manages the Snapshot stack, implementing matrix, save/restore, and clipping methods in the |
| 32 | * Renderer interface. Drawing and recording classes that extend StatefulBaseRenderer will have |
| 33 | * different use cases: |
| 34 | * |
| 35 | * Drawing subclasses (i.e. OpenGLRenderer) can query attributes (such as transform) or hook into |
| 36 | * changes (e.g. save/restore) with minimal surface area for manipulating the stack itself. |
| 37 | * |
| 38 | * Recording subclasses (i.e. DisplayListRenderer) can both record and pass through state operations |
| 39 | * to StatefulBaseRenderer, so that not only will querying operations work (getClip/Matrix), but so |
| 40 | * that quickRejection can also be used. |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 41 | */ |
| 42 | class StatefulBaseRenderer : public Renderer { |
| 43 | public: |
| 44 | StatefulBaseRenderer(); |
| 45 | |
| 46 | virtual status_t prepare(bool opaque) { |
| 47 | return prepareDirty(0.0f, 0.0f, mWidth, mHeight, opaque); |
| 48 | } |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 49 | |
| 50 | /** |
Chris Craik | 797b95b | 2014-05-20 18:10:25 -0700 | [diff] [blame] | 51 | * Initialize the first snapshot, computing the projection matrix, and stores the dimensions of |
| 52 | * the render target. |
Chris Craik | a64a2be | 2014-05-14 14:17:01 -0700 | [diff] [blame] | 53 | */ |
Chris Craik | 797b95b | 2014-05-20 18:10:25 -0700 | [diff] [blame] | 54 | virtual void setViewport(int width, int height); |
Chris Craik | 69e5adf | 2014-08-14 13:34:01 -0700 | [diff] [blame] | 55 | void initializeSaveStack(float clipLeft, float clipTop, float clipRight, float clipBottom, |
| 56 | const Vector3& lightCenter); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 57 | |
| 58 | // getters |
| 59 | bool hasRectToRectTransform() const { |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 60 | return CC_LIKELY(currentTransform()->rectToRect()); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | // Save (layer) |
| 64 | virtual int getSaveCount() const { return mSaveCount; } |
| 65 | virtual int save(int flags); |
| 66 | virtual void restore(); |
| 67 | virtual void restoreToCount(int saveCount); |
| 68 | //virtual int saveLayer(float left, float top, float right, float bottom, |
| 69 | // int alpha, SkXfermode::Mode mode, int flags); |
| 70 | |
| 71 | // Matrix |
| 72 | virtual void getMatrix(SkMatrix* outMatrix) const; |
| 73 | virtual void translate(float dx, float dy, float dz = 0.0f); |
| 74 | virtual void rotate(float degrees); |
| 75 | virtual void scale(float sx, float sy); |
| 76 | virtual void skew(float sx, float sy); |
| 77 | |
Derek Sollenberger | 1390882 | 2013-12-10 12:28:58 -0500 | [diff] [blame] | 78 | virtual void setMatrix(const SkMatrix& matrix); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 79 | void setMatrix(const Matrix4& matrix); // internal only convenience method |
Derek Sollenberger | 1390882 | 2013-12-10 12:28:58 -0500 | [diff] [blame] | 80 | virtual void concatMatrix(const SkMatrix& matrix); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 81 | void concatMatrix(const Matrix4& matrix); // internal only convenience method |
| 82 | |
| 83 | // Clip |
Chris Craik | 3f085429 | 2014-04-15 16:18:08 -0700 | [diff] [blame] | 84 | virtual const Rect& getLocalClipBounds() const { return mSnapshot->getLocalClip(); } |
| 85 | |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 86 | virtual bool quickRejectConservative(float left, float top, float right, float bottom) const; |
| 87 | |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 88 | virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op); |
Chris Craik | d218a92 | 2014-01-02 17:13:34 -0800 | [diff] [blame] | 89 | virtual bool clipPath(const SkPath* path, SkRegion::Op op); |
| 90 | virtual bool clipRegion(const SkRegion* region, SkRegion::Op op); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 91 | |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 92 | /** |
| 93 | * Does not support different clipping Ops (that is, every call to setClippingOutline is |
| 94 | * effectively using SkRegion::kReplaceOp) |
| 95 | * |
| 96 | * The clipping outline is independent from the regular clip. |
| 97 | */ |
| 98 | void setClippingOutline(LinearAllocator& allocator, const Outline* outline); |
Chris Craik | af4d04c | 2014-07-29 12:50:14 -0700 | [diff] [blame] | 99 | void setClippingRoundRect(LinearAllocator& allocator, |
| 100 | const Rect& rect, float radius); |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 101 | |
Chris Craik | c3e75f9 | 2014-08-27 15:34:52 -0700 | [diff] [blame] | 102 | inline const mat4* currentTransform() const { |
| 103 | return mSnapshot->transform; |
| 104 | } |
| 105 | |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 106 | protected: |
Chris Craik | 3f085429 | 2014-04-15 16:18:08 -0700 | [diff] [blame] | 107 | const Rect& getRenderTargetClipBounds() const { return mSnapshot->getRenderTargetClip(); } |
| 108 | |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 109 | int getWidth() { return mWidth; } |
| 110 | int getHeight() { return mHeight; } |
| 111 | |
| 112 | // Save |
| 113 | int saveSnapshot(int flags); |
| 114 | void restoreSnapshot(); |
| 115 | |
| 116 | // allows subclasses to control what value is stored in snapshot's fbo field in |
| 117 | // initializeSaveStack |
| 118 | virtual GLuint getTargetFbo() const { |
| 119 | return -1; |
| 120 | } |
| 121 | |
| 122 | // Clip |
| 123 | bool calculateQuickRejectForScissor(float left, float top, float right, float bottom, |
Chris Craik | deeda3d | 2014-05-05 19:09:33 -0700 | [diff] [blame] | 124 | bool* clipRequired, bool* roundRectClipRequired, bool snapOut) const; |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 125 | |
| 126 | /** |
| 127 | * Called just after a restore has occurred. The 'removed' snapshot popped from the stack, |
| 128 | * 'restored' snapshot has become the top/current. |
| 129 | * |
| 130 | * Subclasses can override this method to handle layer restoration |
| 131 | */ |
| 132 | virtual void onSnapshotRestored(const Snapshot& removed, const Snapshot& restored) {}; |
| 133 | |
Chris Craik | 797b95b | 2014-05-20 18:10:25 -0700 | [diff] [blame] | 134 | virtual void onViewportInitialized() {}; |
| 135 | |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 136 | inline const Rect* currentClipRect() const { |
| 137 | return mSnapshot->clipRect; |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 138 | } |
| 139 | |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 140 | inline const Snapshot* currentSnapshot() const { |
| 141 | return mSnapshot != NULL ? mSnapshot.get() : mFirstSnapshot.get(); |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 142 | } |
| 143 | |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 144 | inline const Snapshot* firstSnapshot() const { |
| 145 | return mFirstSnapshot.get(); |
| 146 | } |
| 147 | |
| 148 | // indicites that the clip has been changed since the last time it was consumed |
| 149 | bool mDirtyClip; |
| 150 | |
| 151 | private: |
| 152 | // Dimensions of the drawing surface |
| 153 | int mWidth, mHeight; |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 154 | |
| 155 | // Number of saved states |
| 156 | int mSaveCount; |
| 157 | |
| 158 | // Base state |
| 159 | sp<Snapshot> mFirstSnapshot; |
| 160 | |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 161 | protected: |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 162 | // Current state |
Chris Craik | d6b65f6 | 2014-01-01 14:45:21 -0800 | [diff] [blame] | 163 | // TODO: should become private, once hooks needed by OpenGLRenderer are added |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 164 | sp<Snapshot> mSnapshot; |
Chris Craik | 14e5130 | 2013-12-30 15:32:54 -0800 | [diff] [blame] | 165 | }; // class StatefulBaseRenderer |
| 166 | |
| 167 | }; // namespace uirenderer |
| 168 | }; // namespace android |
| 169 | |
| 170 | #endif // ANDROID_HWUI_STATEFUL_BASE_RENDERER_H |