skia2/site/user/api/undocumented.md
Cary Clark 80247e594d Publish docs for rrect, picture, blendmode
Complete basic docs for SkRRect, SkPicture, SkBlendMode.
Add a new rule that checks the main description tense.
Check for spelling errors.

R=caryclark@google.com

Docs-Preview: https://skia.org/?cl=138542
Bug: skia:6898
Change-Id: Iba547873775a89f1d652be9b0219b84ffa8d0628
Reviewed-on: https://skia-review.googlesource.com/138542
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
2018-07-11 21:21:28 +00:00

21 KiB

undocumented

Alias

Arc

BBH Factory

Class SkBBHFactory

Backend Semaphore

Class GrBackendSemaphore

Bezier Curve

Big Endian

Cartesian Coordinate

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

Coons Patch

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

Deserial Procs

Struct SkDeserialProcs

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)

Euclidean Distance

Euclidean Space

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 Share Group

GPU Surface

GPU Texture

Glyph

Grayscale

HTML Aqua

HTML Canvas

ArcTo

HTML Fuchsia

HTML Gray

HTML Green

HTML Lime

HTML Silver

ISize

Struct SkISize

Image Filter

Class SkImageFilter

Image Scaling

Kerning

Left Side Bearing

Line

Little Endian

Mask Alpha

Mask Filter

Class SkMaskFilter

Meta Data

Class SkMetaData

Mip Map

Multi Sample Anti Aliasing

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 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

SVG

Canvas

Arc

SVG darkgray

SVG lightgray

Scalar

Typedef SkScalar

Serial Procs

Struct SkSerialProcs

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)

MakeCompose

static sk sp<SkShader> MakeCompose(sk sp<SkShader> dst, sk sp<SkShader> src, SkBlendMode mode,
                                   float lerp = 1)

Size

Struct SkSize

Sprite

Stream

Class SkStream

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

UV Mapping

Unhinted

Unpremultiply

Vertices

Class SkVertices

Colors

Texs

WStream

Class SkWStream

Xfermode Image Filter

Class SkXfermodeImageFilter

YUV Component U

YUV Component V

YUV Component Y