skia2/site/user/api/undocumented.md
Cary Clark 61313f38e1 Generate bookmaker indices
First cut at splitting bookmaker documentation into reference
and overview. Reference starts with a hyperlinked index,
generated from a public include.

This moves towards typing once, minimizing the information
duplicated in the .h file and the .bmh file.

TBR=caryclark@google.com
Docs-Preview: https://skia.org/?cl=154630
Change-Id: I836622db9b1786bd28c0bce2536cd3caef6e5a32
Reviewed-on: https://skia-review.googlesource.com/c/154630
Commit-Queue: Cary Clark <caryclark@skia.org>
Auto-Submit: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-10-08 19:24:31 +00:00

15 KiB

undocumented

Enum SkClipOp

Constants

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

MakeSRGBLinear

static sk sp<SkColorSpace> MakeSRGBLinear()

gammaCloseToSRGB

bool gammaCloseToSRGB() const

Equals

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

SkCreateColorSpaceXformCanvas

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

SkDebugf

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

Recorder

beginPage

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

PDF

draw

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

Enum SkFilterQuality

Constants

Const Value Description
kNone_SkFilterQuality 0
kLow_SkFilterQuality 1
kMedium_SkFilterQuality 2
kHigh_SkFilterQuality 3

Nearest Neighbor

Bilerp

MipMap

BiCubic

Advance

Engine

flush

void flush()

ID

ArcTo

Constants

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)

beginRecording

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

Storage

width

int width() const

height

int height() const

isImmutable

bool isImmutable() const

setImmutable

void setImmutable()

Arct

Typedef SkRasterHandleAllocator::Handle

MakeCanvas

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

isValid

bool isValid() const

Canvas

Arc

Typedef SkScalar

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)

Legacy Font Host

Enum SkSurfaceProps::InitType

Constants

Const Value Description
SkSurfaceProps::kLegacyFontHost_InitType 0

Topic

isValid

bool isValid() const

ID

Typedef SkFontID

uniqueID

SkFontID uniqueID() const

Colors

Texs