AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
4c2a34e480
skia2/site/user/api/undocumented.md
Cary Clark 2d4bf5f288 document SkColor.h 
SkColor.h uses #define liberally, and has many global symbols,
two things bookmaker hasn't seen in other includes.

Revised .h -> .bmh converter to work with SkColor.h as well
as updating how .bmh indices are built.

Generated SkColor_Reference.bmh for globals, and
SkColor4f_Reference.bmh for class.

Other than the existing comments, this doesn't update the
documentation or add new examples.

Docs-Preview: https://skia.org/?cl=118985
TBR=caryclark@google.com
Bug: skia:6898
Change-Id: I5978257ee0e51319823efbe8dfc467a08c99ffe0
Reviewed-on: https://skia-review.googlesource.com/118985
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
2018-04-16 16:26:20 +00:00

22 KiB
Raw Blame History

undocumented

Alias

Anti-alias

Arc

BBH Factory

Class SkBBHFactory

Backend Semaphore

Class GrBackendSemaphore

Blend Mode

Enum SkBlendMode

Constants

Circle

Clip Op

Enum SkClipOp

Constants

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

Color Filter

Class SkColorFilter

toString

void toString(SkString* str) const

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

SkClipOp::kDifference 0
SkClipOp::kIntersect 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

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)

Encoded Image Format

Enum SkEncodedImageFormat

Constants

SkTransferFunctionBehavior::kRespect 0
SkTransferFunctionBehavior::kIgnore 1

Filter Quality

Enum SkFilterQuality

Constants

SkEncodedImageFormat::kUnknown 0
SkEncodedImageFormat::kBMP 1
SkEncodedImageFormat::kGIF 2
SkEncodedImageFormat::kICO 3
SkEncodedImageFormat::kJPEG 4
SkEncodedImageFormat::kPNG 5
SkEncodedImageFormat::kWBMP 6
SkEncodedImageFormat::kWEBP 7
SkEncodedImageFormat::kPKM 8
SkEncodedImageFormat::kKTX 9
SkEncodedImageFormat::kASTC 10
SkEncodedImageFormat::kDNG 11
SkEncodedImageFormat::kHEIF 12

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 Filter

Scaling

Class SkImageFilter

toString

void toString(SkString* str) 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 Alpha

Mask Filter

Class SkMaskFilter

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

kNone_SkFilterQuality 0
kLow_SkFilterQuality 1
kMedium_SkFilterQuality 2
kHigh_SkFilterQuality 3
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
SK_MaxSizeT to be written

OS X

Oval

Paint Defaults

Constants

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

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

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

Shader

Class SkShader

Enum SkShader::TileMode

Constants

SkPaintDefaults_Flags 0
SkPaintDefaults_Hinting 2
SkPaintDefaults_TextSize 12
SkPaintDefaults_MiterLimit 4

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

SkShader::kClamp_TileMode 0
SkShader::kRepeat_TileMode 1
SkShader::kMirror_TileMode 2

Topic

Text

Text Blob

Class SkTextBlob

Texture

Class GrBackendTexture

isValid

bool isValid() const

Transfer Mode

Typeface

Class SkTypeface

Types

Enum GrSurfaceOrigin

Constants

SkSurfaceProps::kLegacyFontHost_InitType 0

Budgeted

Enum SkBudgeted

Constants

kBottomLeft_GrSurfaceOrigin 0
kTopLeft_GrSurfaceOrigin 1

Enum GrSemaphoresSubmitted

Constants

SkBudgeted::kNo 0
SkBudgeted::kYes 1

Unpremultiply

Vertices

Colors

Texs

Write Buffer

Struct SkWriteBuffer

GrSemaphoresSubmitted::kNo 0
GrSemaphoresSubmitted::kYes 1