skia2/site/user/api/undocumented.md
Cary Clark d0530ba8f4 wip pixmap docs
wip pixmap docs

Docs-Preview: https://skia.org/?cl=42522
Bug: skia: 6898
Change-Id: I85947bc36ea057ed008b87d7bef2efa82d7c89ad
Reviewed-on: https://skia-review.googlesource.com/42522
Reviewed-by: Cary Clark <caryclark@skia.org>
Commit-Queue: Cary Clark <caryclark@skia.org>
2017-09-14 16:05:21 +00:00

20 KiB

undocumented

Glyph

Curve

Document

Class SkDocument

beginPage

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

PDF

Arc

Rect

Struct SkRect

MakeEmpty

static constexpr SkRect SK_WARN_UNUSED_RESULT MakeEmpty()

dump

void dump() const

dumpHex

void dumpHex() const

Line

Region

Class SkRegion

Device

Class SkBaseDevice

Vector

Struct SkVector

Point

Struct SkPoint

equalsWithinTolerance

bool equalsWithinTolerance(const SkPoint& p) const

Array

Patch

Typeface

Class SkTypeface

Dump Canvas

Class SkDumpCanvas

HTML Canvas

ArcTo

Alias

Anti-alias

BBH Factory

Class SkBBHFactory

Bitmap

Class SkBitmap

Row Bytes

erase

void erase(SkColor c, const SkIRect& area) const

installPixels

bool installPixels(const SkImageInfo& info, void* pixels, size_t rowBytes)

readPixels

bool readPixels(const SkImageInfo& dstInfo, void* dstPixels, size_t dstRowBytes,
                int srcX, int srcY, SkTransferFunctionBehavior behavior) const

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

Color Space

Class SkColorSpace

MakeSRGBLinear

static sk_sp MakeSRGBLinear()

Enum SkTransferFunctionBehavior

Constants

SkTransferFunctionBehavior::kRespect 0
SkTransferFunctionBehavior::kIgnore 1

Core Graphics

Core Text

Data

Draw Filter

Class SkDrawFilter

Draw Layer

Draw Looper

Class SkDrawLooper

Drawable

Class SkDrawable

draw

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

Raster Handle Allocator

Class SkRasterHandleAllocator

Struct SkRasterHandleAllocator::Rec

MakeCanvas

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

Filter Quality

Enum SkFilterQuality

Constants

kNone_SkFilterQuality 0
kLow_SkFilterQuality 1
kMedium_SkFilterQuality 2
kHigh_SkFilterQuality 3

Nearest Neighbor

Bilerp

MipMap

BiCubic

Left Side Bearing

Font

Advance

Engine

Oval

Font Manager

GPU Context

GPU Surface

Image

Alpha Type

Enum SkAlphaType

Constants

kUnknown_SkAlphaType 0
kOpaque_SkAlphaType 1
kPremul_SkAlphaType 2
kUnpremul_SkAlphaType 3

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

Info

Struct SkImageInfo

SkImageInfo

SkImageInfo()

makeColorSpace

SkImageInfo makeColorSpace(sk_sp cs) const

minRowBytes

size_t minRowBytes() const

isOpaque

bool isOpaque() const

bytesPerPixel

int bytesPerPixel() const

Class SkImage

makeShader

sk_sp makeShader(SkShader::TileMode, SkShader::TileMode,
                           const SkMatrix* localMatrix = nullptr) const

MakeRasterCopy

static sk_sp MakeRasterCopy(const SkPixmap&)

readPixels

bool readPixels(const SkPixmap& dst, int srcX, int srcY,
                CachingHint = kAllow_CachingHint) const

scalePixels

bool scalePixels(const SkPixmap& dst, SkFilterQuality,
                 CachingHint = kAllow_CachingHint) const

Image Filter

Scaling

Class SkImageFilter

Image Scaling

IRect

Struct SkIRect

intersect

bool intersect(const SkIRect& r)

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

Math

sk_64_isS32

static inline bool sk_64_isS32(int64_t value)

Matrix

Struct SkMatrix

Nine Patch

Number Types

Constants

SK_ScalarMax to be written
SK_ScalarInfinity to be written
SK_ScalarNegativeInfinity to be written
SK_ScalarNaN to be written

OS X

Paint Defaults

Constants

SkPaintDefaults_Flags 0
SkPaintDefaults_Hinting 2
SkPaintDefaults_TextSize 12
SkPaintDefaults_MiterLimit 4

Path Effect

Class SkPathEffect

Path Measure

Class SkPathMeasure

dump

void dump() const

PathOps

Op

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

Picture

Recorder

Class SkPictureRecorder

beginRecording

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

Pixel

Storage

PixelRef

Class SkPixelRef

PostScript

Arct

Premultiply

Raster Engine

Raster Surface

Rasterizer

Class SkRasterizer

Layer

Reference Count

Class sk_sp

Right Side Bearing

Round Rect

Class SkRRect

dump

void dump() const

dumpHex

void dumpHex() const

RSXform

Struct SkRSXform

Shader

Class SkShader

Enum SkShader::TileMode

Constants

SkShader::kClamp_TileMode 0

MakeBitmapShader

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

Gradient

Sprite

Stream

Class SkFlattenable

String

Class SkString

Supersampling

Surface

Class SkSurface

MakeRasterDirect

static sk_sp MakeRasterDirect(const SkImageInfo&, void* pixels,
                                         size_t rowBytes,
                                         const SkSurfaceProps* = nullptr)

readPixels

bool readPixels(const SkPixmap& dst, int srcX, int srcY) ;

Properties

Class SkSurfaceProps

Legacy Font Host

Enum SkSurfaceProps::InitType

Constants

SkSurfaceProps::kLegacyFontHost_InitType 0

SVG

Canvas

Arc

Text

Text Blob

Class SkTextBlob

Unpremultiply

Vertices

Colors

Texs

Read Buffer

Struct SkReadBuffer

Write Buffer

Struct SkWriteBuffer