/* * Copyright (C) 2014 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef ANDROID_GRAPHICS_CANVAS_H #define ANDROID_GRAPHICS_CANVAS_H #include #include #include #include namespace android { class ANDROID_API Canvas { public: virtual ~Canvas() {}; static Canvas* create_canvas(const SkBitmap& bitmap); /** * Create a new Canvas object which delegates to an SkCanvas. * * @param skiaCanvas Must not be NULL. All drawing calls will be * delegated to this object. This function will call ref() on the * SkCanvas, and the returned Canvas will unref() it upon * destruction. * @return new Canvas object. Will not return NULL. */ static Canvas* create_canvas(SkCanvas* skiaCanvas); /** * Provides a Skia SkCanvas interface that acts as a proxy to this Canvas. * It is useful for testing and clients (e.g. Picture/Movie) that expect to * draw their contents into an SkCanvas. * * The SkCanvas returned is *only* valid until another Canvas call is made * that would change state (e.g. matrix or clip). Clients of asSkCanvas() * are responsible for *not* persisting this pointer. * * Further, the returned SkCanvas should NOT be unref'd and is valid until * this canvas is destroyed or a new bitmap is set. */ virtual SkCanvas* asSkCanvas() = 0; virtual void setBitmap(const SkBitmap& bitmap) = 0; virtual bool isOpaque() = 0; virtual int width() = 0; virtual int height() = 0; // ---------------------------------------------------------------------------- // Canvas state operations // ---------------------------------------------------------------------------- // Save (layer) virtual int getSaveCount() const = 0; virtual int save(SkCanvas::SaveFlags flags) = 0; virtual void restore() = 0; virtual void restoreToCount(int saveCount) = 0; virtual int saveLayer(float left, float top, float right, float bottom, const SkPaint* paint, SkCanvas::SaveFlags flags) = 0; virtual int saveLayerAlpha(float left, float top, float right, float bottom, int alpha, SkCanvas::SaveFlags flags) = 0; // Matrix virtual void getMatrix(SkMatrix* outMatrix) const = 0; virtual void setMatrix(const SkMatrix& matrix) = 0; /// Like setMatrix(), but to be translated into local / view-relative coordinates /// rather than executed in global / device coordinates at rendering time. virtual void setLocalMatrix(const SkMatrix& matrix) = 0; virtual void concat(const SkMatrix& matrix) = 0; virtual void rotate(float degrees) = 0; virtual void scale(float sx, float sy) = 0; virtual void skew(float sx, float sy) = 0; virtual void translate(float dx, float dy) = 0; // clip virtual bool getClipBounds(SkRect* outRect) const = 0; virtual bool quickRejectRect(float left, float top, float right, float bottom) const = 0; virtual bool quickRejectPath(const SkPath& path) const = 0; virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op = SkRegion::kIntersect_Op) = 0; virtual bool clipPath(const SkPath* path, SkRegion::Op op) = 0; virtual bool clipRegion(const SkRegion* region, SkRegion::Op op) = 0; // filters virtual SkDrawFilter* getDrawFilter() = 0; virtual void setDrawFilter(SkDrawFilter* drawFilter) = 0; // ---------------------------------------------------------------------------- // Canvas draw operations // ---------------------------------------------------------------------------- virtual void drawColor(int color, SkXfermode::Mode mode) = 0; virtual void drawPaint(const SkPaint& paint) = 0; // Geometry virtual void drawPoint(float x, float y, const SkPaint& paint) = 0; virtual void drawPoints(const float* points, int count, const SkPaint& paint) = 0; virtual void drawLine(float startX, float startY, float stopX, float stopY, const SkPaint& paint) = 0; virtual void drawLines(const float* points, int count, const SkPaint& paint) = 0; virtual void drawRect(float left, float top, float right, float bottom, const SkPaint& paint) = 0; virtual void drawRoundRect(float left, float top, float right, float bottom, float rx, float ry, const SkPaint& paint) = 0; virtual void drawCircle(float x, float y, float radius, const SkPaint& paint) = 0; virtual void drawOval(float left, float top, float right, float bottom, const SkPaint& paint) = 0; virtual void drawArc(float left, float top, float right, float bottom, float startAngle, float sweepAngle, bool useCenter, const SkPaint& paint) = 0; virtual void drawPath(const SkPath& path, const SkPaint& paint) = 0; virtual void drawVertices(SkCanvas::VertexMode vertexMode, int vertexCount, const float* verts, const float* tex, const int* colors, const uint16_t* indices, int indexCount, const SkPaint& paint) = 0; // Bitmap-based virtual void drawBitmap(const SkBitmap& bitmap, float left, float top, const SkPaint* paint) = 0; virtual void drawBitmap(const SkBitmap& bitmap, const SkMatrix& matrix, const SkPaint* paint) = 0; virtual void drawBitmap(const SkBitmap& bitmap, float srcLeft, float srcTop, float srcRight, float srcBottom, float dstLeft, float dstTop, float dstRight, float dstBottom, const SkPaint* paint) = 0; virtual void drawBitmapMesh(const SkBitmap& bitmap, int meshWidth, int meshHeight, const float* vertices, const int* colors, const SkPaint* paint) = 0; // Text /** * drawText: count is of glyphs * totalAdvance is ignored in software renderering, used by hardware renderer for * text decorations (underlines, strikethroughs). */ virtual void drawText(const uint16_t* glyphs, const float* positions, int count, const SkPaint& paint, float x, float y, float boundsLeft, float boundsTop, float boundsRight, float boundsBottom, float totalAdvance) = 0; /** drawPosText: count is of UTF16 characters, posCount is floats (2 * glyphs) */ virtual void drawPosText(const uint16_t* text, const float* positions, int count, int posCount, const SkPaint& paint) = 0; /** drawTextOnPath: count is of glyphs */ virtual void drawTextOnPath(const uint16_t* glyphs, int count, const SkPath& path, float hOffset, float vOffset, const SkPaint& paint) = 0; /** * Specifies if the positions passed to ::drawText are absolute or relative * to the (x,y) value provided. * * If true the (x,y) values are ignored. Otherwise, those (x,y) values need * to be added to each glyph's position to get its absolute position. */ virtual bool drawTextAbsolutePos() const = 0; }; }; // namespace android #endif // ANDROID_GRAPHICS_CANVAS_H