bookmaker generated site docs
The documents were generated by running tools/bookmaker against docs/*.bmh No-Try: true Docs-Preview: https://skia.org/?cl=28002 Change-Id: I7d7dd73cdea4a234c6175646d5b8938e1af3117a Reviewed-on: https://skia-review.googlesource.com/28002 Reviewed-by: Cary Clark <caryclark@skia.org> Commit-Queue: Cary Clark <caryclark@skia.org>
This commit is contained in:
Cary Clark
Skia Commit-Bot
parent
293d9bd3c2
commit
12799e17d5
@ -1,4 +1,5 @@
|
||||
#Topic Canvas
|
||||
#Alias Canvas_Reference
|
||||
|
||||
Canvas provides an interface for drawing, and how the drawing is clipped and transformed.
|
||||
Canvas contains a stack of Matrix and Clip values.
|
||||
@ -1,4 +1,5 @@
|
||||
#Topic Paint
|
||||
#Alias Paint_Reference
|
||||
|
||||
Paint controls options applied when drawing and measuring. Paint collects all
|
||||
options outside of the Canvas_Clip and Canvas_Matrix.
|
||||
@ -1,4 +1,5 @@
|
||||
#Topic Path
|
||||
#Alias Path_Reference
|
||||
#Alias Paths
|
||||
|
||||
Path contains Lines and Curves which can be stroked or filled. Contour is
|
||||
@ -1,3 +1,3 @@
|
||||
{
|
||||
"fileOrder": ["skcanvas", "skpaint", "skrect", "skregion", "skmatrix", "grcontext", "canvas"]
|
||||
"fileOrder": ["skcanvas_overview", "skpaint_overview", "skrect_overview", "skregion_overview", "skmatrix_overview", "creating_skcanvas", "SkCanvas_Reference", "SkPaint_Reference", "SkPath_Reference", "usingBookmaker"]
|
||||
}
|
||||
|
||||
4911
site/user/api/SkCanvas_Reference.md
Normal file
4911
site/user/api/SkCanvas_Reference.md
Normal file
File diff suppressed because it is too large
Load Diff
5190
site/user/api/SkPaint_Reference.md
Normal file
5190
site/user/api/SkPaint_Reference.md
Normal file
File diff suppressed because it is too large
Load Diff
4975
site/user/api/SkPath_Reference.md
Normal file
4975
site/user/api/SkPath_Reference.md
Normal file
File diff suppressed because it is too large
Load Diff
@ -24,14 +24,17 @@ attributes of the drawing are controlled by the paint.
|
||||
|
||||
Using the SkCanvas API:
|
||||
|
||||
1. **[SkCanvas](/user/api/skcanvas)** - the drawing context.
|
||||
2. **[SkPaint](/user/api/skpaint)** - color, stroke, font, effects
|
||||
3. **[SkRect](/user/api/skrect)** - rectangles
|
||||
4. **[SkRegion](/user/api/skregion)** - set operations with rectangles and paths
|
||||
1. **[SkCanvas Overview](/user/api/skcanvas_overview)** - the drawing context.
|
||||
2. **[Creating SkCanvas Objects](/user/api/creating_skcanvas)**
|
||||
3. **[SkPaint Overview](/user/api/skpaint_overview)** - color, stroke, font, effects
|
||||
4. **[SkRect Overview](/user/api/skrect_overview)** - rectangles
|
||||
5. **[SkRegion Overview](/user/api/skregion_overview)** - set operations with rectangles and paths
|
||||
|
||||
Appendix:
|
||||
Reference:
|
||||
|
||||
1. **[Creating SkCanvas Objects](/user/api/canvas)**
|
||||
1. **[SkCanvas Reference](/user/api/SkCanvas_Reference)** - the drawing context.
|
||||
2. **[SkPaint Reference](/user/api/SkPaint_Reference)** - color, stroke, font, effects
|
||||
3. **[SkPath Reference](/user/api/SkPath_Reference)** - paths
|
||||
|
||||
Autogenerated Doxygen Documentaion
|
||||
----------------------------------
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
SkCanvas
|
||||
SkCanvas Overview
|
||||
========
|
||||
|
||||
*The drawing context*
|
||||
@ -1,4 +1,4 @@
|
||||
SkMatrix
|
||||
SkMatrix Overview
|
||||
========
|
||||
|
||||
*3x3 transforms*
|
||||
@ -1,4 +1,4 @@
|
||||
SkPaint
|
||||
SkPaint Overview
|
||||
=======
|
||||
<span id="top"></span>
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
SkRect
|
||||
SkRect Overview
|
||||
======
|
||||
|
||||
*Rectangles*
|
||||
@ -1,4 +1,4 @@
|
||||
SkRegion
|
||||
SkRegion Overview
|
||||
========
|
||||
|
||||
*Regions - set operations with rectangles*
|
||||
638
site/user/api/undocumented.md
Normal file
638
site/user/api/undocumented.md
Normal file
@ -0,0 +1,638 @@
|
||||
(to be documented)
|
||||
===
|
||||
|
||||
# <a name="Glyph"></a> Glyph
|
||||
|
||||
# <a name="Curve"></a> Curve
|
||||
|
||||
# <a name="Document"></a> Document
|
||||
|
||||
# <a name="SkDocument"></a> Class SkDocument
|
||||
|
||||
<a name="beginPage"></a>
|
||||
## beginPage
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
SkCanvas* beginPage(SkScalar width, SkScalar height,
|
||||
const SkRect* content = NULL)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
## <a name="PDF"></a> PDF
|
||||
|
||||
# <a name="Arc"></a> Arc
|
||||
|
||||
# <a name="Rect"></a> Rect
|
||||
|
||||
# <a name="SkRect"></a> Struct SkRect
|
||||
|
||||
<a name="MakeEmpty"></a>
|
||||
## MakeEmpty
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
static constexpr SkRect SK_WARN_UNUSED_RESULT MakeEmpty()
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="dump"></a>
|
||||
## dump
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void dump() const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="dumpHex"></a>
|
||||
## dumpHex
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void dumpHex() const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Line"></a> Line
|
||||
|
||||
# <a name="Region"></a> Region
|
||||
|
||||
# <a name="SkRegion"></a> Class SkRegion
|
||||
|
||||
# <a name="Device"></a> Device
|
||||
|
||||
# <a name="SkBaseDevice"></a> Class SkBaseDevice
|
||||
|
||||
# <a name="Vector"></a> Vector
|
||||
|
||||
# <a name="SkVector"></a> Struct SkVector
|
||||
|
||||
# <a name="Point"></a> Point
|
||||
|
||||
# <a name="SkPoint"></a> Struct SkPoint
|
||||
|
||||
<a name="equalsWithinTolerance"></a>
|
||||
## equalsWithinTolerance
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
bool equalsWithinTolerance(const SkPoint& p) const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
## <a name="Array"></a> Array
|
||||
|
||||
# <a name="Patch"></a> Patch
|
||||
|
||||
# <a name="Typeface"></a> Typeface
|
||||
|
||||
# <a name="SkTypeface"></a> Class SkTypeface
|
||||
|
||||
# <a name="Dump_Canvas"></a> Dump Canvas
|
||||
|
||||
# <a name="SkDumpCanvas"></a> Class SkDumpCanvas
|
||||
|
||||
# <a name="BBH_Factory"></a> BBH Factory
|
||||
|
||||
# <a name="SkBBHFactory"></a> Class SkBBHFactory
|
||||
|
||||
# <a name="Bitmap"></a> Bitmap
|
||||
|
||||
# <a name="SkBitmap"></a> Class SkBitmap
|
||||
|
||||
## <a name="Row_Bytes"></a> Row Bytes
|
||||
|
||||
# <a name="Blend_Mode"></a> Blend Mode
|
||||
|
||||
## <a name="SkBlendMode"></a> Enum SkBlendMode
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SkBlendMode::kSrc"></a> <code><strong>SkBlendMode::kSrc </strong></code></td><td>1</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkBlendMode::kSrcOver"></a> <code><strong>SkBlendMode::kSrcOver </strong></code></td><td>3</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkBlendMode::kPlus"></a> <code><strong>SkBlendMode::kPlus </strong></code></td><td>12</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
# <a name="Circle"></a> Circle
|
||||
|
||||
# <a name="Clip_Op"></a> Clip Op
|
||||
|
||||
## <a name="SkClipOp"></a> Enum SkClipOp
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SkClipOp::kDifference"></a> <code><strong>SkClipOp::kDifference </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkClipOp::kIntersect"></a> <code><strong>SkClipOp::kIntersect </strong></code></td><td>1</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
# <a name="Color"></a> Color
|
||||
|
||||
<a name="SkColorGetA"></a>
|
||||
## SkColorGetA
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
int SkColorGetA(color)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="SkColorGetR"></a>
|
||||
## SkColorGetR
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
int SkColorGetR(color)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="SkColorGetG"></a>
|
||||
## SkColorGetG
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
int SkColorGetG(color)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="SkColorGetB"></a>
|
||||
## SkColorGetB
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
int SkColorGetB(color)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="SkColorSetARGB"></a>
|
||||
## SkColorSetARGB
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
int SkColorSetARGB(a, r, g, b)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SK_ColorBLACK"></a> <code><strong>SK_ColorBLACK </strong></code></td><td>0xFF000000 </td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ColorBLUE"></a> <code><strong>SK_ColorBLUE </strong></code></td><td>0xFF0000FF </td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ColorGREEN"></a> <code><strong>SK_ColorGREEN </strong></code></td><td>0xFF00FF00 </td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ColorRED"></a> <code><strong>SK_ColorRED </strong></code></td><td>0xFFFF0000 </td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ColorWHITE"></a> <code><strong>SK_ColorWHITE </strong></code></td><td>0xFFFFFFFF </td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## <a name="Alpha"></a> Alpha
|
||||
|
||||
## <a name="RGB"></a> RGB
|
||||
|
||||
## <a name="Red"></a> Red
|
||||
|
||||
## <a name="Blue"></a> Blue
|
||||
|
||||
## <a name="Green"></a> Green
|
||||
|
||||
## <a name="ARGB"></a> ARGB
|
||||
|
||||
## <a name="RBG"></a> RBG
|
||||
|
||||
## <a name="RGB-565"></a> RGB-565
|
||||
|
||||
# <a name="Color_Filter"></a> Color Filter
|
||||
|
||||
# <a name="SkColorFilter"></a> Class SkColorFilter
|
||||
|
||||
# <a name="Color_Space"></a> Color Space
|
||||
|
||||
# <a name="Data"></a> Data
|
||||
|
||||
# <a name="Draw_Filter"></a> Draw Filter
|
||||
|
||||
# <a name="SkDrawFilter"></a> Class SkDrawFilter
|
||||
|
||||
# <a name="Draw_Looper"></a> Draw Looper
|
||||
|
||||
# <a name="SkDrawLooper"></a> Class SkDrawLooper
|
||||
|
||||
# <a name="Drawable"></a> Drawable
|
||||
|
||||
# <a name="SkDrawable"></a> Class SkDrawable
|
||||
|
||||
<a name="draw"></a>
|
||||
## draw
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void draw(SkCanvas*, const SkMatrix* = NULL)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Raster_Handle_Allocator"></a> Raster Handle Allocator
|
||||
|
||||
# <a name="SkRasterHandleAllocator"></a> Class SkRasterHandleAllocator
|
||||
|
||||
# <a name="SkRasterHandleAllocator::Rec"></a> Struct SkRasterHandleAllocator::Rec
|
||||
|
||||
<a name="MakeCanvas"></a>
|
||||
## MakeCanvas
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
static std::unique_ptr<SkCanvas>
|
||||
MakeCanvas(std::unique_ptr<SkRasterHandleAllocator>,
|
||||
const SkImageInfo&,
|
||||
const Rec* rec = nullptr)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Filter_Quality"></a> Filter Quality
|
||||
|
||||
## <a name="SkFilterQuality"></a> Enum SkFilterQuality
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="kNone_SkFilterQuality"></a> <code><strong>kNone_SkFilterQuality </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kLow_SkFilterQuality"></a> <code><strong>kLow_SkFilterQuality </strong></code></td><td>1</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kMedium_SkFilterQuality"></a> <code><strong>kMedium_SkFilterQuality </strong></code></td><td>2</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kHigh_SkFilterQuality"></a> <code><strong>kHigh_SkFilterQuality </strong></code></td><td>3</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
# <a name="Font"></a> Font
|
||||
|
||||
## <a name="Advance"></a> Advance
|
||||
|
||||
## <a name="Engine"></a> Engine
|
||||
|
||||
# <a name="Oval"></a> Oval
|
||||
|
||||
# <a name="Font_Manager"></a> Font Manager
|
||||
|
||||
# <a name="Image"></a> Image
|
||||
|
||||
## <a name="Alpha_Type"></a> Alpha Type
|
||||
|
||||
## <a name="SkAlphaType"></a> Enum SkAlphaType
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="kPremul_SkAlphaType"></a> <code><strong>kPremul_SkAlphaType </strong></code></td><td>2</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
## <a name="Color_Type"></a> Color Type
|
||||
|
||||
## <a name="SkColorType"></a> Enum SkColorType
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="kUnknown_SkColorType"></a> <code><strong>kUnknown_SkColorType </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kAlpha_8_SkColorType"></a> <code><strong>kAlpha_8_SkColorType </strong></code></td><td>1</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kRGB_565_SkColorType"></a> <code><strong>kRGB_565_SkColorType </strong></code></td><td>2</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kARGB_4444_SkColorType"></a> <code><strong>kARGB_4444_SkColorType </strong></code></td><td>3</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kRGBA_8888_SkColorType"></a> <code><strong>kRGBA_8888_SkColorType </strong></code></td><td>4</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kBGRA_8888_SkColorType"></a> <code><strong>kBGRA_8888_SkColorType </strong></code></td><td>5</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kIndex_8_SkColorType"></a> <code><strong>kIndex_8_SkColorType </strong></code></td><td>6</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kGray_8_SkColorType"></a> <code><strong>kGray_8_SkColorType </strong></code></td><td>7</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="kRGBA_F16_SkColorType"></a> <code><strong>kRGBA_F16_SkColorType </strong></code></td><td>8</td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="kN32_SkColorType"></a> <code><strong>kN32_SkColorType </strong></code></td><td>4</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
## <a name="Info"></a> Info
|
||||
|
||||
# <a name="SkImageInfo"></a> Struct SkImageInfo
|
||||
|
||||
<a name="empty_constructor"></a>
|
||||
## SkImageInfo
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
SkImageInfo()
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="SkImage"></a> Class SkImage
|
||||
|
||||
<a name="makeShader"></a>
|
||||
## makeShader
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
sk_sp<SkShader> makeShader(SkShader::TileMode, SkShader::TileMode,
|
||||
const SkMatrix* localMatrix = nullptr) const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Image_Filter"></a> Image Filter
|
||||
|
||||
## <a name="Scaling"></a> Scaling
|
||||
|
||||
# <a name="SkImageFilter"></a> Class SkImageFilter
|
||||
|
||||
# <a name="Image_Scaling"></a> Image Scaling
|
||||
|
||||
# <a name="IRect"></a> IRect
|
||||
|
||||
# <a name="SkIRect"></a> Struct SkIRect
|
||||
|
||||
# <a name="Mask"></a> Mask
|
||||
|
||||
# <a name="Mask_Alpha"></a> Mask Alpha
|
||||
|
||||
# <a name="Mask_Filter"></a> Mask Filter
|
||||
|
||||
# <a name="SkMaskFilter"></a> Class SkMaskFilter
|
||||
|
||||
# <a name="Matrix"></a> Matrix
|
||||
|
||||
# <a name="SkMatrix"></a> Struct SkMatrix
|
||||
|
||||
# <a name="Nine_Patch"></a> Nine Patch
|
||||
|
||||
# <a name="Number_Types"></a> Number Types
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SK_ScalarMax"></a> <code><strong>SK_ScalarMax </strong></code></td><td>to be written</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ScalarInfinity"></a> <code><strong>SK_ScalarInfinity </strong></code></td><td>to be written</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ScalarNegativeInfinity"></a> <code><strong>SK_ScalarNegativeInfinity </strong></code></td><td>to be written</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SK_ScalarNaN"></a> <code><strong>SK_ScalarNaN </strong></code></td><td>to be written</td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# <a name="Paint_Defaults"></a> Paint Defaults
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SkPaintDefaults_Flags"></a> <code><strong>SkPaintDefaults_Flags </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkPaintDefaults_Hinting"></a> <code><strong>SkPaintDefaults_Hinting </strong></code></td><td>2</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkPaintDefaults_TextSize"></a> <code><strong>SkPaintDefaults_TextSize </strong></code></td><td>12</td><td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a name="SkPaintDefaults_MiterLimit"></a> <code><strong>SkPaintDefaults_MiterLimit </strong></code></td><td>4</td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# <a name="Path_Effect"></a> Path Effect
|
||||
|
||||
# <a name="SkPathEffect"></a> Class SkPathEffect
|
||||
|
||||
# <a name="Path_Measure"></a> Path Measure
|
||||
|
||||
# <a name="SkPathMeasure"></a> Class SkPathMeasure
|
||||
|
||||
<a name="dump"></a>
|
||||
## dump
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void dump() const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="PathOps"></a> PathOps
|
||||
|
||||
<a name="Op"></a>
|
||||
## Op
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
bool SK_API Op(const SkPath& one, const SkPath& two, SkPathOp op, SkPath* result)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Picture"></a> Picture
|
||||
|
||||
## <a name="Recorder"></a> Recorder
|
||||
|
||||
# <a name="SkPictureRecorder"></a> Class SkPictureRecorder
|
||||
|
||||
<a name="beginRecording"></a>
|
||||
## beginRecording
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
SkCanvas* beginRecording(const SkRect& bounds, SkBBHFactory* bbhFactory = NULL,
|
||||
uint32_t recordFlags = 0)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="Pixel"></a> Pixel
|
||||
|
||||
## <a name="Storage"></a> Storage
|
||||
|
||||
# <a name="Pixmap"></a> Pixmap
|
||||
|
||||
# <a name="SkPixmap"></a> Class SkPixmap
|
||||
|
||||
# <a name="Rasterizer"></a> Rasterizer
|
||||
|
||||
# <a name="SkRasterizer"></a> Class SkRasterizer
|
||||
|
||||
## <a name="Layer"></a> Layer
|
||||
|
||||
# <a name="Reference_Count"></a> Reference Count
|
||||
|
||||
# <a name="sk_sp"></a> Class sk_sp
|
||||
|
||||
# <a name="Round_Rect"></a> Round Rect
|
||||
|
||||
# <a name="SkRRect"></a> Class SkRRect
|
||||
|
||||
<a name="dump"></a>
|
||||
## dump
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void dump() const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
<a name="dumpHex"></a>
|
||||
## dumpHex
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
void dumpHex() const
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
# <a name="RSXform"></a> RSXform
|
||||
|
||||
# <a name="SkRSXform"></a> Struct SkRSXform
|
||||
|
||||
# <a name="Shader"></a> Shader
|
||||
|
||||
# <a name="SkShader"></a> Class SkShader
|
||||
|
||||
## <a name="SkShader::TileMode"></a> Enum SkShader::TileMode
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SkShader::kClamp_TileMode"></a> <code><strong>SkShader::kClamp_TileMode </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
<a name="MakeBitmapShader"></a>
|
||||
## MakeBitmapShader
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
static sk_sp<SkShader> MakeBitmapShader(const SkBitmap& src, TileMode tmx,
|
||||
TileMode tmy,
|
||||
const SkMatrix* localMatrix = nullptr)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
## <a name="Gradient"></a> Gradient
|
||||
|
||||
# <a name="Sprite"></a> Sprite
|
||||
|
||||
# <a name="Stream"></a> Stream
|
||||
|
||||
# <a name="SkFlattenable"></a> Class SkFlattenable
|
||||
|
||||
# <a name="String"></a> String
|
||||
|
||||
# <a name="SkString"></a> Class SkString
|
||||
|
||||
# <a name="Surface"></a> Surface
|
||||
|
||||
# <a name="SkSurface"></a> Class SkSurface
|
||||
|
||||
<a name="MakeRasterDirect"></a>
|
||||
## MakeRasterDirect
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 50em; background-color: #f0f0f0">
|
||||
static sk_sp<SkSurface> MakeRasterDirect(const SkImageInfo&, void* pixels,
|
||||
size_t rowBytes,
|
||||
const SkSurfaceProps* = nullptr)
|
||||
</pre>
|
||||
|
||||
---
|
||||
|
||||
## <a name="Properties"></a> Properties
|
||||
|
||||
# <a name="SkSurfaceProps"></a> Class SkSurfaceProps
|
||||
|
||||
## <a name="SkSurfaceProps::InitType"></a> Enum SkSurfaceProps::InitType
|
||||
|
||||
### Constants
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td><a name="SkSurfaceProps::kLegacyFontHost_InitType"></a> <code><strong>SkSurfaceProps::kLegacyFontHost_InitType </strong></code></td><td>0</td><td></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
|
||||
## <a name="GPU"></a> GPU
|
||||
|
||||
## <a name="Raster"></a> Raster
|
||||
|
||||
# <a name="SVG"></a> SVG
|
||||
|
||||
## <a name="Canvas"></a> Canvas
|
||||
|
||||
## <a name="Arc"></a> Arc
|
||||
|
||||
# <a name="Text"></a> Text
|
||||
|
||||
# <a name="Text_Blob"></a> Text Blob
|
||||
|
||||
# <a name="SkTextBlob"></a> Class SkTextBlob
|
||||
|
||||
# <a name="Vertices"></a> Vertices
|
||||
|
||||
## <a name="Colors"></a> Colors
|
||||
|
||||
## <a name="Texs"></a> Texs
|
||||
|
||||
# <a name="Read_Buffer"></a> Read Buffer
|
||||
|
||||
# <a name="SkReadBuffer"></a> Struct SkReadBuffer
|
||||
|
||||
# <a name="Write_Buffer"></a> Write Buffer
|
||||
|
||||
# <a name="SkWriteBuffer"></a> Struct SkWriteBuffer
|
||||
79
site/user/api/usingBookmaker.md
Normal file
79
site/user/api/usingBookmaker.md
Normal file
@ -0,0 +1,79 @@
|
||||
using Bookmaker
|
||||
===
|
||||
|
||||
# <a name="Bookmaker"></a> Bookmaker
|
||||
How to use the <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> utility.
|
||||
|
||||
Get the fiddle command line interface tool.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ go get go.skia.org/infra/fiddle/go/fiddlecli</pre>
|
||||
|
||||
Get the <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> <a href="bmh_usingBookmaker?cl=9919#CL">CL</a> and build it.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ git cl patch 9919
|
||||
$ ninja -<a href="bmh_usingBookmaker?cl=9919#C">C</a> out/dir bookmaker</pre>
|
||||
|
||||
Generate an starter <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> file from an existing include.
|
||||
This writes <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh in the current directory, which is
|
||||
out/dir/obj/ from an IDE.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -t -i include/core/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.h</pre>
|
||||
|
||||
Use your favorite editor to fill out <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh.
|
||||
|
||||
Generate fiddle.json from all examples, including the ones you just wrote.
|
||||
Error checking is syntatic: starting keywords are closed, keywords have the
|
||||
correct parents.
|
||||
If you run <a href="bmh_usingBookmaker?cl=9919#Bookmaker">Bookmaker</a> inside <a href="bmh_usingBookmaker?cl=9919#Visual_Studio">Visual Studio</a>, you can click on errors and it
|
||||
will take you to the source line in question.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -e fiddle.json -b current_directory</pre>
|
||||
|
||||
Once complete, run fiddlecli to generate the example hashes.
|
||||
Errors are contained by the output but aren't reported yet.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ $GOPATH/bin/fiddlecli --input fiddle.json --output fiddleout.json</pre>
|
||||
|
||||
Generate <a href="bmh_usingBookmaker?cl=9919#bmh_SkXXX">bmh SkXXX</a>.md from <a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh and fiddleout.json.
|
||||
Error checking includes: undefined references, fiddle compiler errors,
|
||||
missing or mismatched printf output.
|
||||
Again, you can click on any errors inside <a href="bmh_usingBookmaker?cl=9919#Visual_Studio">Visual Studio</a>.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -r site/user/api -b current_directory -f fiddleout.json</pre>
|
||||
|
||||
The original include may have changed since you started creating the markdown.
|
||||
Check to see if it is up to date.
|
||||
This reports if a method no longer exists or its parameters have changed.
|
||||
|
||||
<pre style="padding: 1em 1em 1em 1em;width: 44em; background-color: #f0f0f0">
|
||||
$ ./out/dir/bookmaker -x -b current_directory/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.bmh -i include/core/<a href="bmh_usingBookmaker?cl=9919#SkXXX">SkXXX</a>.h</pre>
|
||||
|
||||
# <a name="Bugs"></a> Bugs
|
||||
|
||||
<table>
|
||||
overaggressive reference finding in code block
|
||||
missing examples
|
||||
redundant examples -- got tired so used the same one more than once
|
||||
some examples need vertical resizing
|
||||
list doesn't work (ironic, huh)</table>
|
||||
|
||||
# <a name="To_Do"></a> To Do
|
||||
|
||||
<table>
|
||||
check that all methods have one line descriptions in overview
|
||||
see also -- anything that can be done automatically? maybe any ref shows up everywhere
|
||||
index by example png
|
||||
generate pdf or pdf-like out
|
||||
generate b/w out instead of color -- have b/w versions of examples?
|
||||
formalize voice / syntax for parts of topic and method
|
||||
write bmh data back into include
|
||||
have a way to write one block that covers multiple nearly indentical methods?
|
||||
may want to do this for pdf view as well
|
||||
write a one-method-per-page online view?</table>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user