skia2/site/user/api/undocumented.md
Cary Clark 61ca7c56bd update image doc and minor bookmaker fixes
image doc is still a work in progress.
Update online version to latest; updating
include header is still a ways off.

Remove SkPaint::flatten() example since
parameter is not publicly accessible.

Minor changes to fix typedef and std::function
references.

TBR=rmistry@google.com
Docs-Preview: https://skia.org/?cl=87120
Bug: skia:6898
Change-Id: I3553bc5fca97c5997aa61ea034b5ca10cb10df75
Reviewed-on: https://skia-review.googlesource.com/87120
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
2018-01-02 17:00:40 +00:00

26 KiB

undocumented

Alias

Anti-alias

Arc

BBH Factory

Class SkBBHFactory

Backend Semaphore

Class GrBackendSemaphore

Blend Mode

Enum SkBlendMode

Constants

SkBlendMode::kSrc 1
SkBlendMode::kSrcOver 3
SkBlendMode::kPlus 12

Circle

Clip Op

Enum SkClipOp

Constants

SkClipOp::kDifference 0
SkClipOp::kIntersect 1

Color

SkColorGetA

int SkColorGetA(color)

SkColorGetR

int SkColorGetR(color)

SkColorGetG

int SkColorGetG(color)

SkColorGetB

int SkColorGetB(color)

SkColorSetARGB

int SkColorSetARGB(a, r, g, b)

Constants

SK_ColorBLACK 0xFF000000
SK_ColorBLUE 0xFF0000FF
SK_ColorGREEN 0xFF00FF00
SK_ColorRED 0xFFFF0000
SK_ColorWHITE 0xFFFFFFFF

Alpha

RGB

Red

Blue

Green

ARGB

RBG

RGB-565

Color Filter

Class SkColorFilter

toString

void toString(SkString* str) const

Color Space

Class SkColorSpace

MakeSRGBLinear

static sk_sp<SkColorSpace> MakeSRGBLinear()

Enum SkTransferFunctionBehavior

Constants

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

Debugging

SkDebugf

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

Deferred Display List

Class SkDeferredDisplayList

Recorder

Class SkDeferredDisplayListRecorder

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)

Dump Canvas

Class SkDumpCanvas

Filter Quality

Enum SkFilterQuality

Constants

kNone_SkFilterQuality 0
kLow_SkFilterQuality 1
kMedium_SkFilterQuality 2
kHigh_SkFilterQuality 3

Nearest Neighbor

Bilerp

MipMap

BiCubic

Font

Advance

Engine

Font Manager

GPU Context

Resource Cache Limits

Class GrContext

flush

void flush()

GPU Surface

GPU Texture

Glyph

HTML Canvas

ArcTo

ISize

Struct SkISize

Image Alpha Type

Enum SkAlphaType

Constants

kUnknown_SkAlphaType 0
kOpaque_SkAlphaType 1
kPremul_SkAlphaType 2
kUnpremul_SkAlphaType 3

Image Color Type

Native Color Type

Enum SkColorType

Constants

kUnknown_SkColorType 0
kAlpha_8_SkColorType 1
kRGB_565_SkColorType 2
kARGB_4444_SkColorType 3
kRGBA_8888_SkColorType 4
kBGRA_8888_SkColorType 5
kIndex_8_SkColorType 6
kGray_8_SkColorType 7
kRGBA_F16_SkColorType 8

Constants

kN32_SkColorType 4

Image Filter

Scaling

Class SkImageFilter

toString

void toString(SkString* str) const

Image Info

Struct SkImageInfo

SkImageInfo

SkImageInfo()

MakeN32Premul

static SkImageInfo MakeN32Premul(int width, int height, sk_sp<SkColorSpace> cs = nullptr)

makeColorSpace

SkImageInfo makeColorSpace(sk_sp<SkColorSpace> cs) const

minRowBytes

size_t minRowBytes() const

isOpaque

bool isOpaque() const

bytesPerPixel

int bytesPerPixel() const

height

int height() const

width

int width() const

colorType

SkColorType colorType() const

alphaType

SkAlphaType alphaType() const

colorSpace

SkColorSpace* colorSpace() const

bool isOpaque() const

size_t minRowBytes() const

computeByteSize

size_t computeByteSize(size_t rowBytes) const

validate

void validate() const

Image Scaling

Left Side Bearing

Line

Malloc Pixel Ref

Class SkMallocPixelRef

MakeZeroed

static sk_sp<SkPixelRef> MakeZeroed(const SkImageInfo&, size_t rowBytes)

MakeAllocate

static sk_sp<SkPixelRef> MakeAllocate(const SkImageInfo&, size_t rowBytes)

Mask

Class SkMask

Enum SkMask::Format

Constants

k
SkMask::kBW_Format 0
SkMask::kA8_Format 1
SkMask::k3D_Format 2
SkMask::kARGB32_Format 3
SkMask::LCD16_Format 4

Mask Alpha

Mask Filter

Class SkMaskFilter

filterMask

virtual bool filterMask(SkMask* dst, const SkMask& src, const SkMatrix&, SkIPoint* margin) const

toString

void toString(SkString* str) const

Math

sk_64_isS32

static inline bool sk_64_isS32(int64_t value)

SkIntToScalar

SkIntToScalar(x)

SkScalarRoundToInt

SkScalarRoundToInt(x)

SkScalarFloorToInt

SkScalarFloorToInt(x)

SkScalarCeilToInt

SkScalarCeilToInt(x)

SkScalarFloorToScalar

SkScalarFloorToScalar(x)

SkScalarCeilToScalar

SkScalarCeilToScalar(x)

SkScalarIsFinite

SkScalarIsFinite(x)

SkScalarIsNaN

SkScalarIsNaN(x)

SkTFitsIn

template <typename D, typename S> inline bool SkTFitsIn(S s)

Meta Data

Class SkMetaData

Mip Map

Nine Patch

Number Types

Scalar

Constants

SK_MinS32FitsInFloat to be written
SK_MaxS32FitsInFloat to be written
SK_ScalarMin to be written
SK_ScalarMax to be written
SK_ScalarInfinity to be written
SK_ScalarNegativeInfinity to be written
SK_ScalarNaN to be written
SK_MinS32 to be written
SK_MaxS32 to be written

OS X

Oval

Paint Defaults

Constants

SkPaintDefaults_Flags 0
SkPaintDefaults_Hinting 2
SkPaintDefaults_TextSize 12
SkPaintDefaults_MiterLimit 4

Patch

PathOps

Op

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

Path Effect

Class SkPathEffect

toString

void toString(SkString* str) const

Path Measure

Class SkPathMeasure

dump

void dump() const

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

Pixel Serializer

Class SkPixelSerializer

Point3

Struct SkPoint3

PostScript

Arct

Premultiply

RSXform

Struct SkRSXform

Raster Bitmap

Raster Engine

Raster Handle Allocator

Class SkRasterHandleAllocator

Struct SkRasterHandleAllocator::Rec

MakeCanvas

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

Raster Surface

Rasterizer

Class SkRasterizer

Layer

Read Buffer

Struct SkReadBuffer

Reference Count

Class SkRefCnt

Class sk_sp

Region

Class SkRegion

Render Target

Class GrRenderTarget

Right Side Bearing

Round Rect

Class SkRRect

dump

void dump() const

dumpHex

void dumpHex() const

SVG

Canvas

Arc

Shader

Class SkShader

Enum SkShader::TileMode

Constants

SkShader::kClamp_TileMode 0

MakeBitmapShader

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

Gradient

Size

Struct SkSize

Sprite

Stream

Class SkStream

String

Class SkString

Supersampling

Surface Characterization

Class SkSurfaceCharacterization

Surface Properties

Class SkSurfaceProps

Legacy Font Host

Enum SkSurfaceProps::InitType

Constants

SkSurfaceProps::kLegacyFontHost_InitType 0

Text

Text Blob

Class SkTextBlob

Texture

Class GrBackendTexture

Typeface

Class SkTypeface

Types

Enum GrSurfaceOrigin

Constants

kBottomLeft_GrSurfaceOrigin 0
kTopLeft_GrSurfaceOrigin 1

Budgeted

Enum SkBudgeted

Constants

SkBudgeted::kNo 0
SkBudgeted::kYes 1

Enum GrSemaphoresSubmitted

Constants

GrSemaphoresSubmitted::kNo 0
GrSemaphoresSubmitted::kYes 1

Unpremultiply

Vertices

Colors

Texs

Write Buffer

Struct SkWriteBuffer