Canvas.h revision 386aa031793bb037ec43b6cdbd8908c343cc86cb
1cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger/* 2cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * Copyright (C) 2014 The Android Open Source Project 3cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * 4cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * Licensed under the Apache License, Version 2.0 (the "License"); 5cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * you may not use this file except in compliance with the License. 6cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * You may obtain a copy of the License at 7cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * 8cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * http://www.apache.org/licenses/LICENSE-2.0 9cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * 10cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * Unless required by applicable law or agreed to in writing, software 11cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * distributed under the License is distributed on an "AS IS" BASIS, 12cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * See the License for the specific language governing permissions and 14cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * limitations under the License. 15cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger */ 16cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 17cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger#ifndef ANDROID_GRAPHICS_CANVAS_H 18cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger#define ANDROID_GRAPHICS_CANVAS_H 19cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 20849911a9c4315fc552faa38516c842b2541b1909John Reck#include <cutils/compiler.h> 21849911a9c4315fc552faa38516c842b2541b1909John Reck 224c5efe9290543b723b76a8bd48518da1ae1dcb26Derek Sollenberger#include "utils/NinePatch.h" 234c5efe9290543b723b76a8bd48518da1ae1dcb26Derek Sollenberger 24849911a9c4315fc552faa38516c842b2541b1909John Reck#include <SkBitmap.h> 25849911a9c4315fc552faa38516c842b2541b1909John Reck#include <SkCanvas.h> 26849911a9c4315fc552faa38516c842b2541b1909John Reck#include <SkMatrix.h> 27cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 28cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenbergernamespace android { 29cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 30849911a9c4315fc552faa38516c842b2541b1909John Reckclass ANDROID_API Canvas { 31cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenbergerpublic: 32cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual ~Canvas() {}; 33cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 34c1b33d665c8caf5760f68c45c6ca0baa649b832aJohn Reck static Canvas* create_canvas(const SkBitmap& bitmap); 3518981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III 3618981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III /** 3718981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * Create a new Canvas object which delegates to an SkCanvas. 3818981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * 3918981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * @param skiaCanvas Must not be NULL. All drawing calls will be 4018981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * delegated to this object. This function will call ref() on the 4118981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * SkCanvas, and the returned Canvas will unref() it upon 4218981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * destruction. 4318981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III * @return new Canvas object. Will not return NULL. 4418981294a58c411a4a33ebb22caf9c75ba639691Leon Scroggins III */ 45cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger static Canvas* create_canvas(SkCanvas* skiaCanvas); 46cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 471db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger /** 481db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * Provides a Skia SkCanvas interface that acts as a proxy to this Canvas. 491db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * It is useful for testing and clients (e.g. Picture/Movie) that expect to 501db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * draw their contents into an SkCanvas. 511db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * 5290fb1f6732a610ad5ff6acdb3bd9ae392c8eac82Tom Hudson * The SkCanvas returned is *only* valid until another Canvas call is made 5390fb1f6732a610ad5ff6acdb3bd9ae392c8eac82Tom Hudson * that would change state (e.g. matrix or clip). Clients of asSkCanvas() 5490fb1f6732a610ad5ff6acdb3bd9ae392c8eac82Tom Hudson * are responsible for *not* persisting this pointer. 5590fb1f6732a610ad5ff6acdb3bd9ae392c8eac82Tom Hudson * 561db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * Further, the returned SkCanvas should NOT be unref'd and is valid until 571db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger * this canvas is destroyed or a new bitmap is set. 581db141f93c4fe79a4669440c3d14f63bc87b2e34Derek Sollenberger */ 59b3d50e007523d1ada0866d384c391c72ac1a3577Derek Sollenberger virtual SkCanvas* asSkCanvas() = 0; 60cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 61c1b33d665c8caf5760f68c45c6ca0baa649b832aJohn Reck virtual void setBitmap(const SkBitmap& bitmap) = 0; 62cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 63cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool isOpaque() = 0; 64cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int width() = 0; 65cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int height() = 0; 66cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 676578a989566e585eee053095dc80e2552e125db2Derek Sollenberger virtual void setHighContrastText(bool highContrastText) = 0; 686578a989566e585eee053095dc80e2552e125db2Derek Sollenberger virtual bool isHighContrastText() = 0; 696578a989566e585eee053095dc80e2552e125db2Derek Sollenberger 70cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// ---------------------------------------------------------------------------- 71cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// Canvas state operations 72cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// ---------------------------------------------------------------------------- 73cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // Save (layer) 74cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int getSaveCount() const = 0; 75cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int save(SkCanvas::SaveFlags flags) = 0; 76cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void restore() = 0; 77cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void restoreToCount(int saveCount) = 0; 78cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 79cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int saveLayer(float left, float top, float right, float bottom, 80cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint* paint, SkCanvas::SaveFlags flags) = 0; 81cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual int saveLayerAlpha(float left, float top, float right, float bottom, 82cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger int alpha, SkCanvas::SaveFlags flags) = 0; 83cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 84cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // Matrix 85cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void getMatrix(SkMatrix* outMatrix) const = 0; 86cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void setMatrix(const SkMatrix& matrix) = 0; 87cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 88cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void concat(const SkMatrix& matrix) = 0; 89cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void rotate(float degrees) = 0; 90cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void scale(float sx, float sy) = 0; 91cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void skew(float sx, float sy) = 0; 92cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void translate(float dx, float dy) = 0; 93cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 94cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // clip 95cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool getClipBounds(SkRect* outRect) const = 0; 96cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool quickRejectRect(float left, float top, float right, float bottom) const = 0; 97cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool quickRejectPath(const SkPath& path) const = 0; 98cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 99c1b33d665c8caf5760f68c45c6ca0baa649b832aJohn Reck virtual bool clipRect(float left, float top, float right, float bottom, 100c1b33d665c8caf5760f68c45c6ca0baa649b832aJohn Reck SkRegion::Op op = SkRegion::kIntersect_Op) = 0; 101cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool clipPath(const SkPath* path, SkRegion::Op op) = 0; 102cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool clipRegion(const SkRegion* region, SkRegion::Op op) = 0; 103cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 104cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // filters 105cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual SkDrawFilter* getDrawFilter() = 0; 106cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void setDrawFilter(SkDrawFilter* drawFilter) = 0; 107cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 108cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// ---------------------------------------------------------------------------- 109cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// Canvas draw operations 110cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger// ---------------------------------------------------------------------------- 111cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawColor(int color, SkXfermode::Mode mode) = 0; 112cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawPaint(const SkPaint& paint) = 0; 113cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 114cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // Geometry 115cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawPoint(float x, float y, const SkPaint& paint) = 0; 116386aa031793bb037ec43b6cdbd8908c343cc86cbChris Craik virtual void drawPoints(const float* points, int floatCount, const SkPaint& paint) = 0; 117cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawLine(float startX, float startY, float stopX, float stopY, 118cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint& paint) = 0; 119386aa031793bb037ec43b6cdbd8908c343cc86cbChris Craik virtual void drawLines(const float* points, int floatCount, const SkPaint& paint) = 0; 120cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawRect(float left, float top, float right, float bottom, 121cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint& paint) = 0; 12294394b3fb048d5349a77b57950ab7f6b6e92ce34Derek Sollenberger virtual void drawRegion(const SkRegion& region, const SkPaint& paint) = 0; 123cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawRoundRect(float left, float top, float right, float bottom, 124cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger float rx, float ry, const SkPaint& paint) = 0; 125cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawCircle(float x, float y, float radius, const SkPaint& paint) = 0; 126cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawOval(float left, float top, float right, float bottom, 127cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint& paint) = 0; 128cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawArc(float left, float top, float right, float bottom, 129cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger float startAngle, float sweepAngle, bool useCenter, const SkPaint& paint) = 0; 130cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawPath(const SkPath& path, const SkPaint& paint) = 0; 131cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawVertices(SkCanvas::VertexMode vertexMode, int vertexCount, 132cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const float* verts, const float* tex, const int* colors, 133cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const uint16_t* indices, int indexCount, const SkPaint& paint) = 0; 134cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 135cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // Bitmap-based 136cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawBitmap(const SkBitmap& bitmap, float left, float top, 137cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint* paint) = 0; 138cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawBitmap(const SkBitmap& bitmap, const SkMatrix& matrix, 139cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint* paint) = 0; 140cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawBitmap(const SkBitmap& bitmap, float srcLeft, float srcTop, 141cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger float srcRight, float srcBottom, float dstLeft, float dstTop, 142cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger float dstRight, float dstBottom, const SkPaint* paint) = 0; 143cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawBitmapMesh(const SkBitmap& bitmap, int meshWidth, int meshHeight, 144cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const float* vertices, const int* colors, const SkPaint* paint) = 0; 1454c5efe9290543b723b76a8bd48518da1ae1dcb26Derek Sollenberger virtual void drawNinePatch(const SkBitmap& bitmap, const android::Res_png_9patch& chunk, 1464c5efe9290543b723b76a8bd48518da1ae1dcb26Derek Sollenberger float dstLeft, float dstTop, float dstRight, float dstBottom, 1474c5efe9290543b723b76a8bd48518da1ae1dcb26Derek Sollenberger const SkPaint* paint) = 0; 148cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 149cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger // Text 1508dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson /** 1518dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson * drawText: count is of glyphs 152a1717271caac5e8ea3808c331d4141ac01a42134Chris Craik * totalAdvance: used to define width of text decorations (underlines, strikethroughs). 1538dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson */ 1548dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson virtual void drawText(const uint16_t* glyphs, const float* positions, int count, 155cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger const SkPaint& paint, float x, float y, 1568dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson float boundsLeft, float boundsTop, float boundsRight, float boundsBottom, 1578dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson float totalAdvance) = 0; 1588dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson /** drawTextOnPath: count is of glyphs */ 159cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual void drawTextOnPath(const uint16_t* glyphs, int count, const SkPath& path, 160cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger float hOffset, float vOffset, const SkPaint& paint) = 0; 161cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 1628dfaa4904205772cdceee63ef3989bcdedf1a914Tom Hudson /** 163cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * Specifies if the positions passed to ::drawText are absolute or relative 164cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * to the (x,y) value provided. 165cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * 166cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * If true the (x,y) values are ignored. Otherwise, those (x,y) values need 167cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger * to be added to each glyph's position to get its absolute position. 168cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger */ 169cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger virtual bool drawTextAbsolutePos() const = 0; 170a1717271caac5e8ea3808c331d4141ac01a42134Chris Craik 171a1717271caac5e8ea3808c331d4141ac01a42134Chris Craikprotected: 172a1717271caac5e8ea3808c331d4141ac01a42134Chris Craik void drawTextDecorations(float x, float y, float length, const SkPaint& paint); 173cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger}; 174cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger 175cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger}; // namespace android 176cae05e0b4c4726236487bdd7c23b82e93f85fd23Derek Sollenberger#endif // ANDROID_GRAPHICS_CANVAS_H 177