AuroraMiddleware/skia2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[canvaskit] Add docs/types for remaining core functionality

Browse Source 
Change-Id: Ib9f1f1eb942e83683af4c4d7b127de90b440c765
Bug: skia:10717
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/321938
Reviewed-by: Nathaniel Nifong <nifong@google.com>
This commit is contained in:
Kevin Lubick 2020-10-05 08:30:20 -04:00
parent 00dc0bcb4d
commit e2c6940c36
2 changed files with 227 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
modules/canvaskit/canvaskit/types/canvaskit-wasm-tests.ts
View File

@ -31,6 +31,8 @@ import {
SkVertices,
TonalColorsOutput,
TypedArray,
Vector3,
VectorN,
} from "canvaskit-wasm";
CanvasKitInit({locateFile: (file: string) => '/node_modules/canvaskit/bin/' + file}).then((CK: CanvasKit) => {
@ -53,15 +55,26 @@ CanvasKitInit({locateFile: (file: string) => '/node_modules/canvaskit/bin/' + fi
pathTests(CK);
pictureTests(CK);
rectangleTests(CK);
runtimeEffectTests(CK);
shaderTests(CK);
shapedTextTests(CK);
surfaceTests(CK);
textBlobTests(CK);
vectorTests(CK);
verticesTests(CK);
});
function animatedImageTests(CK: CanvasKit) {
const buff = new ArrayBuffer(10);
const img = CK.MakeAnimatedImageFromEncoded(buff); // $ExpectType SkAnimatedImage | null
if (!img) return;
const n = img.decodeNextFrame(); // $ExpectType number
const f = img.getFrameCount(); // $ExpectType number
const r = img.getRepetitionCount(); // $ExpectType number
const h = img.height(); // $ExpectType number
const still = img.makeImageAtCurrentFrame(); // $ExpectType SkImage | null
img.reset();
const w = img.width(); // $ExpectType number
}
// In an effort to keep these type-checking tests easy to read and understand, we can "inject"
@ -506,6 +519,23 @@ function rectangleTests(CK: CanvasKit) {
const rrectOne = CK.RRectXY(rectOne, 3, 7); // $ExpectType Float32Array
}
function runtimeEffectTests(CK: CanvasKit) {
const rt = CK.SkRuntimeEffect.Make('not real sksl code'); // $ExpectType SkRuntimeEffect | null
if (!rt) return;
const someMatr = CK.SkMatrix.translated(2, 60);
const s1 = rt.makeShader([0, 1]); // $ExpectType SkShader
const s2 = rt.makeShader([0, 1], true, someMatr); // $ExpectType SkShader
const s3 = rt.makeShaderWithChildren([4, 5], true, [s1, s2]); // $ExpectType SkShader
const s4 = rt.makeShaderWithChildren([4, 5], true, [s1, s2], someMatr); // $ExpectType SkShader
}
function shaderTests(CK: CanvasKit) {
const s1 = CK.SkShader.Color([0.8, 0.2, 0.5, 0.9], // $ExpectType SkShader
CK.SkColorSpace.SRGB);
const s2 = CK.SkShader.Blend(CK.BlendMode.Src, s1, s1); // $ExpectType SkShader
const s3 = CK.SkShader.Lerp(0.3, s1, s2); // $ExpectType SkShader
}
function shapedTextTests(CK: CanvasKit, textFont?: SkFont) {
if (!textFont) return;
@ -582,6 +612,22 @@ function textBlobTests(CK: CanvasKit, font?: SkFont, path?: SkPath) {
const blob8 = tb.MakeOnPath('tuv', path, font, 10); // $ExpectType SkTextBlob
}
function vectorTests(CK: CanvasKit) {
const a = [1, 2, 3];
const b = [4, 5, 6];
const vec = CK.SkVector; // less typing
const v1 = vec.add(a, b); // $ExpectType VectorN
const v2 = vec.cross(a, b); // $ExpectType Vector3
const n1 = vec.dist(a, b); // $ExpectType number
const n2 = vec.dot(a, b); // $ExpectType number
const n3 = vec.length(a); // $ExpectType number
const n4 = vec.lengthSquared(a); // $ExpectType number
const v3 = vec.mulScalar(a, 10); // $ExpectType VectorN
const v4 = vec.normalize(a); // $ExpectType VectorN
const v5 = vec.sub(a, b); // $ExpectType VectorN
}
function verticesTests(CK: CanvasKit) {
const points = [
[ 70, 170 ], [ 40, 90 ], [ 130, 150 ], [ 100, 50 ],
@ -603,4 +649,8 @@ function verticesTests(CK: CanvasKit) {
1, 0, 1, 1); // purple
const vertices2 = CK.MakeSkVertices(CK.VertexMode.TriangleFan,
points, null, colors, null, true);
const rect = vertices.bounds(); // $ExpectType Float32Array
vertices.bounds(rect);
const id = vertices.uniqueID(); // $ExpectType number
}

187
modules/canvaskit/canvaskit/types/index.d.ts vendored
View File

@ -352,8 +352,8 @@ export interface CanvasKit {
readonly SkImageFilter: SkImageFilterFactory;
readonly SkMaskFilter: SkMaskFilterFactory;
readonly SkPathEffect: SkPathEffectFactory;
readonly SkShader: SkShaderFactory;
readonly SkRuntimeEffect: SkRuntimeEffectFactory;
readonly SkShader: SkShaderFactory;
readonly SkTextBlob: SkTextBlobFactory;
// Misc
@ -568,7 +568,40 @@ export interface ShapedTextOpts {
* See SkAnimatedImage.h for more information on this class.
*/
export interface SkAnimatedImage extends EmbindObject<SkAnimatedImage> {
todo: number; // TODO(kjlubick)
/**
* Decodes the next frame. Returns -1 when the animation is on the last frame.
*/
decodeNextFrame(): number;
/**
* Return the total number of frames in the animation.
*/
getFrameCount(): number;
/**
* Return the repetition count for this animation.
*/
getRepetitionCount(): number;
/**
* Returns the possibly scaled height of the image.
*/
height(): number;
/**
* Returns a still image of the current frame or null if there is no current frame.
*/
makeImageAtCurrentFrame(): SkImage | null;
/**
* Reset the animation to the beginning.
*/
reset(): void;
/**
* Returns the possibly scaled width of the image.
*/
width(): number;
}
/**
@ -1897,10 +1930,35 @@ export interface SkPictureRecorder extends EmbindObject<SkPicture> {
finishRecordingAsPicture(): SkPicture;
}
export interface SkShader extends EmbindObject<SkShader> {
todo: number; // TODO(kjlubick)
/**
* See SkRuntimeEffect.h for more details.
*/
export interface SkRuntimeEffect extends EmbindObject<SkRuntimeEffect> {
/**
* Returns a shader executed using the given uniform data.
* @param uniforms
* @param isOpaque
* @param localMatrix
*/
makeShader(uniforms: Float32Array | number[], isOpaque?: boolean,
localMatrix?: InputMatrix): SkShader;
/**
* Returns a shader executed using the given uniform data and the children as inputs.
* @param uniforms
* @param isOpaque
* @param children
* @param localMatrix
*/
makeShaderWithChildren(uniforms: Float32Array | number[], isOpaque?: boolean,
children?: SkShader[], localMatrix?: InputMatrix): SkShader;
}
/**
* See SkShader.h for more on this class. The objects are opaque.
*/
export type SkShader = EmbindObject<SkShader>;
export interface SkSurface extends EmbindObject<SkSurface> {
/**
* Call the given callback and save the result of that draw to a SkPicture with the
@ -1981,7 +2039,17 @@ export type SkTypeface = EmbindObject<SkTypeface>;
* See SkVertices.h for more on this class.
*/
export interface SkVertices extends EmbindObject<SkVertices> {
todo: number; // TODO(kjlubick)
/**
* Return the bounding area for the vertices.
* @param outputArray - if provided, the bounding box will be copied into this array instead of
* allocating a new one.
*/
bounds(outputArray?: SkRect): SkRect;
/**
* Return a unique ID for this vertices object.
*/
uniqueID(): number;
}
/**
@ -2459,12 +2527,44 @@ export interface SkPathEffectFactory {
MakeDiscrete(segLength: number, dev: number, seedAssist: number): SkPathEffect;
}
export interface SkShaderFactory {
todo: number; // TODO(kjlubick)
/**
* See SkRuntimeEffect.h for more details.
*/
export interface SkRuntimeEffectFactory {
/**
* Compiles a SkRuntimeEffect from the given shader code.
* @param sksl - Source code for a shader written in SkSL
*/
Make(sksl: string): SkRuntimeEffect | null;
}
export interface SkRuntimeEffectFactory {
todo: number; // TODO(kjlubick)
/**
* For more information, see SkShaders.h.
* TODO(kjlubick) Rename these to Make* as per the convention
*/
export interface SkShaderFactory {
/**
* Returns a shader that combines the given shaders with a BlendMode.
* @param mode
* @param one
* @param two
*/
Blend(mode: BlendMode, one: SkShader, two: SkShader): SkShader;
/**
* Returns a shader with a given color and colorspace.
* @param color
* @param space
*/
Color(color: InputColor, space: ColorSpace): SkShader;
/**
* Returns a shader is a linear interpolation combines the given shaders with a BlendMode.
* @param t - range of [0.0, 1.0], indicating how far we should be between one and two.
* @param one
* @param two
*/
Lerp(t: number, one: SkShader, two: SkShader): SkShader;
}
/**
@ -2526,8 +2626,70 @@ export interface SkTextBlobFactory {
MakeOnPath(str: string, path: SkPath, font: SkFont, initialOffset?: number): SkTextBlob;
}
/**
* Functions for manipulating vectors. It is Loosely based off of SkV3 in SkM44.h but Skia
* also has SkVec2 and Skv4. This combines them and works on vectors of any length.
*/
export interface VectorHelpers {
todo: number; // TODO(kjlubick)
/**
* Adds 2 vectors together, term by term, returning a new Vector.
* @param a
* @param b
*/
add(a: VectorN, b: VectorN): VectorN;
/**
* Returns the cross product of the two vectors. Only works for length 3.
* @param a
* @param b
*/
cross(a: Vector3, b: Vector3): Vector3;
/**
* Returns the length(sub(a, b))
* @param a
* @param b
*/
dist(a: VectorN, b: VectorN): number;
/**
* Returns the dot product of the two vectors.
* @param a
* @param b
*/
dot(a: VectorN, b: VectorN): number;
/**
* Returns the length of this vector, which is always positive.
* @param v
*/
length(v: VectorN): number;
/**
* Returns the length squared of this vector.
* @param v
*/
lengthSquared(v: VectorN): number;
/**
* Returns a new vector which is v multiplied by the scalar s.
* @param v
* @param s
*/
mulScalar(v: VectorN, s: number): VectorN;
/**
* Returns a normalized vector.
* @param v
*/
normalize(v: VectorN): VectorN;
/**
* Subtracts vector b from vector a (termwise).
* @param a
* @param b
*/
sub(a: VectorN, b: VectorN): VectorN;
}
/**
@ -2630,6 +2792,11 @@ export type Matrix3x2 = Float32Array;
*/
export type Vector3 = number[]; // TODO(kjlubick) make this include typed array and malloc'd.
/**
* VectorN represents a vector of length n.
*/
export type VectorN = number[];
/**
* CanvasKit APIs accept normal arrays, typed arrays, or Malloc'd memory as colors.
* Length 4.