skia2/site/user/api/undocumented.md
Cary Clark 27dddae313 rebase
This reverts commit 32a4910e57.

Reason for revert: SkMatrix::toString use has been removed from flutter
and has been picked up in fuchsia

Additionally some bookmaker changes take into account recent
additions of typedef comments and the generated header comment.

Original change's description:
> Revert "remove toString"
>
> This reverts commit 5191880cbf.
>
> Reason for revert: broke flutter
>
> Original change's description:
> > remove toString
> >
> > toString may have been used by obsolete debugger only
> > find out if that is so
> >
> > R=​brianosman@google.com,bsalomon@google.com
> >
> > Docs-Preview: https://skia.org/?cl=119894
> > Bug:830651
> > Change-Id: I737f19b7d3fbc869bea2f443fa3b5ed7c1393ffd
> > Reviewed-on: https://skia-review.googlesource.com/119894
> > Commit-Queue: Cary Clark <caryclark@google.com>
> > Reviewed-by: Brian Salomon <bsalomon@google.com>
>
> TBR=bsalomon@google.com,brianosman@google.com,caryclark@google.com,caryclark@skia.org
>
> Change-Id: I9f81de6c3615ee0608bcea9081b77239b4b8816c

TBR=bsalomon@google.com,brianosman@google.com

# Not skipping CQ checks because original CL landed > 1 day ago.

Reviewed-on: https://skia-review.googlesource.com/129623
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@google.com>
Docs-Preview: https://skia.org/?cl=133583
Bug: 830651
Change-Id: If8499e796be63580ad419e150e94d43e8b89de1b
Reviewed-on: https://skia-review.googlesource.com/133583
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-06-08 20:36:53 +00:00

22 KiB

undocumented

Alias

Arc

BBH Factory

Class SkBBHFactory

Backend Semaphore

Class GrBackendSemaphore

Blend Mode

Enum SkBlendMode

Constants

Const Value Description
SkBlendMode::kSrc 1
SkBlendMode::kSrcOver 3
SkBlendMode::kPlus 12

Circle

Clip Op

Enum SkClipOp

Constants

Const Value Description
SkClipOp::kDifference 0
SkClipOp::kIntersect 1

Color Filter

Class SkColorFilter

Color Space

Class SkColorSpace

MakeSRGBLinear

static sk sp<SkColorSpace> MakeSRGBLinear()

gammaCloseToSRGB

bool gammaCloseToSRGB() const

Equals

static bool Equals(const SkColorSpace* src, const SkColorSpace* dst)

Enum SkTransferFunctionBehavior

Constants

Const Value Description
SkTransferFunctionBehavior::kRespect 0
SkTransferFunctionBehavior::kIgnore 1

Core Graphics

Core Text

Create Color Space Xform Canvas

SkCreateColorSpaceXformCanvas

std::unique_ptr<SkCanvas> SK_API SkCreateColorSpaceXformCanvas(SkCanvas* target,
                                                     sk sp<SkColorSpace> targetCS)

Curve

Data

Class SkData

Debug Canvas

Class SkDebugCanvas

Debugging

SkDebugf

SK_API void SkDebugf(const char format[], ...)

Deferred Display List

Class SkDeferredDisplayList

Recorder

Class SkDeferredDisplayListRecorder

Descenders

Destructor

Device

Class SkBaseDevice

Document

Class SkDocument

beginPage

SkCanvas* beginPage(SkScalar width, SkScalar height, const SkRect* content = NULL)

PDF

Draw Filter

Class SkDrawFilter

Draw Layer

Draw Looper

Class SkDrawLooper

Drawable

Class SkDrawable

draw

void draw(SkCanvas*, const SkMatrix* = NULL)

Filter Quality

Enum SkFilterQuality

Constants

Const Value Description
kNone_SkFilterQuality 0
kLow_SkFilterQuality 1
kMedium_SkFilterQuality 2
kHigh_SkFilterQuality 3

Nearest Neighbor

Bilerp

MipMap

BiCubic

Font

Advance

Engine

Font Manager

GPU Context

Class GrContext

flush

void flush()

GPU Surface

GPU Texture

Glyph

Grayscale

HTML Canvas

ArcTo

ISize

Struct SkISize

Image Filter

Class SkImageFilter

Image Scaling

Kerning

Left Side Bearing

Line

Mask Alpha

Mask Filter

Class SkMaskFilter

Meta Data

Class SkMetaData

Mip Map

Nine Patch

OS X

Oval

Paint Defaults

Constants

Patch

PathOps

Enum SkPathOp

Const Value Description
SkPaintDefaults_Flags 0
SkPaintDefaults_Hinting 2
SkPaintDefaults_TextSize 12
SkPaintDefaults_MiterLimit 4

Op

bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result)

Path Effect

Class SkPathEffect

Picture

Class SkPicture

playback

virtual void playback(SkCanvas*, AbortCallback* = nullptr) const = 0

Recorder

Class SkPictureRecorder

beginRecording

SkCanvas* beginRecording(const SkRect& bounds, SkBBHFactory* bbhFactory = NULL,
                         uint32_t recordFlags = 0)

Pixel

Storage

Pixel Ref

Class SkPixelRef

width

int width() const

height

int height() const

isImmutable

bool isImmutable() const

setImmutable

void setImmutable()

Point3

Struct SkPoint3

PostScript

Arct

Premultiply

RSXform

Struct SkRSXform

Raster Bitmap

Raster Engine

Raster Handle Allocator

Class SkRasterHandleAllocator

Typedef SkRasterHandleAllocator::Handle

Struct SkRasterHandleAllocator::Rec

MakeCanvas

static std::unique_ptr<SkCanvas> MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>,
                                            const SkImageInfo&, const Rec* rec = nullptr)

Raster Surface

Reference Count

Class SkRefCnt

Class sk_sp

Region

Class SkRegion

RenderTarget

Class GrBackendRenderTarget

isValid

bool isValid() const

Render Target

Class GrRenderTarget

Right Side Bearing

Round Rect

Class SkRRect

dump

void dump() const

dumpHex

void dumpHex() const

SVG

Canvas

Arc

Scalar

Typedef SkScalar

Shader

Class SkShader

Enum SkShader::TileMode

Constants

Const Value Description
SkShader::kClamp_TileMode 0
SkShader::kRepeat_TileMode 1
SkShader::kMirror_TileMode 2

MakeBitmapShader

static sk sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx, TileMode tmy,
                                        const SkMatrix* localMatrix = nullptr)

Size

Struct SkSize

Sprite

Stream

Class SkWStream

String

Class SkString

Subclasses

Supersampling

Surface Characterization

Class SkSurfaceCharacterization

Surface Properties

Class SkSurfaceProps

Legacy Font Host

Enum SkSurfaceProps::InitType

Constants

Const Value Description
SkSurfaceProps::kLegacyFontHost_InitType 0

Topic

Text

Text Blob

Class SkTextBlob

Texture

Class GrBackendTexture

isValid

bool isValid() const

Transfer Mode

Typeface

Class SkTypeface

Unhinted

Unpremultiply

Vertices

Class SkVertices

Colors

Texs