vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-11 20:40:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update p5 to 0.9 (#37277)

Browse Source 
Also use updated prettier rules to get correct formatting
This commit is contained in:
Pierre Krafft
2019-08-06 16:06:59 -07:00
committed by Nathan Shively-Sanders
parent 5b4ef1615b
commit 6d243e4240
59 changed files with 19587 additions and 22369 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/p5/constants.d.ts
Vendored
+44 -107
View File
@@ -1,131 +1,68 @@
import * as p5 from "./index";
import * as p5 from './index';
declare module "./index" {
type ANGLE_MODE =
| RADIANS
| DEGREES;
declare module './index' {
type ANGLE_MODE = RADIANS | DEGREES;
type ARC_MODE =
| CHORD
| PIE
| OPEN;
type ARC_MODE = CHORD | PIE | OPEN;
type BEGIN_KIND =
| POINTS
| LINES
| TRIANGLES
| TRIANGLE_FAN
| TRIANGLE_STRIP
| QUADS
| QUAD_STRIP;
type BEGIN_KIND = POINTS | LINES | TRIANGLES | TRIANGLE_FAN | TRIANGLE_STRIP | QUADS | QUAD_STRIP;
type BLEND_MODE =
| BLEND
| DARKEST
| LIGHTEST
| DIFFERENCE
| MULTIPLY
| EXCLUSION
| SCREEN
| REPLACE
| OVERLAY
| HARD_LIGHT
| SOFT_LIGHT
| DODGE
| BURN
| ADD
| NORMAL;
type BLEND_MODE =
| BLEND
| DARKEST
| LIGHTEST
| DIFFERENCE
| MULTIPLY
| EXCLUSION
| SCREEN
| REPLACE
| OVERLAY
| HARD_LIGHT
| SOFT_LIGHT
| DODGE
| BURN
| ADD
| NORMAL;
type COLOR_MODE =
| RGB
| HSB
| HSL;
type COLOR_MODE = RGB | HSB | HSL;
type CURSOR_TYPE =
| ARROW
| CROSS
| HAND
| MOVE
| TEXT;
type CURSOR_TYPE = ARROW | CROSS | HAND | MOVE | TEXT;
type DEBUG_MODE =
| GRID
| AXES;
type DEBUG_MODE = GRID | AXES;
type ELLIPSE_MODE =
| CENTER
| RADIUS
| CORNER
| CORNERS;
type ELLIPSE_MODE = CENTER | RADIUS | CORNER | CORNERS;
type END_MODE = CLOSE;
type END_MODE = CLOSE;
type FILTER_TYPE =
| THRESHOLD
| GRAY
| OPAQUE
| INVERT
| POSTERIZE
| BLUR
| ERODE
| DILATE
| BLUR;
type FILTER_TYPE = THRESHOLD | GRAY | OPAQUE | INVERT | POSTERIZE | BLUR | ERODE | DILATE | BLUR;
type GRAPHICS_RENDERER =
| P2D
| WEBGL;
type GRAPHICS_RENDERER = P2D | WEBGL;
type HORIZ_ALIGN =
| LEFT
| CENTER
| RIGHT;
type HORIZ_ALIGN = LEFT | CENTER | RIGHT;
type IMAGE_MODE =
| CORNER
| CORNERS
| CENTER;
type IMAGE_MODE = CORNER | CORNERS | CENTER;
type RECT_MODE =
| CORNER
| CORNERS
| CENTER
| RADIUS;
type RECT_MODE = CORNER | CORNERS | CENTER | RADIUS;
type RENDERER =
| P2D
| WEBGL;
type RENDERER = P2D | WEBGL;
type SIZE_H = AUTO;
type SIZE_H = AUTO;
type SIZE_W = AUTO;
type SIZE_W = AUTO;
type STROKE_CAP =
| SQUARE
| PROJECT
| ROUND;
type STROKE_CAP = SQUARE | PROJECT | ROUND;
type STROKE_JOIN =
| MITER
| BEVEL
| ROUND;
type STROKE_JOIN = MITER | BEVEL | ROUND;
type TEXTURE_MODE =
| IMAGE
| NORMAL;
type TEXTURE_MODE = IMAGE | NORMAL;
type THE_STYLE =
| NORMAL
| ITALIC
| BOLD
| BOLDITALIC;
type THE_STYLE = NORMAL | ITALIC | BOLD | BOLDITALIC;
type TYPE =
| VIDEO
| AUDIO;
type TYPE = VIDEO | AUDIO;
type VERT_ALIGN =
| TOP
| BOTTOM
| CENTER
| BASELINE;
type VERT_ALIGN = TOP | BOTTOM | CENTER | BASELINE;
type WRAP_X = CLAMP | REPEAT | MIRROR;
type WRAP_Y = CLAMP | REPEAT | MIRROR;
}
types/p5/global.d.ts
Vendored
+7249 -8056
View File
File diff suppressed because it is too large Load Diff
types/p5/index.d.ts
Vendored
+120 -121
View File
@@ -1,6 +1,7 @@
// Type definitions for p5 0.7
// Type definitions for p5 0.9
// Project: https://github.com/processing/p5.js
// Definitions by: p5-types <https://github.com/p5-types>
// Pierre Krafft <https://github.com/Zalastax>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.9
@@ -18,6 +19,7 @@
/// <reference path="./src/core/rendering.d.ts" />
/// <reference path="./src/core/structure.d.ts" />
/// <reference path="./src/core/transform.d.ts" />
/// <reference path="./src/data/local_storage.d.ts" />
/// <reference path="./src/data/p5.TypedDict.d.ts" />
/// <reference path="./src/events/acceleration.d.ts" />
/// <reference path="./src/events/keyboard.d.ts" />
@@ -61,133 +63,130 @@
/// <reference path="./constants.d.ts" />
export = p5;
declare class p5 {
/**
* This is the p5 instance constructor. A p5 instance
* holds all the properties and methods related to a
* p5 sketch. It expects an incoming sketch closure
* and it can also take an optional node parameter
* for attaching the generated p5 canvas to a node.
* The sketch closure takes the newly created p5
* instance as its sole argument and may optionally
* set preload(), setup(), and/or draw() properties
* on it for running a sketch.
*
* A p5 sketch can run in "global" or "instance"
* mode: "global" - all properties and methods are
* attached to the window "instance" - all properties
* and methods are bound to this p5 object
*
* @param sketch a closure that can set optional
* preload(), setup(), and/or draw() properties on
* the given p5 instance
* @param [node] element to attach canvas to, if a
* boolean is passed in use it as sync
* @param [sync] start synchronously (optional)
* @return a p5 instance
*/
constructor(
sketch: (
...args: any[]
) => any,
node?:
| HTMLElement
| boolean,
sync?: boolean
);
/**
* This is the p5 instance constructor. A p5 instance
* holds all the properties and methods related to a
* p5 sketch. It expects an incoming sketch closure
* and it can also take an optional node parameter
* for attaching the generated p5 canvas to a node.
* The sketch closure takes the newly created p5
* instance as its sole argument and may optionally
* set preload(), setup(), and/or draw() properties
* on it for running a sketch.
*
* A p5 sketch can run in "global" or "instance"
* mode: "global" - all properties and methods are
* attached to the window "instance" - all properties
* and methods are bound to this p5 object
*
* @param sketch a closure that can set optional
* preload(), setup(), and/or draw() properties on
* the given p5 instance
* @param [node] element to attach canvas to
* @return a p5 instance
*/
constructor(sketch: (...args: any[]) => any, node?: HTMLElement);
/**
* Called directly before setup(), the preload()
* function is used to handle asynchronous loading of
* external files in a blocking way. If a preload
* function is defined, setup() will wait until any
* load calls within have finished. Nothing besides
* load calls (loadImage, loadJSON, loadFont,
* loadStrings, etc.) should be inside the preload
* function. If asynchronous loading is preferred,
* the load methods can instead be called in setup()
* or anywhere else with the use of a callback
* parameter. By default the text "loading..." will
* be displayed. To make your own loading page,
* include an HTML element with id "p5_loading" in
* your page. More information here.
*/
preload(): void;
/**
* Called directly before setup(), the preload()
* function is used to handle asynchronous loading of
* external files in a blocking way. If a preload
* function is defined, setup() will wait until any
* load calls within have finished. Nothing besides
* load calls (loadImage, loadJSON, loadFont,
* loadStrings, etc.) should be inside the preload
* function. If asynchronous loading is preferred,
* the load methods can instead be called in setup()
* or anywhere else with the use of a callback
* parameter. By default the text "loading..." will
* be displayed. To make your own loading page,
* include an HTML element with id "p5_loading" in
* your page. More information here.
*/
preload(): void;
/**
* The setup() function is called once when the
* program starts. It's used to define initial
* environment properties such as screen size and
* background color and to load media such as images
* and fonts as the program starts. There can only be
* one setup() function for each program and it
* shouldn't be called again after its initial
* execution. Note: Variables declared within
* setup() are not accessible within other functions,
* including draw().
*/
setup(): void;
/**
* The setup() function is called once when the
* program starts. It's used to define initial
* environment properties such as screen size and
* background color and to load media such as images
* and fonts as the program starts. There can only be
* one setup() function for each program and it
* shouldn't be called again after its initial
* execution. Note: Variables declared within
* setup() are not accessible within other functions,
* including draw().
*/
setup(): void;
/**
* Called directly after setup(), the draw() function
* continuously executes the lines of code contained
* inside its block until the program is stopped or
* noLoop() is called. Note if noLoop() is called in
* setup(), draw() will still be executed once before
* stopping. draw() is called automatically and
* should never be called explicitly. It should
* always be controlled with noLoop(), redraw() and
* loop(). After noLoop() stops the code in draw()
* from executing, redraw() causes the code inside
* draw() to execute once, and loop() will cause the
* code inside draw() to resume executing
* continuously.
*
*
* The number of times draw() executes in each second
* may be controlled with the frameRate() function.
*
*
* There can only be one draw() function for each
* sketch, and draw() must exist if you want the code
* to run continuously, or to process events such as
* mousePressed(). Sometimes, you might have an empty
* call to draw() in your program, as shown in the
* above example.
*
*
* It is important to note that the drawing
* coordinate system will be reset at the beginning
* of each draw() call. If any transformations are
* performed within draw() (ex: scale, rotate,
* translate), their effects will be undone at the
* beginning of draw(), so transformations will not
* accumulate over time. On the other hand, styling
* applied (ex: fill, stroke, etc) will remain in
* effect.
*/
draw(): void;
/**
* Called directly after setup(), the draw() function
* continuously executes the lines of code contained
* inside its block until the program is stopped or
* noLoop() is called. Note if noLoop() is called in
* setup(), draw() will still be executed once before
* stopping. draw() is called automatically and
* should never be called explicitly. It should
* always be controlled with noLoop(), redraw() and
* loop(). After noLoop() stops the code in draw()
* from executing, redraw() causes the code inside
* draw() to execute once, and loop() will cause the
* code inside draw() to resume executing
* continuously.
*
*
* The number of times draw() executes in each second
* may be controlled with the frameRate() function.
*
*
* There can only be one draw() function for each
* sketch, and draw() must exist if you want the code
* to run continuously, or to process events such as
* mousePressed(). Sometimes, you might have an empty
* call to draw() in your program, as shown in the
* above example.
*
*
* It is important to note that the drawing
* coordinate system will be reset at the beginning
* of each draw() call. If any transformations are
* performed within draw() (ex: scale, rotate,
* translate), their effects will be undone at the
* beginning of draw(), so transformations will not
* accumulate over time. On the other hand, styling
* applied (ex: fill, stroke, etc) will remain in
* effect.
*/
draw(): void;
/**
* Removes the entire p5 sketch. This will remove the
* canvas and any elements created by p5.js. It will
* also stop the draw loop and unbind any properties
* or methods from the window global scope. It will
* leave a variable p5 in case you wanted to create a
* new p5 sketch. If you like, you can set p5 = null
* to erase it. While all functions and variables and
* objects created by the p5 library will be removed,
* any other global variables created by your code
* will remain.
*/
remove(): void;
/**
* Removes the entire p5 sketch. This will remove the
* canvas and any elements created by p5.js. It will
* also stop the draw loop and unbind any properties
* or methods from the window global scope. It will
* leave a variable p5 in case you wanted to create a
* new p5 sketch. If you like, you can set p5 = null
* to erase it. While all functions and variables and
* objects created by the p5 library will be removed,
* any other global variables created by your code
* will remain.
*/
remove(): void;
/**
* Allows for the friendly error system (FES) to be
* turned off when creating a sketch, which can give
* a significant boost to performance when needed.
* See disabling the friendly error system.
*/
disableFriendlyErrors: boolean;
}
// tslint:disable-next-line:no-empty-interface
interface p5
extends p5.p5InstanceExtensions {}
interface p5 extends p5.p5InstanceExtensions {}
declare namespace p5 {
type UNKNOWN_P5_CONSTANT = any;
// tslint:disable-next-line:no-empty-interface
interface p5InstanceExtensions {}
type UNKNOWN_P5_CONSTANT = any;
// tslint:disable-next-line:no-empty-interface
interface p5InstanceExtensions {}
}
types/p5/lib/addons/p5.dom.d.ts
Vendored
+832 -979
View File
File diff suppressed because it is too large Load Diff
types/p5/lib/addons/p5.sound.d.ts
Vendored
+2841 -3410
View File
File diff suppressed because it is too large Load Diff
types/p5/literals.d.ts
Vendored
+89 -76
View File
@@ -1,78 +1,91 @@
import * as p5 from "./index";
import * as p5 from './index';
declare module "./index" {
type ADD = "lighter";
type ARROW = "arrow";
type AUDIO = "audio";
type AUTO = "auto";
type AXES = "axes";
type BASELINE = "alphabetic";
type BEVEL = "bevel";
type BLEND = "source-over";
type BLUR = "blur";
type BOLD = "bold";
type BOLDITALIC = "bolditalic";
type BOTTOM = "bottom";
type BURN = "color-burn";
type CENTER = "center";
type CHORD = "chord";
type CLOSE = "close";
type CORNER = "corner";
type CORNERS = "corners";
type CROSS = "cross";
type DARKEST = "darkest";
type DEGREES = "degrees";
type DIFFERENCE = "difference";
type DILATE = "dilate";
type DODGE = "color-dodge";
type ERODE = "erode";
type EXCLUSION = "exclusion";
type GRAY = "gray";
type GRID = "grid";
type HAND = "hand";
type HARD_LIGHT = "hard-light";
type HSB = "hsb";
type HSL = "hsl";
type IMAGE = "image";
type INVERT = "invert";
type ITALIC = "italic";
type LANDSCAPE = "landscape";
type LEFT = "left";
type LIGHTEST = "lighten";
type LINE_LOOP = 0x0002;
type LINE_STRIP = 0x0003;
type LINES = 0x0001;
type MITER = "miter";
type MOVE = "move";
type MULTIPLY = "multiply";
type NORMAL = "normal";
type OPAQUE = "opaque";
type OPEN = "open";
type OVERLAY = "overlay";
type P2D = "p2d";
type PIE = "pie";
type POINTS = 0x0000;
type PORTRAIT = "portrait";
type POSTERIZE = "posterize";
type PROJECT = "square";
type QUAD_STRIP = "quad_strip";
type QUADS = "quads";
type RADIANS = "radians";
type RADIUS = "radius";
type REPLACE = "copy";
type RGB = "rgb";
type RIGHT = "right";
type ROUND = "round";
type SCREEN = "screen";
type SOFT_LIGHT = "soft-light";
type SQUARE = "butt";
type TEXT = "text";
type THRESHOLD = "threshold";
type TOP = "top";
type TRIANGLE_FAN = 0x0006;
type TRIANGLE_STRIP = 0x0005;
type TRIANGLES = 0x0004;
type VIDEO = "video";
type WAIT = "wait";
type WEBGL = "webgl";
declare module './index' {
type ADD = 'lighter';
type ARROW = 'arrow';
type AUDIO = 'audio';
type AUTO = 'auto';
type AXES = 'axes';
type BASELINE = 'alphabetic';
type BEVEL = 'bevel';
type BEZIER = 'bezier';
type BLEND = 'source-over';
type BLUR = 'blur';
type BOLD = 'bold';
type BOLDITALIC = 'bolditalic';
type BOTTOM = 'bottom';
type BURN = 'color-burn';
type CENTER = 'center';
type CHORD = 'chord';
type CLAMP = 'clamp';
type CLOSE = 'close';
type CORNER = 'corner';
type CORNERS = 'corners';
type CROSS = 'cross';
type CURVE = 'curve';
type DARKEST = 'darkest';
type DEGREES = 'degrees';
type DIFFERENCE = 'difference';
type DILATE = 'dilate';
type DODGE = 'color-dodge';
type ERODE = 'erode';
type EXCLUSION = 'exclusion';
type FILL = 'fill';
type GRAY = 'gray';
type GRID = 'grid';
type HAND = 'hand';
type HARD_LIGHT = 'hard-light';
type HSB = 'hsb';
type HSL = 'hsl';
type IMAGE = 'image';
type IMMEDIATE = 'immediate';
type INVERT = 'invert';
type ITALIC = 'italic';
type LANDSCAPE = 'landscape';
type LEFT = 'left';
type LIGHTEST = 'lighten';
type LINE_LOOP = 0x0002;
type LINE_STRIP = 0x0003;
type LINEAR = 'linear';
type LINES = 0x0001;
type MIRROR = 'mirror';
type MITER = 'miter';
type MOVE = 'move';
type MULTIPLY = 'multiply';
type NEAREST = 'nearest';
type NORMAL = 'normal';
type OPAQUE = 'opaque';
type OPEN = 'open';
type OVERLAY = 'overlay';
type P2D = 'p2d';
type PIE = 'pie';
type POINTS = 0x0000;
type PORTRAIT = 'portrait';
type POSTERIZE = 'posterize';
type PROJECT = 'square';
type QUAD_STRIP = 'quad_strip';
type QUADRATIC = 'quadratic';
type QUADS = 'quads';
type RADIANS = 'radians';
type RADIUS = 'radius';
type REPEAT = 'repeat';
type REPLACE = 'copy';
type RGB = 'rgb';
type RIGHT = 'right';
type ROUND = 'round';
type SCREEN = 'screen';
type SOFT_LIGHT = 'soft-light';
type SQUARE = 'butt';
type STROKE = 'stroke';
type SUBTRACT = 'subtract';
type TEXT = 'text';
type TEXTURE = 'texture';
type THRESHOLD = 'threshold';
type TOP = 'top';
type TRIANGLE_FAN = 0x0006;
type TRIANGLE_STRIP = 0x0005;
type TRIANGLES = 0x0004;
type VIDEO = 'video';
type WAIT = 'wait';
type WEBGL = 'webgl';
}
types/p5/src/color/creating_reading.d.ts
Vendored
+230 -288
View File
@@ -1,305 +1,247 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Extracts the alpha value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the alpha value
*/
alpha(
color:
| Color
| number[]
| string
): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Extracts the alpha value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the alpha value
*/
alpha(color: Color | number[] | string): number;
/**
* Extracts the blue value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the blue value
*/
blue(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the blue value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the blue value
*/
blue(color: Color | number[] | string): number;
/**
* Extracts the HSB brightness value from a color or
* pixel array.
* @param color p5.Color object, color components, or
* CSS color
* @return the brightness value
*/
brightness(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the HSB brightness value from a color or
* pixel array.
* @param color p5.Color object, color components, or
* CSS color
* @return the brightness value
*/
brightness(color: Color | number[] | string): number;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param gray number specifying value between white
* and black.
* @param [alpha] alpha value relative to current
* color range (default is 0-255)
* @return resulting color
*/
color(
gray: number,
alpha?: number
): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param gray number specifying value between white
* and black.
* @param [alpha] alpha value relative to current
* color range (default is 0-255)
* @return resulting color
*/
color(gray: number, alpha?: number): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
* @param [alpha] alpha value relative to current
* color range (default is 0-255)
*/
color(
v1: number,
v2: number,
v3: number,
alpha?: number
): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
* @param [alpha] alpha value relative to current
* color range (default is 0-255)
*/
color(v1: number, v2: number, v3: number, alpha?: number): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param value a color string
*/
color(
value: string
): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param value a color string
*/
color(value: string): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param values an array containing the
* red,green,blue & and alpha components of the color
*/
color(
values: number[]
): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
* @param values an array containing the
* red,green,blue & and alpha components of the color
*/
color(values: number[]): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
*/
color(
color: Color
): Color;
/**
* Creates colors for storing in variables of the
* color datatype. The parameters are interpreted as
* RGB or HSB values depending on the current
* colorMode(). The default mode is RGB values from 0
* to 255 and, therefore, the function call
* color(255, 204, 0) will return a bright yellow
* color. Note that if only one value is provided to
* color(), it will be interpreted as a grayscale
* value. Add a second value, and it will be used for
* alpha transparency. When three values are
* specified, they are interpreted as either RGB or
* HSB values. Adding a fourth value applies alpha
* transparency.
*
*
* If a single string argument is provided, RGB, RGBA
* and Hex CSS color strings and all named color
* strings are supported. In this case, an alpha
* number value as a second argument is not
* supported, the RGBA form should be used.
*/
color(color: Color): Color;
/**
* Extracts the green value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the green value
*/
green(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the green value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the green value
*/
green(color: Color | number[] | string): number;
/**
* Extracts the hue value from a color or pixel
* array. Hue exists in both HSB and HSL. This
* function will return the HSB-normalized hue when
* supplied with an HSB color object (or when
* supplied with a pixel array while the color mode
* is HSB), but will default to the HSL-normalized
* hue otherwise. (The values will only be different
* if the maximum hue setting for each system is
* different.)
* @param color p5.Color object, color components, or
* CSS color
* @return the hue
*/
hue(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the hue value from a color or pixel
* array. Hue exists in both HSB and HSL. This
* function will return the HSB-normalized hue when
* supplied with an HSB color object (or when
* supplied with a pixel array while the color mode
* is HSB), but will default to the HSL-normalized
* hue otherwise. (The values will only be different
* if the maximum hue setting for each system is
* different.)
* @param color p5.Color object, color components, or
* CSS color
* @return the hue
*/
hue(color: Color | number[] | string): number;
/**
* Blends two colors to find a third color somewhere
* between them. The amt parameter is the amount to
* interpolate between the two values where 0.0 equal
* to the first color, 0.1 is very near the first
* color, 0.5 is halfway in between, etc. An amount
* below 0 will be treated as 0. Likewise, amounts
* above 1 will be capped at 1. This is different
* from the behavior of lerp(), but necessary because
* otherwise numbers outside the range will produce
* strange and unexpected colors. The way that
* colours are interpolated depends on the current
* color mode.
* @param c1 interpolate from this color
* @param c2 interpolate to this color
* @param amt number between 0 and 1
* @return interpolated color
*/
lerpColor(
c1: Color,
c2: Color,
amt: number
): Color;
/**
* Blends two colors to find a third color somewhere
* between them. The amt parameter is the amount to
* interpolate between the two values where 0.0 equal
* to the first color, 0.1 is very near the first
* color, 0.5 is halfway in between, etc. An amount
* below 0 will be treated as 0. Likewise, amounts
* above 1 will be capped at 1. This is different
* from the behavior of lerp(), but necessary because
* otherwise numbers outside the range will produce
* strange and unexpected colors. The way that
* colours are interpolated depends on the current
* color mode.
* @param c1 interpolate from this color
* @param c2 interpolate to this color
* @param amt number between 0 and 1
* @return interpolated color
*/
lerpColor(c1: Color, c2: Color, amt: number): Color;
/**
* Extracts the HSL lightness value from a color or
* pixel array.
* @param color p5.Color object, color components, or
* CSS color
* @return the lightness
*/
lightness(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the HSL lightness value from a color or
* pixel array.
* @param color p5.Color object, color components, or
* CSS color
* @return the lightness
*/
lightness(color: Color | number[] | string): number;
/**
* Extracts the red value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the red value
*/
red(
color:
| Color
| number[]
| string
): number;
/**
* Extracts the red value from a color or pixel
* array.
* @param color p5.Color object, color components, or
* CSS color
* @return the red value
*/
red(color: Color | number[] | string): number;
/**
* Extracts the saturation value from a color or
* pixel array. Saturation is scaled differently in
* HSB and HSL. This function will return the HSB
* saturation when supplied with an HSB color object
* (or when supplied with a pixel array while the
* color mode is HSB), but will default to the HSL
* saturation otherwise.
* @param color p5.Color object, color components, or
* CSS color
* @return the saturation value
*/
saturation(
color:
| Color
| number[]
| string
): number;
}
/**
* Extracts the saturation value from a color or
* pixel array. Saturation is scaled differently in
* HSB and HSL. This function will return the HSB
* saturation when supplied with an HSB color object
* (or when supplied with a pixel array while the
* color mode is HSB), but will default to the HSL
* saturation otherwise.
* @param color p5.Color object, color components, or
* CSS color
* @return the saturation value
*/
saturation(color: Color | number[] | string): number;
}
}
types/p5/src/color/p5.Color.d.ts
Vendored
+24 -34
View File
@@ -1,38 +1,28 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Color {
/**
* This function returns the color formatted as a
* string. This can be useful for debugging, or for
* using p5.js with other libraries.
* @param [format] How the color string will be
* formatted. Leaving this empty formats the string
* as rgba(r, g, b, a). '#rgb' '#rgba' '#rrggbb' and
* '#rrggbbaa' format as hexadecimal color codes.
* 'rgb' 'hsb' and 'hsl' return the color formatted
* in the specified color mode. 'rgba' 'hsba' and
* 'hsla' are the same as above but with alpha
* channels. 'rgb%' 'hsb%' 'hsl%' 'rgba%' 'hsba%' and
* 'hsla%' format as percentages.
* @return the formatted string
*/
toString(
format?: string
): string;
setRed(
red: number
): void;
setGreen(
green: number
): void;
setBlue(
blue: number
): void;
setAlpha(
alpha: number
): void;
}
declare module '../../index' {
class Color {
/**
* This function returns the color formatted as a
* string. This can be useful for debugging, or for
* using p5.js with other libraries.
* @param [format] How the color string will be
* formatted. Leaving this empty formats the string
* as rgba(r, g, b, a). '#rgb' '#rgba' '#rrggbb' and
* '#rrggbbaa' format as hexadecimal color codes.
* 'rgb' 'hsb' and 'hsl' return the color formatted
* in the specified color mode. 'rgba' 'hsba' and
* 'hsla' are the same as above but with alpha
* channels. 'rgb%' 'hsb%' 'hsl%' 'rgba%' 'hsba%' and
* 'hsla%' format as percentages.
* @return the formatted string
*/
toString(format?: string): string;
setRed(red: number): void;
setGreen(green: number): void;
setBlue(blue: number): void;
setAlpha(alpha: number): void;
}
}
types/p5/src/color/setting.d.ts
Vendored
+517 -568
View File
File diff suppressed because it is too large Load Diff
types/p5/src/core/constants.d.ts
Vendored
+171 -126
View File
@@ -1,137 +1,182 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
readonly P2D: P2D;
readonly WEBGL: WEBGL;
readonly ARROW: ARROW;
readonly CROSS: CROSS;
readonly HAND: HAND;
readonly MOVE: MOVE;
readonly TEXT: TEXT;
readonly WAIT: WAIT;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The default, two-dimensional renderer.
*/
readonly P2D: P2D;
/**
* HALF_PI is a mathematical constant with the value
* 1.57079632679489661923. It is half the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly HALF_PI: number;
/**
* One of the two render modes in p5.js: P2D (default
* renderer) and WEBGL Enables 3D render by
* introducing the third dimension: Z
*/
readonly WEBGL: WEBGL;
readonly ARROW: ARROW;
readonly CROSS: CROSS;
readonly HAND: HAND;
readonly MOVE: MOVE;
readonly TEXT: TEXT;
readonly WAIT: WAIT;
/**
* PI is a mathematical constant with the value
* 3.14159265358979323846. It is the ratio of the
* circumference of a circle to its diameter. It is
* useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly PI: number;
/**
* HALF_PI is a mathematical constant with the value
* 1.57079632679489661923. It is half the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly HALF_PI: number;
/**
* QUARTER_PI is a mathematical constant with the
* value 0.7853982. It is one quarter the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly QUARTER_PI: number;
/**
* PI is a mathematical constant with the value
* 3.14159265358979323846. It is the ratio of the
* circumference of a circle to its diameter. It is
* useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly PI: number;
/**
* TAU is an alias for TWO_PI, a mathematical
* constant with the value 6.28318530717958647693. It
* is twice the ratio of the circumference of a
* circle to its diameter. It is useful in
* combination with the trigonometric functions sin()
* and cos().
*/
readonly TAU: number;
/**
* QUARTER_PI is a mathematical constant with the
* value 0.7853982. It is one quarter the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly QUARTER_PI: number;
/**
* TWO_PI is a mathematical constant with the value
* 6.28318530717958647693. It is twice the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly TWO_PI: number;
/**
* TAU is an alias for TWO_PI, a mathematical
* constant with the value 6.28318530717958647693. It
* is twice the ratio of the circumference of a
* circle to its diameter. It is useful in
* combination with the trigonometric functions sin()
* and cos().
*/
readonly TAU: number;
/**
* Constant to be used with angleMode() function, to
* set the mode which p5.js interprates and
* calculates angles (either DEGREES or RADIANS).
*/
readonly DEGREES: DEGREES;
/**
* TWO_PI is a mathematical constant with the value
* 6.28318530717958647693. It is twice the ratio of
* the circumference of a circle to its diameter. It
* is useful in combination with the trigonometric
* functions sin() and cos().
*/
readonly TWO_PI: number;
/**
* Constant to be used with angleMode() function, to
* set the mode which p5.js interprates and
* calculates angles (either RADIANS or DEGREES).
*/
readonly RADIANS: RADIANS;
readonly CORNER: CORNER;
readonly CORNERS: CORNERS;
readonly RADIUS: RADIUS;
readonly RIGHT: RIGHT;
readonly LEFT: LEFT;
readonly CENTER: CENTER;
readonly TOP: TOP;
readonly BOTTOM: BOTTOM;
readonly BASELINE: BASELINE;
readonly POINTS: POINTS;
readonly LINES: LINES;
readonly LINE_STRIP: LINE_STRIP;
readonly LINE_LOOP: LINE_LOOP;
readonly TRIANGLES: TRIANGLES;
readonly TRIANGLE_FAN: TRIANGLE_FAN;
readonly TRIANGLE_STRIP: TRIANGLE_STRIP;
readonly QUADS: QUADS;
readonly QUAD_STRIP: QUAD_STRIP;
readonly CLOSE: CLOSE;
readonly OPEN: OPEN;
readonly CHORD: CHORD;
readonly PIE: PIE;
readonly PROJECT: PROJECT;
readonly SQUARE: SQUARE;
readonly ROUND: ROUND;
readonly BEVEL: BEVEL;
readonly MITER: MITER;
readonly RGB: RGB;
readonly HSB: HSB;
readonly HSL: HSL;
readonly AUTO: AUTO;
readonly BLEND: BLEND;
readonly ADD: ADD;
readonly DARKEST: DARKEST;
readonly LIGHTEST: LIGHTEST;
readonly DIFFERENCE: DIFFERENCE;
readonly EXCLUSION: EXCLUSION;
readonly MULTIPLY: MULTIPLY;
readonly SCREEN: SCREEN;
readonly REPLACE: REPLACE;
readonly OVERLAY: OVERLAY;
readonly HARD_LIGHT: HARD_LIGHT;
readonly SOFT_LIGHT: SOFT_LIGHT;
readonly DODGE: DODGE;
readonly BURN: BURN;
readonly THRESHOLD: THRESHOLD;
readonly GRAY: GRAY;
readonly OPAQUE: OPAQUE;
readonly INVERT: INVERT;
readonly POSTERIZE: POSTERIZE;
readonly DILATE: DILATE;
readonly ERODE: ERODE;
readonly BLUR: BLUR;
readonly NORMAL: NORMAL;
readonly ITALIC: ITALIC;
readonly BOLD: BOLD;
readonly BOLDITALIC: BOLDITALIC;
readonly LANDSCAPE: LANDSCAPE;
readonly PORTRAIT: PORTRAIT;
readonly GRID: GRID;
readonly AXES: AXES;
}
/**
* Constant to be used with angleMode() function, to
* set the mode which p5.js interprates and
* calculates angles (either DEGREES or RADIANS).
*/
readonly DEGREES: DEGREES;
/**
* Constant to be used with angleMode() function, to
* set the mode which p5.js interprates and
* calculates angles (either RADIANS or DEGREES).
*/
readonly RADIANS: RADIANS;
readonly CORNER: CORNER;
readonly CORNERS: CORNERS;
readonly RADIUS: RADIUS;
readonly RIGHT: RIGHT;
readonly LEFT: LEFT;
readonly CENTER: CENTER;
readonly TOP: TOP;
readonly BOTTOM: BOTTOM;
readonly BASELINE: BASELINE;
readonly POINTS: POINTS;
readonly LINES: LINES;
readonly LINE_STRIP: LINE_STRIP;
readonly LINE_LOOP: LINE_LOOP;
readonly TRIANGLES: TRIANGLES;
readonly TRIANGLE_FAN: TRIANGLE_FAN;
readonly TRIANGLE_STRIP: TRIANGLE_STRIP;
readonly QUADS: QUADS;
readonly QUAD_STRIP: QUAD_STRIP;
readonly CLOSE: CLOSE;
readonly OPEN: OPEN;
readonly CHORD: CHORD;
readonly PIE: PIE;
readonly PROJECT: PROJECT;
readonly SQUARE: SQUARE;
readonly ROUND: ROUND;
readonly BEVEL: BEVEL;
readonly MITER: MITER;
readonly RGB: RGB;
readonly HSB: HSB;
readonly HSL: HSL;
/**
* AUTO allows us to automatically set the width or
* height of an element (but not both), based on the
* current height and width of the element. Only one
* parameter can be passed to the size function as
* AUTO, at a time.
*/
readonly AUTO: AUTO;
readonly ALT: number;
readonly BACKSPACE: number;
readonly CONTROL: number;
readonly DELETE: number;
readonly DOWN_ARROW: number;
readonly ENTER: number;
readonly ESCAPE: number;
readonly LEFT_ARROW: number;
readonly OPTION: number;
readonly RETURN: number;
readonly RIGHT_ARROW: number;
readonly SHIFT: number;
readonly TAB: number;
readonly UP_ARROW: number;
readonly BLEND: BLEND;
readonly ADD: ADD;
readonly DARKEST: DARKEST;
readonly LIGHTEST: LIGHTEST;
readonly DIFFERENCE: DIFFERENCE;
readonly SUBTRACT: SUBTRACT;
readonly EXCLUSION: EXCLUSION;
readonly MULTIPLY: MULTIPLY;
readonly SCREEN: SCREEN;
readonly REPLACE: REPLACE;
readonly OVERLAY: OVERLAY;
readonly HARD_LIGHT: HARD_LIGHT;
readonly SOFT_LIGHT: SOFT_LIGHT;
readonly DODGE: DODGE;
readonly BURN: BURN;
readonly THRESHOLD: THRESHOLD;
readonly GRAY: GRAY;
readonly OPAQUE: OPAQUE;
readonly INVERT: INVERT;
readonly POSTERIZE: POSTERIZE;
readonly DILATE: DILATE;
readonly ERODE: ERODE;
readonly BLUR: BLUR;
readonly NORMAL: NORMAL;
readonly ITALIC: ITALIC;
readonly BOLD: BOLD;
readonly BOLDITALIC: BOLDITALIC;
readonly LINEAR: LINEAR;
readonly QUADRATIC: QUADRATIC;
readonly BEZIER: BEZIER;
readonly CURVE: CURVE;
readonly STROKE: STROKE;
readonly FILL: FILL;
readonly TEXTURE: TEXTURE;
readonly IMMEDIATE: IMMEDIATE;
readonly IMAGE: IMAGE;
readonly NEAREST: NEAREST;
readonly REPEAT: REPEAT;
readonly CLAMP: CLAMP;
readonly MIRROR: MIRROR;
readonly LANDSCAPE: LANDSCAPE;
readonly PORTRAIT: PORTRAIT;
readonly GRID: GRID;
readonly AXES: AXES;
}
}
types/p5/src/core/environment.d.ts
Vendored
+230 -233
View File
@@ -1,257 +1,254 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The print() function writes to the console area of
* your browser. This function is often helpful for
* looking at the data a program is producing. This
* function creates a new line of text for each call
* to the function. Individual elements can be
* separated with quotes ("") and joined with the
* addition operator (+). Note that calling print()
* without any arguments invokes the window.print()
* function which opens the browser's print dialog.
* To print a blank line to console you can write
* print('\n').
* @param contents any combination of Number, String,
* Object, Boolean, Array to print
*/
print(
contents: any
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The print() function writes to the console area of
* your browser. This function is often helpful for
* looking at the data a program is producing. This
* function creates a new line of text for each call
* to the function. Individual elements can be
* separated with quotes ("") and joined with the
* addition operator (+). Note that calling print()
* without any arguments invokes the window.print()
* function which opens the browser's print dialog.
* To print a blank line to console you can write
* print('\n').
* @param contents any combination of Number, String,
* Object, Boolean, Array to print
*/
print(contents: any): void;
/**
* Sets the cursor to a predefined symbol or an
* image, or makes it visible if already hidden. If
* you are trying to set an image as the cursor, the
* recommended size is 16x16 or 32x32 pixels. The
* values for parameters x and y must be less than
* the dimensions of the image.
* @param type Built-In: either ARROW, CROSS, HAND,
* MOVE, TEXT and WAIT Native CSS properties: 'grab',
* 'progress', 'cell' etc. External: path for
* cursor's images (Allowed File extensions: .cur,
* .gif, .jpg, .jpeg, .png) For more information on
* Native CSS cursors and url visit:
* https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
* @param [x] the horizontal active spot of the
* cursor (must be less than 32)
* @param [y] the vertical active spot of the cursor
* (must be less than 32)
*/
cursor(
type:
| string
| CURSOR_TYPE,
x?: number,
y?: number
): void;
/**
* Sets the cursor to a predefined symbol or an
* image, or makes it visible if already hidden. If
* you are trying to set an image as the cursor, the
* recommended size is 16x16 or 32x32 pixels. The
* values for parameters x and y must be less than
* the dimensions of the image.
* @param type Built-In: either ARROW, CROSS, HAND,
* MOVE, TEXT and WAIT Native CSS properties: 'grab',
* 'progress', 'cell' etc. External: path for
* cursor's images (Allowed File extensions: .cur,
* .gif, .jpg, .jpeg, .png) For more information on
* Native CSS cursors and url visit:
* https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
* @param [x] the horizontal active spot of the
* cursor (must be less than 32)
* @param [y] the vertical active spot of the cursor
* (must be less than 32)
*/
cursor(type: string | CURSOR_TYPE, x?: number, y?: number): void;
/**
* Specifies the number of frames to be displayed
* every second. For example, the function call
* frameRate(30) will attempt to refresh 30 times a
* second. If the processor is not fast enough to
* maintain the specified rate, the frame rate will
* not be achieved. Setting the frame rate within
* setup() is recommended. The default frame rate is
* based on the frame rate of the display (here also
* called "refresh rate"), which is set to 60 frames
* per second on most computers. A frame rate of 24
* frames per second (usual for movies) or above will
* be enough for smooth animations This is the same
* as setFrameRate(val). Calling frameRate() with no
* arguments returns the current framerate. The draw
* function must run at least once before it will
* return a value. This is the same as
* getFrameRate().
*
*
* Calling frameRate() with arguments that are not of
* the type numbers or are non positive also returns
* current framerate.
* @param fps number of frames to be displayed every
* second
* @chainable
*/
frameRate(
fps: number
): p5;
/**
* Specifies the number of frames to be displayed
* every second. For example, the function call
* frameRate(30) will attempt to refresh 30 times a
* second. If the processor is not fast enough to
* maintain the specified rate, the frame rate will
* not be achieved. Setting the frame rate within
* setup() is recommended. The default frame rate is
* based on the frame rate of the display (here also
* called "refresh rate"), which is set to 60 frames
* per second on most computers. A frame rate of 24
* frames per second (usual for movies) or above will
* be enough for smooth animations This is the same
* as setFrameRate(val). Calling frameRate() with no
* arguments returns the current framerate. The draw
* function must run at least once before it will
* return a value. This is the same as
* getFrameRate().
*
*
* Calling frameRate() with arguments that are not of
* the type numbers or are non positive also returns
* current framerate.
* @param fps number of frames to be displayed every
* second
* @chainable
*/
frameRate(fps: number): p5;
/**
* Specifies the number of frames to be displayed
* every second. For example, the function call
* frameRate(30) will attempt to refresh 30 times a
* second. If the processor is not fast enough to
* maintain the specified rate, the frame rate will
* not be achieved. Setting the frame rate within
* setup() is recommended. The default frame rate is
* based on the frame rate of the display (here also
* called "refresh rate"), which is set to 60 frames
* per second on most computers. A frame rate of 24
* frames per second (usual for movies) or above will
* be enough for smooth animations This is the same
* as setFrameRate(val). Calling frameRate() with no
* arguments returns the current framerate. The draw
* function must run at least once before it will
* return a value. This is the same as
* getFrameRate().
*
*
* Calling frameRate() with arguments that are not of
* the type numbers or are non positive also returns
* current framerate.
* @return current frameRate
*/
frameRate(): number;
/**
* Specifies the number of frames to be displayed
* every second. For example, the function call
* frameRate(30) will attempt to refresh 30 times a
* second. If the processor is not fast enough to
* maintain the specified rate, the frame rate will
* not be achieved. Setting the frame rate within
* setup() is recommended. The default frame rate is
* based on the frame rate of the display (here also
* called "refresh rate"), which is set to 60 frames
* per second on most computers. A frame rate of 24
* frames per second (usual for movies) or above will
* be enough for smooth animations This is the same
* as setFrameRate(val). Calling frameRate() with no
* arguments returns the current framerate. The draw
* function must run at least once before it will
* return a value. This is the same as
* getFrameRate().
*
*
* Calling frameRate() with arguments that are not of
* the type numbers or are non positive also returns
* current framerate.
* @return current frameRate
*/
frameRate(): number;
/**
* Hides the cursor from view.
*/
noCursor(): void;
/**
* Hides the cursor from view.
*/
noCursor(): void;
/**
* The windowResized() function is called once every
* time the browser window is resized. This is a good
* place to resize the canvas or do any other
* adjustments to accommodate the new window size.
*/
windowResized(): void;
/**
* The windowResized() function is called once every
* time the browser window is resized. This is a good
* place to resize the canvas or do any other
* adjustments to accommodate the new window size.
*/
windowResized(): void;
/**
* If argument is given, sets the sketch to
* fullscreen or not based on the value of the
* argument. If no argument is given, returns the
* current fullscreen state. Note that due to browser
* restrictions this can only be called on user
* input, for example, on mouse press like the
* example below.
* @param [val] whether the sketch should be in
* fullscreen mode or not
* @return current fullscreen state
*/
fullscreen(
val?: boolean
): boolean;
/**
* If argument is given, sets the sketch to
* fullscreen or not based on the value of the
* argument. If no argument is given, returns the
* current fullscreen state. Note that due to browser
* restrictions this can only be called on user
* input, for example, on mouse press like the
* example below.
* @param [val] whether the sketch should be in
* fullscreen mode or not
* @return current fullscreen state
*/
fullscreen(val?: boolean): boolean;
/**
* Sets the pixel scaling for high pixel density
* displays. By default pixel density is set to match
* display density, call pixelDensity(1) to turn this
* off. Calling pixelDensity() with no arguments
* returns the current pixel density of the sketch.
* @param val whether or how much the sketch should
* scale
* @chainable
*/
pixelDensity(
val: number
): p5;
/**
* Sets the pixel scaling for high pixel density
* displays. By default pixel density is set to match
* display density, call pixelDensity(1) to turn this
* off. Calling pixelDensity() with no arguments
* returns the current pixel density of the sketch.
* @param val whether or how much the sketch should
* scale
* @chainable
*/
pixelDensity(val: number): p5;
/**
* Sets the pixel scaling for high pixel density
* displays. By default pixel density is set to match
* display density, call pixelDensity(1) to turn this
* off. Calling pixelDensity() with no arguments
* returns the current pixel density of the sketch.
* @return current pixel density of the sketch
*/
pixelDensity(): number;
/**
* Sets the pixel scaling for high pixel density
* displays. By default pixel density is set to match
* display density, call pixelDensity(1) to turn this
* off. Calling pixelDensity() with no arguments
* returns the current pixel density of the sketch.
* @return current pixel density of the sketch
*/
pixelDensity(): number;
/**
* Returns the pixel density of the current display
* the sketch is running on.
* @return current pixel density of the display
*/
displayDensity(): number;
/**
* Returns the pixel density of the current display
* the sketch is running on.
* @return current pixel density of the display
*/
displayDensity(): number;
/**
* Gets the current URL.
* @return url
*/
getURL(): string;
/**
* Gets the current URL.
* @return url
*/
getURL(): string;
/**
* Gets the current URL path as an array.
* @return path components
*/
getURLPath(): string[];
/**
* Gets the current URL path as an array.
* @return path components
*/
getURLPath(): string[];
/**
* Gets the current URL params as an Object.
* @return URL params
*/
getURLParams(): object;
/**
* Gets the current URL params as an Object.
* @return URL params
*/
getURLParams(): object;
/**
* The system variable frameCount contains the number
* of frames that have been displayed since the
* program started. Inside setup() the value is 0,
* after the first iteration of draw it is 1, etc.
*/
frameCount: number;
/**
* The system variable frameCount contains the number
* of frames that have been displayed since the
* program started. Inside setup() the value is 0,
* after the first iteration of draw it is 1, etc.
*/
frameCount: number;
/**
* Confirms if the window a p5.js program is in is
* "focused," meaning that the sketch will accept
* mouse or keyboard input. This variable is "true"
* if the window is focused and "false" if not.
*/
focused: boolean;
/**
* The system variable deltaTime contains the time
* difference between the beginning of the previous
* frame and the beginning of the current frame in
* milliseconds. This variable is useful for
* creating time sensitive animation or physics
* calculation that should stay constant regardless
* of frame rate.
*/
deltaTime: number;
/**
* System variable that stores the width of the
* screen display according to The default
* pixelDensity. This is used to run a full-screen
* program on any display size. To return actual
* screen size, multiply this by pixelDensity.
*/
displayWidth: number;
/**
* Confirms if the window a p5.js program is in is
* "focused," meaning that the sketch will accept
* mouse or keyboard input. This variable is "true"
* if the window is focused and "false" if not.
*/
focused: boolean;
/**
* System variable that stores the height of the
* screen display according to The default
* pixelDensity. This is used to run a full-screen
* program on any display size. To return actual
* screen size, multiply this by pixelDensity.
*/
displayHeight: number;
/**
* System variable that stores the width of the
* screen display according to The default
* pixelDensity. This is used to run a full-screen
* program on any display size. To return actual
* screen size, multiply this by pixelDensity.
*/
displayWidth: number;
/**
* System variable that stores the width of the inner
* window, it maps to window.innerWidth.
*/
windowWidth: number;
/**
* System variable that stores the height of the
* screen display according to The default
* pixelDensity. This is used to run a full-screen
* program on any display size. To return actual
* screen size, multiply this by pixelDensity.
*/
displayHeight: number;
/**
* System variable that stores the height of the
* inner window, it maps to window.innerHeight.
*/
windowHeight: number;
/**
* System variable that stores the width of the inner
* window, it maps to window.innerWidth.
*/
windowWidth: number;
/**
* System variable that stores the width of the
* drawing canvas. This value is set by the first
* parameter of the createCanvas() function. For
* example, the function call createCanvas(320, 240)
* sets the width variable to the value 320. The
* value of width defaults to 100 if createCanvas()
* is not used in a program.
*/
width: number;
/**
* System variable that stores the height of the
* inner window, it maps to window.innerHeight.
*/
windowHeight: number;
/**
* System variable that stores the height of the
* drawing canvas. This value is set by the second
* parameter of the createCanvas() function. For
* example, the function call createCanvas(320, 240)
* sets the height variable to the value 240. The
* value of height defaults to 100 if createCanvas()
* is not used in a program.
*/
height: number;
}
/**
* System variable that stores the width of the
* drawing canvas. This value is set by the first
* parameter of the createCanvas() function. For
* example, the function call createCanvas(320, 240)
* sets the width variable to the value 320. The
* value of width defaults to 100 if createCanvas()
* is not used in a program.
*/
width: number;
/**
* System variable that stores the height of the
* drawing canvas. This value is set by the second
* parameter of the createCanvas() function. For
* example, the function call createCanvas(320, 240)
* sets the height variable to the value 240. The
* value of height defaults to 100 if createCanvas()
* is not used in a program.
*/
height: number;
}
}
types/p5/src/core/p5.Element.d.ts
Vendored
+239 -348
View File
@@ -1,371 +1,262 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Element {
/**
* Attaches the element to the parent specified. A
* way of setting the container for the element.
* Accepts either a string ID, DOM node, or
* p5.Element. If no arguments given, parent node is
* returned. For more ways to position the canvas,
* see the positioning the canvas wiki page. All
* above examples except for the first one require
* the inclusion of the p5.dom library in your
* index.html. See the using a library section for
* information on how to include this library.
* @param parent the ID, DOM node, or p5.Element of
* desired parent element
* @chainable
*/
parent(
parent:
| string
| Element
| object
): Element;
declare module '../../index' {
class Element {
/**
* Attaches the element to the parent specified. A
* way of setting the container for the element.
* Accepts either a string ID, DOM node, or
* p5.Element. If no arguments given, parent node is
* returned. For more ways to position the canvas,
* see the positioning the canvas wiki page. All
* above examples except for the first one require
* the inclusion of the p5.dom library in your
* index.html. See the using a library section for
* information on how to include this library.
* @param parent the ID, DOM node, or p5.Element of
* desired parent element
* @chainable
*/
parent(parent: string | Element | object): Element;
/**
* Attaches the element to the parent specified. A
* way of setting the container for the element.
* Accepts either a string ID, DOM node, or
* p5.Element. If no arguments given, parent node is
* returned. For more ways to position the canvas,
* see the positioning the canvas wiki page. All
* above examples except for the first one require
* the inclusion of the p5.dom library in your
* index.html. See the using a library section for
* information on how to include this library.
*/
parent(): Element;
/**
* Attaches the element to the parent specified. A
* way of setting the container for the element.
* Accepts either a string ID, DOM node, or
* p5.Element. If no arguments given, parent node is
* returned. For more ways to position the canvas,
* see the positioning the canvas wiki page. All
* above examples except for the first one require
* the inclusion of the p5.dom library in your
* index.html. See the using a library section for
* information on how to include this library.
*/
parent(): Element;
/**
* Sets the ID of the element. If no ID argument is
* passed in, it instead returns the current ID of
* the element.
* @param id ID of the element
* @chainable
*/
id(
id: string
): Element;
/**
* Sets the ID of the element. If no ID argument is
* passed in, it instead returns the current ID of
* the element. Note that only one element can have a
* particular id in a page. The .class() function can
* be used to identify multiple elements with the
* same class name.
* @param id ID of the element
* @chainable
*/
id(id: string): Element;
/**
* Sets the ID of the element. If no ID argument is
* passed in, it instead returns the current ID of
* the element.
* @return the id of the element
*/
id(): string;
/**
* Sets the ID of the element. If no ID argument is
* passed in, it instead returns the current ID of
* the element. Note that only one element can have a
* particular id in a page. The .class() function can
* be used to identify multiple elements with the
* same class name.
* @return the id of the element
*/
id(): string;
/**
* Adds given class to the element. If no class
* argument is passed in, it instead returns a string
* containing the current class(es) of the element.
* @param class class to add
* @chainable
*/
class(
theClass: string
): Element;
/**
* Adds given class to the element. If no class
* argument is passed in, it instead returns a string
* containing the current class(es) of the element.
* @param class class to add
* @chainable
*/
class(theClass: string): Element;
/**
* Adds given class to the element. If no class
* argument is passed in, it instead returns a string
* containing the current class(es) of the element.
* @return the class of the element
*/
class(): string;
/**
* Adds given class to the element. If no class
* argument is passed in, it instead returns a string
* containing the current class(es) of the element.
* @return the class of the element
*/
class(): string;
/**
* The .mousePressed() function is called once after
* every time a mouse button is pressed over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* pressed over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mousePressed(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mousePressed() function is called once after
* every time a mouse button is pressed over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* pressed over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mousePressed(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .doubleClicked() function is called once after
* every time a mouse button is pressed twice over
* the element. This can be used to attach element
* and action specific event listeners.
* @param fxn function to be fired when mouse is
* double clicked over the element. if false is
* passed instead, the previously firing function
* will no longer fire.
*/
doubleClicked(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .doubleClicked() function is called once after
* every time a mouse button is pressed twice over
* the element. This can be used to attach element
* and action specific event listeners.
* @param fxn function to be fired when mouse is
* double clicked over the element. if false is
* passed instead, the previously firing function
* will no longer fire.
*/
doubleClicked(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseWheel() function is called once after
* every time a mouse wheel is scrolled over the
* element. This can be used to attach element
* specific event listeners. The function accepts a
* callback function as argument which will be
* executed when the wheel event is triggered on the
* element, the callback function is passed one
* argument event. The event.deltaY property returns
* negative values if the mouse wheel is rotated up
* or away from the user and positive in the other
* direction. The event.deltaX does the same as
* event.deltaY except it reads the horizontal wheel
* scroll of the mouse wheel.
*
*
* On OS X with "natural" scrolling enabled, the
* event.deltaY values are reversed.
* @param fxn function to be fired when mouse is
* scrolled over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseWheel(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseWheel() function is called once after
* every time a mouse wheel is scrolled over the
* element. This can be used to attach element
* specific event listeners. The function accepts a
* callback function as argument which will be
* executed when the wheel event is triggered on the
* element, the callback function is passed one
* argument event. The event.deltaY property returns
* negative values if the mouse wheel is rotated up
* or away from the user and positive in the other
* direction. The event.deltaX does the same as
* event.deltaY except it reads the horizontal wheel
* scroll of the mouse wheel.
*
*
* On OS X with "natural" scrolling enabled, the
* event.deltaY values are reversed.
* @param fxn function to be fired when mouse is
* scrolled over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseWheel(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseReleased() function is called once after
* every time a mouse button is released over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* released over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseReleased(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseReleased() function is called once after
* every time a mouse button is released over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* released over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseReleased(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseClicked() function is called once after
* a mouse button is pressed and released over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* clicked over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseClicked(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseClicked() function is called once after
* a mouse button is pressed and released over the
* element. Some mobile browsers may also trigger
* this event on a touch screen, if the user performs
* a quick tap. This can be used to attach element
* specific event listeners.
* @param fxn function to be fired when mouse is
* clicked over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
mouseClicked(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseMoved() function is called once every
* time a mouse moves over the element. This can be
* used to attach an element specific event listener.
* @param fxn function to be fired when a mouse moves
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseMoved(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseMoved() function is called once every
* time a mouse moves over the element. This can be
* used to attach an element specific event listener.
* @param fxn function to be fired when a mouse moves
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseMoved(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseOver() function is called once after
* every time a mouse moves onto the element. This
* can be used to attach an element specific event
* listener.
* @param fxn function to be fired when a mouse moves
* onto the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseOver(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseOver() function is called once after
* every time a mouse moves onto the element. This
* can be used to attach an element specific event
* listener.
* @param fxn function to be fired when a mouse moves
* onto the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseOver(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .mouseOut() function is called once after
* every time a mouse moves off the element. This can
* be used to attach an element specific event
* listener.
* @param fxn function to be fired when a mouse moves
* off of an element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseOut(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .mouseOut() function is called once after
* every time a mouse moves off the element. This can
* be used to attach an element specific event
* listener.
* @param fxn function to be fired when a mouse moves
* off of an element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
mouseOut(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .touchStarted() function is called once after
* every time a touch is registered. This can be used
* to attach element specific event listeners.
* @param fxn function to be fired when a touch
* starts over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
touchStarted(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .touchStarted() function is called once after
* every time a touch is registered. This can be used
* to attach element specific event listeners.
* @param fxn function to be fired when a touch
* starts over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
touchStarted(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .touchMoved() function is called once after
* every time a touch move is registered. This can be
* used to attach element specific event listeners.
* @param fxn function to be fired when a touch moves
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
touchMoved(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .touchMoved() function is called once after
* every time a touch move is registered. This can be
* used to attach element specific event listeners.
* @param fxn function to be fired when a touch moves
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
touchMoved(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .touchEnded() function is called once after
* every time a touch is registered. This can be used
* to attach element specific event listeners.
* @param fxn function to be fired when a touch ends
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
touchEnded(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .touchEnded() function is called once after
* every time a touch is registered. This can be used
* to attach element specific event listeners.
* @param fxn function to be fired when a touch ends
* over the element. if false is passed instead, the
* previously firing function will no longer fire.
* @chainable
*/
touchEnded(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .dragOver() function is called once after
* every time a file is dragged over the element.
* This can be used to attach an element specific
* event listener.
* @param fxn function to be fired when a file is
* dragged over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
dragOver(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .dragOver() function is called once after
* every time a file is dragged over the element.
* This can be used to attach an element specific
* event listener.
* @param fxn function to be fired when a file is
* dragged over the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
dragOver(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* The .dragLeave() function is called once after
* every time a dragged file leaves the element area.
* This can be used to attach an element specific
* event listener.
* @param fxn function to be fired when a file is
* dragged off the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
dragLeave(
fxn:
| ((
...args: any[]
) => any)
| boolean
): Element;
/**
* The .dragLeave() function is called once after
* every time a dragged file leaves the element area.
* This can be used to attach an element specific
* event listener.
* @param fxn function to be fired when a file is
* dragged off the element. if false is passed
* instead, the previously firing function will no
* longer fire.
* @chainable
*/
dragLeave(fxn: ((...args: any[]) => any) | boolean): Element;
/**
* Registers a callback that gets called every time a
* file that is dropped on the element has been
* loaded. p5 will load every dropped file into
* memory and pass it as a p5.File object to the
* callback. Multiple files dropped at the same time
* will result in multiple calls to the callback. You
* can optionally pass a second callback which will
* be registered to the raw drop event. The callback
* will thus be provided the original DragEvent.
* Dropping multiple files at the same time will
* trigger the second callback once per drop, whereas
* the first callback will trigger for each loaded
* file.
* @param callback callback to receive loaded file.
* @param [fxn] callback triggered when files are
* dropped.
* @chainable
*/
drop(
callback: (
...args: any[]
) => any,
fxn?: (
...args: any[]
) => any
): Element;
/**
* Underlying HTML element. All normal HTML methods
* can be called on this.
*/
elt: any;
}
/**
* Underlying HTML element. All normal HTML methods
* can be called on this.
*/
elt: any;
}
}
types/p5/src/core/p5.Graphics.d.ts
Vendored
+22 -9
View File
@@ -1,13 +1,26 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Graphics extends Element {
/**
* Removes a Graphics object from the page and frees
* any resources associated with it.
*/
remove(): void;
}
declare module '../../index' {
// Work-around for p5.Graphics inheriting from both p5 and p5.Element
class __Graphics__ extends Element {
/**
* Resets certain values such as those modified by
* functions in the Transform category and in the
* Lights category that are not automatically reset
* with graphics buffer objects. Calling this in
* draw() will copy the behavior of the standard
* canvas.
*/
reset(): void;
/**
* Removes a Graphics object from the page and frees
* any resources associated with it.
*/
remove(): void;
}
// Work-around for p5.Graphics inheriting from both p5 and p5.Element
type Graphics = __Graphics__ & p5;
}
types/p5/src/core/p5.Renderer.d.ts
Vendored
+16 -20
View File
@@ -1,24 +1,20 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Renderer extends Element {
/**
* Main graphics and rendering context, as well as
* the base API implementation for p5.js "core". To
* be used as the superclass for Renderer2D and
* Renderer3D classes, respecitvely.
*
* @param elt DOM node that is wrapped
* @param [pInst] pointer to p5 instance
* @param [isMainCanvas] whether we're using it as
* main canvas
*/
constructor(
elt: string,
pInst?: p5,
isMainCanvas?: boolean
);
}
declare module '../../index' {
class Renderer extends Element {
/**
* Main graphics and rendering context, as well as
* the base API implementation for p5.js "core". To
* be used as the superclass for Renderer2D and
* Renderer3D classes, respecitvely.
*
* @param elt DOM node that is wrapped
* @param [pInst] pointer to p5 instance
* @param [isMainCanvas] whether we're using it as
* main canvas
*/
constructor(elt: string, pInst?: p5, isMainCanvas?: boolean);
}
}
types/p5/src/core/rendering.d.ts
Vendored
+101 -106
View File
@@ -1,114 +1,109 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Creates a canvas element in the document, and sets
* the dimensions of it in pixels. This method should
* be called only once at the start of setup. Calling
* createCanvas more than once in a sketch will
* result in very unpredictable behavior. If you want
* more than one drawing canvas you could use
* createGraphics (hidden by default but it can be
* shown). The system variables width and height are
* set by the parameters passed to this function. If
* createCanvas() is not used, the window will be
* given a default size of 100x100 pixels.
*
*
* For more ways to position the canvas, see the
* positioning the canvas wiki page.
* @param w width of the canvas
* @param h height of the canvas
* @param [renderer] either P2D or WEBGL
*/
createCanvas(
w: number,
h: number,
renderer?: RENDERER
): Renderer;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Creates a canvas element in the document, and sets
* the dimensions of it in pixels. This method should
* be called only once at the start of setup. Calling
* createCanvas more than once in a sketch will
* result in very unpredictable behavior. If you want
* more than one drawing canvas you could use
* createGraphics (hidden by default but it can be
* shown). The system variables width and height are
* set by the parameters passed to this function. If
* createCanvas() is not used, the window will be
* given a default size of 100x100 pixels.
*
*
* For more ways to position the canvas, see the
* positioning the canvas wiki page.
* @param w width of the canvas
* @param h height of the canvas
* @param [renderer] either P2D or WEBGL
*/
createCanvas(w: number, h: number, renderer?: RENDERER): Renderer;
/**
* Resizes the canvas to given width and height. The
* canvas will be cleared and draw will be called
* immediately, allowing the sketch to re-render
* itself in the resized canvas.
* @param w width of the canvas
* @param h height of the canvas
* @param [noRedraw] don't redraw the canvas
* immediately
*/
resizeCanvas(
w: number,
h: number,
noRedraw?: boolean
): void;
/**
* Resizes the canvas to given width and height. The
* canvas will be cleared and draw will be called
* immediately, allowing the sketch to re-render
* itself in the resized canvas.
* @param w width of the canvas
* @param h height of the canvas
* @param [noRedraw] don't redraw the canvas
* immediately
*/
resizeCanvas(w: number, h: number, noRedraw?: boolean): void;
/**
* Removes the default canvas for a p5 sketch that
* doesn't require a canvas
*/
noCanvas(): void;
/**
* Removes the default canvas for a p5 sketch that
* doesn't require a canvas
*/
noCanvas(): void;
/**
* Creates and returns a new p5.Renderer object. Use
* this class if you need to draw into an off-screen
* graphics buffer. The two parameters define the
* width and height in pixels.
* @param w width of the offscreen graphics buffer
* @param h height of the offscreen graphics buffer
* @param [renderer] either P2D or WEBGL undefined
* defaults to p2d
* @return offscreen graphics buffer
*/
createGraphics(
w: number,
h: number,
renderer?: RENDERER
): Graphics;
/**
* Creates and returns a new p5.Renderer object. Use
* this class if you need to draw into an off-screen
* graphics buffer. The two parameters define the
* width and height in pixels.
* @param w width of the offscreen graphics buffer
* @param h height of the offscreen graphics buffer
* @param [renderer] either P2D or WEBGL undefined
* defaults to p2d
* @return offscreen graphics buffer
*/
createGraphics(w: number, h: number, renderer?: RENDERER): Graphics;
/**
* Blends the pixels in the display window according
* to the defined mode. There is a choice of the
* following modes to blend the source pixels (A)
* with the ones of pixels already in the display
* window (B): - BLEND - linear interpolation of
* colours: C = A*factor + B. This is the default
* blending mode.
* - ADD - sum of A and B
* - DARKEST - only the darkest colour succeeds: C =
* min(A*factor, B).
* - LIGHTEST - only the lightest colour succeeds: C
* = max(A*factor, B).
* - DIFFERENCE - subtract colors from underlying
* image.
* - EXCLUSION - similar to DIFFERENCE, but less
* extreme.
* - MULTIPLY - multiply the colors, result will
* always be darker.
* - SCREEN - opposite multiply, uses inverse values
* of the colors.
* - REPLACE - the pixels entirely replace the others
* and don't utilize alpha (transparency) values.
* - OVERLAY - mix of MULTIPLY and SCREEN .
* Multiplies dark values, and screens light values.
* - HARD_LIGHT - SCREEN when greater than 50% gray,
* MULTIPLY when lower.
* - SOFT_LIGHT - mix of DARKEST and LIGHTEST. Works
* like OVERLAY, but not as harsh.
* - DODGE - lightens light tones and increases
* contrast, ignores darks.
* - BURN - darker areas are applied, increasing
* contrast, ignores lights.
* @param mode blend mode to set for canvas. either
* BLEND, DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL
*/
blendMode(
mode: BLEND_MODE
): void;
}
/**
* Blends the pixels in the display window according
* to the defined mode. There is a choice of the
* following modes to blend the source pixels (A)
* with the ones of pixels already in the display
* window (B): - BLEND - linear interpolation of
* colours: C = A*factor + B. This is the default
* blending mode.
* - ADD - sum of A and B
* - DARKEST - only the darkest colour succeeds: C =
* min(A*factor, B).
* - LIGHTEST - only the lightest colour succeeds: C
* = max(A*factor, B).
* - DIFFERENCE - subtract colors from underlying
* image.
* - EXCLUSION - similar to DIFFERENCE, but less
* extreme.
* - MULTIPLY - multiply the colors, result will
* always be darker.
* - SCREEN - opposite multiply, uses inverse values
* of the colors.
* - REPLACE - the pixels entirely replace the others
* and don't utilize alpha (transparency) values.
* - OVERLAY - mix of MULTIPLY and SCREEN .
* Multiplies dark values, and screens light values.
* (2D)
* - HARD_LIGHT - SCREEN when greater than 50% gray,
* MULTIPLY when lower. (2D)
* - SOFT_LIGHT - mix of DARKEST and LIGHTEST. Works
* like OVERLAY, but not as harsh. (2D)
* - DODGE - lightens light tones and increases
* contrast, ignores darks. (2D)
* - BURN - darker areas are applied, increasing
* contrast, ignores lights. (2D)
* - SUBTRACT - remainder of A and B (3D)
*
*
* (2D) indicates that this blend mode only works in
* the 2D renderer.
*
* (3D) indicates that this blend mode only works in
* the WEBGL renderer.
* @param mode blend mode to set for canvas. either
* BLEND, DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD, or SUBTRACT
*/
blendMode(mode: BLEND_MODE): void;
}
}
types/p5/src/core/shape/2d_primitives.d.ts
Vendored
+298 -364
View File
@@ -1,380 +1,314 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../../index";
import * as p5 from '../../../index';
declare module "../../../index" {
interface p5InstanceExtensions {
/**
* Draw an arc to the screen. If called with only x,
* y, w, h, start, and stop, the arc will be drawn
* and filled as an open pie segment. If a mode
* parameter is provided, the arc will be filled like
* an open semi-circle (OPEN) , a closed semi-circle
* (CHORD), or as a closed pie segment (PIE). The
* origin may be changed with the ellipseMode()
* function. Note that drawing a full circle (ex: 0
* to TWO_PI) will appear blank because 0 and TWO_PI
* are the same position on the unit circle. The best
* way to handle this is by using the ellipse()
* function instead to create a closed ellipse, and
* to use the arc() function only to draw parts of an
* ellipse.
* @param x x-coordinate of the arc's ellipse
* @param y y-coordinate of the arc's ellipse
* @param w width of the arc's ellipse by default
* @param h height of the arc's ellipse by default
* @param start angle to start the arc, specified in
* radians
* @param stop angle to stop the arc, specified in
* radians
* @param [mode] optional parameter to determine the
* way of drawing the arc. either CHORD, PIE or OPEN
* @param [detail] optional parameter for WebGL mode
* only. This is to specify the number of vertices
* that makes up the perimeter of the arc. Default
* value is 25.
* @chainable
*/
arc(
x: number,
y: number,
w: number,
h: number,
start: number,
stop: number,
mode?: ARC_MODE,
detail?: number
): p5;
declare module '../../../index' {
interface p5InstanceExtensions {
/**
* Draw an arc to the screen. If called with only x,
* y, w, h, start, and stop, the arc will be drawn
* and filled as an open pie segment. If a mode
* parameter is provided, the arc will be filled like
* an open semi-circle (OPEN) , a closed semi-circle
* (CHORD), or as a closed pie segment (PIE). The
* origin may be changed with the ellipseMode()
* function. The arc is always drawn clockwise from
* wherever start falls to wherever stop falls on the
* ellipse. Adding or subtracting TWO_PI to either
* angle does not change where they fall. If both
* start and stop fall at the same place, a full
* ellipse will be drawn. Be aware that the the
* y-axis increases in the downward direction
* therefore the values of PI is counter clockwise.
* @param x x-coordinate of the arc's ellipse
* @param y y-coordinate of the arc's ellipse
* @param w width of the arc's ellipse by default
* @param h height of the arc's ellipse by default
* @param start angle to start the arc, specified in
* radians
* @param stop angle to stop the arc, specified in
* radians
* @param [mode] optional parameter to determine the
* way of drawing the arc. either CHORD, PIE or OPEN
* @param [detail] optional parameter for WebGL mode
* only. This is to specify the number of vertices
* that makes up the perimeter of the arc. Default
* value is 25.
* @chainable
*/
arc(
x: number,
y: number,
w: number,
h: number,
start: number,
stop: number,
mode?: ARC_MODE,
detail?: number
): p5;
/**
* Draws an ellipse (oval) to the screen. An ellipse
* with equal width and height is a circle. By
* default, the first two parameters set the
* location, and the third and fourth parameters set
* the shape's width and height. If no height is
* specified, the value of width is used for both the
* width and height. If a negative height or width is
* specified, the absolute value is taken. The origin
* may be changed with the ellipseMode() function.
* @param x x-coordinate of the ellipse.
* @param y y-coordinate of the ellipse.
* @param w width of the ellipse.
* @param [h] height of the ellipse.
* @chainable
*/
ellipse(
x: number,
y: number,
w: number,
h?: number
): p5;
/**
* Draws an ellipse (oval) to the screen. An ellipse
* with equal width and height is a circle. By
* default, the first two parameters set the
* location, and the third and fourth parameters set
* the shape's width and height. If no height is
* specified, the value of width is used for both the
* width and height. If a negative height or width is
* specified, the absolute value is taken. The origin
* may be changed with the ellipseMode() function.
* @param x x-coordinate of the ellipse.
* @param y y-coordinate of the ellipse.
* @param w width of the ellipse.
* @param [h] height of the ellipse.
* @chainable
*/
ellipse(x: number, y: number, w: number, h?: number): p5;
/**
* Draws an ellipse (oval) to the screen. An ellipse
* with equal width and height is a circle. By
* default, the first two parameters set the
* location, and the third and fourth parameters set
* the shape's width and height. If no height is
* specified, the value of width is used for both the
* width and height. If a negative height or width is
* specified, the absolute value is taken. The origin
* may be changed with the ellipseMode() function.
* @param x x-coordinate of the ellipse.
* @param y y-coordinate of the ellipse.
* @param w width of the ellipse.
* @param h height of the ellipse.
* @param detail number of radial sectors to draw
* (for WebGL mode)
*/
ellipse(
x: number,
y: number,
w: number,
h: number,
detail: number
): void;
/**
* Draws an ellipse (oval) to the screen. An ellipse
* with equal width and height is a circle. By
* default, the first two parameters set the
* location, and the third and fourth parameters set
* the shape's width and height. If no height is
* specified, the value of width is used for both the
* width and height. If a negative height or width is
* specified, the absolute value is taken. The origin
* may be changed with the ellipseMode() function.
* @param x x-coordinate of the ellipse.
* @param y y-coordinate of the ellipse.
* @param w width of the ellipse.
* @param h height of the ellipse.
* @param detail number of radial sectors to draw
* (for WebGL mode)
*/
ellipse(x: number, y: number, w: number, h: number, detail: number): void;
/**
* Draws a circle to the screen. A circle is a simple
* closed shape. It is the set of all points in a
* plane that are at a given distance from a given
* point, the centre. This function is a special case
* of the ellipse() function, where the width and
* height of the ellipse are the same. Height and
* width of the ellipse is equal to twice the radius
* of the circle.. By default, the first two
* parameters set the location of the centre of the
* circle, the third sets the radius of the circle.
* @param x x-coordinate of the centre of the circle.
* @param y y-coordinate of the centre of the circle.
* @param r radius of the circle.
* @chainable
*/
circle(
x: number,
y: number,
r: number
): p5;
/**
* Draws a circle to the screen. A circle is a simple
* closed shape. It is the set of all points in a
* plane that are at a given distance from a given
* point, the centre. This function is a special case
* of the ellipse() function, where the width and
* height of the ellipse are the same. Height and
* width of the ellipse correspond to the diameter of
* the circle. By default, the first two parameters
* set the location of the centre of the circle, the
* third sets the diameter of the circle.
* @param x x-coordinate of the centre of the circle.
* @param y y-coordinate of the centre of the circle.
* @param d diameter of the circle.
* @chainable
*/
circle(x: number, y: number, d: number): p5;
/**
* Draws a line (a direct path between two points) to
* the screen. The version of line() with four
* parameters draws the line in 2D. To color a line,
* use the stroke() function. A line cannot be
* filled, therefore the fill() function will not
* affect the color of a line. 2D lines are drawn
* with a width of one pixel by default, but this can
* be changed with the strokeWeight() function.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @chainable
*/
line(
x1: number,
y1: number,
x2: number,
y2: number
): p5;
/**
* Draws a line (a direct path between two points) to
* the screen. The version of line() with four
* parameters draws the line in 2D. To color a line,
* use the stroke() function. A line cannot be
* filled, therefore the fill() function will not
* affect the color of a line. 2D lines are drawn
* with a width of one pixel by default, but this can
* be changed with the strokeWeight() function.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @chainable
*/
line(x1: number, y1: number, x2: number, y2: number): p5;
/**
* Draws a line (a direct path between two points) to
* the screen. The version of line() with four
* parameters draws the line in 2D. To color a line,
* use the stroke() function. A line cannot be
* filled, therefore the fill() function will not
* affect the color of a line. 2D lines are drawn
* with a width of one pixel by default, but this can
* be changed with the strokeWeight() function.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param z1 the z-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param z2 the z-coordinate of the second point
* @chainable
*/
line(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number
): p5;
/**
* Draws a line (a direct path between two points) to
* the screen. The version of line() with four
* parameters draws the line in 2D. To color a line,
* use the stroke() function. A line cannot be
* filled, therefore the fill() function will not
* affect the color of a line. 2D lines are drawn
* with a width of one pixel by default, but this can
* be changed with the strokeWeight() function.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param z1 the z-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param z2 the z-coordinate of the second point
* @chainable
*/
line(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number): p5;
/**
* Draws a point, a coordinate in space at the
* dimension of one pixel. The first parameter is the
* horizontal value for the point, the second value
* is the vertical value for the point. The color of
* the point is determined by the current stroke.
* @param x the x-coordinate
* @param y the y-coordinate
* @param [z] the z-coordinate (for WebGL mode)
* @chainable
*/
point(
x: number,
y: number,
z?: number
): p5;
/**
* Draws a point, a coordinate in space at the
* dimension of one pixel. The first parameter is the
* horizontal value for the point, the second value
* is the vertical value for the point. The color of
* the point is determined by the current stroke.
* @param x the x-coordinate
* @param y the y-coordinate
* @param [z] the z-coordinate (for WebGL mode)
* @chainable
*/
point(x: number, y: number, z?: number): p5;
/**
* Draw a quad. A quad is a quadrilateral, a four
* sided polygon. It is similar to a rectangle, but
* the angles between its edges are not constrained
* to ninety degrees. The first pair of parameters
* (x1,y1) sets the first vertex and the subsequent
* pairs should proceed clockwise or
* counter-clockwise around the defined shape.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param x3 the x-coordinate of the third point
* @param y3 the y-coordinate of the third point
* @param x4 the x-coordinate of the fourth point
* @param y4 the y-coordinate of the fourth point
* @chainable
*/
quad(
x1: number,
y1: number,
x2: number,
y2: number,
x3: number,
y3: number,
x4: number,
y4: number
): p5;
/**
* Draw a quad. A quad is a quadrilateral, a four
* sided polygon. It is similar to a rectangle, but
* the angles between its edges are not constrained
* to ninety degrees. The first pair of parameters
* (x1,y1) sets the first vertex and the subsequent
* pairs should proceed clockwise or
* counter-clockwise around the defined shape.
* z-arguments only work when quad() is used in WEBGL
* mode.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param x3 the x-coordinate of the third point
* @param y3 the y-coordinate of the third point
* @param x4 the x-coordinate of the fourth point
* @param y4 the y-coordinate of the fourth point
* @chainable
*/
quad(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): p5;
/**
* Draw a quad. A quad is a quadrilateral, a four
* sided polygon. It is similar to a rectangle, but
* the angles between its edges are not constrained
* to ninety degrees. The first pair of parameters
* (x1,y1) sets the first vertex and the subsequent
* pairs should proceed clockwise or
* counter-clockwise around the defined shape.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param z1 the z-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param z2 the z-coordinate of the second point
* @param x3 the x-coordinate of the third point
* @param y3 the y-coordinate of the third point
* @param z3 the z-coordinate of the third point
* @param x4 the x-coordinate of the fourth point
* @param y4 the y-coordinate of the fourth point
* @param z4 the z-coordinate of the fourth point
* @chainable
*/
quad(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Draw a quad. A quad is a quadrilateral, a four
* sided polygon. It is similar to a rectangle, but
* the angles between its edges are not constrained
* to ninety degrees. The first pair of parameters
* (x1,y1) sets the first vertex and the subsequent
* pairs should proceed clockwise or
* counter-clockwise around the defined shape.
* z-arguments only work when quad() is used in WEBGL
* mode.
* @param x1 the x-coordinate of the first point
* @param y1 the y-coordinate of the first point
* @param z1 the z-coordinate of the first point
* @param x2 the x-coordinate of the second point
* @param y2 the y-coordinate of the second point
* @param z2 the z-coordinate of the second point
* @param x3 the x-coordinate of the third point
* @param y3 the y-coordinate of the third point
* @param z3 the z-coordinate of the third point
* @param x4 the x-coordinate of the fourth point
* @param y4 the y-coordinate of the fourth point
* @param z4 the z-coordinate of the fourth point
* @chainable
*/
quad(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Draws a rectangle to the screen. A rectangle is a
* four-sided shape with every angle at ninety
* degrees. By default, the first two parameters set
* the location of the upper-left corner, the third
* sets the width, and the fourth sets the height.
* The way these parameters are interpreted, however,
* may be changed with the rectMode() function. The
* fifth, sixth, seventh and eighth parameters, if
* specified, determine corner radius for the
* top-left, top-right, lower-right and lower-left
* corners, respectively. An omitted corner radius
* parameter is set to the value of the previously
* specified radius value in the parameter list.
* @param x x-coordinate of the rectangle.
* @param y y-coordinate of the rectangle.
* @param w width of the rectangle.
* @param h height of the rectangle.
* @param [tl] optional radius of top-left corner.
* @param [tr] optional radius of top-right corner.
* @param [br] optional radius of bottom-right
* corner.
* @param [bl] optional radius of bottom-left corner.
* @chainable
*/
rect(
x: number,
y: number,
w: number,
h: number,
tl?: number,
tr?: number,
br?: number,
bl?: number
): p5;
/**
* Draws a rectangle to the screen. A rectangle is a
* four-sided shape with every angle at ninety
* degrees. By default, the first two parameters set
* the location of the upper-left corner, the third
* sets the width, and the fourth sets the height.
* The way these parameters are interpreted, however,
* may be changed with the rectMode() function. The
* fifth, sixth, seventh and eighth parameters, if
* specified, determine corner radius for the
* top-left, top-right, lower-right and lower-left
* corners, respectively. An omitted corner radius
* parameter is set to the value of the previously
* specified radius value in the parameter list.
* @param x x-coordinate of the rectangle.
* @param y y-coordinate of the rectangle.
* @param w width of the rectangle.
* @param h height of the rectangle.
* @param [tl] optional radius of top-left corner.
* @param [tr] optional radius of top-right corner.
* @param [br] optional radius of bottom-right
* corner.
* @param [bl] optional radius of bottom-left corner.
* @chainable
*/
rect(x: number, y: number, w: number, h: number, tl?: number, tr?: number, br?: number, bl?: number): p5;
/**
* Draws a rectangle to the screen. A rectangle is a
* four-sided shape with every angle at ninety
* degrees. By default, the first two parameters set
* the location of the upper-left corner, the third
* sets the width, and the fourth sets the height.
* The way these parameters are interpreted, however,
* may be changed with the rectMode() function. The
* fifth, sixth, seventh and eighth parameters, if
* specified, determine corner radius for the
* top-left, top-right, lower-right and lower-left
* corners, respectively. An omitted corner radius
* parameter is set to the value of the previously
* specified radius value in the parameter list.
* @param x x-coordinate of the rectangle.
* @param y y-coordinate of the rectangle.
* @param w width of the rectangle.
* @param h height of the rectangle.
* @param [detailX] number of segments in the
* x-direction (for WebGL mode)
* @param [detailY] number of segments in the
* y-direction (for WebGL mode)
* @chainable
*/
rect(
x: number,
y: number,
w: number,
h: number,
detailX?: number,
detailY?: number
): p5;
/**
* Draws a rectangle to the screen. A rectangle is a
* four-sided shape with every angle at ninety
* degrees. By default, the first two parameters set
* the location of the upper-left corner, the third
* sets the width, and the fourth sets the height.
* The way these parameters are interpreted, however,
* may be changed with the rectMode() function. The
* fifth, sixth, seventh and eighth parameters, if
* specified, determine corner radius for the
* top-left, top-right, lower-right and lower-left
* corners, respectively. An omitted corner radius
* parameter is set to the value of the previously
* specified radius value in the parameter list.
* @param x x-coordinate of the rectangle.
* @param y y-coordinate of the rectangle.
* @param w width of the rectangle.
* @param h height of the rectangle.
* @param [detailX] number of segments in the
* x-direction (for WebGL mode)
* @param [detailY] number of segments in the
* y-direction (for WebGL mode)
* @chainable
*/
rect(x: number, y: number, w: number, h: number, detailX?: number, detailY?: number): p5;
/**
* Draws a square to the screen. A square is a
* four-sided shape with every angle at ninety
* degrees, and equal side size. This function is a
* special case of the rect() function, where the
* width and height are the same, and the parameter
* is called "s" for side size. By default, the first
* two parameters set the location of the upper-left
* corner, the third sets the side size of the
* square. The way these parameters are interpreted,
* however, may be changed with the rectMode()
* function. The fourth, fifth, sixth and seventh
* parameters, if specified, determine corner radius
* for the top-left, top-right, lower-right and
* lower-left corners, respectively. An omitted
* corner radius parameter is set to the value of the
* previously specified radius value in the parameter
* list.
* @param x x-coordinate of the square.
* @param y y-coordinate of the square.
* @param s side size of the square.
* @param [tl] optional radius of top-left corner.
* @param [tr] optional radius of top-right corner.
* @param [br] optional radius of bottom-right
* corner.
* @param [bl] optional radius of bottom-left corner.
* @chainable
*/
square(
x: number,
y: number,
s: number,
tl?: number,
tr?: number,
br?: number,
bl?: number
): p5;
/**
* Draws a square to the screen. A square is a
* four-sided shape with every angle at ninety
* degrees, and equal side size. This function is a
* special case of the rect() function, where the
* width and height are the same, and the parameter
* is called "s" for side size. By default, the first
* two parameters set the location of the upper-left
* corner, the third sets the side size of the
* square. The way these parameters are interpreted,
* however, may be changed with the rectMode()
* function. The fourth, fifth, sixth and seventh
* parameters, if specified, determine corner radius
* for the top-left, top-right, lower-right and
* lower-left corners, respectively. An omitted
* corner radius parameter is set to the value of the
* previously specified radius value in the parameter
* list.
* @param x x-coordinate of the square.
* @param y y-coordinate of the square.
* @param s side size of the square.
* @param [tl] optional radius of top-left corner.
* @param [tr] optional radius of top-right corner.
* @param [br] optional radius of bottom-right
* corner.
* @param [bl] optional radius of bottom-left corner.
* @chainable
*/
square(x: number, y: number, s: number, tl?: number, tr?: number, br?: number, bl?: number): p5;
/**
* A triangle is a plane created by connecting three
* points. The first two arguments specify the first
* point, the middle two arguments specify the second
* point, and the last two arguments specify the
* third point.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @param x3 x-coordinate of the third point
* @param y3 y-coordinate of the third point
* @chainable
*/
triangle(
x1: number,
y1: number,
x2: number,
y2: number,
x3: number,
y3: number
): p5;
}
/**
* A triangle is a plane created by connecting three
* points. The first two arguments specify the first
* point, the middle two arguments specify the second
* point, and the last two arguments specify the
* third point.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @param x3 x-coordinate of the third point
* @param y3 y-coordinate of the third point
* @chainable
*/
triangle(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number): p5;
}
}
types/p5/src/core/shape/attributes.d.ts
Vendored
+126 -136
View File
@@ -1,146 +1,136 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../../index";
import * as p5 from '../../../index';
declare module "../../../index" {
interface p5InstanceExtensions {
/**
* Modifies the location from which ellipses are
* drawn by changing the way in which parameters
* given to ellipse() are interpreted. The default
* mode is ellipseMode(CENTER), which interprets the
* first two parameters of ellipse() as the shape's
* center point, while the third and fourth
* parameters are its width and height.
*
*
* ellipseMode(RADIUS) also uses the first two
* parameters of ellipse() as the shape's center
* point, but uses the third and fourth parameters to
* specify half of the shapes's width and height.
*
*
* ellipseMode(CORNER) interprets the first two
* parameters of ellipse() as the upper-left corner
* of the shape, while the third and fourth
* parameters are its width and height.
*
*
* ellipseMode(CORNERS) interprets the first two
* parameters of ellipse() as the location of one
* corner of the ellipse's bounding box, and the
* third and fourth parameters as the location of the
* opposite corner.
*
*
* The parameter must be written in ALL CAPS because
* Javascript is a case-sensitive language.
* @param mode either CENTER, RADIUS, CORNER, or
* CORNERS
* @chainable
*/
ellipseMode(
mode: ELLIPSE_MODE
): p5;
declare module '../../../index' {
interface p5InstanceExtensions {
/**
* Modifies the location from which ellipses are
* drawn by changing the way in which parameters
* given to ellipse() are interpreted. The default
* mode is ellipseMode(CENTER), which interprets the
* first two parameters of ellipse() as the shape's
* center point, while the third and fourth
* parameters are its width and height.
*
*
* ellipseMode(RADIUS) also uses the first two
* parameters of ellipse() as the shape's center
* point, but uses the third and fourth parameters to
* specify half of the shapes's width and height.
*
*
* ellipseMode(CORNER) interprets the first two
* parameters of ellipse() as the upper-left corner
* of the shape, while the third and fourth
* parameters are its width and height.
*
*
* ellipseMode(CORNERS) interprets the first two
* parameters of ellipse() as the location of one
* corner of the ellipse's bounding box, and the
* third and fourth parameters as the location of the
* opposite corner.
*
*
* The parameter must be written in ALL CAPS because
* Javascript is a case-sensitive language.
* @param mode either CENTER, RADIUS, CORNER, or
* CORNERS
* @chainable
*/
ellipseMode(mode: ELLIPSE_MODE): p5;
/**
* Draws all geometry with jagged (aliased) edges.
* Note that smooth() is active by default in 2D
* mode, so it is necessary to call noSmooth() to
* disable smoothing of geometry, images, and fonts.
* In 3D mode, noSmooth() is enabled by default, so
* it is necessary to call smooth() if you would like
* smooth (antialiased) edges on your geometry.
* @chainable
*/
noSmooth(): p5;
/**
* Draws all geometry with jagged (aliased) edges.
* Note that smooth() is active by default in 2D
* mode, so it is necessary to call noSmooth() to
* disable smoothing of geometry, images, and fonts.
* In 3D mode, noSmooth() is enabled by default, so
* it is necessary to call smooth() if you would like
* smooth (antialiased) edges on your geometry.
* @chainable
*/
noSmooth(): p5;
/**
* Modifies the location from which rectangles are
* drawn by changing the way in which parameters
* given to rect() are interpreted. The default mode
* is rectMode(CORNER), which interprets the first
* two parameters of rect() as the upper-left corner
* of the shape, while the third and fourth
* parameters are its width and height.
*
*
* rectMode(CORNERS) interprets the first two
* parameters of rect() as the location of one
* corner, and the third and fourth parameters as the
* location of the opposite corner.
*
*
* rectMode(CENTER) interprets the first two
* parameters of rect() as the shape's center point,
* while the third and fourth parameters are its
* width and height.
*
*
* rectMode(RADIUS) also uses the first two
* parameters of rect() as the shape's center point,
* but uses the third and fourth parameters to
* specify half of the shapes's width and height.
*
*
* The parameter must be written in ALL CAPS because
* Javascript is a case-sensitive language.
* @param mode either CORNER, CORNERS, CENTER, or
* RADIUS
* @chainable
*/
rectMode(
mode: RECT_MODE
): p5;
/**
* Modifies the location from which rectangles are
* drawn by changing the way in which parameters
* given to rect() are interpreted. The default mode
* is rectMode(CORNER), which interprets the first
* two parameters of rect() as the upper-left corner
* of the shape, while the third and fourth
* parameters are its width and height.
*
*
* rectMode(CORNERS) interprets the first two
* parameters of rect() as the location of one
* corner, and the third and fourth parameters as the
* location of the opposite corner.
*
*
* rectMode(CENTER) interprets the first two
* parameters of rect() as the shape's center point,
* while the third and fourth parameters are its
* width and height.
*
*
* rectMode(RADIUS) also uses the first two
* parameters of rect() as the shape's center point,
* but uses the third and fourth parameters to
* specify half of the shapes's width and height.
*
*
* The parameter must be written in ALL CAPS because
* Javascript is a case-sensitive language.
* @param mode either CORNER, CORNERS, CENTER, or
* RADIUS
* @chainable
*/
rectMode(mode: RECT_MODE): p5;
/**
* Draws all geometry with smooth (anti-aliased)
* edges. smooth() will also improve image quality of
* resized images. Note that smooth() is active by
* default in 2D mode; noSmooth() can be used to
* disable smoothing of geometry, images, and fonts.
* In 3D mode, noSmooth() is enabled by default, so
* it is necessary to call smooth() if you would like
* smooth (antialiased) edges on your geometry.
* @chainable
*/
smooth(): p5;
/**
* Draws all geometry with smooth (anti-aliased)
* edges. smooth() will also improve image quality of
* resized images. Note that smooth() is active by
* default in 2D mode; noSmooth() can be used to
* disable smoothing of geometry, images, and fonts.
* In 3D mode, noSmooth() is enabled by default, so
* it is necessary to call smooth() if you would like
* smooth (antialiased) edges on your geometry.
* @chainable
*/
smooth(): p5;
/**
* Sets the style for rendering line endings. These
* ends are either squared, extended, or rounded,
* each of which specified with the corresponding
* parameters: SQUARE, PROJECT, and ROUND. The
* default cap is ROUND.
* @param cap either SQUARE, PROJECT, or ROUND
* @chainable
*/
strokeCap(
cap: STROKE_CAP
): p5;
/**
* Sets the style for rendering line endings. These
* ends are either squared, extended, or rounded,
* each of which specified with the corresponding
* parameters: SQUARE, PROJECT, and ROUND. The
* default cap is ROUND.
* @param cap either SQUARE, PROJECT, or ROUND
* @chainable
*/
strokeCap(cap: STROKE_CAP): p5;
/**
* Sets the style of the joints which connect line
* segments. These joints are either mitered,
* beveled, or rounded and specified with the
* corresponding parameters MITER, BEVEL, and ROUND.
* The default joint is MITER.
* @param join either MITER, BEVEL, ROUND
* @chainable
*/
strokeJoin(
join: STROKE_JOIN
): p5;
/**
* Sets the style of the joints which connect line
* segments. These joints are either mitered,
* beveled, or rounded and specified with the
* corresponding parameters MITER, BEVEL, and ROUND.
* The default joint is MITER.
* @param join either MITER, BEVEL, ROUND
* @chainable
*/
strokeJoin(join: STROKE_JOIN): p5;
/**
* Sets the width of the stroke used for lines,
* points, and the border around shapes. All widths
* are set in units of pixels.
* @param weight the weight (in pixels) of the stroke
* @chainable
*/
strokeWeight(
weight: number
): p5;
}
/**
* Sets the width of the stroke used for lines,
* points, and the border around shapes. All widths
* are set in units of pixels.
* @param weight the weight (in pixels) of the stroke
* @chainable
*/
strokeWeight(weight: number): p5;
}
}
types/p5/src/core/shape/curves.d.ts
Vendored
+251 -299
View File
@@ -1,313 +1,265 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../../index";
import * as p5 from '../../../index';
declare module "../../../index" {
interface p5InstanceExtensions {
/**
* Draws a cubic Bezier curve on the screen. These
* curves are defined by a series of anchor and
* control points. The first two parameters specify
* the first anchor point and the last two parameters
* specify the other anchor point, which become the
* first and last points on the curve. The middle
* parameters specify the two control points which
* define the shape of the curve. Approximately
* speaking, control points "pull" the curve towards
* them.Bezier curves were developed by French
* automotive engineer Pierre Bezier, and are
* commonly used in computer graphics to define
* gently sloping curves. See also curve().
* @param x1 x-coordinate for the first anchor point
* @param y1 y-coordinate for the first anchor point
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param x4 x-coordinate for the second anchor point
* @param y4 y-coordinate for the second anchor point
* @chainable
*/
bezier(
x1: number,
y1: number,
x2: number,
y2: number,
x3: number,
y3: number,
x4: number,
y4: number
): p5;
declare module '../../../index' {
interface p5InstanceExtensions {
/**
* Draws a cubic Bezier curve on the screen. These
* curves are defined by a series of anchor and
* control points. The first two parameters specify
* the first anchor point and the last two parameters
* specify the other anchor point, which become the
* first and last points on the curve. The middle
* parameters specify the two control points which
* define the shape of the curve. Approximately
* speaking, control points "pull" the curve towards
* them.Bezier curves were developed by French
* automotive engineer Pierre Bezier, and are
* commonly used in computer graphics to define
* gently sloping curves. See also curve().
* @param x1 x-coordinate for the first anchor point
* @param y1 y-coordinate for the first anchor point
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param x4 x-coordinate for the second anchor point
* @param y4 y-coordinate for the second anchor point
* @chainable
*/
bezier(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): p5;
/**
* Draws a cubic Bezier curve on the screen. These
* curves are defined by a series of anchor and
* control points. The first two parameters specify
* the first anchor point and the last two parameters
* specify the other anchor point, which become the
* first and last points on the curve. The middle
* parameters specify the two control points which
* define the shape of the curve. Approximately
* speaking, control points "pull" the curve towards
* them.Bezier curves were developed by French
* automotive engineer Pierre Bezier, and are
* commonly used in computer graphics to define
* gently sloping curves. See also curve().
* @param x1 x-coordinate for the first anchor point
* @param y1 y-coordinate for the first anchor point
* @param z1 z-coordinate for the first anchor point
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param z2 z-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param z3 z-coordinate for the second control
* point
* @param x4 x-coordinate for the second anchor point
* @param y4 y-coordinate for the second anchor point
* @param z4 z-coordinate for the second anchor point
* @chainable
*/
bezier(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Draws a cubic Bezier curve on the screen. These
* curves are defined by a series of anchor and
* control points. The first two parameters specify
* the first anchor point and the last two parameters
* specify the other anchor point, which become the
* first and last points on the curve. The middle
* parameters specify the two control points which
* define the shape of the curve. Approximately
* speaking, control points "pull" the curve towards
* them.Bezier curves were developed by French
* automotive engineer Pierre Bezier, and are
* commonly used in computer graphics to define
* gently sloping curves. See also curve().
* @param x1 x-coordinate for the first anchor point
* @param y1 y-coordinate for the first anchor point
* @param z1 z-coordinate for the first anchor point
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param z2 z-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param z3 z-coordinate for the second control
* point
* @param x4 x-coordinate for the second anchor point
* @param y4 y-coordinate for the second anchor point
* @param z4 z-coordinate for the second anchor point
* @chainable
*/
bezier(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Sets the resolution at which Beziers display. The
* default value is 20.
*
* This function is only useful when using the WEBGL
* renderer as the default canvas renderer does not
* use this information.
* @param detail resolution of the curves
* @chainable
*/
bezierDetail(
detail: number
): p5;
/**
* Sets the resolution at which Beziers display. The
* default value is 20.
*
* This function is only useful when using the WEBGL
* renderer as the default canvas renderer does not
* use this information.
* @param detail resolution of the curves
* @chainable
*/
bezierDetail(detail: number): p5;
/**
* Evaluates the Bezier at position t for points a,
* b, c, d. The parameters a and d are the first and
* last points on the curve, and b and c are the
* control points. The final parameter t varies
* between 0 and 1. This can be done once with the x
* coordinates and a second time with the y
* coordinates to get the location of a bezier curve
* at t.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the value of the Bezier at position t
*/
bezierPoint(
a: number,
b: number,
c: number,
d: number,
t: number
): number;
/**
* Evaluates the Bezier at position t for points a,
* b, c, d. The parameters a and d are the first and
* last points on the curve, and b and c are the
* control points. The final parameter t varies
* between 0 and 1. This can be done once with the x
* coordinates and a second time with the y
* coordinates to get the location of a bezier curve
* at t.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the value of the Bezier at position t
*/
bezierPoint(a: number, b: number, c: number, d: number, t: number): number;
/**
* Evaluates the tangent to the Bezier at position t
* for points a, b, c, d. The parameters a and d are
* the first and last points on the curve, and b and
* c are the control points. The final parameter t
* varies between 0 and 1.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the tangent at position t
*/
bezierTangent(
a: number,
b: number,
c: number,
d: number,
t: number
): number;
/**
* Evaluates the tangent to the Bezier at position t
* for points a, b, c, d. The parameters a and d are
* the first and last points on the curve, and b and
* c are the control points. The final parameter t
* varies between 0 and 1.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the tangent at position t
*/
bezierTangent(a: number, b: number, c: number, d: number, t: number): number;
/**
* Draws a curved line on the screen between two
* points, given as the middle four parameters. The
* first two parameters are a control point, as if
* the curve came from this point even though it's
* not drawn. The last two parameters similarly
* describe the other control point. Longer curves
* can be created by putting a series of curve()
* functions together or using curveVertex(). An
* additional function called curveTightness()
* provides control for the visual quality of the
* curve. The curve() function is an implementation
* of Catmull-Rom splines.
* @param x1 x-coordinate for the beginning control
* point
* @param y1 y-coordinate for the beginning control
* point
* @param x2 x-coordinate for the first point
* @param y2 y-coordinate for the first point
* @param x3 x-coordinate for the second point
* @param y3 y-coordinate for the second point
* @param x4 x-coordinate for the ending control
* point
* @param y4 y-coordinate for the ending control
* point
* @chainable
*/
curve(
x1: number,
y1: number,
x2: number,
y2: number,
x3: number,
y3: number,
x4: number,
y4: number
): p5;
/**
* Draws a curved line on the screen between two
* points, given as the middle four parameters. The
* first two parameters are a control point, as if
* the curve came from this point even though it's
* not drawn. The last two parameters similarly
* describe the other control point. Longer curves
* can be created by putting a series of curve()
* functions together or using curveVertex(). An
* additional function called curveTightness()
* provides control for the visual quality of the
* curve. The curve() function is an implementation
* of Catmull-Rom splines.
* @param x1 x-coordinate for the beginning control
* point
* @param y1 y-coordinate for the beginning control
* point
* @param x2 x-coordinate for the first point
* @param y2 y-coordinate for the first point
* @param x3 x-coordinate for the second point
* @param y3 y-coordinate for the second point
* @param x4 x-coordinate for the ending control
* point
* @param y4 y-coordinate for the ending control
* point
* @chainable
*/
curve(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): p5;
/**
* Draws a curved line on the screen between two
* points, given as the middle four parameters. The
* first two parameters are a control point, as if
* the curve came from this point even though it's
* not drawn. The last two parameters similarly
* describe the other control point. Longer curves
* can be created by putting a series of curve()
* functions together or using curveVertex(). An
* additional function called curveTightness()
* provides control for the visual quality of the
* curve. The curve() function is an implementation
* of Catmull-Rom splines.
* @param x1 x-coordinate for the beginning control
* point
* @param y1 y-coordinate for the beginning control
* point
* @param z1 z-coordinate for the beginning control
* point
* @param x2 x-coordinate for the first point
* @param y2 y-coordinate for the first point
* @param z2 z-coordinate for the first point
* @param x3 x-coordinate for the second point
* @param y3 y-coordinate for the second point
* @param z3 z-coordinate for the second point
* @param x4 x-coordinate for the ending control
* point
* @param y4 y-coordinate for the ending control
* point
* @param z4 z-coordinate for the ending control
* point
* @chainable
*/
curve(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Draws a curved line on the screen between two
* points, given as the middle four parameters. The
* first two parameters are a control point, as if
* the curve came from this point even though it's
* not drawn. The last two parameters similarly
* describe the other control point. Longer curves
* can be created by putting a series of curve()
* functions together or using curveVertex(). An
* additional function called curveTightness()
* provides control for the visual quality of the
* curve. The curve() function is an implementation
* of Catmull-Rom splines.
* @param x1 x-coordinate for the beginning control
* point
* @param y1 y-coordinate for the beginning control
* point
* @param z1 z-coordinate for the beginning control
* point
* @param x2 x-coordinate for the first point
* @param y2 y-coordinate for the first point
* @param z2 z-coordinate for the first point
* @param x3 x-coordinate for the second point
* @param y3 y-coordinate for the second point
* @param z3 z-coordinate for the second point
* @param x4 x-coordinate for the ending control
* point
* @param y4 y-coordinate for the ending control
* point
* @param z4 z-coordinate for the ending control
* point
* @chainable
*/
curve(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Sets the resolution at which curves display. The
* default value is 20 while the minimum value is 3.
*
* This function is only useful when using the WEBGL
* renderer as the default canvas renderer does not
* use this information.
* @param resolution resolution of the curves
* @chainable
*/
curveDetail(
resolution: number
): p5;
/**
* Sets the resolution at which curves display. The
* default value is 20 while the minimum value is 3.
*
* This function is only useful when using the WEBGL
* renderer as the default canvas renderer does not
* use this information.
* @param resolution resolution of the curves
* @chainable
*/
curveDetail(resolution: number): p5;
/**
* Modifies the quality of forms created with curve()
* and curveVertex(). The parameter tightness
* determines how the curve fits to the vertex
* points. The value 0.0 is the default value for
* tightness (this value defines the curves to be
* Catmull-Rom splines) and the value 1.0 connects
* all the points with straight lines. Values within
* the range -5.0 and 5.0 will deform the curves but
* will leave them recognizable and as values
* increase in magnitude, they will continue to
* deform.
* @param amount amount of deformation from the
* original vertices
* @chainable
*/
curveTightness(
amount: number
): p5;
/**
* Modifies the quality of forms created with curve()
* and curveVertex(). The parameter tightness
* determines how the curve fits to the vertex
* points. The value 0.0 is the default value for
* tightness (this value defines the curves to be
* Catmull-Rom splines) and the value 1.0 connects
* all the points with straight lines. Values within
* the range -5.0 and 5.0 will deform the curves but
* will leave them recognizable and as values
* increase in magnitude, they will continue to
* deform.
* @param amount amount of deformation from the
* original vertices
* @chainable
*/
curveTightness(amount: number): p5;
/**
* Evaluates the curve at position t for points a, b,
* c, d. The parameter t varies between 0 and 1, a
* and d are control points of the curve, and b and c
* are the start and end points of the curve. This
* can be done once with the x coordinates and a
* second time with the y coordinates to get the
* location of a curve at t.
* @param a coordinate of first control point of the
* curve
* @param b coordinate of first point
* @param c coordinate of second point
* @param d coordinate of second control point
* @param t value between 0 and 1
* @return bezier value at position t
*/
curvePoint(
a: number,
b: number,
c: number,
d: number,
t: number
): number;
/**
* Evaluates the curve at position t for points a, b,
* c, d. The parameter t varies between 0 and 1, a
* and d are control points of the curve, and b and c
* are the start and end points of the curve. This
* can be done once with the x coordinates and a
* second time with the y coordinates to get the
* location of a curve at t.
* @param a coordinate of first control point of the
* curve
* @param b coordinate of first point
* @param c coordinate of second point
* @param d coordinate of second control point
* @param t value between 0 and 1
* @return bezier value at position t
*/
curvePoint(a: number, b: number, c: number, d: number, t: number): number;
/**
* Evaluates the tangent to the curve at position t
* for points a, b, c, d. The parameter t varies
* between 0 and 1, a and d are points on the curve,
* and b and c are the control points.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the tangent at position t
*/
curveTangent(
a: number,
b: number,
c: number,
d: number,
t: number
): number;
}
/**
* Evaluates the tangent to the curve at position t
* for points a, b, c, d. The parameter t varies
* between 0 and 1, a and d are points on the curve,
* and b and c are the control points.
* @param a coordinate of first point on the curve
* @param b coordinate of first control point
* @param c coordinate of second control point
* @param d coordinate of second point on the curve
* @param t value between 0 and 1
* @return the tangent at position t
*/
curveTangent(a: number, b: number, c: number, d: number, t: number): number;
}
}
types/p5/src/core/shape/vertex.d.ts
Vendored
+269 -308
View File
@@ -1,323 +1,284 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../../index";
import * as p5 from '../../../index';
declare module "../../../index" {
interface p5InstanceExtensions {
/**
* Use the beginContour() and endContour() functions
* to create negative shapes within shapes such as
* the center of the letter 'O'. beginContour()
* begins recording vertices for the shape and
* endContour() stops recording. The vertices that
* define a negative shape must "wind" in the
* opposite direction from the exterior shape. First
* draw vertices for the exterior clockwise order,
* then for internal shapes, draw vertices shape in
* counter-clockwise. These functions can only be
* used within a beginShape()/endShape() pair and
* transformations such as translate(), rotate(), and
* scale() do not work within a
* beginContour()/endContour() pair. It is also not
* possible to use other shapes, such as ellipse() or
* rect() within.
* @chainable
*/
beginContour(): p5;
declare module '../../../index' {
interface p5InstanceExtensions {
/**
* Use the beginContour() and endContour() functions
* to create negative shapes within shapes such as
* the center of the letter 'O'. beginContour()
* begins recording vertices for the shape and
* endContour() stops recording. The vertices that
* define a negative shape must "wind" in the
* opposite direction from the exterior shape. First
* draw vertices for the exterior clockwise order,
* then for internal shapes, draw vertices shape in
* counter-clockwise. These functions can only be
* used within a beginShape()/endShape() pair and
* transformations such as translate(), rotate(), and
* scale() do not work within a
* beginContour()/endContour() pair. It is also not
* possible to use other shapes, such as ellipse() or
* rect() within.
* @chainable
*/
beginContour(): p5;
/**
* Using the beginShape() and endShape() functions
* allow creating more complex forms. beginShape()
* begins recording vertices for a shape and
* endShape() stops recording. The value of the kind
* parameter tells it which types of shapes to create
* from the provided vertices. With no mode
* specified, the shape can be any irregular polygon.
* The parameters available for beginShape() are
* POINTS, LINES, TRIANGLES, TRIANGLE_FAN,
* TRIANGLE_STRIP, QUADS, and QUAD_STRIP. After
* calling the beginShape() function, a series of
* vertex() commands must follow. To stop drawing the
* shape, call endShape(). Each shape will be
* outlined with the current stroke color and filled
* with the fill color.
*
*
* Transformations such as translate(), rotate(), and
* scale() do not work within beginShape(). It is
* also not possible to use other shapes, such as
* ellipse() or rect() within beginShape().
* @param [kind] either POINTS, LINES, TRIANGLES,
* TRIANGLE_FAN TRIANGLE_STRIP, QUADS, or QUAD_STRIP
* @chainable
*/
beginShape(
kind?: BEGIN_KIND
): p5;
/**
* Using the beginShape() and endShape() functions
* allow creating more complex forms. beginShape()
* begins recording vertices for a shape and
* endShape() stops recording. The value of the kind
* parameter tells it which types of shapes to create
* from the provided vertices. With no mode
* specified, the shape can be any irregular polygon.
* The parameters available for beginShape() are
* POINTS, LINES, TRIANGLES, TRIANGLE_FAN,
* TRIANGLE_STRIP, QUADS, and QUAD_STRIP. After
* calling the beginShape() function, a series of
* vertex() commands must follow. To stop drawing the
* shape, call endShape(). Each shape will be
* outlined with the current stroke color and filled
* with the fill color.
*
*
* Transformations such as translate(), rotate(), and
* scale() do not work within beginShape(). It is
* also not possible to use other shapes, such as
* ellipse() or rect() within beginShape().
* @param [kind] either POINTS, LINES, TRIANGLES,
* TRIANGLE_FAN TRIANGLE_STRIP, QUADS, or QUAD_STRIP
* @chainable
*/
beginShape(kind?: BEGIN_KIND): p5;
/**
* Specifies vertex coordinates for Bezier curves.
* Each call to bezierVertex() defines the position
* of two control points and one anchor point of a
* Bezier curve, adding a new segment to a line or
* shape. For WebGL mode bezierVertex() can be used
* in 2D as well as 3D mode. 2D mode expects 6
* parameters, while 3D mode expects 9 parameters
* (including z coordinates). The first time
* bezierVertex() is used within a beginShape() call,
* it must be prefaced with a call to vertex() to set
* the first anchor point. This function must be used
* between beginShape() and endShape() and only when
* there is no MODE or POINTS parameter specified to
* beginShape().
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param x4 x-coordinate for the anchor point
* @param y4 y-coordinate for the anchor point
* @chainable
*/
bezierVertex(
x2: number,
y2: number,
x3: number,
y3: number,
x4: number,
y4: number
): p5;
/**
* Specifies vertex coordinates for Bezier curves.
* Each call to bezierVertex() defines the position
* of two control points and one anchor point of a
* Bezier curve, adding a new segment to a line or
* shape. For WebGL mode bezierVertex() can be used
* in 2D as well as 3D mode. 2D mode expects 6
* parameters, while 3D mode expects 9 parameters
* (including z coordinates). The first time
* bezierVertex() is used within a beginShape() call,
* it must be prefaced with a call to vertex() to set
* the first anchor point. This function must be used
* between beginShape() and endShape() and only when
* there is no MODE or POINTS parameter specified to
* beginShape().
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param x4 x-coordinate for the anchor point
* @param y4 y-coordinate for the anchor point
* @chainable
*/
bezierVertex(x2: number, y2: number, x3: number, y3: number, x4: number, y4: number): p5;
/**
* Specifies vertex coordinates for Bezier curves.
* Each call to bezierVertex() defines the position
* of two control points and one anchor point of a
* Bezier curve, adding a new segment to a line or
* shape. For WebGL mode bezierVertex() can be used
* in 2D as well as 3D mode. 2D mode expects 6
* parameters, while 3D mode expects 9 parameters
* (including z coordinates). The first time
* bezierVertex() is used within a beginShape() call,
* it must be prefaced with a call to vertex() to set
* the first anchor point. This function must be used
* between beginShape() and endShape() and only when
* there is no MODE or POINTS parameter specified to
* beginShape().
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param z2 z-coordinate for the first control point
* (for WebGL mode)
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param z3 z-coordinate for the second control
* point (for WebGL mode)
* @param x4 x-coordinate for the anchor point
* @param y4 y-coordinate for the anchor point
* @param z4 z-coordinate for the anchor point (for
* WebGL mode)
* @chainable
*/
bezierVertex(
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Specifies vertex coordinates for Bezier curves.
* Each call to bezierVertex() defines the position
* of two control points and one anchor point of a
* Bezier curve, adding a new segment to a line or
* shape. For WebGL mode bezierVertex() can be used
* in 2D as well as 3D mode. 2D mode expects 6
* parameters, while 3D mode expects 9 parameters
* (including z coordinates). The first time
* bezierVertex() is used within a beginShape() call,
* it must be prefaced with a call to vertex() to set
* the first anchor point. This function must be used
* between beginShape() and endShape() and only when
* there is no MODE or POINTS parameter specified to
* beginShape().
* @param x2 x-coordinate for the first control point
* @param y2 y-coordinate for the first control point
* @param z2 z-coordinate for the first control point
* (for WebGL mode)
* @param x3 x-coordinate for the second control
* point
* @param y3 y-coordinate for the second control
* point
* @param z3 z-coordinate for the second control
* point (for WebGL mode)
* @param x4 x-coordinate for the anchor point
* @param y4 y-coordinate for the anchor point
* @param z4 z-coordinate for the anchor point (for
* WebGL mode)
* @chainable
*/
bezierVertex(
x2: number,
y2: number,
z2: number,
x3: number,
y3: number,
z3: number,
x4: number,
y4: number,
z4: number
): p5;
/**
* Specifies vertex coordinates for curves. This
* function may only be used between beginShape() and
* endShape() and only when there is no MODE
* parameter specified to beginShape(). For WebGL
* mode curveVertex() can be used in 2D as well as 3D
* mode. 2D mode expects 2 parameters, while 3D mode
* expects 3 parameters. The first and last points
* in a series of curveVertex() lines will be used to
* guide the beginning and end of a the curve. A
* minimum of four points is required to draw a tiny
* curve between the second and third points. Adding
* a fifth point with curveVertex() will draw the
* curve between the second, third, and fourth
* points. The curveVertex() function is an
* implementation of Catmull-Rom splines.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @chainable
*/
curveVertex(
x: number,
y: number
): p5;
/**
* Specifies vertex coordinates for curves. This
* function may only be used between beginShape() and
* endShape() and only when there is no MODE
* parameter specified to beginShape(). For WebGL
* mode curveVertex() can be used in 2D as well as 3D
* mode. 2D mode expects 2 parameters, while 3D mode
* expects 3 parameters. The first and last points
* in a series of curveVertex() lines will be used to
* guide the beginning and end of a the curve. A
* minimum of four points is required to draw a tiny
* curve between the second and third points. Adding
* a fifth point with curveVertex() will draw the
* curve between the second, third, and fourth
* points. The curveVertex() function is an
* implementation of Catmull-Rom splines.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @chainable
*/
curveVertex(x: number, y: number): p5;
/**
* Specifies vertex coordinates for curves. This
* function may only be used between beginShape() and
* endShape() and only when there is no MODE
* parameter specified to beginShape(). For WebGL
* mode curveVertex() can be used in 2D as well as 3D
* mode. 2D mode expects 2 parameters, while 3D mode
* expects 3 parameters. The first and last points
* in a series of curveVertex() lines will be used to
* guide the beginning and end of a the curve. A
* minimum of four points is required to draw a tiny
* curve between the second and third points. Adding
* a fifth point with curveVertex() will draw the
* curve between the second, third, and fourth
* points. The curveVertex() function is an
* implementation of Catmull-Rom splines.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @param [z] z-coordinate of the vertex (for WebGL
* mode)
* @chainable
*/
curveVertex(
x: number,
y: number,
z?: number
): p5;
/**
* Specifies vertex coordinates for curves. This
* function may only be used between beginShape() and
* endShape() and only when there is no MODE
* parameter specified to beginShape(). For WebGL
* mode curveVertex() can be used in 2D as well as 3D
* mode. 2D mode expects 2 parameters, while 3D mode
* expects 3 parameters. The first and last points
* in a series of curveVertex() lines will be used to
* guide the beginning and end of a the curve. A
* minimum of four points is required to draw a tiny
* curve between the second and third points. Adding
* a fifth point with curveVertex() will draw the
* curve between the second, third, and fourth
* points. The curveVertex() function is an
* implementation of Catmull-Rom splines.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @param [z] z-coordinate of the vertex (for WebGL
* mode)
* @chainable
*/
curveVertex(x: number, y: number, z?: number): p5;
/**
* Use the beginContour() and endContour() functions
* to create negative shapes within shapes such as
* the center of the letter 'O'. beginContour()
* begins recording vertices for the shape and
* endContour() stops recording. The vertices that
* define a negative shape must "wind" in the
* opposite direction from the exterior shape. First
* draw vertices for the exterior clockwise order,
* then for internal shapes, draw vertices shape in
* counter-clockwise. These functions can only be
* used within a beginShape()/endShape() pair and
* transformations such as translate(), rotate(), and
* scale() do not work within a
* beginContour()/endContour() pair. It is also not
* possible to use other shapes, such as ellipse() or
* rect() within.
* @chainable
*/
endContour(): p5;
/**
* Use the beginContour() and endContour() functions
* to create negative shapes within shapes such as
* the center of the letter 'O'. beginContour()
* begins recording vertices for the shape and
* endContour() stops recording. The vertices that
* define a negative shape must "wind" in the
* opposite direction from the exterior shape. First
* draw vertices for the exterior clockwise order,
* then for internal shapes, draw vertices shape in
* counter-clockwise. These functions can only be
* used within a beginShape()/endShape() pair and
* transformations such as translate(), rotate(), and
* scale() do not work within a
* beginContour()/endContour() pair. It is also not
* possible to use other shapes, such as ellipse() or
* rect() within.
* @chainable
*/
endContour(): p5;
/**
* The endShape() function is the companion to
* beginShape() and may only be called after
* beginShape(). When endshape() is called, all of
* image data defined since the previous call to
* beginShape() is written into the image buffer. The
* constant CLOSE as the value for the MODE parameter
* to close the shape (to connect the beginning and
* the end).
* @param [mode] use CLOSE to close the shape
* @chainable
*/
endShape(
mode?: END_MODE
): p5;
/**
* The endShape() function is the companion to
* beginShape() and may only be called after
* beginShape(). When endshape() is called, all of
* image data defined since the previous call to
* beginShape() is written into the image buffer. The
* constant CLOSE as the value for the MODE parameter
* to close the shape (to connect the beginning and
* the end).
* @param [mode] use CLOSE to close the shape
* @chainable
*/
endShape(mode?: END_MODE): p5;
/**
* Specifies vertex coordinates for quadratic Bezier
* curves. Each call to quadraticVertex() defines the
* position of one control points and one anchor
* point of a Bezier curve, adding a new segment to a
* line or shape. The first time quadraticVertex() is
* used within a beginShape() call, it must be
* prefaced with a call to vertex() to set the first
* anchor point. For WebGL mode quadraticVertex() can
* be used in 2D as well as 3D mode. 2D mode expects
* 4 parameters, while 3D mode expects 6 parameters
* (including z coordinates). This function must be
* used between beginShape() and endShape() and only
* when there is no MODE or POINTS parameter
* specified to beginShape().
* @param cx x-coordinate for the control point
* @param cy y-coordinate for the control point
* @param x3 x-coordinate for the anchor point
* @param y3 y-coordinate for the anchor point
* @chainable
*/
quadraticVertex(
cx: number,
cy: number,
x3: number,
y3: number
): p5;
/**
* Specifies vertex coordinates for quadratic Bezier
* curves. Each call to quadraticVertex() defines the
* position of one control points and one anchor
* point of a Bezier curve, adding a new segment to a
* line or shape. The first time quadraticVertex() is
* used within a beginShape() call, it must be
* prefaced with a call to vertex() to set the first
* anchor point. For WebGL mode quadraticVertex() can
* be used in 2D as well as 3D mode. 2D mode expects
* 4 parameters, while 3D mode expects 6 parameters
* (including z coordinates). This function must be
* used between beginShape() and endShape() and only
* when there is no MODE or POINTS parameter
* specified to beginShape().
* @param cx x-coordinate for the control point
* @param cy y-coordinate for the control point
* @param x3 x-coordinate for the anchor point
* @param y3 y-coordinate for the anchor point
* @chainable
*/
quadraticVertex(cx: number, cy: number, x3: number, y3: number): p5;
/**
* Specifies vertex coordinates for quadratic Bezier
* curves. Each call to quadraticVertex() defines the
* position of one control points and one anchor
* point of a Bezier curve, adding a new segment to a
* line or shape. The first time quadraticVertex() is
* used within a beginShape() call, it must be
* prefaced with a call to vertex() to set the first
* anchor point. For WebGL mode quadraticVertex() can
* be used in 2D as well as 3D mode. 2D mode expects
* 4 parameters, while 3D mode expects 6 parameters
* (including z coordinates). This function must be
* used between beginShape() and endShape() and only
* when there is no MODE or POINTS parameter
* specified to beginShape().
* @param cx x-coordinate for the control point
* @param cy y-coordinate for the control point
* @param cz z-coordinate for the control point (for
* WebGL mode)
* @param x3 x-coordinate for the anchor point
* @param y3 y-coordinate for the anchor point
* @param z3 z-coordinate for the anchor point (for
* WebGL mode)
* @chainable
*/
quadraticVertex(
cx: number,
cy: number,
cz: number,
x3: number,
y3: number,
z3: number
): p5;
/**
* Specifies vertex coordinates for quadratic Bezier
* curves. Each call to quadraticVertex() defines the
* position of one control points and one anchor
* point of a Bezier curve, adding a new segment to a
* line or shape. The first time quadraticVertex() is
* used within a beginShape() call, it must be
* prefaced with a call to vertex() to set the first
* anchor point. For WebGL mode quadraticVertex() can
* be used in 2D as well as 3D mode. 2D mode expects
* 4 parameters, while 3D mode expects 6 parameters
* (including z coordinates). This function must be
* used between beginShape() and endShape() and only
* when there is no MODE or POINTS parameter
* specified to beginShape().
* @param cx x-coordinate for the control point
* @param cy y-coordinate for the control point
* @param cz z-coordinate for the control point (for
* WebGL mode)
* @param x3 x-coordinate for the anchor point
* @param y3 y-coordinate for the anchor point
* @param z3 z-coordinate for the anchor point (for
* WebGL mode)
* @chainable
*/
quadraticVertex(cx: number, cy: number, cz: number, x3: number, y3: number, z3: number): p5;
/**
* All shapes are constructed by connecting a series
* of vertices. vertex() is used to specify the
* vertex coordinates for points, lines, triangles,
* quads, and polygons. It is used exclusively within
* the beginShape() and endShape() functions.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @chainable
*/
vertex(
x: number,
y: number
): p5;
/**
* All shapes are constructed by connecting a series
* of vertices. vertex() is used to specify the
* vertex coordinates for points, lines, triangles,
* quads, and polygons. It is used exclusively within
* the beginShape() and endShape() functions.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @chainable
*/
vertex(x: number, y: number): p5;
/**
* All shapes are constructed by connecting a series
* of vertices. vertex() is used to specify the
* vertex coordinates for points, lines, triangles,
* quads, and polygons. It is used exclusively within
* the beginShape() and endShape() functions.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @param z z-coordinate of the vertex
* @param [u] the vertex's texture u-coordinate
* @param [v] the vertex's texture v-coordinate
* @chainable
*/
vertex(
x: number,
y: number,
z: number,
u?: number,
v?: number
): p5;
}
/**
* All shapes are constructed by connecting a series
* of vertices. vertex() is used to specify the
* vertex coordinates for points, lines, triangles,
* quads, and polygons. It is used exclusively within
* the beginShape() and endShape() functions.
* @param x x-coordinate of the vertex
* @param y y-coordinate of the vertex
* @param z z-coordinate of the vertex
* @param [u] the vertex's texture u-coordinate
* @param [v] the vertex's texture v-coordinate
* @chainable
*/
vertex(x: number, y: number, z: number, u?: number, v?: number): p5;
}
}
types/p5/src/core/structure.d.ts
Vendored
+117 -102
View File
@@ -1,110 +1,125 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Stops p5.js from continuously executing the code
* within draw(). If loop() is called, the code in
* draw() begins to run continuously again. If using
* noLoop() in setup(), it should be the last line
* inside the block. When noLoop() is used, it's not
* possible to manipulate or access the screen inside
* event handling functions such as mousePressed() or
* keyPressed(). Instead, use those functions to call
* redraw() or loop(), which will run draw(), which
* can update the screen properly. This means that
* when noLoop() has been called, no drawing can
* happen, and functions like saveFrame() or
* loadPixels() may not be used.
*
*
* Note that if the sketch is resized, redraw() will
* be called to update the sketch, even after
* noLoop() has been specified. Otherwise, the sketch
* would enter an odd state until loop() was called.
*/
noLoop(): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Stops p5.js from continuously executing the code
* within draw(). If loop() is called, the code in
* draw() begins to run continuously again. If using
* noLoop() in setup(), it should be the last line
* inside the block. When noLoop() is used, it's not
* possible to manipulate or access the screen inside
* event handling functions such as mousePressed() or
* keyPressed(). Instead, use those functions to call
* redraw() or loop(), which will run draw(), which
* can update the screen properly. This means that
* when noLoop() has been called, no drawing can
* happen, and functions like saveFrame() or
* loadPixels() may not be used.
*
*
* Note that if the sketch is resized, redraw() will
* be called to update the sketch, even after
* noLoop() has been specified. Otherwise, the sketch
* would enter an odd state until loop() was called.
*/
noLoop(): void;
/**
* By default, p5.js loops through draw()
* continuously, executing the code within it.
* However, the draw() loop may be stopped by calling
* noLoop(). In that case, the draw() loop can be
* resumed with loop().
*/
loop(): void;
/**
* By default, p5.js loops through draw()
* continuously, executing the code within it.
* However, the draw() loop may be stopped by calling
* noLoop(). In that case, the draw() loop can be
* resumed with loop(). Avoid calling loop() from
* inside setup().
*/
loop(): void;
/**
* The push() function saves the current drawing
* style settings and transformations, while pop()
* restores these settings. Note that these functions
* are always used together. They allow you to change
* the style and transformation settings and later
* return to what you had. When a new state is
* started with push(), it builds on the current
* style and transform information. The push() and
* pop() functions can be embedded to provide more
* control. (See the second example for a
* demonstration.) push() stores information related
* to the current transformation state and style
* settings controlled by the following functions:
* fill(), stroke(), tint(), strokeWeight(),
* strokeCap(), strokeJoin(), imageMode(),
* rectMode(), ellipseMode(), colorMode(),
* textAlign(), textFont(), textMode(), textSize(),
* textLeading().
*/
push(): void;
/**
* The push() function saves the current drawing
* style settings and transformations, while pop()
* restores these settings. Note that these functions
* are always used together. They allow you to change
* the style and transformation settings and later
* return to what you had. When a new state is
* started with push(), it builds on the current
* style and transform information. The push() and
* pop() functions can be embedded to provide more
* control. (See the second example for a
* demonstration.) push() stores information related
* to the current transformation state and style
* settings controlled by the following functions:
* fill(), stroke(), tint(), strokeWeight(),
* strokeCap(), strokeJoin(), imageMode(),
* rectMode(), ellipseMode(), colorMode(),
* textAlign(), textFont(), textSize(),
* textLeading().
*
*
* In WEBGL mode additional style settings are
* stored. These are controlled by the following
* functions: setCamera(), ambientLight(),
* directionalLight(), pointLight(), texture(),
* specularMaterial(), shininess(), normalMaterial()
* and shader().
*/
push(): void;
/**
* The push() function saves the current drawing
* style settings and transformations, while pop()
* restores these settings. Note that these functions
* are always used together. They allow you to change
* the style and transformation settings and later
* return to what you had. When a new state is
* started with push(), it builds on the current
* style and transform information. The push() and
* pop() functions can be embedded to provide more
* control. (See the second example for a
* demonstration.) push() stores information related
* to the current transformation state and style
* settings controlled by the following functions:
* fill(), stroke(), tint(), strokeWeight(),
* strokeCap(), strokeJoin(), imageMode(),
* rectMode(), ellipseMode(), colorMode(),
* textAlign(), textFont(), textMode(), textSize(),
* textLeading().
*/
pop(): void;
/**
* The push() function saves the current drawing
* style settings and transformations, while pop()
* restores these settings. Note that these functions
* are always used together. They allow you to change
* the style and transformation settings and later
* return to what you had. When a new state is
* started with push(), it builds on the current
* style and transform information. The push() and
* pop() functions can be embedded to provide more
* control. (See the second example for a
* demonstration.) push() stores information related
* to the current transformation state and style
* settings controlled by the following functions:
* fill(), stroke(), tint(), strokeWeight(),
* strokeCap(), strokeJoin(), imageMode(),
* rectMode(), ellipseMode(), colorMode(),
* textAlign(), textFont(), textSize(),
* textLeading().
*
*
* In WEBGL mode additional style settings are
* stored. These are controlled by the following
* functions: setCamera(), ambientLight(),
* directionalLight(), pointLight(), texture(),
* specularMaterial(), shininess(), normalMaterial()
* and shader().
*/
pop(): void;
/**
* Executes the code within draw() one time. This
* functions allows the program to update the display
* window only when necessary, for example when an
* event registered by mousePressed() or keyPressed()
* occurs. In structuring a program, it only makes
* sense to call redraw() within events such as
* mousePressed(). This is because redraw() does not
* run draw() immediately (it only sets a flag that
* indicates an update is needed).
*
*
* The redraw() function does not work properly when
* called inside draw(). To enable/disable
* animations, use loop() and noLoop().
*
*
* In addition you can set the number of redraws per
* method call. Just add an integer as single
* parameter for the number of redraws.
* @param [n] Redraw for n-times. The default value
* is 1.
*/
redraw(
n?: number
): void;
}
/**
* Executes the code within draw() one time. This
* functions allows the program to update the display
* window only when necessary, for example when an
* event registered by mousePressed() or keyPressed()
* occurs. In structuring a program, it only makes
* sense to call redraw() within events such as
* mousePressed(). This is because redraw() does not
* run draw() immediately (it only sets a flag that
* indicates an update is needed).
*
*
* The redraw() function does not work properly when
* called inside draw(). To enable/disable
* animations, use loop() and noLoop().
*
*
* In addition you can set the number of redraws per
* method call. Just add an integer as single
* parameter for the number of redraws.
* @param [n] Redraw for n-times. The default value
* is 1.
*/
redraw(n?: number): void;
}
}
types/p5/src/core/transform.d.ts
Vendored
+221 -260
View File
@@ -1,275 +1,236 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Multiplies the current matrix by the one specified
* through the parameters. This is a powerful
* operation that can perform the equivalent of
* translate, scale, shear and rotate all at once.
* You can learn more about transformation matrices
* on Wikipedia. The naming of the arguments here
* follows the naming of the WHATWG specification
* and corresponds to a transformation matrix of the
* form:
* @param a numbers which define the 2x3 matrix to be
* multiplied
* @param b numbers which define the 2x3 matrix to be
* multiplied
* @param c numbers which define the 2x3 matrix to be
* multiplied
* @param d numbers which define the 2x3 matrix to be
* multiplied
* @param e numbers which define the 2x3 matrix to be
* multiplied
* @param f numbers which define the 2x3 matrix to be
* multiplied
* @chainable
*/
applyMatrix(
a: number,
b: number,
c: number,
d: number,
e: number,
f: number
): p5;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Multiplies the current matrix by the one specified
* through the parameters. This is a powerful
* operation that can perform the equivalent of
* translate, scale, shear and rotate all at once.
* You can learn more about transformation matrices
* on Wikipedia. The naming of the arguments here
* follows the naming of the WHATWG specification
* and corresponds to a transformation matrix of the
* form:
* @param a numbers which define the 2x3 matrix to be
* multiplied
* @param b numbers which define the 2x3 matrix to be
* multiplied
* @param c numbers which define the 2x3 matrix to be
* multiplied
* @param d numbers which define the 2x3 matrix to be
* multiplied
* @param e numbers which define the 2x3 matrix to be
* multiplied
* @param f numbers which define the 2x3 matrix to be
* multiplied
* @chainable
*/
applyMatrix(a: number, b: number, c: number, d: number, e: number, f: number): p5;
/**
* Replaces the current matrix with the identity
* matrix.
* @chainable
*/
resetMatrix(): p5;
/**
* Replaces the current matrix with the identity
* matrix.
* @chainable
*/
resetMatrix(): p5;
/**
* Rotates a shape the amount specified by the angle
* parameter. This function accounts for angleMode,
* so angles can be entered in either RADIANS or
* DEGREES. Objects are always rotated around their
* relative position to the origin and positive
* numbers rotate objects in a clockwise direction.
* Transformations apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* rotate(HALF_PI) and then rotate(HALF_PI) is the
* same as rotate(PI). All tranformations are reset
* when draw() begins again.
*
*
* Technically, rotate() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop().
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @param [axis] (in 3d) the axis to rotate around
* @chainable
*/
rotate(
angle: number,
axis?:
| Vector
| number[]
): p5;
/**
* Rotates a shape the amount specified by the angle
* parameter. This function accounts for angleMode,
* so angles can be entered in either RADIANS or
* DEGREES. Objects are always rotated around their
* relative position to the origin and positive
* numbers rotate objects in a clockwise direction.
* Transformations apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* rotate(HALF_PI) and then rotate(HALF_PI) is the
* same as rotate(PI). All tranformations are reset
* when draw() begins again.
*
*
* Technically, rotate() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop().
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @param [axis] (in 3d) the axis to rotate around
* @chainable
*/
rotate(angle: number, axis?: Vector | number[]): p5;
/**
* Rotates around X axis.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateX(
angle: number
): p5;
/**
* Rotates around X axis.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateX(angle: number): p5;
/**
* Rotates around Y axis.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateY(
angle: number
): p5;
/**
* Rotates around Y axis.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateY(angle: number): p5;
/**
* Rotates around Z axis. Webgl mode only.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateZ(
angle: number
): p5;
/**
* Rotates around Z axis. Webgl mode only.
* @param angle the angle of rotation, specified in
* radians or degrees, depending on current angleMode
* @chainable
*/
rotateZ(angle: number): p5;
/**
* Increases or decreases the size of a shape by
* expanding and contracting vertices. Objects always
* scale from their relative origin to the coordinate
* system. Scale values are specified as decimal
* percentages. For example, the function call
* scale(2.0) increases the dimension of a shape by
* 200%. Transformations apply to everything that
* happens after and subsequent calls to the function
* multiply the effect. For example, calling
* scale(2.0) and then scale(1.5) is the same as
* scale(3.0). If scale() is called within draw(),
* the transformation is reset when the loop begins
* again.
*
*
* Using this function with the z parameter is only
* available in WEBGL mode. This function can be
* further controlled with push() and pop().
* @param s percent to scale the object, or
* percentage to scale the object in the x-axis if
* multiple arguments are given
* @param [y] percent to scale the object in the
* y-axis
* @param [z] percent to scale the object in the
* z-axis (webgl only)
* @chainable
*/
scale(
s:
| number
| Vector
| number[],
y?: number,
z?: number
): p5;
/**
* Increases or decreases the size of a shape by
* expanding and contracting vertices. Objects always
* scale from their relative origin to the coordinate
* system. Scale values are specified as decimal
* percentages. For example, the function call
* scale(2.0) increases the dimension of a shape by
* 200%. Transformations apply to everything that
* happens after and subsequent calls to the function
* multiply the effect. For example, calling
* scale(2.0) and then scale(1.5) is the same as
* scale(3.0). If scale() is called within draw(),
* the transformation is reset when the loop begins
* again.
*
*
* Using this function with the z parameter is only
* available in WEBGL mode. This function can be
* further controlled with push() and pop().
* @param s percent to scale the object, or
* percentage to scale the object in the x-axis if
* multiple arguments are given
* @param [y] percent to scale the object in the
* y-axis
* @param [z] percent to scale the object in the
* z-axis (webgl only)
* @chainable
*/
scale(s: number | Vector | number[], y?: number, z?: number): p5;
/**
* Increases or decreases the size of a shape by
* expanding and contracting vertices. Objects always
* scale from their relative origin to the coordinate
* system. Scale values are specified as decimal
* percentages. For example, the function call
* scale(2.0) increases the dimension of a shape by
* 200%. Transformations apply to everything that
* happens after and subsequent calls to the function
* multiply the effect. For example, calling
* scale(2.0) and then scale(1.5) is the same as
* scale(3.0). If scale() is called within draw(),
* the transformation is reset when the loop begins
* again.
*
*
* Using this function with the z parameter is only
* available in WEBGL mode. This function can be
* further controlled with push() and pop().
* @param scales per-axis percents to scale the
* object
* @chainable
*/
scale(
scales:
| Vector
| number[]
): p5;
/**
* Increases or decreases the size of a shape by
* expanding and contracting vertices. Objects always
* scale from their relative origin to the coordinate
* system. Scale values are specified as decimal
* percentages. For example, the function call
* scale(2.0) increases the dimension of a shape by
* 200%. Transformations apply to everything that
* happens after and subsequent calls to the function
* multiply the effect. For example, calling
* scale(2.0) and then scale(1.5) is the same as
* scale(3.0). If scale() is called within draw(),
* the transformation is reset when the loop begins
* again.
*
*
* Using this function with the z parameter is only
* available in WEBGL mode. This function can be
* further controlled with push() and pop().
* @param scales per-axis percents to scale the
* object
* @chainable
*/
scale(scales: Vector | number[]): p5;
/**
* Shears a shape around the x-axis the amount
* specified by the angle parameter. Angles should be
* specified in the current angleMode. Objects are
* always sheared around their relative position to
* the origin and positive numbers shear objects in a
* clockwise direction. Transformations apply to
* everything that happens after and subsequent calls
* to the function accumulates the effect. For
* example, calling shearX(PI/2) and then
* shearX(PI/2) is the same as shearX(PI). If
* shearX() is called within the draw(), the
* transformation is reset when the loop begins
* again.
*
*
* Technically, shearX() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop() functions.
* @param angle angle of shear specified in radians
* or degrees, depending on current angleMode
* @chainable
*/
shearX(
angle: number
): p5;
/**
* Shears a shape around the x-axis the amount
* specified by the angle parameter. Angles should be
* specified in the current angleMode. Objects are
* always sheared around their relative position to
* the origin and positive numbers shear objects in a
* clockwise direction. Transformations apply to
* everything that happens after and subsequent calls
* to the function accumulates the effect. For
* example, calling shearX(PI/2) and then
* shearX(PI/2) is the same as shearX(PI). If
* shearX() is called within the draw(), the
* transformation is reset when the loop begins
* again.
*
*
* Technically, shearX() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop() functions.
* @param angle angle of shear specified in radians
* or degrees, depending on current angleMode
* @chainable
*/
shearX(angle: number): p5;
/**
* Shears a shape around the y-axis the amount
* specified by the angle parameter. Angles should be
* specified in the current angleMode. Objects are
* always sheared around their relative position to
* the origin and positive numbers shear objects in a
* clockwise direction. Transformations apply to
* everything that happens after and subsequent calls
* to the function accumulates the effect. For
* example, calling shearY(PI/2) and then
* shearY(PI/2) is the same as shearY(PI). If
* shearY() is called within the draw(), the
* transformation is reset when the loop begins
* again.
*
*
* Technically, shearY() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop() functions.
* @param angle angle of shear specified in radians
* or degrees, depending on current angleMode
* @chainable
*/
shearY(
angle: number
): p5;
/**
* Shears a shape around the y-axis the amount
* specified by the angle parameter. Angles should be
* specified in the current angleMode. Objects are
* always sheared around their relative position to
* the origin and positive numbers shear objects in a
* clockwise direction. Transformations apply to
* everything that happens after and subsequent calls
* to the function accumulates the effect. For
* example, calling shearY(PI/2) and then
* shearY(PI/2) is the same as shearY(PI). If
* shearY() is called within the draw(), the
* transformation is reset when the loop begins
* again.
*
*
* Technically, shearY() multiplies the current
* transformation matrix by a rotation matrix. This
* function can be further controlled by the push()
* and pop() functions.
* @param angle angle of shear specified in radians
* or degrees, depending on current angleMode
* @chainable
*/
shearY(angle: number): p5;
/**
* Specifies an amount to displace objects within the
* display window. The x parameter specifies
* left/right translation, the y parameter specifies
* up/down translation. Transformations are
* cumulative and apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* translate(50, 0) and then translate(20, 0) is the
* same as translate(70, 0). If translate() is called
* within draw(), the transformation is reset when
* the loop begins again. This function can be
* further controlled by using push() and pop().
* @param x left/right translation
* @param y up/down translation
* @param [z] forward/backward translation (webgl
* only)
* @chainable
*/
translate(
x: number,
y: number,
z?: number
): p5;
/**
* Specifies an amount to displace objects within the
* display window. The x parameter specifies
* left/right translation, the y parameter specifies
* up/down translation. Transformations are
* cumulative and apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* translate(50, 0) and then translate(20, 0) is the
* same as translate(70, 0). If translate() is called
* within draw(), the transformation is reset when
* the loop begins again. This function can be
* further controlled by using push() and pop().
* @param x left/right translation
* @param y up/down translation
* @param [z] forward/backward translation (webgl
* only)
* @chainable
*/
translate(x: number, y: number, z?: number): p5;
/**
* Specifies an amount to displace objects within the
* display window. The x parameter specifies
* left/right translation, the y parameter specifies
* up/down translation. Transformations are
* cumulative and apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* translate(50, 0) and then translate(20, 0) is the
* same as translate(70, 0). If translate() is called
* within draw(), the transformation is reset when
* the loop begins again. This function can be
* further controlled by using push() and pop().
* @param vector the vector to translate by
* @chainable
*/
translate(
vector: Vector
): p5;
}
/**
* Specifies an amount to displace objects within the
* display window. The x parameter specifies
* left/right translation, the y parameter specifies
* up/down translation. Transformations are
* cumulative and apply to everything that happens
* after and subsequent calls to the function
* accumulates the effect. For example, calling
* translate(50, 0) and then translate(20, 0) is the
* same as translate(70, 0). If translate() is called
* within draw(), the transformation is reset when
* the loop begins again. This function can be
* further controlled by using push() and pop().
* @param vector the vector to translate by
* @chainable
*/
translate(vector: Vector): p5;
}
}
types/p5/src/data/local_storage.d.ts
Vendored
+39
View File
@@ -0,0 +1,39 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from '../../index';
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Stores a value in local storage under the key
* name. Local storage is saved in the browser and
* persists between browsing sessions and page
* reloads. The key can be the name of the variable
* but doesn't have to be. To retrieve stored items
* see getItem. Sensitive data such as passwords or
* personal information should not be stored in local
* storage.
*/
storeItem(key: string, value: string | number | object | boolean | Color): void;
/**
* Returns the value of an item that was stored in
* local storage using storeItem()
* @param key name that you wish to use to store in
* local storage
* @return Value of stored item
*/
getItem(key: string): number | object | string | boolean | Color;
/**
* Clears all local storage items set with
* storeItem() for the current domain.
*/
clearStorage(): void;
/**
* Removes an item that was stored with storeItem()
*/
removeItem(key: string): void;
}
}
types/p5/src/data/p5.TypedDict.d.ts
Vendored
+146 -198
View File
@@ -1,222 +1,170 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class TypedDict {
/**
* Returns the number of key-value pairs currently
* stored in the Dictionary.
* @return the number of key-value pairs in the
* Dictionary
*/
size(): number;
declare module '../../index' {
class TypedDict {
/**
* Returns the number of key-value pairs currently
* stored in the Dictionary.
* @return the number of key-value pairs in the
* Dictionary
*/
size(): number;
/**
* Returns true if the given key exists in the
* Dictionary, otherwise returns false.
* @param key that you want to look up
* @return whether that key exists in Dictionary
*/
hasKey(
key:
| number
| string
): boolean;
/**
* Returns true if the given key exists in the
* Dictionary, otherwise returns false.
* @param key that you want to look up
* @return whether that key exists in Dictionary
*/
hasKey(key: number | string): boolean;
/**
* Returns the value stored at the given key.
* @param the key you want to access
* @return the value stored at that key
*/
get(
the:
| number
| string
):
| number
| string;
/**
* Returns the value stored at the given key.
* @param the key you want to access
* @return the value stored at that key
*/
get(the: number | string): number | string;
/**
* Updates the value associated with the given key in
* case it already exists in the Dictionary.
* Otherwise a new key-value pair is added.
*/
set(
key:
| number
| string,
value:
| number
| string
): void;
/**
* Updates the value associated with the given key in
* case it already exists in the Dictionary.
* Otherwise a new key-value pair is added.
*/
set(key: number | string, value: number | string): void;
/**
* Creates a new key-value pair in the Dictionary.
*/
create(
key:
| number
| string,
value:
| number
| string
): void;
/**
* Creates a new key-value pair in the Dictionary.
*/
create(key: number | string, value: number | string): void;
/**
* Creates a new key-value pair in the Dictionary.
* @param obj key/value pair
*/
create(
obj: object
): void;
/**
* Creates a new key-value pair in the Dictionary.
* @param obj key/value pair
*/
create(obj: object): void;
/**
* Removes all previously stored key-value pairs from
* the Dictionary.
*/
clear(): void;
/**
* Removes all previously stored key-value pairs from
* the Dictionary.
*/
clear(): void;
/**
* Removes the key-value pair stored at the given key
* from the Dictionary.
* @param key for the pair to remove
*/
remove(
key:
| number
| string
): void;
/**
* Removes the key-value pair stored at the given key
* from the Dictionary.
* @param key for the pair to remove
*/
remove(key: number | string): void;
/**
* Logs the set of items currently stored in the
* Dictionary to the console.
*/
print(): void;
/**
* Logs the set of items currently stored in the
* Dictionary to the console.
*/
print(): void;
/**
* Converts the Dictionary into a CSV file for local
* download.
*/
saveTable(): void;
/**
* Converts the Dictionary into a CSV file for local
* download.
*/
saveTable(): void;
/**
* Converts the Dictionary into a JSON file for local
* download.
*/
saveJSON(): void;
}
class NumberDict extends TypedDict {
/**
* Add the given number to the value currently stored
* at the given key. The sum then replaces the value
* previously stored in the Dictionary.
* @param Key for the value you wish to add to
* @param Number to add to the value
*/
add(
Key: number,
Number: number
): void;
/**
* Converts the Dictionary into a JSON file for local
* download.
*/
saveJSON(): void;
}
class NumberDict extends TypedDict {
/**
* Add the given number to the value currently stored
* at the given key. The sum then replaces the value
* previously stored in the Dictionary.
* @param Key for the value you wish to add to
* @param Number to add to the value
*/
add(Key: number, Number: number): void;
/**
* Subtract the given number from the value currently
* stored at the given key. The difference then
* replaces the value previously stored in the
* Dictionary.
* @param Key for the value you wish to subtract from
* @param Number to subtract from the value
*/
sub(
Key: number,
Number: number
): void;
/**
* Subtract the given number from the value currently
* stored at the given key. The difference then
* replaces the value previously stored in the
* Dictionary.
* @param Key for the value you wish to subtract from
* @param Number to subtract from the value
*/
sub(Key: number, Number: number): void;
/**
* Multiply the given number with the value currently
* stored at the given key. The product then replaces
* the value previously stored in the Dictionary.
* @param Key for value you wish to multiply
* @param Amount to multiply the value by
*/
mult(
Key: number,
Amount: number
): void;
/**
* Multiply the given number with the value currently
* stored at the given key. The product then replaces
* the value previously stored in the Dictionary.
* @param Key for value you wish to multiply
* @param Amount to multiply the value by
*/
mult(Key: number, Amount: number): void;
/**
* Divide the given number with the value currently
* stored at the given key. The quotient then
* replaces the value previously stored in the
* Dictionary.
* @param Key for value you wish to divide
* @param Amount to divide the value by
*/
div(
Key: number,
Amount: number
): void;
/**
* Divide the given number with the value currently
* stored at the given key. The quotient then
* replaces the value previously stored in the
* Dictionary.
* @param Key for value you wish to divide
* @param Amount to divide the value by
*/
div(Key: number, Amount: number): void;
/**
* Return the lowest number currently stored in the
* Dictionary.
*/
minValue(): number;
/**
* Return the lowest number currently stored in the
* Dictionary.
*/
minValue(): number;
/**
* Return the highest number currently stored in the
* Dictionary.
*/
maxValue(): number;
/**
* Return the highest number currently stored in the
* Dictionary.
*/
maxValue(): number;
/**
* Return the lowest key currently used in the
* Dictionary.
*/
minKey(): number;
/**
* Return the lowest key currently used in the
* Dictionary.
*/
minKey(): number;
/**
* Return the highest key currently used in the
* Dictionary.
*/
maxKey(): number;
}
class StringDict extends TypedDict {}
interface p5InstanceExtensions {
/**
* Creates a new instance of p5.StringDict using the
* key-value pair or the object you provide.
*/
createStringDict(
key: string,
value: string
): StringDict;
/**
* Return the highest key currently used in the
* Dictionary.
*/
maxKey(): number;
}
class StringDict extends TypedDict {}
interface p5InstanceExtensions {
/**
* Creates a new instance of p5.StringDict using the
* key-value pair or the object you provide.
*/
createStringDict(key: string, value: string): StringDict;
/**
* Creates a new instance of p5.StringDict using the
* key-value pair or the object you provide.
* @param object object
*/
createStringDict(
object: object
): StringDict;
/**
* Creates a new instance of p5.StringDict using the
* key-value pair or the object you provide.
* @param object object
*/
createStringDict(object: object): StringDict;
/**
* Creates a new instance of p5.NumberDict using the
* key-value pair or object you provide.
*/
createNumberDict(
key: number,
value: number
): NumberDict;
/**
* Creates a new instance of p5.NumberDict using the
* key-value pair or object you provide.
*/
createNumberDict(key: number, value: number): NumberDict;
/**
* Creates a new instance of p5.NumberDict using the
* key-value pair or object you provide.
* @param object object
*/
createNumberDict(
object: object
): NumberDict;
}
/**
* Creates a new instance of p5.NumberDict using the
* key-value pair or object you provide.
* @param object object
*/
createNumberDict(object: object): NumberDict;
}
}
types/p5/src/events/acceleration.d.ts
Vendored
+158 -162
View File
@@ -1,184 +1,180 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The setMoveThreshold() function is used to set the
* movement threshold for the deviceMoved() function.
* The default threshold is set to 0.5.
* @param value The threshold value
*/
setMoveThreshold(
value: number
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The setMoveThreshold() function is used to set the
* movement threshold for the deviceMoved() function.
* The default threshold is set to 0.5.
* @param value The threshold value
*/
setMoveThreshold(value: number): void;
/**
* The setShakeThreshold() function is used to set
* the movement threshold for the deviceShaken()
* function. The default threshold is set to 30.
* @param value The threshold value
*/
setShakeThreshold(
value: number
): void;
/**
* The setShakeThreshold() function is used to set
* the movement threshold for the deviceShaken()
* function. The default threshold is set to 30.
* @param value The threshold value
*/
setShakeThreshold(value: number): void;
/**
* The deviceMoved() function is called when the
* device is moved by more than the threshold value
* along X, Y or Z axis. The default threshold is set
* to 0.5. The threshold value can be changed using
* setMoveThreshold().
*/
deviceMoved(): void;
/**
* The deviceMoved() function is called when the
* device is moved by more than the threshold value
* along X, Y or Z axis. The default threshold is set
* to 0.5. The threshold value can be changed using
* setMoveThreshold().
*/
deviceMoved(): void;
/**
* The deviceTurned() function is called when the
* device rotates by more than 90 degrees
* continuously. The axis that triggers the
* deviceTurned() method is stored in the turnAxis
* variable. The deviceTurned() method can be locked
* to trigger on any axis: X, Y or Z by comparing the
* turnAxis variable to 'X', 'Y' or 'Z'.
*/
deviceTurned(): void;
/**
* The deviceTurned() function is called when the
* device rotates by more than 90 degrees
* continuously. The axis that triggers the
* deviceTurned() method is stored in the turnAxis
* variable. The deviceTurned() method can be locked
* to trigger on any axis: X, Y or Z by comparing the
* turnAxis variable to 'X', 'Y' or 'Z'.
*/
deviceTurned(): void;
/**
* The deviceShaken() function is called when the
* device total acceleration changes of accelerationX
* and accelerationY values is more than the
* threshold value. The default threshold is set to
* 30. The threshold value can be changed using
* setShakeThreshold().
*/
deviceShaken(): void;
/**
* The deviceShaken() function is called when the
* device total acceleration changes of accelerationX
* and accelerationY values is more than the
* threshold value. The default threshold is set to
* 30. The threshold value can be changed using
* setShakeThreshold().
*/
deviceShaken(): void;
/**
* The system variable deviceOrientation always
* contains the orientation of the device. The value
* of this variable will either be set 'landscape' or
* 'portrait'. If no data is available it will be set
* to 'undefined'. either LANDSCAPE or PORTRAIT.
*/
deviceOrientation: UNKNOWN_P5_CONSTANT;
/**
* The system variable deviceOrientation always
* contains the orientation of the device. The value
* of this variable will either be set 'landscape' or
* 'portrait'. If no data is available it will be set
* to 'undefined'. either LANDSCAPE or PORTRAIT.
*/
deviceOrientation: UNKNOWN_P5_CONSTANT;
/**
* The system variable accelerationX always contains
* the acceleration of the device along the x axis.
* Value is represented as meters per second squared.
*/
accelerationX: number;
/**
* The system variable accelerationX always contains
* the acceleration of the device along the x axis.
* Value is represented as meters per second squared.
*/
accelerationX: number;
/**
* The system variable accelerationY always contains
* the acceleration of the device along the y axis.
* Value is represented as meters per second squared.
*/
accelerationY: number;
/**
* The system variable accelerationY always contains
* the acceleration of the device along the y axis.
* Value is represented as meters per second squared.
*/
accelerationY: number;
/**
* The system variable accelerationZ always contains
* the acceleration of the device along the z axis.
* Value is represented as meters per second squared.
*/
accelerationZ: number;
/**
* The system variable accelerationZ always contains
* the acceleration of the device along the z axis.
* Value is represented as meters per second squared.
*/
accelerationZ: number;
/**
* The system variable pAccelerationX always contains
* the acceleration of the device along the x axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationX: number;
/**
* The system variable pAccelerationX always contains
* the acceleration of the device along the x axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationX: number;
/**
* The system variable pAccelerationY always contains
* the acceleration of the device along the y axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationY: number;
/**
* The system variable pAccelerationY always contains
* the acceleration of the device along the y axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationY: number;
/**
* The system variable pAccelerationZ always contains
* the acceleration of the device along the z axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationZ: number;
/**
* The system variable pAccelerationZ always contains
* the acceleration of the device along the z axis in
* the frame previous to the current frame. Value is
* represented as meters per second squared.
*/
pAccelerationZ: number;
/**
* The system variable rotationX always contains the
* rotation of the device along the x axis. Value is
* represented as 0 to +/-180 degrees. Note: The
* order the rotations are called is important, ie.
* if used together, it must be called in the order
* Z-X-Y or there might be unexpected behaviour.
*/
rotationX: number;
/**
* The system variable rotationX always contains the
* rotation of the device along the x axis. Value is
* represented as 0 to +/-180 degrees. Note: The
* order the rotations are called is important, ie.
* if used together, it must be called in the order
* Z-X-Y or there might be unexpected behaviour.
*/
rotationX: number;
/**
* The system variable rotationY always contains the
* rotation of the device along the y axis. Value is
* represented as 0 to +/-90 degrees. Note: The
* order the rotations are called is important, ie.
* if used together, it must be called in the order
* Z-X-Y or there might be unexpected behaviour.
*/
rotationY: number;
/**
* The system variable rotationY always contains the
* rotation of the device along the y axis. Value is
* represented as 0 to +/-90 degrees. Note: The
* order the rotations are called is important, ie.
* if used together, it must be called in the order
* Z-X-Y or there might be unexpected behaviour.
*/
rotationY: number;
/**
* The system variable rotationZ always contains the
* rotation of the device along the z axis. Value is
* represented as 0 to 359 degrees. Unlike rotationX
* and rotationY, this variable is available for
* devices with a built-in compass only.
*
*
* Note: The order the rotations are called is
* important, ie. if used together, it must be called
* in the order Z-X-Y or there might be unexpected
* behaviour.
*/
rotationZ: number;
/**
* The system variable rotationZ always contains the
* rotation of the device along the z axis. Value is
* represented as 0 to 359 degrees. Unlike rotationX
* and rotationY, this variable is available for
* devices with a built-in compass only.
*
*
* Note: The order the rotations are called is
* important, ie. if used together, it must be called
* in the order Z-X-Y or there might be unexpected
* behaviour.
*/
rotationZ: number;
/**
* The system variable pRotationX always contains the
* rotation of the device along the x axis in the
* frame previous to the current frame. Value is
* represented as 0 to +/-180 degrees. pRotationX
* can also be used with rotationX to determine the
* rotate direction of the device along the X-axis.
*/
pRotationX: number;
/**
* The system variable pRotationX always contains the
* rotation of the device along the x axis in the
* frame previous to the current frame. Value is
* represented as 0 to +/-180 degrees. pRotationX
* can also be used with rotationX to determine the
* rotate direction of the device along the X-axis.
*/
pRotationX: number;
/**
* The system variable pRotationY always contains the
* rotation of the device along the y axis in the
* frame previous to the current frame. Value is
* represented as 0 to +/-90 degrees. pRotationY can
* also be used with rotationY to determine the
* rotate direction of the device along the Y-axis.
*/
pRotationY: number;
/**
* The system variable pRotationY always contains the
* rotation of the device along the y axis in the
* frame previous to the current frame. Value is
* represented as 0 to +/-90 degrees. pRotationY can
* also be used with rotationY to determine the
* rotate direction of the device along the Y-axis.
*/
pRotationY: number;
/**
* The system variable pRotationZ always contains the
* rotation of the device along the z axis in the
* frame previous to the current frame. Value is
* represented as 0 to 359 degrees. pRotationZ can
* also be used with rotationZ to determine the
* rotate direction of the device along the Z-axis.
*/
pRotationZ: number;
/**
* The system variable pRotationZ always contains the
* rotation of the device along the z axis in the
* frame previous to the current frame. Value is
* represented as 0 to 359 degrees. pRotationZ can
* also be used with rotationZ to determine the
* rotate direction of the device along the Z-axis.
*/
pRotationZ: number;
/**
* When a device is rotated, the axis that triggers
* the deviceTurned() method is stored in the
* turnAxis variable. The turnAxis variable is only
* defined within the scope of deviceTurned().
*/
turnAxis: string;
}
/**
* When a device is rotated, the axis that triggers
* the deviceTurned() method is stored in the
* turnAxis variable. The turnAxis variable is only
* defined within the scope of deviceTurned().
*/
turnAxis: string;
}
}
types/p5/src/events/keyboard.d.ts
Vendored
+103 -102
View File
@@ -1,112 +1,113 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The keyPressed() function is called once every
* time a key is pressed. The keyCode for the key
* that was pressed is stored in the keyCode
* variable. For non-ASCII keys, use the keyCode
* variable. You can check if the keyCode equals
* BACKSPACE, DELETE, ENTER, RETURN, TAB, ESCAPE,
* SHIFT, CONTROL, OPTION, ALT, UP_ARROW, DOWN_ARROW,
* LEFT_ARROW, RIGHT_ARROW.
*
*
* For ASCII keys, the key that was pressed is stored
* in the key variable. However, it does not
* distinguish between uppercase and lowercase. For
* this reason, it is recommended to use keyTyped()
* to read the key variable, in which the case of the
* variable will be distinguished.
*
*
* Because of how operating systems handle key
* repeats, holding down a key may cause multiple
* calls to keyTyped() (and keyReleased() as well).
* The rate of repeat is set by the operating system
* and how each computer is configured.
*
*
* Browsers may have different default behaviors
* attached to various key events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*/
keyPressed(): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The keyPressed() function is called once every
* time a key is pressed. The keyCode for the key
* that was pressed is stored in the keyCode
* variable. For non-ASCII keys, use the keyCode
* variable. You can check if the keyCode equals
* BACKSPACE, DELETE, ENTER, RETURN, TAB, ESCAPE,
* SHIFT, CONTROL, OPTION, ALT, UP_ARROW, DOWN_ARROW,
* LEFT_ARROW, RIGHT_ARROW.
*
*
* For ASCII keys, the key that was pressed is stored
* in the key variable. However, it does not
* distinguish between uppercase and lowercase. For
* this reason, it is recommended to use keyTyped()
* to read the key variable, in which the case of the
* variable will be distinguished.
*
*
* Because of how operating systems handle key
* repeats, holding down a key may cause multiple
* calls to keyTyped() (and keyReleased() as well).
* The rate of repeat is set by the operating system
* and how each computer is configured.
*
*
* Browsers may have different default behaviors
* attached to various key events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*/
keyPressed(): void;
/**
* The keyReleased() function is called once every
* time a key is released. See key and keyCode for
* more information. Browsers may have different
* default behaviors attached to various key events.
* To prevent any default behavior for this event,
* add "return false" to the end of the method.
*/
keyReleased(): void;
/**
* The keyReleased() function is called once every
* time a key is released. See key and keyCode for
* more information. Browsers may have different
* default behaviors attached to various key events.
* To prevent any default behavior for this event,
* add "return false" to the end of the method.
*/
keyReleased(): void;
/**
* The keyTyped() function is called once every time
* a key is pressed, but action keys such as Ctrl,
* Shift, and Alt are ignored. The most recent key
* pressed will be stored in the key variable.
* Because of how operating systems handle key
* repeats, holding down a key will cause multiple
* calls to keyTyped() (and keyReleased() as well).
* The rate of repeat is set by the operating system
* and how each computer is configured.
*
*
* Browsers may have different default behaviors
* attached to various key events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*/
keyTyped(): void;
/**
* The keyTyped() function is called once every time
* a key is pressed, but action keys such as
* Backspace, Delete, Ctrl, Shift, and Alt are
* ignored. If you are trying to detect a keyCode for
* one of these keys, use the keyPressed() function
* instead. The most recent key typed will be stored
* in the key variable. Because of how operating
* systems handle key repeats, holding down a key
* will cause multiple calls to keyTyped() (and
* keyReleased() as well). The rate of repeat is set
* by the operating system and how each computer is
* configured.
*
*
* Browsers may have different default behaviors
* attached to various key events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*/
keyTyped(): void;
/**
* The keyIsDown() function checks if the key is
* currently down, i.e. pressed. It can be used if
* you have an object that moves, and you want
* several keys to be able to affect its behaviour
* simultaneously, such as moving a sprite
* diagonally. You can put in any number representing
* the keyCode of the key, or use any of the variable
* keyCode names listed here.
* @param code The key to check for.
* @return whether key is down or not
*/
keyIsDown(
code: number
): boolean;
/**
* The keyIsDown() function checks if the key is
* currently down, i.e. pressed. It can be used if
* you have an object that moves, and you want
* several keys to be able to affect its behaviour
* simultaneously, such as moving a sprite
* diagonally. You can put in any number representing
* the keyCode of the key, or use any of the variable
* keyCode names listed here.
* @param code The key to check for.
* @return whether key is down or not
*/
keyIsDown(code: number): boolean;
/**
* The boolean system variable keyIsPressed is true
* if any key is pressed and false if no keys are
* pressed.
*/
keyIsPressed: boolean;
/**
* The boolean system variable keyIsPressed is true
* if any key is pressed and false if no keys are
* pressed.
*/
keyIsPressed: boolean;
/**
* The system variable key always contains the value
* of the most recent key on the keyboard that was
* typed. To get the proper capitalization, it is
* best to use it within keyTyped(). For non-ASCII
* keys, use the keyCode variable.
*/
key: string;
/**
* The system variable key always contains the value
* of the most recent key on the keyboard that was
* typed. To get the proper capitalization, it is
* best to use it within keyTyped(). For non-ASCII
* keys, use the keyCode variable.
*/
key: string;
/**
* The variable keyCode is used to detect special
* keys such as BACKSPACE, DELETE, ENTER, RETURN,
* TAB, ESCAPE, SHIFT, CONTROL, OPTION, ALT,
* UP_ARROW, DOWN_ARROW, LEFT_ARROW, RIGHT_ARROW. You
* can also check for custom keys by looking up the
* keyCode of any key on a site like this:
* keycode.info.
*/
keyCode: number;
}
/**
* The variable keyCode is used to detect special
* keys such as BACKSPACE, DELETE, ENTER, RETURN,
* TAB, ESCAPE, SHIFT, CONTROL, OPTION, ALT,
* UP_ARROW, DOWN_ARROW, LEFT_ARROW, RIGHT_ARROW. You
* can also check for custom keys by looking up the
* keyCode of any key on a site like this:
* keycode.info.
*/
keyCode: number;
}
}
types/p5/src/events/mouse.d.ts
Vendored
+200 -206
View File
@@ -1,226 +1,220 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The mouseMoved() function is called every time the
* mouse moves and a mouse button is not pressed.
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseMoved(
event?: object
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The mouseMoved() function is called every time the
* mouse moves and a mouse button is not pressed.
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseMoved(event?: object): void;
/**
* The mouseDragged() function is called once every
* time the mouse moves and a mouse button is
* pressed. If no mouseDragged() function is defined,
* the touchMoved() function will be called instead
* if it is defined. Browsers may have different
* default behaviors attached to various mouse
* events. To prevent any default behavior for this
* event, add "return false" to the end of the
* method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseDragged(
event?: object
): void;
/**
* The mouseDragged() function is called once every
* time the mouse moves and a mouse button is
* pressed. If no mouseDragged() function is defined,
* the touchMoved() function will be called instead
* if it is defined. Browsers may have different
* default behaviors attached to various mouse
* events. To prevent any default behavior for this
* event, add "return false" to the end of the
* method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseDragged(event?: object): void;
/**
* The mousePressed() function is called once after
* every time a mouse button is pressed. The
* mouseButton variable (see the related reference
* entry) can be used to determine which button has
* been pressed. If no mousePressed() function is
* defined, the touchStarted() function will be
* called instead if it is defined. Browsers may have
* different default behaviors attached to various
* mouse events. To prevent any default behavior for
* this event, add "return false" to the end of the
* method.
* @param [event] optional MouseEvent callback
* argument.
*/
mousePressed(
event?: object
): void;
/**
* The mousePressed() function is called once after
* every time a mouse button is pressed. The
* mouseButton variable (see the related reference
* entry) can be used to determine which button has
* been pressed. If no mousePressed() function is
* defined, the touchStarted() function will be
* called instead if it is defined. Browsers may have
* different default behaviors attached to various
* mouse events. To prevent any default behavior for
* this event, add "return false" to the end of the
* method.
* @param [event] optional MouseEvent callback
* argument.
*/
mousePressed(event?: object): void;
/**
* The mouseReleased() function is called every time
* a mouse button is released. If no mouseReleased()
* function is defined, the touchEnded() function
* will be called instead if it is defined. Browsers
* may have different default behaviors attached to
* various mouse events. To prevent any default
* behavior for this event, add "return false" to the
* end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseReleased(
event?: object
): void;
/**
* The mouseReleased() function is called every time
* a mouse button is released. If no mouseReleased()
* function is defined, the touchEnded() function
* will be called instead if it is defined. Browsers
* may have different default behaviors attached to
* various mouse events. To prevent any default
* behavior for this event, add "return false" to the
* end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseReleased(event?: object): void;
/**
* The mouseClicked() function is called once after a
* mouse button has been pressed and then released.
* Browsers handle clicks differently, so this
* function is only guaranteed to be run when the
* left mouse button is clicked. To handle other
* mouse buttons being pressed or released, see
* mousePressed() or mouseReleased().
*
*
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseClicked(
event?: object
): void;
/**
* The mouseClicked() function is called once after a
* mouse button has been pressed and then released.
* Browsers handle clicks differently, so this
* function is only guaranteed to be run when the
* left mouse button is clicked. To handle other
* mouse buttons being pressed or released, see
* mousePressed() or mouseReleased().
*
*
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
* @param [event] optional MouseEvent callback
* argument.
*/
mouseClicked(event?: object): void;
/**
* The doubleClicked() function is executed every
* time a event listener has detected a dblclick
* event which is a part of the DOM L3 specification.
* The doubleClicked event is fired when a pointing
* device button (usually a mouse's primary button)
* is clicked twice on a single element. For more
* info on the dblclick event refer to mozilla's
* documentation here:
* https://developer.mozilla.org/en-US/docs/Web/Events/dblclick
* @param [event] optional MouseEvent callback
* argument.
*/
doubleClicked(
event?: object
): void;
/**
* The doubleClicked() function is executed every
* time a event listener has detected a dblclick
* event which is a part of the DOM L3 specification.
* The doubleClicked event is fired when a pointing
* device button (usually a mouse's primary button)
* is clicked twice on a single element. For more
* info on the dblclick event refer to mozilla's
* documentation here:
* https://developer.mozilla.org/en-US/docs/Web/Events/dblclick
* @param [event] optional MouseEvent callback
* argument.
*/
doubleClicked(event?: object): void;
/**
* The function mouseWheel() is executed every time a
* vertical mouse wheel event is detected either
* triggered by an actual mouse wheel or by a
* touchpad. The event.delta property returns the
* amount the mouse wheel have scrolled. The values
* can be positive or negative depending on the
* scroll direction (on OS X with "natural" scrolling
* enabled, the signs are inverted).
*
*
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*
*
* Due to the current support of the "wheel" event on
* Safari, the function may only work as expected if
* "return false" is included while using Safari.
* @param [event] optional WheelEvent callback
* argument.
*/
mouseWheel(
event?: object
): void;
/**
* The function mouseWheel() is executed every time a
* vertical mouse wheel event is detected either
* triggered by an actual mouse wheel or by a
* touchpad. The event.delta property returns the
* amount the mouse wheel have scrolled. The values
* can be positive or negative depending on the
* scroll direction (on OS X with "natural" scrolling
* enabled, the signs are inverted).
*
*
* Browsers may have different default behaviors
* attached to various mouse events. To prevent any
* default behavior for this event, add "return
* false" to the end of the method.
*
*
* Due to the current support of the "wheel" event on
* Safari, the function may only work as expected if
* "return false" is included while using Safari.
* @param [event] optional WheelEvent callback
* argument.
*/
mouseWheel(event?: object): void;
/**
* The system variable mouseX always contains the
* current horizontal position of the mouse, relative
* to (0, 0) of the canvas. If touch is used instead
* of mouse input, mouseX will hold the x value of
* the most recent touch point.
*/
mouseX: number;
/**
* The system variable mouseX always contains the
* current horizontal position of the mouse, relative
* to (0, 0) of the canvas. The value at the top-left
* corner is (0, 0) for 2-D and (-width/2, -height/2)
* for WebGL. If touch is used instead of mouse
* input, mouseX will hold the x value of the most
* recent touch point.
*/
mouseX: number;
/**
* The system variable mouseY always contains the
* current vertical position of the mouse, relative
* to (0, 0) of the canvas. If touch is used instead
* of mouse input, mouseY will hold the y value of
* the most recent touch point.
*/
mouseY: number;
/**
* The system variable mouseY always contains the
* current vertical position of the mouse, relative
* to (0, 0) of the canvas. The value at the top-left
* corner is (0, 0) for 2-D and (-width/2, -height/2)
* for WebGL. If touch is used instead of mouse
* input, mouseY will hold the y value of the most
* recent touch point.
*/
mouseY: number;
/**
* The system variable pmouseX always contains the
* horizontal position of the mouse or finger in the
* frame previous to the current frame, relative to
* (0, 0) of the canvas. Note: pmouseX will be reset
* to the current mouseX value at the start of each
* touch event.
*/
pmouseX: number;
/**
* The system variable pmouseX always contains the
* horizontal position of the mouse or finger in the
* frame previous to the current frame, relative to
* (0, 0) of the canvas. The value at the top-left
* corner is (0, 0) for 2-D and (-width/2, -height/2)
* for WebGL. Note: pmouseX will be reset to the
* current mouseX value at the start of each touch
* event.
*/
pmouseX: number;
/**
* The system variable pmouseY always contains the
* vertical position of the mouse or finger in the
* frame previous to the current frame, relative to
* (0, 0) of the canvas. Note: pmouseY will be reset
* to the current mouseY value at the start of each
* touch event.
*/
pmouseY: number;
/**
* The system variable pmouseY always contains the
* vertical position of the mouse or finger in the
* frame previous to the current frame, relative to
* (0, 0) of the canvas. The value at the top-left
* corner is (0, 0) for 2-D and (-width/2, -height/2)
* for WebGL. Note: pmouseY will be reset to the
* current mouseY value at the start of each touch
* event.
*/
pmouseY: number;
/**
* The system variable winMouseX always contains the
* current horizontal position of the mouse, relative
* to (0, 0) of the window.
*/
winMouseX: number;
/**
* The system variable winMouseX always contains the
* current horizontal position of the mouse, relative
* to (0, 0) of the window.
*/
winMouseX: number;
/**
* The system variable winMouseY always contains the
* current vertical position of the mouse, relative
* to (0, 0) of the window.
*/
winMouseY: number;
/**
* The system variable winMouseY always contains the
* current vertical position of the mouse, relative
* to (0, 0) of the window.
*/
winMouseY: number;
/**
* The system variable pwinMouseX always contains the
* horizontal position of the mouse in the frame
* previous to the current frame, relative to (0, 0)
* of the window. Note: pwinMouseX will be reset to
* the current winMouseX value at the start of each
* touch event.
*/
pwinMouseX: number;
/**
* The system variable pwinMouseX always contains the
* horizontal position of the mouse in the frame
* previous to the current frame, relative to (0, 0)
* of the window. Note: pwinMouseX will be reset to
* the current winMouseX value at the start of each
* touch event.
*/
pwinMouseX: number;
/**
* The system variable pwinMouseY always contains the
* vertical position of the mouse in the frame
* previous to the current frame, relative to (0, 0)
* of the window. Note: pwinMouseY will be reset to
* the current winMouseY value at the start of each
* touch event.
*/
pwinMouseY: number;
/**
* The system variable pwinMouseY always contains the
* vertical position of the mouse in the frame
* previous to the current frame, relative to (0, 0)
* of the window. Note: pwinMouseY will be reset to
* the current winMouseY value at the start of each
* touch event.
*/
pwinMouseY: number;
/**
* Processing automatically tracks if the mouse
* button is pressed and which button is pressed. The
* value of the system variable mouseButton is either
* LEFT, RIGHT, or CENTER depending on which button
* was pressed last. Warning: different browsers may
* track mouseButton differently.
*/
mouseButton: UNKNOWN_P5_CONSTANT;
/**
* Processing automatically tracks if the mouse
* button is pressed and which button is pressed. The
* value of the system variable mouseButton is either
* LEFT, RIGHT, or CENTER depending on which button
* was pressed last. Warning: different browsers may
* track mouseButton differently.
*/
mouseButton: UNKNOWN_P5_CONSTANT;
/**
* The boolean system variable mouseIsPressed is true
* if the mouse is pressed and false if not.
*/
mouseIsPressed: boolean;
}
/**
* The boolean system variable mouseIsPressed is true
* if the mouse is pressed and false if not.
*/
mouseIsPressed: boolean;
}
}
types/p5/src/events/touch.d.ts
Vendored
+54 -60
View File
@@ -1,67 +1,61 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The touchStarted() function is called once after
* every time a touch is registered. If no
* touchStarted() function is defined, the
* mousePressed() function will be called instead if
* it is defined. Browsers may have different default
* behaviors attached to various touch events. To
* prevent any default behavior for this event, add
* "return false" to the end of the method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchStarted(
event?: object
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The touchStarted() function is called once after
* every time a touch is registered. If no
* touchStarted() function is defined, the
* mousePressed() function will be called instead if
* it is defined. Browsers may have different default
* behaviors attached to various touch events. To
* prevent any default behavior for this event, add
* "return false" to the end of the method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchStarted(event?: object): void;
/**
* The touchMoved() function is called every time a
* touch move is registered. If no touchMoved()
* function is defined, the mouseDragged() function
* will be called instead if it is defined. Browsers
* may have different default behaviors attached to
* various touch events. To prevent any default
* behavior for this event, add "return false" to the
* end of the method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchMoved(
event?: object
): void;
/**
* The touchMoved() function is called every time a
* touch move is registered. If no touchMoved()
* function is defined, the mouseDragged() function
* will be called instead if it is defined. Browsers
* may have different default behaviors attached to
* various touch events. To prevent any default
* behavior for this event, add "return false" to the
* end of the method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchMoved(event?: object): void;
/**
* The touchEnded() function is called every time a
* touch ends. If no touchEnded() function is
* defined, the mouseReleased() function will be
* called instead if it is defined. Browsers may have
* different default behaviors attached to various
* touch events. To prevent any default behavior for
* this event, add "return false" to the end of the
* method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchEnded(
event?: object
): void;
/**
* The touchEnded() function is called every time a
* touch ends. If no touchEnded() function is
* defined, the mouseReleased() function will be
* called instead if it is defined. Browsers may have
* different default behaviors attached to various
* touch events. To prevent any default behavior for
* this event, add "return false" to the end of the
* method.
* @param [event] optional TouchEvent callback
* argument.
*/
touchEnded(event?: object): void;
/**
* The system variable touches[] contains an array of
* the positions of all current touch points,
* relative to (0, 0) of the canvas, and IDs
* identifying a unique touch as it moves. Each
* element in the array is an object with x, y, and
* id properties. The touches[] array is not
* supported on Safari and IE on touch-based desktops
* (laptops).
*/
touches: object[];
}
/**
* The system variable touches[] contains an array of
* the positions of all current touch points,
* relative to (0, 0) of the canvas, and IDs
* identifying a unique touch as it moves. Each
* element in the array is an object with x, y, and
* id properties. The touches[] array is not
* supported on Safari and IE on touch-based desktops
* (laptops).
*/
touches: object[];
}
}
types/p5/src/image/image.d.ts
Vendored
+80 -94
View File
@@ -1,101 +1,87 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Creates a new p5.Image (the datatype for storing
* images). This provides a fresh buffer of pixels to
* play with. Set the size of the buffer with the
* width and height parameters. .pixels gives access
* to an array containing the values for all the
* pixels in the display window. These values are
* numbers. This array is the size (including an
* appropriate factor for the pixelDensity) of the
* display window x4, representing the R, G, B, A
* values in order for each pixel, moving from left
* to right across each row, then down each column.
* See .pixels for more info. It may also be simpler
* to use set() or get().
*
*
* Before accessing the pixels of an image, the data
* must loaded with the loadPixels() function. After
* the array data has been modified, the
* updatePixels() function must be run to update the
* changes.
* @param width width in pixels
* @param height height in pixels
* @return the p5.Image object
*/
createImage(
width: number,
height: number
): Image;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Creates a new p5.Image (the datatype for storing
* images). This provides a fresh buffer of pixels to
* play with. Set the size of the buffer with the
* width and height parameters. .pixels gives access
* to an array containing the values for all the
* pixels in the display window. These values are
* numbers. This array is the size (including an
* appropriate factor for the pixelDensity) of the
* display window x4, representing the R, G, B, A
* values in order for each pixel, moving from left
* to right across each row, then down each column.
* See .pixels for more info. It may also be simpler
* to use set() or get().
*
*
* Before accessing the pixels of an image, the data
* must loaded with the loadPixels() function. After
* the array data has been modified, the
* updatePixels() function must be run to update the
* changes.
* @param width width in pixels
* @param height height in pixels
* @return the p5.Image object
*/
createImage(width: number, height: number): Image;
/**
* Save the current canvas as an image. The browser
* will either save the file immediately, or prompt
* the user with a dialogue window.
* @param selectedCanvas a variable representing a
* specific html5 canvas (optional)
* @param [extension] 'jpg' or 'png'
*/
saveCanvas(
selectedCanvas:
| Element
| HTMLCanvasElement,
filename?: string,
extension?: string
): void;
/**
* Save the current canvas as an image. The browser
* will either save the file immediately, or prompt
* the user with a dialogue window.
* @param selectedCanvas a variable representing a
* specific html5 canvas (optional)
* @param [extension] 'jpg' or 'png'
*/
saveCanvas(selectedCanvas: Element | HTMLCanvasElement, filename?: string, extension?: string): void;
/**
* Save the current canvas as an image. The browser
* will either save the file immediately, or prompt
* the user with a dialogue window.
* @param [extension] 'jpg' or 'png'
*/
saveCanvas(
filename?: string,
extension?: string
): void;
/**
* Save the current canvas as an image. The browser
* will either save the file immediately, or prompt
* the user with a dialogue window.
* @param [extension] 'jpg' or 'png'
*/
saveCanvas(filename?: string, extension?: string): void;
/**
* Capture a sequence of frames that can be used to
* create a movie. Accepts a callback. For example,
* you may wish to send the frames to a server where
* they can be stored or converted into a movie. If
* no callback is provided, the browser will pop up
* save dialogues in an attempt to download all of
* the images that have just been created. With the
* callback provided the image data isn't saved by
* default but instead passed as an argument to the
* callback function as an array of objects, with the
* size of array equal to the total number of frames.
* Note that saveFrames() will only save the first 15
* frames of an animation. To export longer
* animations, you might look into a library like
* ccapture.js.
* @param extension 'jpg' or 'png'
* @param duration Duration in seconds to save the
* frames for.
* @param framerate Framerate to save the frames in.
* @param [callback] A callback function that will be
* executed to handle the image data. This function
* should accept an array as argument. The array will
* contain the specified number of frames of objects.
* Each object has three properties: imageData - an
* image/octet-stream, filename and extension.
*/
saveFrames(
filename: string,
extension: string,
duration: number,
framerate: number,
callback?: (
p1: any[]
) => any
): void;
}
/**
* Capture a sequence of frames that can be used to
* create a movie. Accepts a callback. For example,
* you may wish to send the frames to a server where
* they can be stored or converted into a movie. If
* no callback is provided, the browser will pop up
* save dialogues in an attempt to download all of
* the images that have just been created. With the
* callback provided the image data isn't saved by
* default but instead passed as an argument to the
* callback function as an array of objects, with the
* size of array equal to the total number of frames.
* Note that saveFrames() will only save the first 15
* frames of an animation. To export longer
* animations, you might look into a library like
* ccapture.js.
* @param extension 'jpg' or 'png'
* @param duration Duration in seconds to save the
* frames for.
* @param framerate Framerate to save the frames in.
* @param [callback] A callback function that will be
* executed to handle the image data. This function
* should accept an array as argument. The array will
* contain the specified number of frames of objects.
* Each object has three properties: imageData - an
* image/octet-stream, filename and extension.
*/
saveFrames(
filename: string,
extension: string,
duration: number,
framerate: number,
callback?: (p1: any[]) => any
): void;
}
}
types/p5/src/image/loading_displaying.d.ts
Vendored
+229 -263
View File
@@ -1,276 +1,242 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Loads an image from a path and creates a p5.Image
* from it. The image may not be immediately
* available for rendering If you want to ensure that
* the image is ready before doing anything with it,
* place the loadImage() call in preload(). You may
* also supply a callback function to handle the
* image when it's ready.
*
*
* The path to the image should be relative to the
* HTML file that links in your sketch. Loading an
* image from a URL or other remote location may be
* blocked due to your browser's built-in security.
* @param path Path of the image to be loaded
* @param [successCallback] Function to be called
* once the image is loaded. Will be passed the
* p5.Image.
* @param [failureCallback] called with event error
* if the image fails to load.
* @return the p5.Image object
*/
loadImage(
path: string,
successCallback?: (
p1: Image
) => any,
failureCallback?: (
p1: Event
) => any
): Image;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Loads an image from a path and creates a p5.Image
* from it. The image may not be immediately
* available for rendering If you want to ensure that
* the image is ready before doing anything with it,
* place the loadImage() call in preload(). You may
* also supply a callback function to handle the
* image when it's ready.
*
*
* The path to the image should be relative to the
* HTML file that links in your sketch. Loading an
* image from a URL or other remote location may be
* blocked due to your browser's built-in security.
* @param path Path of the image to be loaded
* @param [successCallback] Function to be called
* once the image is loaded. Will be passed the
* p5.Image.
* @param [failureCallback] called with event error
* if the image fails to load.
* @return the p5.Image object
*/
loadImage(path: string, successCallback?: (p1: Image) => any, failureCallback?: (p1: Event) => any): Image;
/**
* Draw an image to the p5.js canvas. This function
* can be used with different numbers of parameters.
* The simplest use requires only three parameters:
* img, x, and y—where (x, y) is the position of the
* image. Two more parameters can optionally be added
* to specify the width and height of the image.
*
* This function can also be used with all eight
* Number parameters. To differentiate between all
* these parameters, p5.js uses the language of
* "destination rectangle" (which corresponds to
* "dx", "dy", etc.) and "source image" (which
* corresponds to "sx", "sy", etc.) below. Specifying
* the "source image" dimensions can be useful when
* you want to display a subsection of the source
* image instead of the whole thing. Here's a diagram
* to explain further:
* @param img the image to display
* @param x the x-coordinate of the top-left corner
* of the image
* @param y the y-coordinate of the top-left corner
* of the image
* @param [width] the width to draw the image
* @param [height] the height to draw the image
*/
image(
img:
| Image
| Element,
x: number,
y: number,
width?: number,
height?: number
): void;
/**
* Draw an image to the p5.js canvas. This function
* can be used with different numbers of parameters.
* The simplest use requires only three parameters:
* img, x, and y—where (x, y) is the position of the
* image. Two more parameters can optionally be added
* to specify the width and height of the image.
*
* This function can also be used with all eight
* Number parameters. To differentiate between all
* these parameters, p5.js uses the language of
* "destination rectangle" (which corresponds to
* "dx", "dy", etc.) and "source image" (which
* corresponds to "sx", "sy", etc.) below. Specifying
* the "source image" dimensions can be useful when
* you want to display a subsection of the source
* image instead of the whole thing. Here's a diagram
* to explain further:
* @param img the image to display
* @param x the x-coordinate of the top-left corner
* of the image
* @param y the y-coordinate of the top-left corner
* of the image
* @param [width] the width to draw the image
* @param [height] the height to draw the image
*/
image(img: Image | Element, x: number, y: number, width?: number, height?: number): void;
/**
* Draw an image to the p5.js canvas. This function
* can be used with different numbers of parameters.
* The simplest use requires only three parameters:
* img, x, and y—where (x, y) is the position of the
* image. Two more parameters can optionally be added
* to specify the width and height of the image.
*
* This function can also be used with all eight
* Number parameters. To differentiate between all
* these parameters, p5.js uses the language of
* "destination rectangle" (which corresponds to
* "dx", "dy", etc.) and "source image" (which
* corresponds to "sx", "sy", etc.) below. Specifying
* the "source image" dimensions can be useful when
* you want to display a subsection of the source
* image instead of the whole thing. Here's a diagram
* to explain further:
* @param img the image to display
* @param dx the x-coordinate of the destination
* rectangle in which to draw the source image
* @param dy the y-coordinate of the destination
* rectangle in which to draw the source image
* @param dWidth the width of the destination
* rectangle
* @param dHeight the height of the destination
* rectangle
* @param sx the x-coordinate of the subsection of
* the source image to draw into the destination
* rectangle
* @param sy the y-coordinate of the subsection of
* the source image to draw into the destination
* rectangle
* @param [sWidth] the width of the subsection of the
* source image to draw into the destination
* rectangle
* @param [sHeight] the height of the subsection of
* the source image to draw into the destination
* rectangle
*/
image(
img:
| Image
| Element,
dx: number,
dy: number,
dWidth: number,
dHeight: number,
sx: number,
sy: number,
sWidth?: number,
sHeight?: number
): void;
/**
* Draw an image to the p5.js canvas. This function
* can be used with different numbers of parameters.
* The simplest use requires only three parameters:
* img, x, and y—where (x, y) is the position of the
* image. Two more parameters can optionally be added
* to specify the width and height of the image.
*
* This function can also be used with all eight
* Number parameters. To differentiate between all
* these parameters, p5.js uses the language of
* "destination rectangle" (which corresponds to
* "dx", "dy", etc.) and "source image" (which
* corresponds to "sx", "sy", etc.) below. Specifying
* the "source image" dimensions can be useful when
* you want to display a subsection of the source
* image instead of the whole thing. Here's a diagram
* to explain further:
* @param img the image to display
* @param dx the x-coordinate of the destination
* rectangle in which to draw the source image
* @param dy the y-coordinate of the destination
* rectangle in which to draw the source image
* @param dWidth the width of the destination
* rectangle
* @param dHeight the height of the destination
* rectangle
* @param sx the x-coordinate of the subsection of
* the source image to draw into the destination
* rectangle
* @param sy the y-coordinate of the subsection of
* the source image to draw into the destination
* rectangle
* @param [sWidth] the width of the subsection of the
* source image to draw into the destination
* rectangle
* @param [sHeight] the height of the subsection of
* the source image to draw into the destination
* rectangle
*/
image(
img: Image | Element,
dx: number,
dy: number,
dWidth: number,
dHeight: number,
sx: number,
sy: number,
sWidth?: number,
sHeight?: number
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
*/
tint(
v1: number,
v2: number,
v3: number,
alpha?: number
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
*/
tint(v1: number, v2: number, v3: number, alpha?: number): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param value a color string
*/
tint(
value: string
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param value a color string
*/
tint(value: string): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param gray a gray value
*/
tint(
gray: number,
alpha?: number
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param gray a gray value
*/
tint(gray: number, alpha?: number): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param values an array containing the
* red,green,blue & and alpha components of the color
*/
tint(
values: number[]
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param values an array containing the
* red,green,blue & and alpha components of the color
*/
tint(values: number[]): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param color the tint color
*/
tint(
color: Color
): void;
/**
* Sets the fill value for displaying images. Images
* can be tinted to specified colors or made
* transparent by including an alpha value. To apply
* transparency to an image without affecting its
* color, use white as the tint color and specify an
* alpha value. For instance, tint(255, 128) will
* make an image 50% transparent (assuming the
* default alpha range of 0-255, which can be changed
* with colorMode()).
*
*
* The value for the gray parameter must be less than
* or equal to the current maximum value as specified
* by colorMode(). The default maximum value is 255.
* @param color the tint color
*/
tint(color: Color): void;
/**
* Removes the current fill value for displaying
* images and reverts to displaying images with their
* original hues.
*/
noTint(): void;
/**
* Removes the current fill value for displaying
* images and reverts to displaying images with their
* original hues.
*/
noTint(): void;
/**
* Set image mode. Modifies the location from which
* images are drawn by changing the way in which
* parameters given to image() are interpreted. The
* default mode is imageMode(CORNER), which
* interprets the second and third parameters of
* image() as the upper-left corner of the image. If
* two additional parameters are specified, they are
* used to set the image's width and height.
* imageMode(CORNERS) interprets the second and third
* parameters of image() as the location of one
* corner, and the fourth and fifth parameters as the
* opposite corner.
*
*
* imageMode(CENTER) interprets the second and third
* parameters of image() as the image's center point.
* If two additional parameters are specified, they
* are used to set the image's width and height.
* @param mode either CORNER, CORNERS, or CENTER
*/
imageMode(
mode: IMAGE_MODE
): void;
}
/**
* Set image mode. Modifies the location from which
* images are drawn by changing the way in which
* parameters given to image() are interpreted. The
* default mode is imageMode(CORNER), which
* interprets the second and third parameters of
* image() as the upper-left corner of the image. If
* two additional parameters are specified, they are
* used to set the image's width and height.
* imageMode(CORNERS) interprets the second and third
* parameters of image() as the location of one
* corner, and the fourth and fifth parameters as the
* opposite corner.
*
*
* imageMode(CENTER) interprets the second and third
* parameters of image() as the image's center point.
* If two additional parameters are specified, they
* are used to set the image's width and height.
* @param mode either CORNER, CORNERS, or CENTER
*/
imageMode(mode: IMAGE_MODE): void;
}
}
types/p5/src/image/p5.Image.d.ts
Vendored
+285 -308
View File
@@ -1,327 +1,304 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Image {
/**
* Loads the pixels data for this image into the
* [pixels] attribute.
*/
loadPixels(): void;
declare module '../../index' {
class Image {
/**
* Loads the pixels data for this image into the
* [pixels] attribute.
*/
loadPixels(): void;
/**
* Updates the backing canvas for this image with the
* contents of the [pixels] array.
* @param x x-offset of the target update area for
* the underlying canvas
* @param y y-offset of the target update area for
* the underlying canvas
* @param w height of the target update area for the
* underlying canvas
* @param h height of the target update area for the
* underlying canvas
*/
updatePixels(
x: number,
y: number,
w: number,
h: number
): void;
/**
* Updates the backing canvas for this image with the
* contents of the [pixels] array.
* @param x x-offset of the target update area for
* the underlying canvas
* @param y y-offset of the target update area for
* the underlying canvas
* @param w height of the target update area for the
* underlying canvas
* @param h height of the target update area for the
* underlying canvas
*/
updatePixels(x: number, y: number, w: number, h: number): void;
/**
* Updates the backing canvas for this image with the
* contents of the [pixels] array.
*/
updatePixels(): void;
/**
* Updates the backing canvas for this image with the
* contents of the [pixels] array.
*/
updatePixels(): void;
/**
* Get a region of pixels from an image. If no params
* are passed, those whole image is returned, if x
* and y are the only params passed a single pixel is
* extracted if all params are passed a rectangle
* region is extracted and a p5.Image is returned.
*
* Returns undefined if the region is outside the
* bounds of the image
* @param [x] x-coordinate of the pixel
* @param [y] y-coordinate of the pixel
* @param [w] width
* @param [h] height
* @return color of pixel at x,y in array format [R,
* G, B, A] or p5.Image
*/
get(
x?: number,
y?: number,
w?: number,
h?: number
):
| number[]
| Color
| Image;
/**
* Get a region of pixels from an image. If no params
* are passed, the whole image is returned. If x and
* y are the only params passed a single pixel is
* extracted. If all params are passed a rectangle
* region is extracted and a p5.Image is returned.
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param w width
* @param h height
* @return the rectangle p5.Image
*/
get(x: number, y: number, w: number, h: number): Image;
/**
* Set the color of a single pixel or write an image
* into this p5.Image. Note that for a large number
* of pixels this will be slower than directly
* manipulating the pixels array and then calling
* updatePixels().
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param a grayscale value | pixel array | a
* p5.Color | image to copy
*/
set(
x: number,
y: number,
a:
| number
| number[]
| object
): void;
/**
* Get a region of pixels from an image. If no params
* are passed, the whole image is returned. If x and
* y are the only params passed a single pixel is
* extracted. If all params are passed a rectangle
* region is extracted and a p5.Image is returned.
* @return the whole p5.Image
*/
get(): Image;
/**
* Resize the image to a new width and height. To
* make the image scale proportionally, use 0 as the
* value for the wide or high parameter. For
* instance, to make the width of an image 150
* pixels, and change the height using the same
* proportion, use resize(150, 0).
* @param width the resized image width
* @param height the resized image height
*/
resize(
width: number,
height: number
): void;
/**
* Get a region of pixels from an image. If no params
* are passed, the whole image is returned. If x and
* y are the only params passed a single pixel is
* extracted. If all params are passed a rectangle
* region is extracted and a p5.Image is returned.
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @return color of pixel at x,y in array format [R,
* G, B, A]
*/
get(x: number, y: number): number[];
/**
* Copies a region of pixels from one image to
* another. If no srcImage is specified this is used
* as the source. If the source and destination
* regions aren't the same size, it will
* automatically resize source pixels to fit the
* specified target region.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
srcImage:
| Image
| Element,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Set the color of a single pixel or write an image
* into this p5.Image. Note that for a large number
* of pixels this will be slower than directly
* manipulating the pixels array and then calling
* updatePixels().
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param a grayscale value | pixel array | a
* p5.Color | image to copy
*/
set(x: number, y: number, a: number | number[] | object): void;
/**
* Copies a region of pixels from one image to
* another. If no srcImage is specified this is used
* as the source. If the source and destination
* regions aren't the same size, it will
* automatically resize source pixels to fit the
* specified target region.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Resize the image to a new width and height. To
* make the image scale proportionally, use 0 as the
* value for the wide or high parameter. For
* instance, to make the width of an image 150
* pixels, and change the height using the same
* proportion, use resize(150, 0).
* @param width the resized image width
* @param height the resized image height
*/
resize(width: number, height: number): void;
/**
* Masks part of an image from displaying by loading
* another image and using it's alpha channel as an
* alpha channel for this image.
* @param srcImage source image
*/
mask(
srcImage: Image
): void;
/**
* Copies a region of pixels from one image to
* another. If no srcImage is specified this is used
* as the source. If the source and destination
* regions aren't the same size, it will
* automatically resize source pixels to fit the
* specified target region.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
srcImage: Image | Element,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Applies an image filter to a p5.Image
* @param filterType either THRESHOLD, GRAY, OPAQUE,
* INVERT, POSTERIZE, BLUR, ERODE, DILATE or BLUR.
* See Filters.js for docs on each available filter
* @param [filterParam] an optional parameter unique
* to each filter, see above
*/
filter(
filterType: FILTER_TYPE,
filterParam?: number
): void;
/**
* Copies a region of pixels from one image to
* another. If no srcImage is specified this is used
* as the source. If the source and destination
* regions aren't the same size, it will
* automatically resize source pixels to fit the
* specified target region.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(sx: number, sy: number, sw: number, sh: number, dx: number, dy: number, dw: number, dh: number): void;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*
* Available blend modes are: normal | multiply |
* screen | overlay | darken | lighten | color-dodge
* | color-burn | hard-light | soft-light |
* difference | exclusion | hue | saturation | color
* | luminosity
*
* http://blogs.adobe.com/webplatform/2013/01/28/blending-features-in-canvas/
*/
blend(
srcImage: Image,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: BLEND_MODE
): void;
/**
* Masks part of an image from displaying by loading
* another image and using it's alpha channel as an
* alpha channel for this image.
* @param srcImage source image
*/
mask(srcImage: Image): void;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*
* Available blend modes are: normal | multiply |
* screen | overlay | darken | lighten | color-dodge
* | color-burn | hard-light | soft-light |
* difference | exclusion | hue | saturation | color
* | luminosity
*
* http://blogs.adobe.com/webplatform/2013/01/28/blending-features-in-canvas/
*/
blend(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: UNKNOWN_P5_CONSTANT
): void;
/**
* Applies an image filter to a p5.Image
* @param filterType either THRESHOLD, GRAY, OPAQUE,
* INVERT, POSTERIZE, BLUR, ERODE, DILATE or BLUR.
* See Filters.js for docs on each available filter
* @param [filterParam] an optional parameter unique
* to each filter, see above
*/
filter(filterType: FILTER_TYPE, filterParam?: number): void;
/**
* Saves the image to a file and force the browser to
* download it. Accepts two strings for filename and
* file extension Supports png (default) and jpg.
* @param filename give your file a name
* @param extension 'png' or 'jpg'
*/
save(
filename: string,
extension: string
): void;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*
* Available blend modes are: normal | multiply |
* screen | overlay | darken | lighten | color-dodge
* | color-burn | hard-light | soft-light |
* difference | exclusion | hue | saturation | color
* | luminosity
*
* http://blogs.adobe.com/webplatform/2013/01/28/blending-features-in-canvas/
*/
blend(
srcImage: Image,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: BLEND_MODE
): void;
/**
* Image width.
*/
width: number;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*
* Available blend modes are: normal | multiply |
* screen | overlay | darken | lighten | color-dodge
* | color-burn | hard-light | soft-light |
* difference | exclusion | hue | saturation | color
* | luminosity
*
* http://blogs.adobe.com/webplatform/2013/01/28/blending-features-in-canvas/
*/
blend(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: UNKNOWN_P5_CONSTANT
): void;
/**
* Image height.
*/
height: number;
/**
* Saves the image to a file and force the browser to
* download it. Accepts two strings for filename and
* file extension Supports png (default) and jpg.
* @param filename give your file a name
* @param extension 'png' or 'jpg'
*/
save(filename: string, extension: string): void;
/**
* Array containing the values for all the pixels in
* the display window. These values are numbers. This
* array is the size (include an appropriate factor
* for pixelDensity) of the display window x4,
* representing the R, G, B, A values in order for
* each pixel, moving from left to right across each
* row, then down each column. Retina and other high
* denisty displays may have more pixels (by a factor
* of pixelDensity^2). For example, if the image is
* 100x100 pixels, there will be 40,000. With
* pixelDensity = 2, there will be 160,000. The first
* four values (indices 0-3) in the array will be the
* R, G, B, A values of the pixel at (0, 0). The
* second four values (indices 4-7) will contain the
* R, G, B, A values of the pixel at (1, 0). More
* generally, to set values for a pixel at (x, y):
* let d = pixelDensity(); for (let i = 0; i < d;
* i++) { for (let j = 0; j < d; j++) { // loop over
* index = 4 * ((y * d + j) * width * d + (x * d +
* i)); pixels[index] = r; pixels[index+1] = g;
* pixels[index+2] = b; pixels[index+3] = a; } }
*
*
*
*
* Before accessing this array, the data must loaded
* with the loadPixels() function. After the array
* data has been modified, the updatePixels()
* function must be run to update the changes.
*/
pixels: number[];
}
/**
* Image width.
*/
width: number;
/**
* Image height.
*/
height: number;
/**
* Array containing the values for all the pixels in
* the display window. These values are numbers. This
* array is the size (include an appropriate factor
* for pixelDensity) of the display window x4,
* representing the R, G, B, A values in order for
* each pixel, moving from left to right across each
* row, then down each column. Retina and other high
* denisty displays may have more pixels (by a factor
* of pixelDensity^2). For example, if the image is
* 100x100 pixels, there will be 40,000. With
* pixelDensity = 2, there will be 160,000. The first
* four values (indices 0-3) in the array will be the
* R, G, B, A values of the pixel at (0, 0). The
* second four values (indices 4-7) will contain the
* R, G, B, A values of the pixel at (1, 0). More
* generally, to set values for a pixel at (x, y):
* let d = pixelDensity(); for (let i = 0; i < d;
* i++) { for (let j = 0; j < d; j++) { // loop over
* index = 4 * ((y * d + j) * width * d + (x * d +
* i)); pixels[index] = r; pixels[index+1] = g;
* pixels[index+2] = b; pixels[index+3] = a; } }
*
*
*
*
* Before accessing this array, the data must loaded
* with the loadPixels() function. After the array
* data has been modified, the updatePixels()
* function must be run to update the changes.
*/
pixels: number[];
}
}
types/p5/src/image/pixels.d.ts
Vendored
+412 -367
View File
@@ -1,380 +1,425 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*/
blend(
srcImage: Image,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: BLEND_MODE
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*/
blend(
srcImage: Image,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: BLEND_MODE
): void;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*/
blend(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: UNKNOWN_P5_CONSTANT
): void;
/**
* Copies a region of pixels from one image to
* another, using a specified blend mode to do the
* operation.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
* @param blendMode the blend mode. either BLEND,
* DARKEST, LIGHTEST, DIFFERENCE, MULTIPLY,
* EXCLUSION, SCREEN, REPLACE, OVERLAY, HARD_LIGHT,
* SOFT_LIGHT, DODGE, BURN, ADD or NORMAL.
*/
blend(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number,
blendMode: UNKNOWN_P5_CONSTANT
): void;
/**
* Copies a region of the canvas to another region of
* the canvas and copies a region of pixels from an
* image used as the srcImg parameter into the canvas
* srcImage is specified this is used as the source.
* If the source and destination regions aren't the
* same size, it will automatically resize source
* pixels to fit the specified target region.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
srcImage:
| Image
| Element,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Copies a region of the canvas to another region of
* the canvas and copies a region of pixels from an
* image used as the srcImg parameter into the canvas
* srcImage is specified this is used as the source.
* If the source and destination regions aren't the
* same size, it will automatically resize source
* pixels to fit the specified target region.
* @param srcImage source image
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
srcImage: Image | Element,
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Copies a region of the canvas to another region of
* the canvas and copies a region of pixels from an
* image used as the srcImg parameter into the canvas
* srcImage is specified this is used as the source.
* If the source and destination regions aren't the
* same size, it will automatically resize source
* pixels to fit the specified target region.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(
sx: number,
sy: number,
sw: number,
sh: number,
dx: number,
dy: number,
dw: number,
dh: number
): void;
/**
* Copies a region of the canvas to another region of
* the canvas and copies a region of pixels from an
* image used as the srcImg parameter into the canvas
* srcImage is specified this is used as the source.
* If the source and destination regions aren't the
* same size, it will automatically resize source
* pixels to fit the specified target region.
* @param sx X coordinate of the source's upper left
* corner
* @param sy Y coordinate of the source's upper left
* corner
* @param sw source image width
* @param sh source image height
* @param dx X coordinate of the destination's upper
* left corner
* @param dy Y coordinate of the destination's upper
* left corner
* @param dw destination image width
* @param dh destination image height
*/
copy(sx: number, sy: number, sw: number, sh: number, dx: number, dy: number, dw: number, dh: number): void;
/**
* Applies a filter to the canvas.
*
* The presets options are:
*
*
*
* THRESHOLD Converts the image to black and white
* pixels depending if they are above or below the
* threshold defined by the level parameter. The
* parameter must be between 0.0 (black) and 1.0
* (white). If no level is specified, 0.5 is used.
*
*
*
* GRAY Converts any colors in the image to grayscale
* equivalents. No parameter is used.
*
*
*
* OPAQUE Sets the alpha channel to entirely opaque.
* No parameter is used.
*
*
*
* INVERT Sets each pixel to its inverse value. No
* parameter is used.
*
*
*
* POSTERIZE Limits each channel of the image to the
* number of colors specified as the parameter. The
* parameter can be set to values between 2 and 255,
* but results are most noticeable in the lower
* ranges.
*
*
*
* BLUR Executes a Gaussian blur with the level
* parameter specifying the extent of the blurring.
* If no parameter is used, the blur is equivalent to
* Gaussian blur of radius 1. Larger values increase
* the blur.
*
*
*
* ERODE Reduces the light areas. No parameter is
* used.
*
*
*
* DILATE Increases the light areas. No parameter is
* used.
* @param filterType either THRESHOLD, GRAY, OPAQUE,
* INVERT, POSTERIZE, BLUR, ERODE, DILATE or BLUR.
* See Filters.js for docs on each available filter
* @param [filterParam] an optional parameter unique
* to each filter, see above
*/
filter(
filterType: FILTER_TYPE,
filterParam?: number
): void;
/**
* Applies a filter to the canvas.
*
* The presets options are:
*
*
*
* THRESHOLD Converts the image to black and white
* pixels depending if they are above or below the
* threshold defined by the level parameter. The
* parameter must be between 0.0 (black) and 1.0
* (white). If no level is specified, 0.5 is used.
*
*
*
* GRAY Converts any colors in the image to grayscale
* equivalents. No parameter is used.
*
*
*
* OPAQUE Sets the alpha channel to entirely opaque.
* No parameter is used.
*
*
*
* INVERT Sets each pixel to its inverse value. No
* parameter is used.
*
*
*
* POSTERIZE Limits each channel of the image to the
* number of colors specified as the parameter. The
* parameter can be set to values between 2 and 255,
* but results are most noticeable in the lower
* ranges.
*
*
*
* BLUR Executes a Gaussian blur with the level
* parameter specifying the extent of the blurring.
* If no parameter is used, the blur is equivalent to
* Gaussian blur of radius 1. Larger values increase
* the blur.
*
*
*
* ERODE Reduces the light areas. No parameter is
* used.
*
*
*
* DILATE Increases the light areas. No parameter is
* used.
* @param filterType either THRESHOLD, GRAY, OPAQUE,
* INVERT, POSTERIZE, BLUR, ERODE, DILATE or BLUR.
* See Filters.js for docs on each available filter
* @param [filterParam] an optional parameter unique
* to each filter, see above
*/
filter(filterType: FILTER_TYPE, filterParam?: number): void;
/**
* Returns an array of [R,G,B,A] values for any pixel
* or grabs a section of an image. If no parameters
* are specified, the entire image is returned. Use
* the x and y parameters to get the value of one
* pixel. Get a section of the display window by
* specifying additional w and h parameters. When
* getting an image, the x and y parameters define
* the coordinates for the upper-left corner of the
* image, regardless of the current imageMode(). If
* the pixel requested is outside of the image
* window, [0,0,0,255] is returned. To get the
* numbers scaled according to the current color
* ranges and taking into account colorMode, use
* getColor instead of get.
*
*
* Getting the color of a single pixel with get(x, y)
* is easy, but not as fast as grabbing the data
* directly from pixels[]. The equivalent statement
* to get(x, y) using pixels[] with pixel density d
* is
*
* let x, y, d; // set these to the coordinates let
* off = (y * width + x) * d * 4; let components = [
* pixels[off], pixels[off + 1], pixels[off + 2],
* pixels[off + 3] ]; print(components);
*
*
*
*
* See the reference for pixels[] for more
* information.
*
* If you want to extract an array of colors or a
* subimage from an p5.Image object, take a look at
* p5.Image.get()
* @param [x] x-coordinate of the pixel
* @param [y] y-coordinate of the pixel
* @param [w] width
* @param [h] height
* @return values of pixel at x,y in array format [R,
* G, B, A] or p5.Image
*/
get(
x?: number,
y?: number,
w?: number,
h?: number
):
| number[]
| Image;
/**
* Get a region of pixels, or a single pixel, from
* the canvas. Returns an array of [R,G,B,A] values
* for any pixel or grabs a section of an image. If
* no parameters are specified, the entire image is
* returned. Use the x and y parameters to get the
* value of one pixel. Get a section of the display
* window by specifying additional w and h
* parameters. When getting an image, the x and y
* parameters define the coordinates for the
* upper-left corner of the image, regardless of the
* current imageMode().
*
*
* Getting the color of a single pixel with get(x, y)
* is easy, but not as fast as grabbing the data
* directly from pixels[]. The equivalent statement
* to get(x, y) using pixels[] with pixel density d
* is
*
* let x, y, d; // set these to the coordinates let
* off = (y * width + x) * d * 4; let components = [
* pixels[off], pixels[off + 1], pixels[off + 2],
* pixels[off + 3] ]; print(components);
*
*
*
*
*
* See the reference for pixels[] for more
* information.
*
* If you want to extract an array of colors or a
* subimage from an p5.Image object, take a look at
* p5.Image.get()
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param w width
* @param h height
* @return the rectangle p5.Image
*/
get(x: number, y: number, w: number, h: number): Image;
/**
* Loads the pixel data for the display window into
* the pixels[] array. This function must always be
* called before reading from or writing to pixels[].
* Note that only changes made with set() or direct
* manipulation of pixels[] will occur.
*/
loadPixels(): void;
/**
* Get a region of pixels, or a single pixel, from
* the canvas. Returns an array of [R,G,B,A] values
* for any pixel or grabs a section of an image. If
* no parameters are specified, the entire image is
* returned. Use the x and y parameters to get the
* value of one pixel. Get a section of the display
* window by specifying additional w and h
* parameters. When getting an image, the x and y
* parameters define the coordinates for the
* upper-left corner of the image, regardless of the
* current imageMode().
*
*
* Getting the color of a single pixel with get(x, y)
* is easy, but not as fast as grabbing the data
* directly from pixels[]. The equivalent statement
* to get(x, y) using pixels[] with pixel density d
* is
*
* let x, y, d; // set these to the coordinates let
* off = (y * width + x) * d * 4; let components = [
* pixels[off], pixels[off + 1], pixels[off + 2],
* pixels[off + 3] ]; print(components);
*
*
*
*
*
* See the reference for pixels[] for more
* information.
*
* If you want to extract an array of colors or a
* subimage from an p5.Image object, take a look at
* p5.Image.get()
* @return the whole p5.Image
*/
get(): Image;
/**
* Changes the color of any pixel, or writes an image
* directly to the display window. The x and y
* parameters specify the pixel to change and the c
* parameter specifies the color value. This can be a
* p5.Color object, or [R, G, B, A] pixel array. It
* can also be a single grayscale value. When setting
* an image, the x and y parameters define the
* coordinates for the upper-left corner of the
* image, regardless of the current imageMode().
*
*
* After using set(), you must call updatePixels()
* for your changes to appear. This should be called
* once all pixels have been set, and must be called
* before calling .get() or drawing the image.
*
* Setting the color of a single pixel with set(x, y)
* is easy, but not as fast as putting the data
* directly into pixels[]. Setting the pixels[]
* values directly may be complicated when working
* with a retina display, but will perform better
* when lots of pixels need to be set directly on
* every loop.
*
* See the reference for pixels[] for more
* information.
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param c insert a grayscale value | a pixel array
* | a p5.Color object | a p5.Image to copy
*/
set(
x: number,
y: number,
c:
| number
| number[]
| object
): void;
/**
* Get a region of pixels, or a single pixel, from
* the canvas. Returns an array of [R,G,B,A] values
* for any pixel or grabs a section of an image. If
* no parameters are specified, the entire image is
* returned. Use the x and y parameters to get the
* value of one pixel. Get a section of the display
* window by specifying additional w and h
* parameters. When getting an image, the x and y
* parameters define the coordinates for the
* upper-left corner of the image, regardless of the
* current imageMode().
*
*
* Getting the color of a single pixel with get(x, y)
* is easy, but not as fast as grabbing the data
* directly from pixels[]. The equivalent statement
* to get(x, y) using pixels[] with pixel density d
* is
*
* let x, y, d; // set these to the coordinates let
* off = (y * width + x) * d * 4; let components = [
* pixels[off], pixels[off + 1], pixels[off + 2],
* pixels[off + 3] ]; print(components);
*
*
*
*
*
* See the reference for pixels[] for more
* information.
*
* If you want to extract an array of colors or a
* subimage from an p5.Image object, take a look at
* p5.Image.get()
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @return color of pixel at x,y in array format [R,
* G, B, A]
*/
get(x: number, y: number): number[];
/**
* Updates the display window with the data in the
* pixels[] array. Use in conjunction with
* loadPixels(). If you're only reading pixels from
* the array, there's no need to call updatePixels()
* — updating is only necessary to apply changes.
* updatePixels() should be called anytime the pixels
* array is manipulated or set() is called, and only
* changes made with set() or direct changes to
* pixels[] will occur.
* @param [x] x-coordinate of the upper-left corner
* of region to update
* @param [y] y-coordinate of the upper-left corner
* of region to update
* @param [w] width of region to update
* @param [h] height of region to update
*/
updatePixels(
x?: number,
y?: number,
w?: number,
h?: number
): void;
/**
* Loads the pixel data for the display window into
* the pixels[] array. This function must always be
* called before reading from or writing to pixels[].
* Note that only changes made with set() or direct
* manipulation of pixels[] will occur.
*/
loadPixels(): void;
/**
* Uint8ClampedArray containing the values for all
* the pixels in the display window. These values are
* numbers. This array is the size (include an
* appropriate factor for pixelDensity) of the
* display window x4, representing the R, G, B, A
* values in order for each pixel, moving from left
* to right across each row, then down each column.
* Retina and other high density displays will have
* more pixels[] (by a factor of pixelDensity^2). For
* example, if the image is 100x100 pixels, there
* will be 40,000. On a retina display, there will be
* 160,000. The first four values (indices 0-3) in
* the array will be the R, G, B, A values of the
* pixel at (0, 0). The second four values (indices
* 4-7) will contain the R, G, B, A values of the
* pixel at (1, 0). More generally, to set values for
* a pixel at (x, y):
*
* let d = pixelDensity(); for (let i = 0; i < d;
* i++) { for (let j = 0; j < d; j++) { // loop over
* index = 4 * ((y * d + j) * width * d + (x * d +
* i)); pixels[index] = r; pixels[index+1] = g;
* pixels[index+2] = b; pixels[index+3] = a; } }
*
* While the above method is complex, it is flexible
* enough to work with any pixelDensity. Note that
* set() will automatically take care of setting all
* the appropriate values in pixels[] for a given (x,
* y) at any pixelDensity, but the performance may
* not be as fast when lots of modifications are made
* to the pixel array.
*
*
* Before accessing this array, the data must loaded
* with the loadPixels() function. After the array
* data has been modified, the updatePixels()
* function must be run to update the changes.
*
*
* Note that this is not a standard javascript array.
* This means that standard javascript functions such
* as slice() or arrayCopy() do not work.
*/
pixels: number[];
}
/**
* Changes the color of any pixel, or writes an image
* directly to the display window. The x and y
* parameters specify the pixel to change and the c
* parameter specifies the color value. This can be a
* p5.Color object, or [R, G, B, A] pixel array. It
* can also be a single grayscale value. When setting
* an image, the x and y parameters define the
* coordinates for the upper-left corner of the
* image, regardless of the current imageMode().
*
*
* After using set(), you must call updatePixels()
* for your changes to appear. This should be called
* once all pixels have been set, and must be called
* before calling .get() or drawing the image.
*
* Setting the color of a single pixel with set(x, y)
* is easy, but not as fast as putting the data
* directly into pixels[]. Setting the pixels[]
* values directly may be complicated when working
* with a retina display, but will perform better
* when lots of pixels need to be set directly on
* every loop.
*
* See the reference for pixels[] for more
* information.
* @param x x-coordinate of the pixel
* @param y y-coordinate of the pixel
* @param c insert a grayscale value | a pixel array
* | a p5.Color object | a p5.Image to copy
*/
set(x: number, y: number, c: number | number[] | object): void;
/**
* Updates the display window with the data in the
* pixels[] array. Use in conjunction with
* loadPixels(). If you're only reading pixels from
* the array, there's no need to call updatePixels()
* — updating is only necessary to apply changes.
* updatePixels() should be called anytime the pixels
* array is manipulated or set() is called, and only
* changes made with set() or direct changes to
* pixels[] will occur.
* @param [x] x-coordinate of the upper-left corner
* of region to update
* @param [y] y-coordinate of the upper-left corner
* of region to update
* @param [w] width of region to update
* @param [h] height of region to update
*/
updatePixels(x?: number, y?: number, w?: number, h?: number): void;
/**
* Uint8ClampedArray containing the values for all
* the pixels in the display window. These values are
* numbers. This array is the size (include an
* appropriate factor for pixelDensity) of the
* display window x4, representing the R, G, B, A
* values in order for each pixel, moving from left
* to right across each row, then down each column.
* Retina and other high density displays will have
* more pixels[] (by a factor of pixelDensity^2). For
* example, if the image is 100x100 pixels, there
* will be 40,000. On a retina display, there will be
* 160,000. The first four values (indices 0-3) in
* the array will be the R, G, B, A values of the
* pixel at (0, 0). The second four values (indices
* 4-7) will contain the R, G, B, A values of the
* pixel at (1, 0). More generally, to set values for
* a pixel at (x, y):
*
* let d = pixelDensity(); for (let i = 0; i < d;
* i++) { for (let j = 0; j < d; j++) { // loop over
* index = 4 * ((y * d + j) * width * d + (x * d +
* i)); pixels[index] = r; pixels[index+1] = g;
* pixels[index+2] = b; pixels[index+3] = a; } }
*
* While the above method is complex, it is flexible
* enough to work with any pixelDensity. Note that
* set() will automatically take care of setting all
* the appropriate values in pixels[] for a given (x,
* y) at any pixelDensity, but the performance may
* not be as fast when lots of modifications are made
* to the pixel array.
*
*
* Before accessing this array, the data must loaded
* with the loadPixels() function. After the array
* data has been modified, the updatePixels()
* function must be run to update the changes.
*
*
* Note that this is not a standard javascript array.
* This means that standard javascript functions such
* as slice() or arrayCopy() do not work.
*/
pixels: number[];
}
}
types/p5/src/io/files.d.ts
Vendored
+590 -725
View File
File diff suppressed because it is too large Load Diff
types/p5/src/io/p5.Table.d.ts
Vendored
+232 -320
View File
@@ -1,348 +1,260 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Table {
/**
* Table objects store data with multiple rows and
* columns, much like in a traditional spreadsheet.
* Tables can be generated from scratch, dynamically,
* or using data from an existing file.
*
* @param [rows] An array of p5.TableRow objects
*/
constructor(
rows?: TableRow[]
);
declare module '../../index' {
class Table {
/**
* Table objects store data with multiple rows and
* columns, much like in a traditional spreadsheet.
* Tables can be generated from scratch, dynamically,
* or using data from an existing file.
*
* @param [rows] An array of p5.TableRow objects
*/
constructor(rows?: TableRow[]);
/**
* Use addRow() to add a new row of data to a
* p5.Table object. By default, an empty row is
* created. Typically, you would store a reference to
* the new row in a TableRow object (see newRow in
* the example above), and then set individual values
* using set(). If a p5.TableRow object is included
* as a parameter, then that row is duplicated and
* added to the table.
* @param [row] row to be added to the table
* @return the row that was added
*/
addRow(
row?: TableRow
): TableRow;
/**
* Use addRow() to add a new row of data to a
* p5.Table object. By default, an empty row is
* created. Typically, you would store a reference to
* the new row in a TableRow object (see newRow in
* the example above), and then set individual values
* using set(). If a p5.TableRow object is included
* as a parameter, then that row is duplicated and
* added to the table.
* @param [row] row to be added to the table
* @return the row that was added
*/
addRow(row?: TableRow): TableRow;
/**
* Removes a row from the table object.
* @param id ID number of the row to remove
*/
removeRow(
id: number
): void;
/**
* Removes a row from the table object.
* @param id ID number of the row to remove
*/
removeRow(id: number): void;
/**
* Returns a reference to the specified p5.TableRow.
* The reference can then be used to get and set
* values of the selected row.
* @param rowID ID number of the row to get
* @return p5.TableRow object
*/
getRow(
rowID: number
): TableRow;
/**
* Returns a reference to the specified p5.TableRow.
* The reference can then be used to get and set
* values of the selected row.
* @param rowID ID number of the row to get
* @return p5.TableRow object
*/
getRow(rowID: number): TableRow;
/**
* Gets all rows from the table. Returns an array of
* p5.TableRows.
* @return Array of p5.TableRows
*/
getRows(): TableRow[];
/**
* Gets all rows from the table. Returns an array of
* p5.TableRows.
* @return Array of p5.TableRows
*/
getRows(): TableRow[];
/**
* Finds the first row in the Table that contains the
* value provided, and returns a reference to that
* row. Even if multiple rows are possible matches,
* only the first matching row is returned. The
* column to search may be specified by either its ID
* or title.
* @param value The value to match
* @param column ID number or title of the column to
* search
*/
findRow(
value: string,
column:
| number
| string
): TableRow;
/**
* Finds the first row in the Table that contains the
* value provided, and returns a reference to that
* row. Even if multiple rows are possible matches,
* only the first matching row is returned. The
* column to search may be specified by either its ID
* or title.
* @param value The value to match
* @param column ID number or title of the column to
* search
*/
findRow(value: string, column: number | string): TableRow;
/**
* Finds the rows in the Table that contain the value
* provided, and returns references to those rows.
* Returns an Array, so for must be used to iterate
* through all the rows, as shown in the example
* above. The column to search may be specified by
* either its ID or title.
* @param value The value to match
* @param column ID number or title of the column to
* search
* @return An Array of TableRow objects
*/
findRows(
value: string,
column:
| number
| string
): TableRow[];
/**
* Finds the rows in the Table that contain the value
* provided, and returns references to those rows.
* Returns an Array, so for must be used to iterate
* through all the rows, as shown in the example
* above. The column to search may be specified by
* either its ID or title.
* @param value The value to match
* @param column ID number or title of the column to
* search
* @return An Array of TableRow objects
*/
findRows(value: string, column: number | string): TableRow[];
/**
* Finds the first row in the Table that matches the
* regular expression provided, and returns a
* reference to that row. Even if multiple rows are
* possible matches, only the first matching row is
* returned. The column to search may be specified by
* either its ID or title.
* @param regexp The regular expression to match
* @param column The column ID (number) or title
* (string)
* @return TableRow object
*/
matchRow(
regexp:
| string
| RegExp,
column:
| string
| number
): TableRow;
/**
* Finds the first row in the Table that matches the
* regular expression provided, and returns a
* reference to that row. Even if multiple rows are
* possible matches, only the first matching row is
* returned. The column to search may be specified by
* either its ID or title.
* @param regexp The regular expression to match
* @param column The column ID (number) or title
* (string)
* @return TableRow object
*/
matchRow(regexp: string | RegExp, column: string | number): TableRow;
/**
* Finds the rows in the Table that match the regular
* expression provided, and returns references to
* those rows. Returns an array, so for must be used
* to iterate through all the rows, as shown in the
* example. The column to search may be specified by
* either its ID or title.
* @param regexp The regular expression to match
* @param [column] The column ID (number) or title
* (string)
* @return An Array of TableRow objects
*/
matchRows(
regexp: string,
column?:
| string
| number
): TableRow[];
/**
* Finds the rows in the Table that match the regular
* expression provided, and returns references to
* those rows. Returns an array, so for must be used
* to iterate through all the rows, as shown in the
* example. The column to search may be specified by
* either its ID or title.
* @param regexp The regular expression to match
* @param [column] The column ID (number) or title
* (string)
* @return An Array of TableRow objects
*/
matchRows(regexp: string, column?: string | number): TableRow[];
/**
* Retrieves all values in the specified column, and
* returns them as an array. The column may be
* specified by either its ID or title.
* @param column String or Number of the column to
* return
* @return Array of column values
*/
getColumn(
column:
| string
| number
): any[];
/**
* Retrieves all values in the specified column, and
* returns them as an array. The column may be
* specified by either its ID or title.
* @param column String or Number of the column to
* return
* @return Array of column values
*/
getColumn(column: string | number): any[];
/**
* Removes all rows from a Table. While all rows are
* removed, columns and column titles are maintained.
*/
clearRows(): void;
/**
* Removes all rows from a Table. While all rows are
* removed, columns and column titles are maintained.
*/
clearRows(): void;
/**
* Use addColumn() to add a new column to a Table
* object. Typically, you will want to specify a
* title, so the column may be easily referenced
* later by name. (If no title is specified, the new
* column's title will be null.)
* @param [title] title of the given column
*/
addColumn(
title?: string
): void;
/**
* Use addColumn() to add a new column to a Table
* object. Typically, you will want to specify a
* title, so the column may be easily referenced
* later by name. (If no title is specified, the new
* column's title will be null.)
* @param [title] title of the given column
*/
addColumn(title?: string): void;
/**
* Returns the total number of columns in a Table.
* @return Number of columns in this table
*/
getColumnCount(): number;
/**
* Returns the total number of columns in a Table.
* @return Number of columns in this table
*/
getColumnCount(): number;
/**
* Returns the total number of rows in a Table.
* @return Number of rows in this table
*/
getRowCount(): number;
/**
* Returns the total number of rows in a Table.
* @return Number of rows in this table
*/
getRowCount(): number;
/**
* Removes any of the specified characters (or
* "tokens"). If no column is specified, then the
* values in all columns and rows are processed. A
* specific column may be referenced by either its ID
* or title.
* @param chars String listing characters to be
* removed
* @param [column] Column ID (number) or name
* (string)
*/
removeTokens(
chars: string,
column?:
| string
| number
): void;
/**
* Removes any of the specified characters (or
* "tokens"). If no column is specified, then the
* values in all columns and rows are processed. A
* specific column may be referenced by either its ID
* or title.
* @param chars String listing characters to be
* removed
* @param [column] Column ID (number) or name
* (string)
*/
removeTokens(chars: string, column?: string | number): void;
/**
* Trims leading and trailing whitespace, such as
* spaces and tabs, from String table values. If no
* column is specified, then the values in all
* columns and rows are trimmed. A specific column
* may be referenced by either its ID or title.
* @param [column] Column ID (number) or name
* (string)
*/
trim(
column?:
| string
| number
): void;
/**
* Trims leading and trailing whitespace, such as
* spaces and tabs, from String table values. If no
* column is specified, then the values in all
* columns and rows are trimmed. A specific column
* may be referenced by either its ID or title.
* @param [column] Column ID (number) or name
* (string)
*/
trim(column?: string | number): void;
/**
* Use removeColumn() to remove an existing column
* from a Table object. The column to be removed may
* be identified by either its title (a String) or
* its index value (an int). removeColumn(0) would
* remove the first column, removeColumn(1) would
* remove the second column, and so on.
* @param column columnName (string) or ID (number)
*/
removeColumn(
column:
| string
| number
): void;
/**
* Use removeColumn() to remove an existing column
* from a Table object. The column to be removed may
* be identified by either its title (a String) or
* its index value (an int). removeColumn(0) would
* remove the first column, removeColumn(1) would
* remove the second column, and so on.
* @param column columnName (string) or ID (number)
*/
removeColumn(column: string | number): void;
/**
* Stores a value in the Table's specified row and
* column. The row is specified by its ID, while the
* column may be specified by either its ID or title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
set(
row: number,
column:
| string
| number,
value:
| string
| number
): void;
/**
* Stores a value in the Table's specified row and
* column. The row is specified by its ID, while the
* column may be specified by either its ID or title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
set(row: number, column: string | number, value: string | number): void;
/**
* Stores a Float value in the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
setNum(
row: number,
column:
| string
| number,
value: number
): void;
/**
* Stores a Float value in the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
setNum(row: number, column: string | number, value: number): void;
/**
* Stores a String value in the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
setString(
row: number,
column:
| string
| number,
value: string
): void;
/**
* Stores a String value in the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column column ID (Number) or title (String)
* @param value value to assign
*/
setString(row: number, column: string | number, value: string): void;
/**
* Retrieves a value from the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
get(
row: number,
column:
| string
| number
):
| string
| number;
/**
* Retrieves a value from the Table's specified row
* and column. The row is specified by its ID, while
* the column may be specified by either its ID or
* title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
get(row: number, column: string | number): string | number;
/**
* Retrieves a Float value from the Table's specified
* row and column. The row is specified by its ID,
* while the column may be specified by either its ID
* or title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
getNum(
row: number,
column:
| string
| number
): number;
/**
* Retrieves a Float value from the Table's specified
* row and column. The row is specified by its ID,
* while the column may be specified by either its ID
* or title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
getNum(row: number, column: string | number): number;
/**
* Retrieves a String value from the Table's
* specified row and column. The row is specified by
* its ID, while the column may be specified by
* either its ID or title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
getString(
row: number,
column:
| string
| number
): string;
/**
* Retrieves a String value from the Table's
* specified row and column. The row is specified by
* its ID, while the column may be specified by
* either its ID or title.
* @param row row ID
* @param column columnName (string) or ID (number)
*/
getString(row: number, column: string | number): string;
/**
* Retrieves all table data and returns as an object.
* If a column name is passed in, each row object
* will be stored with that attribute as its title.
* @param [headerColumn] Name of the column which
* should be used to title each row object (optional)
*/
getObject(
headerColumn?: string
): object;
/**
* Retrieves all table data and returns as an object.
* If a column name is passed in, each row object
* will be stored with that attribute as its title.
* @param [headerColumn] Name of the column which
* should be used to title each row object (optional)
*/
getObject(headerColumn?: string): object;
/**
* Retrieves all table data and returns it as a
* multidimensional array.
*/
getArray(): any[];
columns: string[];
rows: TableRow[];
}
/**
* Retrieves all table data and returns it as a
* multidimensional array.
*/
getArray(): any[];
columns: string[];
rows: TableRow[];
}
}
types/p5/src/io/p5.TableRow.d.ts
Vendored
+63 -103
View File
@@ -1,113 +1,73 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class TableRow {
/**
* A TableRow object represents a single row of data
* values, stored in columns, from a table. A Table
* Row contains both an ordered array, and an
* unordered JSON object.
*
* @param [str] optional: populate the row with a
* string of values, separated by the separator
* @param [separator] comma separated values (csv) by
* default
*/
constructor(
str?: string,
separator?: string
);
declare module '../../index' {
class TableRow {
/**
* A TableRow object represents a single row of data
* values, stored in columns, from a table. A Table
* Row contains both an ordered array, and an
* unordered JSON object.
*
* @param [str] optional: populate the row with a
* string of values, separated by the separator
* @param [separator] comma separated values (csv) by
* default
*/
constructor(str?: string, separator?: string);
/**
* Stores a value in the TableRow's specified column.
* The column may be specified by either its ID or
* title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored
*/
set(
column:
| string
| number,
value:
| string
| number
): void;
/**
* Stores a value in the TableRow's specified column.
* The column may be specified by either its ID or
* title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored
*/
set(column: string | number, value: string | number): void;
/**
* Stores a Float value in the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored as a Float
*/
setNum(
column:
| string
| number,
value:
| number
| string
): void;
/**
* Stores a Float value in the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored as a Float
*/
setNum(column: string | number, value: number | string): void;
/**
* Stores a String value in the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored as a String
*/
setString(
column:
| string
| number,
value:
| string
| number
| boolean
| object
): void;
/**
* Stores a String value in the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column Column ID (Number) or Title (String)
* @param value The value to be stored as a String
*/
setString(column: string | number, value: string | number | boolean | object): void;
/**
* Retrieves a value from the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column columnName (string) or ID (number)
*/
get(
column:
| string
| number
):
| string
| number;
/**
* Retrieves a value from the TableRow's specified
* column. The column may be specified by either its
* ID or title.
* @param column columnName (string) or ID (number)
*/
get(column: string | number): string | number;
/**
* Retrieves a Float value from the TableRow's
* specified column. The column may be specified by
* either its ID or title.
* @param column columnName (string) or ID (number)
* @return Float Floating point number
*/
getNum(
column:
| string
| number
): number;
/**
* Retrieves a Float value from the TableRow's
* specified column. The column may be specified by
* either its ID or title.
* @param column columnName (string) or ID (number)
* @return Float Floating point number
*/
getNum(column: string | number): number;
/**
* Retrieves an String value from the TableRow's
* specified column. The column may be specified by
* either its ID or title.
* @param column columnName (string) or ID (number)
* @return String
*/
getString(
column:
| string
| number
): string;
}
/**
* Retrieves an String value from the TableRow's
* specified column. The column may be specified by
* either its ID or title.
* @param column columnName (string) or ID (number)
* @return String
*/
getString(column: string | number): string;
}
}
types/p5/src/io/p5.XML.d.ts
Vendored
+147 -179
View File
@@ -1,201 +1,169 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class XML {
/**
* XML is a representation of an XML object, able to
* parse XML code. Use loadXML() to load external XML
* files and create XML objects.
*
*/
constructor();
declare module '../../index' {
class XML {
/**
* XML is a representation of an XML object, able to
* parse XML code. Use loadXML() to load external XML
* files and create XML objects.
*
*/
constructor();
/**
* Gets a copy of the element's parent. Returns the
* parent as another p5.XML object.
* @return element parent
*/
getParent(): XML;
/**
* Gets a copy of the element's parent. Returns the
* parent as another p5.XML object.
* @return element parent
*/
getParent(): XML;
/**
* Gets the element's full name, which is returned as
* a String.
* @return the name of the node
*/
getName(): string;
/**
* Gets the element's full name, which is returned as
* a String.
* @return the name of the node
*/
getName(): string;
/**
* Sets the element's name, which is specified as a
* String.
* @param the new name of the node
*/
setName(
the: string
): void;
/**
* Sets the element's name, which is specified as a
* String.
* @param the new name of the node
*/
setName(the: string): void;
/**
* Checks whether or not the element has any
* children, and returns the result as a boolean.
*/
hasChildren(): boolean;
/**
* Checks whether or not the element has any
* children, and returns the result as a boolean.
*/
hasChildren(): boolean;
/**
* Get the names of all of the element's children,
* and returns the names as an array of Strings. This
* is the same as looping through and calling
* getName() on each child element individually.
* @return names of the children of the element
*/
listChildren(): string[];
/**
* Get the names of all of the element's children,
* and returns the names as an array of Strings. This
* is the same as looping through and calling
* getName() on each child element individually.
* @return names of the children of the element
*/
listChildren(): string[];
/**
* Returns all of the element's children as an array
* of p5.XML objects. When the name parameter is
* specified, then it will return all children that
* match that name.
* @param [name] element name
* @return children of the element
*/
getChildren(
name?: string
): XML[];
/**
* Returns all of the element's children as an array
* of p5.XML objects. When the name parameter is
* specified, then it will return all children that
* match that name.
* @param [name] element name
* @return children of the element
*/
getChildren(name?: string): XML[];
/**
* Returns the first of the element's children that
* matches the name parameter or the child of the
* given index.It returns undefined if no matching
* child is found.
* @param name element name or index
*/
getChild(
name:
| string
| number
): XML;
/**
* Returns the first of the element's children that
* matches the name parameter or the child of the
* given index.It returns undefined if no matching
* child is found.
* @param name element name or index
*/
getChild(name: string | number): XML;
/**
* Appends a new child to the element. The child can
* be specified with either a String, which will be
* used as the new tag's name, or as a reference to
* an existing p5.XML object. A reference to the
* newly created child is returned as an p5.XML
* object.
* @param node a p5.XML Object which will be the
* child to be added
*/
addChild(
node: XML
): void;
/**
* Appends a new child to the element. The child can
* be specified with either a String, which will be
* used as the new tag's name, or as a reference to
* an existing p5.XML object. A reference to the
* newly created child is returned as an p5.XML
* object.
* @param node a p5.XML Object which will be the
* child to be added
*/
addChild(node: XML): void;
/**
* Removes the element specified by name or index.
* @param name element name or index
*/
removeChild(
name:
| string
| number
): void;
/**
* Removes the element specified by name or index.
* @param name element name or index
*/
removeChild(name: string | number): void;
/**
* Counts the specified element's number of
* attributes, returned as an Number.
*/
getAttributeCount(): number;
/**
* Counts the specified element's number of
* attributes, returned as an Number.
*/
getAttributeCount(): number;
/**
* Gets all of the specified element's attributes,
* and returns them as an array of Strings.
* @return an array of strings containing the names
* of attributes
*/
listAttributes(): string[];
/**
* Gets all of the specified element's attributes,
* and returns them as an array of Strings.
* @return an array of strings containing the names
* of attributes
*/
listAttributes(): string[];
/**
* Checks whether or not an element has the specified
* attribute.
* @param the attribute to be checked
* @return true if attribute found else false
*/
hasAttribute(
the: string
): boolean;
/**
* Checks whether or not an element has the specified
* attribute.
* @param the attribute to be checked
* @return true if attribute found else false
*/
hasAttribute(the: string): boolean;
/**
* Returns an attribute value of the element as an
* Number. If the defaultValue parameter is specified
* and the attribute doesn't exist, then defaultValue
* is returned. If no defaultValue is specified and
* the attribute doesn't exist, the value 0 is
* returned.
* @param name the non-null full name of the
* attribute
* @param [defaultValue] the default value of the
* attribute
*/
getNum(
name: string,
defaultValue?: number
): number;
/**
* Returns an attribute value of the element as an
* Number. If the defaultValue parameter is specified
* and the attribute doesn't exist, then defaultValue
* is returned. If no defaultValue is specified and
* the attribute doesn't exist, the value 0 is
* returned.
* @param name the non-null full name of the
* attribute
* @param [defaultValue] the default value of the
* attribute
*/
getNum(name: string, defaultValue?: number): number;
/**
* Returns an attribute value of the element as an
* String. If the defaultValue parameter is specified
* and the attribute doesn't exist, then defaultValue
* is returned. If no defaultValue is specified and
* the attribute doesn't exist, null is returned.
* @param name the non-null full name of the
* attribute
* @param [defaultValue] the default value of the
* attribute
*/
getString(
name: string,
defaultValue?: number
): string;
/**
* Returns an attribute value of the element as an
* String. If the defaultValue parameter is specified
* and the attribute doesn't exist, then defaultValue
* is returned. If no defaultValue is specified and
* the attribute doesn't exist, null is returned.
* @param name the non-null full name of the
* attribute
* @param [defaultValue] the default value of the
* attribute
*/
getString(name: string, defaultValue?: number): string;
/**
* Sets the content of an element's attribute. The
* first parameter specifies the attribute name,
* while the second specifies the new content.
* @param name the full name of the attribute
* @param value the value of the attribute
*/
setAttribute(
name: string,
value:
| number
| string
| boolean
): void;
/**
* Sets the content of an element's attribute. The
* first parameter specifies the attribute name,
* while the second specifies the new content.
* @param name the full name of the attribute
* @param value the value of the attribute
*/
setAttribute(name: string, value: number | string | boolean): void;
/**
* Returns the content of an element. If there is no
* such content, defaultValue is returned if
* specified, otherwise null is returned.
* @param [defaultValue] value returned if no content
* is found
*/
getContent(
defaultValue?: string
): string;
/**
* Returns the content of an element. If there is no
* such content, defaultValue is returned if
* specified, otherwise null is returned.
* @param [defaultValue] value returned if no content
* is found
*/
getContent(defaultValue?: string): string;
/**
* Sets the element's content.
* @param text the new content
*/
setContent(
text: string
): void;
/**
* Sets the element's content.
* @param text the new content
*/
setContent(text: string): void;
/**
* Serializes the element into a string. This
* function is useful for preparing the content to be
* sent over a http request or saved to file.
* @return Serialized string of the element
*/
serialize(): string;
}
/**
* Serializes the element into a string. This
* function is useful for preparing the content to be
* sent over a http request or saved to file.
* @return Serialized string of the element
*/
serialize(): string;
}
}
types/p5/src/math/calculation.d.ts
Vendored
+224 -278
View File
@@ -1,301 +1,247 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Calculates the absolute value (magnitude) of a
* number. Maps to Math.abs(). The absolute value of
* a number is always positive.
* @param n number to compute
* @return absolute value of given number
*/
abs(
n: number
): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Calculates the absolute value (magnitude) of a
* number. Maps to Math.abs(). The absolute value of
* a number is always positive.
* @param n number to compute
* @return absolute value of given number
*/
abs(n: number): number;
/**
* Calculates the closest int value that is greater
* than or equal to the value of the parameter. Maps
* to Math.ceil(). For example, ceil(9.03) returns
* the value 10.
* @param n number to round up
* @return rounded up number
*/
ceil(
n: number
): number;
/**
* Calculates the closest int value that is greater
* than or equal to the value of the parameter. Maps
* to Math.ceil(). For example, ceil(9.03) returns
* the value 10.
* @param n number to round up
* @return rounded up number
*/
ceil(n: number): number;
/**
* Constrains a value between a minimum and maximum
* value.
* @param n number to constrain
* @param low minimum limit
* @param high maximum limit
* @return constrained number
*/
constrain(
n: number,
low: number,
high: number
): number;
/**
* Constrains a value between a minimum and maximum
* value.
* @param n number to constrain
* @param low minimum limit
* @param high maximum limit
* @return constrained number
*/
constrain(n: number, low: number, high: number): number;
/**
* Calculates the distance between two points.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @return distance between the two points
*/
dist(
x1: number,
y1: number,
x2: number,
y2: number
): number;
/**
* Calculates the distance between two points, in
* either two or three dimensions.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @return distance between the two points
*/
dist(x1: number, y1: number, x2: number, y2: number): number;
/**
* Calculates the distance between two points.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param z1 z-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @param z2 z-coordinate of the second point
* @return distance between the two points
*/
dist(
x1: number,
y1: number,
z1: number,
x2: number,
y2: number,
z2: number
): number;
/**
* Calculates the distance between two points, in
* either two or three dimensions.
* @param x1 x-coordinate of the first point
* @param y1 y-coordinate of the first point
* @param z1 z-coordinate of the first point
* @param x2 x-coordinate of the second point
* @param y2 y-coordinate of the second point
* @param z2 z-coordinate of the second point
* @return distance between the two points
*/
dist(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number): number;
/**
* Returns Euler's number e (2.71828...) raised to
* the power of the n parameter. Maps to Math.exp().
* @param n exponent to raise
* @return e^n
*/
exp(
n: number
): number;
/**
* Returns Euler's number e (2.71828...) raised to
* the power of the n parameter. Maps to Math.exp().
* @param n exponent to raise
* @return e^n
*/
exp(n: number): number;
/**
* Calculates the closest int value that is less than
* or equal to the value of the parameter. Maps to
* Math.floor().
* @param n number to round down
* @return rounded down number
*/
floor(
n: number
): number;
/**
* Calculates the closest int value that is less than
* or equal to the value of the parameter. Maps to
* Math.floor().
* @param n number to round down
* @return rounded down number
*/
floor(n: number): number;
/**
* Calculates a number between two numbers at a
* specific increment. The amt parameter is the
* amount to interpolate between the two values where
* 0.0 equal to the first point, 0.1 is very near the
* first point, 0.5 is half-way in between, and 1.0
* is equal to the second point. If the value of amt
* is more than 1.0 or less than 0.0, the number will
* be calculated accordingly in the ratio of the two
* given numbers. The lerp function is convenient for
* creating motion along a straight path and for
* drawing dotted lines.
* @param start first value
* @param stop second value
* @param amt number
* @return lerped value
*/
lerp(
start: number,
stop: number,
amt: number
): number;
/**
* Calculates a number between two numbers at a
* specific increment. The amt parameter is the
* amount to interpolate between the two values where
* 0.0 equal to the first point, 0.1 is very near the
* first point, 0.5 is half-way in between, and 1.0
* is equal to the second point. If the value of amt
* is more than 1.0 or less than 0.0, the number will
* be calculated accordingly in the ratio of the two
* given numbers. The lerp function is convenient for
* creating motion along a straight path and for
* drawing dotted lines.
* @param start first value
* @param stop second value
* @param amt number
* @return lerped value
*/
lerp(start: number, stop: number, amt: number): number;
/**
* Calculates the natural logarithm (the base-e
* logarithm) of a number. This function expects the
* n parameter to be a value greater than 0.0. Maps
* to Math.log().
* @param n number greater than 0
* @return natural logarithm of n
*/
log(
n: number
): number;
/**
* Calculates the natural logarithm (the base-e
* logarithm) of a number. This function expects the
* n parameter to be a value greater than 0.0. Maps
* to Math.log().
* @param n number greater than 0
* @return natural logarithm of n
*/
log(n: number): number;
/**
* Calculates the magnitude (or length) of a vector.
* A vector is a direction in space commonly used in
* computer graphics and linear algebra. Because it
* has no "start" position, the magnitude of a vector
* can be thought of as the distance from the
* coordinate 0,0 to its x,y value. Therefore, mag()
* is a shortcut for writing dist(0, 0, x, y).
* @param a first value
* @param b second value
* @return magnitude of vector from (0,0) to (a,b)
*/
mag(
a: number,
b: number
): number;
/**
* Calculates the magnitude (or length) of a vector.
* A vector is a direction in space commonly used in
* computer graphics and linear algebra. Because it
* has no "start" position, the magnitude of a vector
* can be thought of as the distance from the
* coordinate 0,0 to its x,y value. Therefore, mag()
* is a shortcut for writing dist(0, 0, x, y).
* @param a first value
* @param b second value
* @return magnitude of vector from (0,0) to (a,b)
*/
mag(a: number, b: number): number;
/**
* Re-maps a number from one range to another. In
* the first example above, the number 25 is
* converted from a value in the range of 0 to 100
* into a value that ranges from the left edge of the
* window (0) to the right edge (width).
* @param value the incoming value to be converted
* @param start1 lower bound of the value's current
* range
* @param stop1 upper bound of the value's current
* range
* @param start2 lower bound of the value's target
* range
* @param stop2 upper bound of the value's target
* range
* @param [withinBounds] constrain the value to the
* newly mapped range
* @return remapped number
*/
map(
value: number,
start1: number,
stop1: number,
start2: number,
stop2: number,
withinBounds?: boolean
): number;
/**
* Re-maps a number from one range to another. In
* the first example above, the number 25 is
* converted from a value in the range of 0 to 100
* into a value that ranges from the left edge of the
* window (0) to the right edge (width).
* @param value the incoming value to be converted
* @param start1 lower bound of the value's current
* range
* @param stop1 upper bound of the value's current
* range
* @param start2 lower bound of the value's target
* range
* @param stop2 upper bound of the value's target
* range
* @param [withinBounds] constrain the value to the
* newly mapped range
* @return remapped number
*/
map(
value: number,
start1: number,
stop1: number,
start2: number,
stop2: number,
withinBounds?: boolean
): number;
/**
* Determines the largest value in a sequence of
* numbers, and then returns that value. max()
* accepts any number of Number parameters, or an
* Array of any length.
* @param n0 Number to compare
* @param n1 Number to compare
* @return maximum Number
*/
max(
n0: number,
n1: number
): number;
/**
* Determines the largest value in a sequence of
* numbers, and then returns that value. max()
* accepts any number of Number parameters, or an
* Array of any length.
* @param n0 Number to compare
* @param n1 Number to compare
* @return maximum Number
*/
max(n0: number, n1: number): number;
/**
* Determines the largest value in a sequence of
* numbers, and then returns that value. max()
* accepts any number of Number parameters, or an
* Array of any length.
* @param nums Numbers to compare
*/
max(
nums: number[]
): number;
/**
* Determines the largest value in a sequence of
* numbers, and then returns that value. max()
* accepts any number of Number parameters, or an
* Array of any length.
* @param nums Numbers to compare
*/
max(nums: number[]): number;
/**
* Determines the smallest value in a sequence of
* numbers, and then returns that value. min()
* accepts any number of Number parameters, or an
* Array of any length.
* @param n0 Number to compare
* @param n1 Number to compare
* @return minimum Number
*/
min(
n0: number,
n1: number
): number;
/**
* Determines the smallest value in a sequence of
* numbers, and then returns that value. min()
* accepts any number of Number parameters, or an
* Array of any length.
* @param n0 Number to compare
* @param n1 Number to compare
* @return minimum Number
*/
min(n0: number, n1: number): number;
/**
* Determines the smallest value in a sequence of
* numbers, and then returns that value. min()
* accepts any number of Number parameters, or an
* Array of any length.
* @param nums Numbers to compare
*/
min(
nums: number[]
): number;
/**
* Determines the smallest value in a sequence of
* numbers, and then returns that value. min()
* accepts any number of Number parameters, or an
* Array of any length.
* @param nums Numbers to compare
*/
min(nums: number[]): number;
/**
* Normalizes a number from another range into a
* value between 0 and 1. Identical to map(value,
* low, high, 0, 1). Numbers outside of the range are
* not clamped to 0 and 1, because out-of-range
* values are often intentional and useful. (See the
* second example above.)
* @param value incoming value to be normalized
* @param start lower bound of the value's current
* range
* @param stop upper bound of the value's current
* range
* @return normalized number
*/
norm(
value: number,
start: number,
stop: number
): number;
/**
* Normalizes a number from another range into a
* value between 0 and 1. Identical to map(value,
* low, high, 0, 1). Numbers outside of the range are
* not clamped to 0 and 1, because out-of-range
* values are often intentional and useful. (See the
* example above.)
* @param value incoming value to be normalized
* @param start lower bound of the value's current
* range
* @param stop upper bound of the value's current
* range
* @return normalized number
*/
norm(value: number, start: number, stop: number): number;
/**
* Facilitates exponential expressions. The pow()
* function is an efficient way of multiplying
* numbers by themselves (or their reciprocals) in
* large quantities. For example, pow(3, 5) is
* equivalent to the expression 33333 and pow(3, -5)
* is equivalent to 1 / 33333. Maps to Math.pow().
* @param n base of the exponential expression
* @param e power by which to raise the base
* @return n^e
*/
pow(
n: number,
e: number
): number;
/**
* Facilitates exponential expressions. The pow()
* function is an efficient way of multiplying
* numbers by themselves (or their reciprocals) in
* large quantities. For example, pow(3, 5) is
* equivalent to the expression 33333 and pow(3, -5)
* is equivalent to 1 / 33333. Maps to Math.pow().
* @param n base of the exponential expression
* @param e power by which to raise the base
* @return n^e
*/
pow(n: number, e: number): number;
/**
* Calculates the integer closest to the n parameter.
* For example, round(133.8) returns the value 134.
* Maps to Math.round().
* @param n number to round
* @return rounded number
*/
round(
n: number
): number;
/**
* Calculates the integer closest to the n parameter.
* For example, round(133.8) returns the value 134.
* Maps to Math.round().
* @param n number to round
* @return rounded number
*/
round(n: number): number;
/**
* Squares a number (multiplies a number by itself).
* The result is always a positive number, as
* multiplying two negative numbers always yields a
* positive result. For example, -1 * -1 = 1.
* @param n number to square
* @return squared number
*/
sq(
n: number
): number;
/**
* Squares a number (multiplies a number by itself).
* The result is always a positive number, as
* multiplying two negative numbers always yields a
* positive result. For example, -1 * -1 = 1.
* @param n number to square
* @return squared number
*/
sq(n: number): number;
/**
* Calculates the square root of a number. The square
* root of a number is always positive, even though
* there may be a valid negative root. The square
* root s of number a is such that s*s = a. It is the
* opposite of squaring. Maps to Math.sqrt().
* @param n non-negative number to square root
* @return square root of number
*/
sqrt(
n: number
): number;
}
/**
* Calculates the square root of a number. The square
* root of a number is always positive, even though
* there may be a valid negative root. The square
* root s of number a is such that s*s = a. It is the
* opposite of squaring. Maps to Math.sqrt().
* @param n non-negative number to square root
* @return square root of number
*/
sqrt(n: number): number;
}
}
types/p5/src/math/math.d.ts
Vendored
+15 -19
View File
@@ -1,23 +1,19 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Creates a new p5.Vector (the datatype for storing
* vectors). This provides a two or three dimensional
* vector, specifically a Euclidean (also known as
* geometric) vector. A vector is an entity that has
* both magnitude and direction.
* @param [x] x component of the vector
* @param [y] y component of the vector
* @param [z] z component of the vector
*/
createVector(
x?: number,
y?: number,
z?: number
): Vector;
}
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Creates a new p5.Vector (the datatype for storing
* vectors). This provides a two or three dimensional
* vector, specifically a Euclidean (also known as
* geometric) vector. A vector is an entity that has
* both magnitude and direction.
* @param [x] x component of the vector
* @param [y] y component of the vector
* @param [z] z component of the vector
*/
createVector(x?: number, y?: number, z?: number): Vector;
}
}
types/p5/src/math/noise.d.ts
Vendored
+90 -99
View File
@@ -1,105 +1,96 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Returns the Perlin noise value at specified
* coordinates. Perlin noise is a random sequence
* generator producing a more natural ordered,
* harmonic succession of numbers compared to the
* standard random() function. It was invented by Ken
* Perlin in the 1980s and been used since in
* graphical applications to produce procedural
* textures, natural motion, shapes, terrains etc.
* The main difference to the random() function is
* that Perlin noise is defined in an infinite
* n-dimensional space where each pair of coordinates
* corresponds to a fixed semi-random value (fixed
* only for the lifespan of the program; see the
* noiseSeed() function). p5.js can compute 1D, 2D
* and 3D noise, depending on the number of
* coordinates given. The resulting value will always
* be between 0.0 and 1.0. The noise value can be
* animated by moving through the noise space as
* demonstrated in the example above. The 2nd and 3rd
* dimension can also be interpreted as time.
*
* The actual noise is structured similar to an audio
* signal, in respect to the function's use of
* frequencies. Similar to the concept of harmonics
* in physics, perlin noise is computed over several
* octaves which are added together for the final
* result.
*
* Another way to adjust the character of the
* resulting sequence is the scale of the input
* coordinates. As the function works within an
* infinite space the value of the coordinates
* doesn't matter as such, only the distance between
* successive coordinates does (eg. when using
* noise() within a loop). As a general rule the
* smaller the difference between coordinates, the
* smoother the resulting noise sequence will be.
* Steps of 0.005-0.03 work best for most
* applications, but this will differ depending on
* use.
* @param x x-coordinate in noise space
* @param [y] y-coordinate in noise space
* @param [z] z-coordinate in noise space
* @return Perlin noise value (between 0 and 1) at
* specified coordinates
*/
noise(
x: number,
y?: number,
z?: number
): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Returns the Perlin noise value at specified
* coordinates. Perlin noise is a random sequence
* generator producing a more natural ordered,
* harmonic succession of numbers compared to the
* standard random() function. It was invented by Ken
* Perlin in the 1980s and been used since in
* graphical applications to produce procedural
* textures, natural motion, shapes, terrains etc.
* The main difference to the random() function is
* that Perlin noise is defined in an infinite
* n-dimensional space where each pair of coordinates
* corresponds to a fixed semi-random value (fixed
* only for the lifespan of the program; see the
* noiseSeed() function). p5.js can compute 1D, 2D
* and 3D noise, depending on the number of
* coordinates given. The resulting value will always
* be between 0.0 and 1.0. The noise value can be
* animated by moving through the noise space as
* demonstrated in the example above. The 2nd and 3rd
* dimension can also be interpreted as time.
*
* The actual noise is structured similar to an audio
* signal, in respect to the function's use of
* frequencies. Similar to the concept of harmonics
* in physics, perlin noise is computed over several
* octaves which are added together for the final
* result.
*
* Another way to adjust the character of the
* resulting sequence is the scale of the input
* coordinates. As the function works within an
* infinite space the value of the coordinates
* doesn't matter as such, only the distance between
* successive coordinates does (eg. when using
* noise() within a loop). As a general rule the
* smaller the difference between coordinates, the
* smoother the resulting noise sequence will be.
* Steps of 0.005-0.03 work best for most
* applications, but this will differ depending on
* use.
* @param x x-coordinate in noise space
* @param [y] y-coordinate in noise space
* @param [z] z-coordinate in noise space
* @return Perlin noise value (between 0 and 1) at
* specified coordinates
*/
noise(x: number, y?: number, z?: number): number;
/**
* Adjusts the character and level of detail produced
* by the Perlin noise function. Similar to harmonics
* in physics, noise is computed over several
* octaves. Lower octaves contribute more to the
* output signal and as such define the overall
* intensity of the noise, whereas higher octaves
* create finer grained details in the noise
* sequence. By default, noise is computed over 4
* octaves with each octave contributing exactly half
* than its predecessor, starting at 50% strength for
* the 1st octave. This falloff amount can be changed
* by adding an additional function parameter. Eg. a
* falloff factor of 0.75 means each octave will now
* have 75% impact (25% less) of the previous lower
* octave. Any value between 0.0 and 1.0 is valid,
* however note that values greater than 0.5 might
* result in greater than 1.0 values returned by
* noise().
*
*
* By changing these parameters, the signal created
* by the noise() function can be adapted to fit very
* specific needs and characteristics.
* @param lod number of octaves to be used by the
* noise
* @param falloff falloff factor for each octave
*/
noiseDetail(
lod: number,
falloff: number
): void;
/**
* Adjusts the character and level of detail produced
* by the Perlin noise function. Similar to harmonics
* in physics, noise is computed over several
* octaves. Lower octaves contribute more to the
* output signal and as such define the overall
* intensity of the noise, whereas higher octaves
* create finer grained details in the noise
* sequence. By default, noise is computed over 4
* octaves with each octave contributing exactly half
* than its predecessor, starting at 50% strength for
* the 1st octave. This falloff amount can be changed
* by adding an additional function parameter. Eg. a
* falloff factor of 0.75 means each octave will now
* have 75% impact (25% less) of the previous lower
* octave. Any value between 0.0 and 1.0 is valid,
* however note that values greater than 0.5 might
* result in greater than 1.0 values returned by
* noise().
*
*
* By changing these parameters, the signal created
* by the noise() function can be adapted to fit very
* specific needs and characteristics.
* @param lod number of octaves to be used by the
* noise
* @param falloff falloff factor for each octave
*/
noiseDetail(lod: number, falloff: number): void;
/**
* Sets the seed value for noise(). By default,
* noise() produces different results each time the
* program is run. Set the value parameter to a
* constant to return the same pseudo-random numbers
* each time the software is run.
* @param seed the seed value
*/
noiseSeed(
seed: number
): void;
}
/**
* Sets the seed value for noise(). By default,
* noise() produces different results each time the
* program is run. Set the value parameter to a
* constant to return the same pseudo-random numbers
* each time the software is run.
* @param seed the seed value
*/
noiseSeed(seed: number): void;
}
}
types/p5/src/math/p5.Vector.d.ts
Vendored
+431 -546
View File
File diff suppressed because it is too large Load Diff
types/p5/src/math/random.d.ts
Vendored
+79 -89
View File
@@ -1,96 +1,86 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Sets the seed value for random(). By default,
* random() produces different results each time the
* program is run. Set the seed parameter to a
* constant to return the same pseudo-random numbers
* each time the software is run.
* @param seed the seed value
*/
randomSeed(
seed: number
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Sets the seed value for random(). By default,
* random() produces different results each time the
* program is run. Set the seed parameter to a
* constant to return the same pseudo-random numbers
* each time the software is run.
* @param seed the seed value
*/
randomSeed(seed: number): void;
/**
* Return a random floating-point number. Takes
* either 0, 1 or 2 arguments.
*
* If no argument is given, returns a random number
* from 0 up to (but not including) 1.
*
* If one argument is given and it is a number,
* returns a random number from 0 up to (but not
* including) the number.
*
* If one argument is given and it is an array,
* returns a random element from that array.
*
* If two arguments are given, returns a random
* number from the first argument up to (but not
* including) the second argument.
* @param [min] the lower bound (inclusive)
* @param [max] the upper bound (exclusive)
* @return the random number
*/
random(
min?: number,
max?: number
): number;
/**
* Return a random floating-point number. Takes
* either 0, 1 or 2 arguments.
*
* If no argument is given, returns a random number
* from 0 up to (but not including) 1.
*
* If one argument is given and it is a number,
* returns a random number from 0 up to (but not
* including) the number.
*
* If one argument is given and it is an array,
* returns a random element from that array.
*
* If two arguments are given, returns a random
* number from the first argument up to (but not
* including) the second argument.
* @param [min] the lower bound (inclusive)
* @param [max] the upper bound (exclusive)
* @return the random number
*/
random(min?: number, max?: number): number;
/**
* Return a random floating-point number. Takes
* either 0, 1 or 2 arguments.
*
* If no argument is given, returns a random number
* from 0 up to (but not including) 1.
*
* If one argument is given and it is a number,
* returns a random number from 0 up to (but not
* including) the number.
*
* If one argument is given and it is an array,
* returns a random element from that array.
*
* If two arguments are given, returns a random
* number from the first argument up to (but not
* including) the second argument.
* @param choices the array to choose from
* @return the random element from the array
*/
random(
choices: any[]
): any;
/**
* Return a random floating-point number. Takes
* either 0, 1 or 2 arguments.
*
* If no argument is given, returns a random number
* from 0 up to (but not including) 1.
*
* If one argument is given and it is a number,
* returns a random number from 0 up to (but not
* including) the number.
*
* If one argument is given and it is an array,
* returns a random element from that array.
*
* If two arguments are given, returns a random
* number from the first argument up to (but not
* including) the second argument.
* @param choices the array to choose from
* @return the random element from the array
*/
random(choices: any[]): any;
/**
* Returns a random number fitting a Gaussian, or
* normal, distribution. There is theoretically no
* minimum or maximum value that randomGaussian()
* might return. Rather, there is just a very low
* probability that values far from the mean will be
* returned; and a higher probability that numbers
* near the mean will be returned. Takes either 0, 1
* or 2 arguments.
*
* If no args, returns a mean of 0 and standard
* deviation of 1.
*
* If one arg, that arg is the mean (standard
* deviation is 1).
*
* If two args, first is mean, second is standard
* deviation.
* @param mean the mean
* @param sd the standard deviation
* @return the random number
*/
randomGaussian(
mean: number,
sd: number
): number;
}
/**
* Returns a random number fitting a Gaussian, or
* normal, distribution. There is theoretically no
* minimum or maximum value that randomGaussian()
* might return. Rather, there is just a very low
* probability that values far from the mean will be
* returned; and a higher probability that numbers
* near the mean will be returned. Takes either 0, 1
* or 2 arguments.
*
* If no args, returns a mean of 0 and standard
* deviation of 1.
*
* If one arg, that arg is the mean (standard
* deviation is 1).
*
* If two args, first is mean, second is standard
* deviation.
* @param mean the mean
* @param sd the standard deviation
* @return the random number
*/
randomGaussian(mean: number, sd: number): number;
}
}
types/p5/src/math/trigonometry.d.ts
Vendored
+103 -124
View File
@@ -1,137 +1,116 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* The inverse of cos(), returns the arc cosine of a
* value. This function expects the values in the
* range of -1 to 1 and values are returned in the
* range 0 to PI (3.1415927).
* @param value the value whose arc cosine is to be
* returned
* @return the arc cosine of the given value
*/
acos(
value: number
): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* The inverse of cos(), returns the arc cosine of a
* value. This function expects the values in the
* range of -1 to 1 and values are returned in the
* range 0 to PI (3.1415927).
* @param value the value whose arc cosine is to be
* returned
* @return the arc cosine of the given value
*/
acos(value: number): number;
/**
* The inverse of sin(), returns the arc sine of a
* value. This function expects the values in the
* range of -1 to 1 and values are returned in the
* range -PI/2 to PI/2.
* @param value the value whose arc sine is to be
* returned
* @return the arc sine of the given value
*/
asin(
value: number
): number;
/**
* The inverse of sin(), returns the arc sine of a
* value. This function expects the values in the
* range of -1 to 1 and values are returned in the
* range -PI/2 to PI/2.
* @param value the value whose arc sine is to be
* returned
* @return the arc sine of the given value
*/
asin(value: number): number;
/**
* The inverse of tan(), returns the arc tangent of a
* value. This function expects the values in the
* range of -Infinity to Infinity (exclusive) and
* values are returned in the range -PI/2 to PI/2.
* @param value the value whose arc tangent is to be
* returned
* @return the arc tangent of the given value
*/
atan(
value: number
): number;
/**
* The inverse of tan(), returns the arc tangent of a
* value. This function expects the values in the
* range of -Infinity to Infinity (exclusive) and
* values are returned in the range -PI/2 to PI/2.
* @param value the value whose arc tangent is to be
* returned
* @return the arc tangent of the given value
*/
atan(value: number): number;
/**
* Calculates the angle (in radians) from a specified
* point to the coordinate origin as measured from
* the positive x-axis. Values are returned as a
* float in the range from PI to -PI. The atan2()
* function is most often used for orienting geometry
* to the position of the cursor. Note: The
* y-coordinate of the point is the first parameter,
* and the x-coordinate is the second parameter, due
* the the structure of calculating the tangent.
* @param y y-coordinate of the point
* @param x x-coordinate of the point
* @return the arc tangent of the given point
*/
atan2(
y: number,
x: number
): number;
/**
* Calculates the angle (in radians) from a specified
* point to the coordinate origin as measured from
* the positive x-axis. Values are returned as a
* float in the range from PI to -PI. The atan2()
* function is most often used for orienting geometry
* to the position of the cursor. Note: The
* y-coordinate of the point is the first parameter,
* and the x-coordinate is the second parameter, due
* the the structure of calculating the tangent.
* @param y y-coordinate of the point
* @param x x-coordinate of the point
* @return the arc tangent of the given point
*/
atan2(y: number, x: number): number;
/**
* Calculates the cosine of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the cosine of the angle
*/
cos(
angle: number
): number;
/**
* Calculates the cosine of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the cosine of the angle
*/
cos(angle: number): number;
/**
* Calculates the sine of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the sine of the angle
*/
sin(
angle: number
): number;
/**
* Calculates the sine of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the sine of the angle
*/
sin(angle: number): number;
/**
* Calculates the tangent of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the tangent of the angle
*/
tan(
angle: number
): number;
/**
* Calculates the tangent of an angle. This function
* takes into account the current angleMode. Values
* are returned in the range -1 to 1.
* @param angle the angle
* @return the tangent of the angle
*/
tan(angle: number): number;
/**
* Converts a radian measurement to its corresponding
* value in degrees. Radians and degrees are two ways
* of measuring the same thing. There are 360 degrees
* in a circle and 2*PI radians in a circle. For
* example, 90° = PI/2 = 1.5707964. This function
* does not take into account the current angleMode.
* @param radians the radians value to convert to
* degrees
* @return the converted angle
*/
degrees(
radians: number
): number;
/**
* Converts a radian measurement to its corresponding
* value in degrees. Radians and degrees are two ways
* of measuring the same thing. There are 360 degrees
* in a circle and 2*PI radians in a circle. For
* example, 90° = PI/2 = 1.5707964. This function
* does not take into account the current angleMode.
* @param radians the radians value to convert to
* degrees
* @return the converted angle
*/
degrees(radians: number): number;
/**
* Converts a degree measurement to its corresponding
* value in radians. Radians and degrees are two ways
* of measuring the same thing. There are 360 degrees
* in a circle and 2*PI radians in a circle. For
* example, 90° = PI/2 = 1.5707964. This function
* does not take into account the current angleMode.
* @param degrees the degree value to convert to
* radians
* @return the converted angle
*/
radians(
degrees: number
): number;
/**
* Converts a degree measurement to its corresponding
* value in radians. Radians and degrees are two ways
* of measuring the same thing. There are 360 degrees
* in a circle and 2*PI radians in a circle. For
* example, 90° = PI/2 = 1.5707964. This function
* does not take into account the current angleMode.
* @param degrees the degree value to convert to
* radians
* @return the converted angle
*/
radians(degrees: number): number;
/**
* Sets the current mode of p5 to given mode. Default
* mode is RADIANS.
* @param mode either RADIANS or DEGREES
*/
angleMode(
mode: ANGLE_MODE
): void;
}
/**
* Sets the current mode of p5 to given mode. Default
* mode is RADIANS.
* @param mode either RADIANS or DEGREES
*/
angleMode(mode: ANGLE_MODE): void;
}
}
types/p5/src/typography/attributes.d.ts
Vendored
+112 -123
View File
@@ -1,137 +1,126 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Sets the current alignment for drawing text.
* Accepts two arguments: horizAlign (LEFT, CENTER,
* or RIGHT) and vertAlign (TOP, BOTTOM, CENTER, or
* BASELINE). The horizAlign parameter is in
* reference to the x value of the text() function,
* while the vertAlign parameter is in reference to
* the y value.
*
* So if you write textAlign(LEFT), you are aligning
* the left edge of your text to the x value you give
* in text(). If you write textAlign(RIGHT, TOP), you
* are aligning the right edge of your text to the x
* value and the top of edge of the text to the y
* value.
* @param horizAlign horizontal alignment, either
* LEFT, CENTER, or RIGHT
* @param [vertAlign] vertical alignment, either TOP,
* BOTTOM, CENTER, or BASELINE
* @chainable
*/
textAlign(
horizAlign: HORIZ_ALIGN,
vertAlign?: VERT_ALIGN
): p5;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Sets the current alignment for drawing text.
* Accepts two arguments: horizAlign (LEFT, CENTER,
* or RIGHT) and vertAlign (TOP, BOTTOM, CENTER, or
* BASELINE). The horizAlign parameter is in
* reference to the x value of the text() function,
* while the vertAlign parameter is in reference to
* the y value.
*
* So if you write textAlign(LEFT), you are aligning
* the left edge of your text to the x value you give
* in text(). If you write textAlign(RIGHT, TOP), you
* are aligning the right edge of your text to the x
* value and the top of edge of the text to the y
* value.
* @param horizAlign horizontal alignment, either
* LEFT, CENTER, or RIGHT
* @param [vertAlign] vertical alignment, either TOP,
* BOTTOM, CENTER, or BASELINE
* @chainable
*/
textAlign(horizAlign: HORIZ_ALIGN, vertAlign?: VERT_ALIGN): p5;
/**
* Sets the current alignment for drawing text.
* Accepts two arguments: horizAlign (LEFT, CENTER,
* or RIGHT) and vertAlign (TOP, BOTTOM, CENTER, or
* BASELINE). The horizAlign parameter is in
* reference to the x value of the text() function,
* while the vertAlign parameter is in reference to
* the y value.
*
* So if you write textAlign(LEFT), you are aligning
* the left edge of your text to the x value you give
* in text(). If you write textAlign(RIGHT, TOP), you
* are aligning the right edge of your text to the x
* value and the top of edge of the text to the y
* value.
*/
textAlign(): object;
/**
* Sets the current alignment for drawing text.
* Accepts two arguments: horizAlign (LEFT, CENTER,
* or RIGHT) and vertAlign (TOP, BOTTOM, CENTER, or
* BASELINE). The horizAlign parameter is in
* reference to the x value of the text() function,
* while the vertAlign parameter is in reference to
* the y value.
*
* So if you write textAlign(LEFT), you are aligning
* the left edge of your text to the x value you give
* in text(). If you write textAlign(RIGHT, TOP), you
* are aligning the right edge of your text to the x
* value and the top of edge of the text to the y
* value.
*/
textAlign(): object;
/**
* Sets/gets the spacing, in pixels, between lines of
* text. This setting will be used in all subsequent
* calls to the text() function.
* @param leading the size in pixels for spacing
* between lines
* @chainable
*/
textLeading(
leading: number
): p5;
/**
* Sets/gets the spacing, in pixels, between lines of
* text. This setting will be used in all subsequent
* calls to the text() function.
* @param leading the size in pixels for spacing
* between lines
* @chainable
*/
textLeading(leading: number): p5;
/**
* Sets/gets the spacing, in pixels, between lines of
* text. This setting will be used in all subsequent
* calls to the text() function.
*/
textLeading(): number;
/**
* Sets/gets the spacing, in pixels, between lines of
* text. This setting will be used in all subsequent
* calls to the text() function.
*/
textLeading(): number;
/**
* Sets/gets the current font size. This size will be
* used in all subsequent calls to the text()
* function. Font size is measured in pixels.
* @param theSize the size of the letters in units of
* pixels
* @chainable
*/
textSize(
theSize: number
): p5;
/**
* Sets/gets the current font size. This size will be
* used in all subsequent calls to the text()
* function. Font size is measured in pixels.
* @param theSize the size of the letters in units of
* pixels
* @chainable
*/
textSize(theSize: number): p5;
/**
* Sets/gets the current font size. This size will be
* used in all subsequent calls to the text()
* function. Font size is measured in pixels.
*/
textSize(): number;
/**
* Sets/gets the current font size. This size will be
* used in all subsequent calls to the text()
* function. Font size is measured in pixels.
*/
textSize(): number;
/**
* Sets/gets the style of the text for system fonts
* to NORMAL, ITALIC, BOLD or BOLDITALIC. Note: this
* may be is overridden by CSS styling. For
* non-system fonts (opentype, truetype, etc.) please
* load styled fonts instead.
* @param theStyle styling for text, either NORMAL,
* ITALIC, BOLD or BOLDITALIC
* @chainable
*/
textStyle(
theStyle: THE_STYLE
): p5;
/**
* Sets/gets the style of the text for system fonts
* to NORMAL, ITALIC, BOLD or BOLDITALIC. Note: this
* may be is overridden by CSS styling. For
* non-system fonts (opentype, truetype, etc.) please
* load styled fonts instead.
* @param theStyle styling for text, either NORMAL,
* ITALIC, BOLD or BOLDITALIC
* @chainable
*/
textStyle(theStyle: THE_STYLE): p5;
/**
* Sets/gets the style of the text for system fonts
* to NORMAL, ITALIC, BOLD or BOLDITALIC. Note: this
* may be is overridden by CSS styling. For
* non-system fonts (opentype, truetype, etc.) please
* load styled fonts instead.
*/
textStyle(): string;
/**
* Sets/gets the style of the text for system fonts
* to NORMAL, ITALIC, BOLD or BOLDITALIC. Note: this
* may be is overridden by CSS styling. For
* non-system fonts (opentype, truetype, etc.) please
* load styled fonts instead.
*/
textStyle(): string;
/**
* Calculates and returns the width of any character
* or text string.
* @param theText the String of characters to measure
*/
textWidth(
theText: string
): number;
/**
* Calculates and returns the width of any character
* or text string.
* @param theText the String of characters to measure
*/
textWidth(theText: string): number;
/**
* Returns the ascent of the current font at its
* current size. The ascent represents the distance,
* in pixels, of the tallest character above the
* baseline.
*/
textAscent(): number;
/**
* Returns the ascent of the current font at its
* current size. The ascent represents the distance,
* in pixels, of the tallest character above the
* baseline.
*/
textAscent(): number;
/**
* Returns the descent of the current font at its
* current size. The descent represents the distance,
* in pixels, of the character with the longest
* descender below the baseline.
*/
textDescent(): number;
}
/**
* Returns the descent of the current font at its
* current size. The descent represents the distance,
* in pixels, of the character with the longest
* descender below the baseline.
*/
textDescent(): number;
}
}
types/p5/src/typography/loading_displaying.d.ts
Vendored
+81 -105
View File
@@ -1,112 +1,88 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Loads an opentype font file (.otf, .ttf) from a
* file or a URL, and returns a PFont Object. This
* method is asynchronous, meaning it may not finish
* before the next line in your sketch is executed.
* The path to the font should be relative to the
* HTML file that links in your sketch. Loading fonts
* from a URL or other remote location may be blocked
* due to your browser's built-in security.
* @param path name of the file or url to load
* @param [callback] function to be executed after
* loadFont() completes
* @param [onError] function to be executed if an
* error occurs
* @return p5.Font object
*/
loadFont(
path: string,
callback?: (
...args: any[]
) => any,
onError?: (
...args: any[]
) => any
): Font;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Loads an opentype font file (.otf, .ttf) from a
* file or a URL, and returns a PFont Object. This
* method is asynchronous, meaning it may not finish
* before the next line in your sketch is executed.
* The path to the font should be relative to the
* HTML file that links in your sketch. Loading fonts
* from a URL or other remote location may be blocked
* due to your browser's built-in security.
* @param path name of the file or url to load
* @param [callback] function to be executed after
* loadFont() completes
* @param [onError] function to be executed if an
* error occurs
* @return p5.Font object
*/
loadFont(path: string, callback?: (...args: any[]) => any, onError?: (...args: any[]) => any): Font;
/**
* Draws text to the screen. Displays the information
* specified in the first parameter on the screen in
* the position specified by the additional
* parameters. A default font will be used unless a
* font is set with the textFont() function and a
* default size will be used unless a font is set
* with textSize(). Change the color of the text with
* the fill() function. Change the outline of the
* text with the stroke() and strokeWeight()
* functions. The text displays in relation to the
* textAlign() function, which gives the option to
* draw to the left, right, and center of the
* coordinates.
*
*
* The x2 and y2 parameters define a rectangular area
* to display within and may only be used with string
* data. When these parameters are specified, they
* are interpreted based on the current rectMode()
* setting. Text that does not fit completely within
* the rectangle specified will not be drawn to the
* screen. If x2 and y2 are not specified, the
* baseline alignment is the default, which means
* that the text will be drawn upwards from x and y.
*
*
* WEBGL: Only opentype/truetype fonts are supported.
* You must load a font using the loadFont() method
* (see the example above). stroke() currently has no
* effect in webgl mode.
* @param str the alphanumeric symbols to be
* displayed
* @param x x-coordinate of text
* @param y y-coordinate of text
* @param [x2] by default, the width of the text box,
* see rectMode() for more info
* @param [y2] by default, the height of the text
* box, see rectMode() for more info
* @chainable
*/
text(
str:
| string
| object
| any[]
| number
| boolean,
x: number,
y: number,
x2?: number,
y2?: number
): p5;
/**
* Draws text to the screen. Displays the information
* specified in the first parameter on the screen in
* the position specified by the additional
* parameters. A default font will be used unless a
* font is set with the textFont() function and a
* default size will be used unless a font is set
* with textSize(). Change the color of the text with
* the fill() function. Change the outline of the
* text with the stroke() and strokeWeight()
* functions. The text displays in relation to the
* textAlign() function, which gives the option to
* draw to the left, right, and center of the
* coordinates.
*
*
* The x2 and y2 parameters define a rectangular area
* to display within and may only be used with string
* data. When these parameters are specified, they
* are interpreted based on the current rectMode()
* setting. Text that does not fit completely within
* the rectangle specified will not be drawn to the
* screen. If x2 and y2 are not specified, the
* baseline alignment is the default, which means
* that the text will be drawn upwards from x and y.
*
*
* WEBGL: Only opentype/truetype fonts are supported.
* You must load a font using the loadFont() method
* (see the example above). stroke() currently has no
* effect in webgl mode.
* @param str the alphanumeric symbols to be
* displayed
* @param x x-coordinate of text
* @param y y-coordinate of text
* @param [x2] by default, the width of the text box,
* see rectMode() for more info
* @param [y2] by default, the height of the text
* box, see rectMode() for more info
* @chainable
*/
text(str: string | object | any[] | number | boolean, x: number, y: number, x2?: number, y2?: number): p5;
/**
* Sets the current font that will be drawn with the
* text() function. WEBGL: Only fonts loaded via
* loadFont() are supported.
* @return the current font
*/
textFont(): object;
/**
* Sets the current font that will be drawn with the
* text() function. WEBGL: Only fonts loaded via
* loadFont() are supported.
* @return the current font
*/
textFont(): object;
/**
* Sets the current font that will be drawn with the
* text() function. WEBGL: Only fonts loaded via
* loadFont() are supported.
* @param font a font loaded via loadFont(), or a
* String representing a web safe font (a font that
* is generally available across all systems)
* @param [size] the font size to use
* @chainable
*/
textFont(
font:
| object
| string,
size?: number
): p5;
}
/**
* Sets the current font that will be drawn with the
* text() function. WEBGL: Only fonts loaded via
* loadFont() are supported.
* @param font a font loaded via loadFont(), or a
* String representing a web safe font (a font that
* is generally available across all systems)
* @param [size] the font size to use
* @chainable
*/
textFont(font: object | string, size?: number): p5;
}
}
types/p5/src/typography/p5.Font.d.ts
Vendored
+49 -61
View File
@@ -1,67 +1,55 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Font {
/**
* Returns a tight bounding box for the given text
* string using this font (currently only supports
* single lines)
* @param line a line of text
* @param x x-position
* @param y y-position
* @param [fontSize] font size to use (optional)
* Default is 12.
* @param [options] opentype options (optional)
* opentype fonts contains alignment and baseline
* options. Default is 'LEFT' and 'alphabetic'
* @return a rectangle object with properties: x, y,
* w, h
*/
textBounds(
line: string,
x: number,
y: number,
fontSize?: number,
options?: object
): object;
declare module '../../index' {
class Font {
/**
* Returns a tight bounding box for the given text
* string using this font (currently only supports
* single lines)
* @param line a line of text
* @param x x-position
* @param y y-position
* @param [fontSize] font size to use (optional)
* Default is 12.
* @param [options] opentype options (optional)
* opentype fonts contains alignment and baseline
* options. Default is 'LEFT' and 'alphabetic'
* @return a rectangle object with properties: x, y,
* w, h
*/
textBounds(line: string, x: number, y: number, fontSize?: number, options?: object): object;
/**
* Computes an array of points following the path for
* specified text
* @param txt a line of text
* @param x x-position
* @param y y-position
* @param fontSize font size to use (optional)
* @param [options] an (optional) object that can
* contain:
*
*
* sampleFactor - the ratio of path-length to number
* of samples (default=.25); higher values yield more
* points and are therefore more precise
*
*
* simplifyThreshold - if set to a non-zero value,
* collinear points will be be removed from the
* polygon; the value represents the threshold angle
* to use when determining whether two edges are
* collinear
* @return an array of points, each with x, y, alpha
* (the path angle)
*/
textToPoints(
txt: string,
x: number,
y: number,
fontSize: number,
options?: object
): any[];
/**
* Computes an array of points following the path for
* specified text
* @param txt a line of text
* @param x x-position
* @param y y-position
* @param fontSize font size to use (optional)
* @param [options] an (optional) object that can
* contain:
*
*
* sampleFactor - the ratio of path-length to number
* of samples (default=.1); higher values yield more
* points and are therefore more precise
*
*
* simplifyThreshold - if set to a non-zero value,
* collinear points will be be removed from the
* polygon; the value represents the threshold angle
* to use when determining whether two edges are
* collinear
* @return an array of points, each with x, y, alpha
* (the path angle)
*/
textToPoints(txt: string, x: number, y: number, fontSize: number, options?: object): any[];
/**
* Underlying opentype font implementation
*/
font: any;
}
/**
* Underlying opentype font implementation
*/
font: any;
}
}
types/p5/src/utilities/array_functions.d.ts
Vendored
+144 -178
View File
@@ -1,191 +1,157 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Adds a value to the end of an array. Extends the
* length of the array by one. Maps to Array.push().
* @param array Array to append
* @param value to be added to the Array
* @return the array that was appended to
*/
append(
array: any[],
value: any
): any[];
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Adds a value to the end of an array. Extends the
* length of the array by one. Maps to Array.push().
* @param array Array to append
* @param value to be added to the Array
* @return the array that was appended to
*/
append(array: any[], value: any): any[];
/**
* Copies an array (or part of an array) to another
* array. The src array is copied to the dst array,
* beginning at the position specified by srcPosition
* and into the position specified by dstPosition.
* The number of elements to copy is determined by
* length. Note that copying values overwrites
* existing values in the destination array. To
* append values instead of overwriting them, use
* concat(). The simplified version with only two
* arguments, arrayCopy(src, dst), copies an entire
* array to another of the same size. It is
* equivalent to arrayCopy(src, 0, dst, 0,
* src.length).
*
*
* Using this function is far more efficient for
* copying array data than iterating through a for()
* loop and copying each element individually.
* @param src the source Array
* @param srcPosition starting position in the source
* Array
* @param dst the destination Array
* @param dstPosition starting position in the
* destination Array
* @param length number of Array elements to be
* copied
*/
arrayCopy(
src: any[],
srcPosition: number,
dst: any[],
dstPosition: number,
length: number
): void;
/**
* Copies an array (or part of an array) to another
* array. The src array is copied to the dst array,
* beginning at the position specified by srcPosition
* and into the position specified by dstPosition.
* The number of elements to copy is determined by
* length. Note that copying values overwrites
* existing values in the destination array. To
* append values instead of overwriting them, use
* concat(). The simplified version with only two
* arguments, arrayCopy(src, dst), copies an entire
* array to another of the same size. It is
* equivalent to arrayCopy(src, 0, dst, 0,
* src.length).
*
*
* Using this function is far more efficient for
* copying array data than iterating through a for()
* loop and copying each element individually.
* @param src the source Array
* @param srcPosition starting position in the source
* Array
* @param dst the destination Array
* @param dstPosition starting position in the
* destination Array
* @param length number of Array elements to be
* copied
*/
arrayCopy(src: any[], srcPosition: number, dst: any[], dstPosition: number, length: number): void;
/**
* Copies an array (or part of an array) to another
* array. The src array is copied to the dst array,
* beginning at the position specified by srcPosition
* and into the position specified by dstPosition.
* The number of elements to copy is determined by
* length. Note that copying values overwrites
* existing values in the destination array. To
* append values instead of overwriting them, use
* concat(). The simplified version with only two
* arguments, arrayCopy(src, dst), copies an entire
* array to another of the same size. It is
* equivalent to arrayCopy(src, 0, dst, 0,
* src.length).
*
*
* Using this function is far more efficient for
* copying array data than iterating through a for()
* loop and copying each element individually.
* @param src the source Array
* @param dst the destination Array
* @param [length] number of Array elements to be
* copied
*/
arrayCopy(
src: any[],
dst: any[],
length?: number
): void;
/**
* Copies an array (or part of an array) to another
* array. The src array is copied to the dst array,
* beginning at the position specified by srcPosition
* and into the position specified by dstPosition.
* The number of elements to copy is determined by
* length. Note that copying values overwrites
* existing values in the destination array. To
* append values instead of overwriting them, use
* concat(). The simplified version with only two
* arguments, arrayCopy(src, dst), copies an entire
* array to another of the same size. It is
* equivalent to arrayCopy(src, 0, dst, 0,
* src.length).
*
*
* Using this function is far more efficient for
* copying array data than iterating through a for()
* loop and copying each element individually.
* @param src the source Array
* @param dst the destination Array
* @param [length] number of Array elements to be
* copied
*/
arrayCopy(src: any[], dst: any[], length?: number): void;
/**
* Concatenates two arrays, maps to Array.concat().
* Does not modify the input arrays.
* @param a first Array to concatenate
* @param b second Array to concatenate
* @return concatenated array
*/
concat(
a: any[],
b: any[]
): any[];
/**
* Concatenates two arrays, maps to Array.concat().
* Does not modify the input arrays.
* @param a first Array to concatenate
* @param b second Array to concatenate
* @return concatenated array
*/
concat(a: any[], b: any[]): any[];
/**
* Reverses the order of an array, maps to
* Array.reverse()
* @param list Array to reverse
* @return the reversed list
*/
reverse(
list: any[]
): any[];
/**
* Reverses the order of an array, maps to
* Array.reverse()
* @param list Array to reverse
* @return the reversed list
*/
reverse(list: any[]): any[];
/**
* Decreases an array by one element and returns the
* shortened array, maps to Array.pop().
* @param list Array to shorten
* @return shortened Array
*/
shorten(
list: any[]
): any[];
/**
* Decreases an array by one element and returns the
* shortened array, maps to Array.pop().
* @param list Array to shorten
* @return shortened Array
*/
shorten(list: any[]): any[];
/**
* Randomizes the order of the elements of an array.
* Implements Fisher-Yates Shuffle Algorithm.
* @param array Array to shuffle
* @param [bool] modify passed array
* @return shuffled Array
*/
shuffle(
array: any[],
bool?: boolean
): any[];
/**
* Randomizes the order of the elements of an array.
* Implements Fisher-Yates Shuffle Algorithm.
* @param array Array to shuffle
* @param [bool] modify passed array
* @return shuffled Array
*/
shuffle(array: any[], bool?: boolean): any[];
/**
* Sorts an array of numbers from smallest to
* largest, or puts an array of words in alphabetical
* order. The original array is not modified; a
* re-ordered array is returned. The count parameter
* states the number of elements to sort. For
* example, if there are 12 elements in an array and
* count is set to 5, only the first 5 elements in
* the array will be sorted.
* @param list Array to sort
* @param [count] number of elements to sort,
* starting from 0
* @return the sorted list
*/
sort(
list: any[],
count?: number
): any[];
/**
* Sorts an array of numbers from smallest to
* largest, or puts an array of words in alphabetical
* order. The original array is not modified; a
* re-ordered array is returned. The count parameter
* states the number of elements to sort. For
* example, if there are 12 elements in an array and
* count is set to 5, only the first 5 elements in
* the array will be sorted.
* @param list Array to sort
* @param [count] number of elements to sort,
* starting from 0
* @return the sorted list
*/
sort(list: any[], count?: number): any[];
/**
* Inserts a value or an array of values into an
* existing array. The first parameter specifies the
* initial array to be modified, and the second
* parameter defines the data to be inserted. The
* third parameter is an index value which specifies
* the array position from which to insert data.
* (Remember that array index numbering starts at
* zero, so the first position is 0, the second
* position is 1, and so on.)
* @param list Array to splice into
* @param value value to be spliced in
* @param position in the array from which to insert
* data
* @return the list
*/
splice(
list: any[],
value: any,
position: number
): any[];
/**
* Inserts a value or an array of values into an
* existing array. The first parameter specifies the
* initial array to be modified, and the second
* parameter defines the data to be inserted. The
* third parameter is an index value which specifies
* the array position from which to insert data.
* (Remember that array index numbering starts at
* zero, so the first position is 0, the second
* position is 1, and so on.)
* @param list Array to splice into
* @param value value to be spliced in
* @param position in the array from which to insert
* data
* @return the list
*/
splice(list: any[], value: any, position: number): any[];
/**
* Extracts an array of elements from an existing
* array. The list parameter defines the array from
* which the elements will be copied, and the start
* and count parameters specify which elements to
* extract. If no count is given, elements will be
* extracted from the start to the end of the array.
* When specifying the start, remember that the first
* array element is 0. This function does not change
* the source array.
* @param list Array to extract from
* @param start position to begin
* @param [count] number of values to extract
* @return Array of extracted elements
*/
subset(
list: any[],
start: number,
count?: number
): any[];
}
/**
* Extracts an array of elements from an existing
* array. The list parameter defines the array from
* which the elements will be copied, and the start
* and count parameters specify which elements to
* extract. If no count is given, elements will be
* extracted from the start to the end of the array.
* When specifying the start, remember that the first
* array element is 0. This function does not change
* the source array.
* @param list Array to extract from
* @param start position to begin
* @param [count] number of values to extract
* @return Array of extracted elements
*/
subset(list: any[], start: number, count?: number): any[];
}
}
types/p5/src/utilities/conversion.d.ts
Vendored
+177 -226
View File
@@ -1,244 +1,195 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Converts a string to its floating point
* representation. The contents of a string must
* resemble a number, or NaN (not a number) will be
* returned. For example, float("1234.56") evaluates
* to 1234.56, but float("giraffe") will return NaN.
* When an array of values is passed in, then an
* array of floats of the same length is returned.
* @param str float string to parse
* @return floating point representation of string
*/
float(
str: string
): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Converts a string to its floating point
* representation. The contents of a string must
* resemble a number, or NaN (not a number) will be
* returned. For example, float("1234.56") evaluates
* to 1234.56, but float("giraffe") will return NaN.
* When an array of values is passed in, then an
* array of floats of the same length is returned.
* @param str float string to parse
* @return floating point representation of string
*/
float(str: string): number;
/**
* Converts a boolean, string, or float to its
* integer representation. When an array of values is
* passed in, then an int array of the same length is
* returned.
* @param n value to parse
* @param [radix] the radix to convert to (default:
* 10)
* @return integer representation of value
*/
int(
n:
| string
| boolean
| number,
radix?: number
): number;
/**
* Converts a boolean, string, or float to its
* integer representation. When an array of values is
* passed in, then an int array of the same length is
* returned.
* @param n value to parse
* @param [radix] the radix to convert to (default:
* 10)
* @return integer representation of value
*/
int(n: string | boolean | number, radix?: number): number;
/**
* Converts a boolean, string, or float to its
* integer representation. When an array of values is
* passed in, then an int array of the same length is
* returned.
* @param ns values to parse
* @return integer representation of values
*/
int(
ns: any[]
): number[];
/**
* Converts a boolean, string, or float to its
* integer representation. When an array of values is
* passed in, then an int array of the same length is
* returned.
* @param ns values to parse
* @return integer representation of values
*/
int(ns: any[]): number[];
/**
* Converts a boolean, string or number to its string
* representation. When an array of values is passed
* in, then an array of strings of the same length is
* returned.
* @param n value to parse
* @return string representation of value
*/
str(
n:
| string
| boolean
| number
| any[]
): string;
/**
* Converts a boolean, string or number to its string
* representation. When an array of values is passed
* in, then an array of strings of the same length is
* returned.
* @param n value to parse
* @return string representation of value
*/
str(n: string | boolean | number | any[]): string;
/**
* Converts a number or string to its boolean
* representation. For a number, any non-zero value
* (positive or negative) evaluates to true, while
* zero evaluates to false. For a string, the value
* "true" evaluates to true, while any other value
* evaluates to false. When an array of number or
* string values is passed in, then a array of
* booleans of the same length is returned.
* @param n value to parse
* @return boolean representation of value
*/
boolean(
n:
| string
| boolean
| number
| any[]
): boolean;
/**
* Converts a number or string to its boolean
* representation. For a number, any non-zero value
* (positive or negative) evaluates to true, while
* zero evaluates to false. For a string, the value
* "true" evaluates to true, while any other value
* evaluates to false. When an array of number or
* string values is passed in, then a array of
* booleans of the same length is returned.
* @param n value to parse
* @return boolean representation of value
*/
boolean(n: string | boolean | number | any[]): boolean;
/**
* Converts a number, string representation of a
* number, or boolean to its byte representation. A
* byte can be only a whole number between -128 and
* 127, so when a value outside of this range is
* converted, it wraps around to the corresponding
* byte representation. When an array of number,
* string or boolean values is passed in, then an
* array of bytes the same length is returned.
* @param n value to parse
* @return byte representation of value
*/
byte(
n:
| string
| boolean
| number
): number;
/**
* Converts a number, string representation of a
* number, or boolean to its byte representation. A
* byte can be only a whole number between -128 and
* 127, so when a value outside of this range is
* converted, it wraps around to the corresponding
* byte representation. When an array of number,
* string or boolean values is passed in, then an
* array of bytes the same length is returned.
* @param n value to parse
* @return byte representation of value
*/
byte(n: string | boolean | number): number;
/**
* Converts a number, string representation of a
* number, or boolean to its byte representation. A
* byte can be only a whole number between -128 and
* 127, so when a value outside of this range is
* converted, it wraps around to the corresponding
* byte representation. When an array of number,
* string or boolean values is passed in, then an
* array of bytes the same length is returned.
* @param ns values to parse
* @return array of byte representation of values
*/
byte(
ns: any[]
): number[];
/**
* Converts a number, string representation of a
* number, or boolean to its byte representation. A
* byte can be only a whole number between -128 and
* 127, so when a value outside of this range is
* converted, it wraps around to the corresponding
* byte representation. When an array of number,
* string or boolean values is passed in, then an
* array of bytes the same length is returned.
* @param ns values to parse
* @return array of byte representation of values
*/
byte(ns: any[]): number[];
/**
* Converts a number or string to its corresponding
* single-character string representation. If a
* string parameter is provided, it is first parsed
* as an integer and then translated into a
* single-character string. When an array of number
* or string values is passed in, then an array of
* single-character strings of the same length is
* returned.
* @param n value to parse
* @return string representation of value
*/
char(
n:
| string
| number
): string;
/**
* Converts a number or string to its corresponding
* single-character string representation. If a
* string parameter is provided, it is first parsed
* as an integer and then translated into a
* single-character string. When an array of number
* or string values is passed in, then an array of
* single-character strings of the same length is
* returned.
* @param n value to parse
* @return string representation of value
*/
char(n: string | number): string;
/**
* Converts a number or string to its corresponding
* single-character string representation. If a
* string parameter is provided, it is first parsed
* as an integer and then translated into a
* single-character string. When an array of number
* or string values is passed in, then an array of
* single-character strings of the same length is
* returned.
* @param ns values to parse
* @return array of string representation of values
*/
char(
ns: any[]
): string[];
/**
* Converts a number or string to its corresponding
* single-character string representation. If a
* string parameter is provided, it is first parsed
* as an integer and then translated into a
* single-character string. When an array of number
* or string values is passed in, then an array of
* single-character strings of the same length is
* returned.
* @param ns values to parse
* @return array of string representation of values
*/
char(ns: any[]): string[];
/**
* Converts a single-character string to its
* corresponding integer representation. When an
* array of single-character string values is passed
* in, then an array of integers of the same length
* is returned.
* @param n value to parse
* @return integer representation of value
*/
unchar(
n: string
): number;
/**
* Converts a single-character string to its
* corresponding integer representation. When an
* array of single-character string values is passed
* in, then an array of integers of the same length
* is returned.
* @param n value to parse
* @return integer representation of value
*/
unchar(n: string): number;
/**
* Converts a single-character string to its
* corresponding integer representation. When an
* array of single-character string values is passed
* in, then an array of integers of the same length
* is returned.
* @param ns values to parse
* @return integer representation of values
*/
unchar(
ns: any[]
): number[];
/**
* Converts a single-character string to its
* corresponding integer representation. When an
* array of single-character string values is passed
* in, then an array of integers of the same length
* is returned.
* @param ns values to parse
* @return integer representation of values
*/
unchar(ns: any[]): number[];
/**
* Converts a number to a string in its equivalent
* hexadecimal notation. If a second parameter is
* passed, it is used to set the number of characters
* to generate in the hexadecimal notation. When an
* array is passed in, an array of strings in
* hexadecimal notation of the same length is
* returned.
* @param n value to parse
* @return hexadecimal string representation of value
*/
hex(
n: number,
digits?: number
): string;
/**
* Converts a number to a string in its equivalent
* hexadecimal notation. If a second parameter is
* passed, it is used to set the number of characters
* to generate in the hexadecimal notation. When an
* array is passed in, an array of strings in
* hexadecimal notation of the same length is
* returned.
* @param n value to parse
* @return hexadecimal string representation of value
*/
hex(n: number, digits?: number): string;
/**
* Converts a number to a string in its equivalent
* hexadecimal notation. If a second parameter is
* passed, it is used to set the number of characters
* to generate in the hexadecimal notation. When an
* array is passed in, an array of strings in
* hexadecimal notation of the same length is
* returned.
* @param ns array of values to parse
* @return hexadecimal string representation of
* values
*/
hex(
ns: number[],
digits?: number
): string[];
/**
* Converts a number to a string in its equivalent
* hexadecimal notation. If a second parameter is
* passed, it is used to set the number of characters
* to generate in the hexadecimal notation. When an
* array is passed in, an array of strings in
* hexadecimal notation of the same length is
* returned.
* @param ns array of values to parse
* @return hexadecimal string representation of
* values
*/
hex(ns: number[], digits?: number): string[];
/**
* Converts a string representation of a hexadecimal
* number to its equivalent integer value. When an
* array of strings in hexadecimal notation is passed
* in, an array of integers of the same length is
* returned.
* @param n value to parse
* @return integer representation of hexadecimal
* value
*/
unhex(
n: string
): number;
/**
* Converts a string representation of a hexadecimal
* number to its equivalent integer value. When an
* array of strings in hexadecimal notation is passed
* in, an array of integers of the same length is
* returned.
* @param n value to parse
* @return integer representation of hexadecimal
* value
*/
unhex(n: string): number;
/**
* Converts a string representation of a hexadecimal
* number to its equivalent integer value. When an
* array of strings in hexadecimal notation is passed
* in, an array of integers of the same length is
* returned.
* @param ns values to parse
* @return integer representations of hexadecimal
* value
*/
unhex(
ns: any[]
): number[];
}
/**
* Converts a string representation of a hexadecimal
* number to its equivalent integer value. When an
* array of strings in hexadecimal notation is passed
* in, an array of integers of the same length is
* returned.
* @param ns values to parse
* @return integer representations of hexadecimal
* value
*/
unhex(ns: any[]): number[];
}
}
types/p5/src/utilities/string_functions.d.ts
Vendored
+287 -352
View File
@@ -1,370 +1,305 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Combines an array of Strings into one String, each
* separated by the character(s) used for the
* separator parameter. To join arrays of ints or
* floats, it's necessary to first convert them to
* Strings using nf() or nfs().
* @param list array of Strings to be joined
* @param separator String to be placed between each
* item
* @return joined String
*/
join(
list: any[],
separator: string
): string;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Combines an array of Strings into one String, each
* separated by the character(s) used for the
* separator parameter. To join arrays of ints or
* floats, it's necessary to first convert them to
* Strings using nf() or nfs().
* @param list array of Strings to be joined
* @param separator String to be placed between each
* item
* @return joined String
*/
join(list: any[], separator: string): string;
/**
* This function is used to apply a regular
* expression to a piece of text, and return matching
* groups (elements found inside parentheses) as a
* String array. If there are no matches, a null
* value will be returned. If no groups are specified
* in the regular expression, but the sequence
* matches, an array of length 1 (with the matched
* text as the first element of the array) will be
* returned. To use the function, first check to see
* if the result is null. If the result is null, then
* the sequence did not match at all. If the sequence
* did match, an array is returned.
*
*
* If there are groups (specified by sets of
* parentheses) in the regular expression, then the
* contents of each will be returned in the array.
* Element [0] of a regular expression match returns
* the entire matching string, and the match groups
* start at element [1] (the first group is [1], the
* second [2], and so on).
* @param str the String to be searched
* @param regexp the regexp to be used for matching
* @return Array of Strings found
*/
match(
str: string,
regexp: string
): string[];
/**
* This function is used to apply a regular
* expression to a piece of text, and return matching
* groups (elements found inside parentheses) as a
* String array. If there are no matches, a null
* value will be returned. If no groups are specified
* in the regular expression, but the sequence
* matches, an array of length 1 (with the matched
* text as the first element of the array) will be
* returned. To use the function, first check to see
* if the result is null. If the result is null, then
* the sequence did not match at all. If the sequence
* did match, an array is returned.
*
*
* If there are groups (specified by sets of
* parentheses) in the regular expression, then the
* contents of each will be returned in the array.
* Element [0] of a regular expression match returns
* the entire matching string, and the match groups
* start at element [1] (the first group is [1], the
* second [2], and so on).
* @param str the String to be searched
* @param regexp the regexp to be used for matching
* @return Array of Strings found
*/
match(str: string, regexp: string): string[];
/**
* This function is used to apply a regular
* expression to a piece of text, and return a list
* of matching groups (elements found inside
* parentheses) as a two-dimensional String array. If
* there are no matches, a null value will be
* returned. If no groups are specified in the
* regular expression, but the sequence matches, a
* two dimensional array is still returned, but the
* second dimension is only of length one. To use
* the function, first check to see if the result is
* null. If the result is null, then the sequence did
* not match at all. If the sequence did match, a 2D
* array is returned.
*
*
* If there are groups (specified by sets of
* parentheses) in the regular expression, then the
* contents of each will be returned in the array.
* Assuming a loop with counter variable i, element
* [i][0] of a regular expression match returns the
* entire matching string, and the match groups start
* at element [i][1] (the first group is [i][1], the
* second [i][2], and so on).
* @param str the String to be searched
* @param regexp the regexp to be used for matching
* @return 2d Array of Strings found
*/
matchAll(
str: string,
regexp: string
): string[];
/**
* This function is used to apply a regular
* expression to a piece of text, and return a list
* of matching groups (elements found inside
* parentheses) as a two-dimensional String array. If
* there are no matches, a null value will be
* returned. If no groups are specified in the
* regular expression, but the sequence matches, a
* two dimensional array is still returned, but the
* second dimension is only of length one. To use
* the function, first check to see if the result is
* null. If the result is null, then the sequence did
* not match at all. If the sequence did match, a 2D
* array is returned.
*
*
* If there are groups (specified by sets of
* parentheses) in the regular expression, then the
* contents of each will be returned in the array.
* Assuming a loop with counter variable i, element
* [i][0] of a regular expression match returns the
* entire matching string, and the match groups start
* at element [i][1] (the first group is [i][1], the
* second [i][2], and so on).
* @param str the String to be searched
* @param regexp the regexp to be used for matching
* @return 2d Array of Strings found
*/
matchAll(str: string, regexp: string): string[];
/**
* Utility function for formatting numbers into
* strings. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for the digits, left, and right
* parameters should always be positive integers.
* (NOTE): Be cautious when using left and right
* parameters as it prepends numbers of 0's if the
* parameter if greater than the current length of
* the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nf(
num:
| number
| string,
left?:
| number
| string,
right?:
| number
| string
): string;
/**
* Utility function for formatting numbers into
* strings. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for the digits, left, and right
* parameters should always be positive integers.
* (NOTE): Be cautious when using left and right
* parameters as it prepends numbers of 0's if the
* parameter if greater than the current length of
* the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nf(num: number | string, left?: number | string, right?: number | string): string;
/**
* Utility function for formatting numbers into
* strings. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for the digits, left, and right
* parameters should always be positive integers.
* (NOTE): Be cautious when using left and right
* parameters as it prepends numbers of 0's if the
* parameter if greater than the current length of
* the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nf(
nums: any[],
left?:
| number
| string,
right?:
| number
| string
): string[];
/**
* Utility function for formatting numbers into
* strings. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for the digits, left, and right
* parameters should always be positive integers.
* (NOTE): Be cautious when using left and right
* parameters as it prepends numbers of 0's if the
* parameter if greater than the current length of
* the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nf(nums: any[], left?: number | string, right?: number | string): string[];
/**
* Utility function for formatting numbers into
* strings and placing appropriate commas to mark
* units of 1000. There are two versions: one for
* formatting ints, and one for formatting an array
* of ints. The value for the right parameter should
* always be a positive integer.
* @param num the Number to format
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfc(
num:
| number
| string,
right?:
| number
| string
): string;
/**
* Utility function for formatting numbers into
* strings and placing appropriate commas to mark
* units of 1000. There are two versions: one for
* formatting ints, and one for formatting an array
* of ints. The value for the right parameter should
* always be a positive integer.
* @param num the Number to format
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfc(num: number | string, right?: number | string): string;
/**
* Utility function for formatting numbers into
* strings and placing appropriate commas to mark
* units of 1000. There are two versions: one for
* formatting ints, and one for formatting an array
* of ints. The value for the right parameter should
* always be a positive integer.
* @param nums the Numbers to format
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfc(
nums: any[],
right?:
| number
| string
): string[];
/**
* Utility function for formatting numbers into
* strings and placing appropriate commas to mark
* units of 1000. There are two versions: one for
* formatting ints, and one for formatting an array
* of ints. The value for the right parameter should
* always be a positive integer.
* @param nums the Numbers to format
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfc(nums: any[], right?: number | string): string[];
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts a "+" in front
* of positive numbers and a "-" in front of negative
* numbers. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for left, and right parameters should
* always be positive integers.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfp(
num: number,
left?: number,
right?: number
): string;
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts a "+" in front
* of positive numbers and a "-" in front of negative
* numbers. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for left, and right parameters should
* always be positive integers.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfp(num: number, left?: number, right?: number): string;
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts a "+" in front
* of positive numbers and a "-" in front of negative
* numbers. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for left, and right parameters should
* always be positive integers.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfp(
nums: number[],
left?: number,
right?: number
): string[];
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts a "+" in front
* of positive numbers and a "-" in front of negative
* numbers. There are two versions: one for
* formatting floats, and one for formatting ints.
* The values for left, and right parameters should
* always be positive integers.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfp(nums: number[], left?: number, right?: number): string[];
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts an additional
* "_" (space) in front of positive numbers just in
* case to align it with negative numbers which
* includes "-" (minus) sign. The main usecase of
* nfs() can be seen when one wants to align the
* digits (place values) of a positive number with
* some negative number (See the example to get a
* clear picture). There are two versions: one for
* formatting float, and one for formatting int. The
* values for the digits, left, and right parameters
* should always be positive integers. (IMP): The
* result on the canvas basically the expected
* alignment can vary based on the typeface you are
* using. (NOTE): Be cautious when using left and
* right parameters as it prepends numbers of 0's if
* the parameter if greater than the current length
* of the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfs(
num: number,
left?: number,
right?: number
): string;
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts an additional
* "_" (space) in front of positive numbers just in
* case to align it with negative numbers which
* includes "-" (minus) sign. The main usecase of
* nfs() can be seen when one wants to align the
* digits (place values) of a non-negative number
* with some negative number (See the example to get
* a clear picture). There are two versions: one for
* formatting float, and one for formatting int. The
* values for the digits, left, and right parameters
* should always be positive integers. (IMP): The
* result on the canvas basically the expected
* alignment can vary based on the typeface you are
* using. (NOTE): Be cautious when using left and
* right parameters as it prepends numbers of 0's if
* the parameter if greater than the current length
* of the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param num the Number to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted String
*/
nfs(num: number, left?: number, right?: number): string;
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts an additional
* "_" (space) in front of positive numbers just in
* case to align it with negative numbers which
* includes "-" (minus) sign. The main usecase of
* nfs() can be seen when one wants to align the
* digits (place values) of a positive number with
* some negative number (See the example to get a
* clear picture). There are two versions: one for
* formatting float, and one for formatting int. The
* values for the digits, left, and right parameters
* should always be positive integers. (IMP): The
* result on the canvas basically the expected
* alignment can vary based on the typeface you are
* using. (NOTE): Be cautious when using left and
* right parameters as it prepends numbers of 0's if
* the parameter if greater than the current length
* of the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfs(
nums: any[],
left?: number,
right?: number
): string[];
/**
* Utility function for formatting numbers into
* strings. Similar to nf() but puts an additional
* "_" (space) in front of positive numbers just in
* case to align it with negative numbers which
* includes "-" (minus) sign. The main usecase of
* nfs() can be seen when one wants to align the
* digits (place values) of a non-negative number
* with some negative number (See the example to get
* a clear picture). There are two versions: one for
* formatting float, and one for formatting int. The
* values for the digits, left, and right parameters
* should always be positive integers. (IMP): The
* result on the canvas basically the expected
* alignment can vary based on the typeface you are
* using. (NOTE): Be cautious when using left and
* right parameters as it prepends numbers of 0's if
* the parameter if greater than the current length
* of the number. For example if number is 123.2 and
* left parameter passed is 4 which is greater than
* length of 123 (integer part) i.e 3 than result
* will be 0123.2. Same case for right parameter i.e.
* if right is 3 than the result will be 123.200.
* @param nums the Numbers to format
* @param [left] number of digits to the left of the
* decimal point
* @param [right] number of digits to the right of
* the decimal point
* @return formatted Strings
*/
nfs(nums: any[], left?: number, right?: number): string[];
/**
* The split() function maps to String.split(), it
* breaks a String into pieces using a character or
* string as the delimiter. The delim parameter
* specifies the character or characters that mark
* the boundaries between each piece. A String[]
* array is returned that contains each of the
* pieces. The splitTokens() function works in a
* similar fashion, except that it splits using a
* range of characters instead of a specific
* character or sequence.
* @param value the String to be split
* @param delim the String used to separate the data
* @return Array of Strings
*/
split(
value: string,
delim: string
): string[];
/**
* The split() function maps to String.split(), it
* breaks a String into pieces using a character or
* string as the delimiter. The delim parameter
* specifies the character or characters that mark
* the boundaries between each piece. A String[]
* array is returned that contains each of the
* pieces. The splitTokens() function works in a
* similar fashion, except that it splits using a
* range of characters instead of a specific
* character or sequence.
* @param value the String to be split
* @param delim the String used to separate the data
* @return Array of Strings
*/
split(value: string, delim: string): string[];
/**
* The splitTokens() function splits a String at one
* or many character delimiters or "tokens." The
* delim parameter specifies the character or
* characters to be used as a boundary. If no delim
* characters are specified, any whitespace character
* is used to split. Whitespace characters include
* tab (\t), line feed (\n), carriage return (\r),
* form feed (\f), and space.
* @param value the String to be split
* @param [delim] list of individual Strings that
* will be used as separators
* @return Array of Strings
*/
splitTokens(
value: string,
delim?: string
): string[];
/**
* The splitTokens() function splits a String at one
* or many character delimiters or "tokens." The
* delim parameter specifies the character or
* characters to be used as a boundary. If no delim
* characters are specified, any whitespace character
* is used to split. Whitespace characters include
* tab (\t), line feed (\n), carriage return (\r),
* form feed (\f), and space.
* @param value the String to be split
* @param [delim] list of individual Strings that
* will be used as separators
* @return Array of Strings
*/
splitTokens(value: string, delim?: string): string[];
/**
* Removes whitespace characters from the beginning
* and end of a String. In addition to standard
* whitespace characters such as space, carriage
* return, and tab, this function also removes the
* Unicode "nbsp" character.
* @param str a String to be trimmed
* @return a trimmed String
*/
trim(
str: string
): string;
/**
* Removes whitespace characters from the beginning
* and end of a String. In addition to standard
* whitespace characters such as space, carriage
* return, and tab, this function also removes the
* Unicode "nbsp" character.
* @param str a String to be trimmed
* @return a trimmed String
*/
trim(str: string): string;
/**
* Removes whitespace characters from the beginning
* and end of a String. In addition to standard
* whitespace characters such as space, carriage
* return, and tab, this function also removes the
* Unicode "nbsp" character.
* @param strs an Array of Strings to be trimmed
* @return an Array of trimmed Strings
*/
trim(
strs: any[]
): string[];
}
/**
* Removes whitespace characters from the beginning
* and end of a String. In addition to standard
* whitespace characters such as space, carriage
* return, and tab, this function also removes the
* Unicode "nbsp" character.
* @param strs an Array of Strings to be trimmed
* @return an Array of trimmed Strings
*/
trim(strs: any[]): string[];
}
}
types/p5/src/utilities/time_date.d.ts
Vendored
+55 -55
View File
@@ -1,65 +1,65 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* p5.js communicates with the clock on your
* computer. The day() function returns the current
* day as a value from 1 - 31.
* @return the current day
*/
day(): number;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* p5.js communicates with the clock on your
* computer. The day() function returns the current
* day as a value from 1 - 31.
* @return the current day
*/
day(): number;
/**
* p5.js communicates with the clock on your
* computer. The hour() function returns the current
* hour as a value from 0 - 23.
* @return the current hour
*/
hour(): number;
/**
* p5.js communicates with the clock on your
* computer. The hour() function returns the current
* hour as a value from 0 - 23.
* @return the current hour
*/
hour(): number;
/**
* p5.js communicates with the clock on your
* computer. The minute() function returns the
* current minute as a value from 0 - 59.
* @return the current minute
*/
minute(): number;
/**
* p5.js communicates with the clock on your
* computer. The minute() function returns the
* current minute as a value from 0 - 59.
* @return the current minute
*/
minute(): number;
/**
* Returns the number of milliseconds (thousandths of
* a second) since starting the program. This
* information is often used for timing events and
* animation sequences.
* @return the number of milliseconds since starting
* the program
*/
millis(): number;
/**
* Returns the number of milliseconds (thousandths of
* a second) since starting the program. This
* information is often used for timing events and
* animation sequences.
* @return the number of milliseconds since starting
* the program
*/
millis(): number;
/**
* p5.js communicates with the clock on your
* computer. The month() function returns the current
* month as a value from 1 - 12.
* @return the current month
*/
month(): number;
/**
* p5.js communicates with the clock on your
* computer. The month() function returns the current
* month as a value from 1 - 12.
* @return the current month
*/
month(): number;
/**
* p5.js communicates with the clock on your
* computer. The second() function returns the
* current second as a value from 0 - 59.
* @return the current second
*/
second(): number;
/**
* p5.js communicates with the clock on your
* computer. The second() function returns the
* current second as a value from 0 - 59.
* @return the current second
*/
second(): number;
/**
* p5.js communicates with the clock on your
* computer. The year() function returns the current
* year as an integer (2014, 2015, 2016, etc).
* @return the current year
*/
year(): number;
}
/**
* p5.js communicates with the clock on your
* computer. The year() function returns the current
* year as an integer (2014, 2015, 2016, etc).
* @return the current year
*/
year(): number;
}
}
types/p5/src/webgl/3d_primitives.d.ts
Vendored
+101 -133
View File
@@ -1,143 +1,111 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Draw a plane with given a width and height
* @param [width] width of the plane
* @param [height] height of the plane
* @param [detailX] Optional number of triangle
* subdivisions in x-dimension
* @param [detailY] Optional number of triangle
* subdivisions in y-dimension
* @chainable
*/
plane(
width?: number,
height?: number,
detailX?: number,
detailY?: number
): p5;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Draw a plane with given a width and height
* @param [width] width of the plane
* @param [height] height of the plane
* @param [detailX] Optional number of triangle
* subdivisions in x-dimension
* @param [detailY] Optional number of triangle
* subdivisions in y-dimension
* @chainable
*/
plane(width?: number, height?: number, detailX?: number, detailY?: number): p5;
/**
* Draw a box with given width, height and depth
* @param [width] width of the box
* @param [Height] height of the box
* @param [depth] depth of the box
* @param [detailX] Optional number of triangle
* subdivisions in x-dimension
* @param [detailY] Optional number of triangle
* subdivisions in y-dimension
* @chainable
*/
box(
width?: number,
Height?: number,
depth?: number,
detailX?: number,
detailY?: number
): p5;
/**
* Draw a box with given width, height and depth
* @param [width] width of the box
* @param [Height] height of the box
* @param [depth] depth of the box
* @param [detailX] Optional number of triangle
* subdivisions in x-dimension
* @param [detailY] Optional number of triangle
* subdivisions in y-dimension
* @chainable
*/
box(width?: number, Height?: number, depth?: number, detailX?: number, detailY?: number): p5;
/**
* Draw a sphere with given radius
* @param [radius] radius of circle
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 16
* @chainable
*/
sphere(
radius?: number,
detailX?: number,
detailY?: number
): p5;
/**
* Draw a sphere with given radius
* @param [radius] radius of circle
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 16
* @chainable
*/
sphere(radius?: number, detailX?: number, detailY?: number): p5;
/**
* Draw a cylinder with given radius and height
* @param [radius] radius of the surface
* @param [height] height of the cylinder
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments in
* y-dimension, the more segments the smoother
* geometry default is 1
* @param [bottomCap] whether to draw the bottom of
* the cylinder
* @param [topCap] whether to draw the top of the
* cylinder
* @chainable
*/
cylinder(
radius?: number,
height?: number,
detailX?: number,
detailY?: number,
bottomCap?: boolean,
topCap?: boolean
): p5;
/**
* Draw a cylinder with given radius and height
* @param [radius] radius of the surface
* @param [height] height of the cylinder
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments in
* y-dimension, the more segments the smoother
* geometry default is 1
* @param [bottomCap] whether to draw the bottom of
* the cylinder
* @param [topCap] whether to draw the top of the
* cylinder
* @chainable
*/
cylinder(
radius?: number,
height?: number,
detailX?: number,
detailY?: number,
bottomCap?: boolean,
topCap?: boolean
): p5;
/**
* Draw a cone with given radius and height
* @param [radius] radius of the bottom surface
* @param [height] height of the cone
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 1
* @param [cap] whether to draw the base of the cone
* @chainable
*/
cone(
radius?: number,
height?: number,
detailX?: number,
detailY?: number,
cap?: boolean
): p5;
/**
* Draw a cone with given radius and height
* @param [radius] radius of the bottom surface
* @param [height] height of the cone
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 1
* @param [cap] whether to draw the base of the cone
* @chainable
*/
cone(radius?: number, height?: number, detailX?: number, detailY?: number, cap?: boolean): p5;
/**
* Draw an ellipsoid with given radius
* @param [radiusx] xradius of circle
* @param [radiusy] yradius of circle
* @param [radiusz] zradius of circle
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24.
* Avoid detail number above 150, it may crash the
* browser.
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 16.
* Avoid detail number above 150, it may crash the
* browser.
* @chainable
*/
ellipsoid(
radiusx?: number,
radiusy?: number,
radiusz?: number,
detailX?: number,
detailY?: number
): p5;
/**
* Draw an ellipsoid with given radius
* @param [radiusx] x-radius of ellipsoid
* @param [radiusy] y-radius of ellipsoid
* @param [radiusz] z-radius of ellipsoid
* @param [detailX] number of segments, the more
* segments the smoother geometry default is 24.
* Avoid detail number above 150, it may crash the
* browser.
* @param [detailY] number of segments, the more
* segments the smoother geometry default is 16.
* Avoid detail number above 150, it may crash the
* browser.
* @chainable
*/
ellipsoid(radiusx?: number, radiusy?: number, radiusz?: number, detailX?: number, detailY?: number): p5;
/**
* Draw a torus with given radius and tube radius
* @param [radius] radius of the whole ring
* @param [tubeRadius] radius of the tube
* @param [detailX] number of segments in
* x-dimension, the more segments the smoother
* geometry default is 24
* @param [detailY] number of segments in
* y-dimension, the more segments the smoother
* geometry default is 16
* @chainable
*/
torus(
radius?: number,
tubeRadius?: number,
detailX?: number,
detailY?: number
): p5;
}
/**
* Draw a torus with given radius and tube radius
* @param [radius] radius of the whole ring
* @param [tubeRadius] radius of the tube
* @param [detailX] number of segments in
* x-dimension, the more segments the smoother
* geometry default is 24
* @param [detailY] number of segments in
* y-dimension, the more segments the smoother
* geometry default is 16
* @chainable
*/
torus(radius?: number, tubeRadius?: number, detailX?: number, detailY?: number): p5;
}
}
types/p5/src/webgl/interaction.d.ts
Vendored
+179 -190
View File
@@ -1,200 +1,189 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Allows movement around a 3D sketch using a mouse
* or trackpad. Left-clicking and dragging will
* rotate the camera position about the center of the
* sketch, right-clicking and dragging will pan the
* camera position without rotation, and using the
* mouse wheel (scrolling) will move the camera
* closer or further from the center of the sketch.
* This function can be called with parameters
* dictating sensitivity to mouse movement along the
* X and Y axes. Calling this function without
* parameters is equivalent to calling
* orbitControl(1,1). To reverse direction of
* movement in either axis, enter a negative number
* for sensitivity.
* @param [sensitivityX] sensitivity to mouse
* movement along X axis
* @param [sensitivityY] sensitivity to mouse
* movement along Y axis
* @chainable
*/
orbitControl(
sensitivityX?: number,
sensitivityY?: number
): p5;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Allows movement around a 3D sketch using a mouse
* or trackpad. Left-clicking and dragging will
* rotate the camera position about the center of the
* sketch, right-clicking and dragging will pan the
* camera position without rotation, and using the
* mouse wheel (scrolling) will move the camera
* closer or further from the center of the sketch.
* This function can be called with parameters
* dictating sensitivity to mouse movement along the
* X and Y axes. Calling this function without
* parameters is equivalent to calling
* orbitControl(1,1). To reverse direction of
* movement in either axis, enter a negative number
* for sensitivity.
* @param [sensitivityX] sensitivity to mouse
* movement along X axis
* @param [sensitivityY] sensitivity to mouse
* movement along Y axis
* @chainable
*/
orbitControl(sensitivityX?: number, sensitivityY?: number): p5;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
*/
debugMode(): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
*/
debugMode(): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
*/
debugMode(
mode: DEBUG_MODE
): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
*/
debugMode(mode: DEBUG_MODE): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
* @param [gridSize] size of one side of the grid
* @param [gridDivisions] number of divisions in the
* grid
* @param [xOff] X axis offset from origin (0,0,0)
* @param [yOff] Y axis offset from origin (0,0,0)
* @param [zOff] Z axis offset from origin (0,0,0)
*/
debugMode(
mode: UNKNOWN_P5_CONSTANT,
gridSize?: number,
gridDivisions?: number,
xOff?: number,
yOff?: number,
zOff?: number
): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
* @param [gridSize] size of one side of the grid
* @param [gridDivisions] number of divisions in the
* grid
* @param [xOff] X axis offset from origin (0,0,0)
* @param [yOff] Y axis offset from origin (0,0,0)
* @param [zOff] Z axis offset from origin (0,0,0)
*/
debugMode(
mode: UNKNOWN_P5_CONSTANT,
gridSize?: number,
gridDivisions?: number,
xOff?: number,
yOff?: number,
zOff?: number
): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
* @param [axesSize] size of axes icon
* @param [xOff] X axis offset from origin (0,0,0)
* @param [yOff] Y axis offset from origin (0,0,0)
* @param [zOff] Z axis offset from origin (0,0,0)
*/
debugMode(
mode: UNKNOWN_P5_CONSTANT,
axesSize?: number,
xOff?: number,
yOff?: number,
zOff?: number
): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param mode either GRID or AXES
* @param [axesSize] size of axes icon
* @param [xOff] X axis offset from origin (0,0,0)
* @param [yOff] Y axis offset from origin (0,0,0)
* @param [zOff] Z axis offset from origin (0,0,0)
*/
debugMode(mode: UNKNOWN_P5_CONSTANT, axesSize?: number, xOff?: number, yOff?: number, zOff?: number): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param [gridSize] size of one side of the grid
* @param [gridDivisions] number of divisions in the
* grid
* @param [axesSize] size of axes icon
*/
debugMode(
gridSize?: number,
gridDivisions?: number,
gridXOff?: number,
gridYOff?: number,
gridZOff?: number,
axesSize?: number,
axesXOff?: number,
axesYOff?: number,
axesZOff?: number
): void;
/**
* debugMode() helps visualize 3D space by adding a
* grid to indicate where the ‘ground’ is in a sketch
* and an axes icon which indicates the +X, +Y, and
* +Z directions. This function can be called without
* parameters to create a default grid and axes icon,
* or it can be called according to the examples
* above to customize the size and position of the
* grid and/or axes icon. The grid is drawn using the
* most recently set stroke color and weight. To
* specify these parameters, add a call to stroke()
* and strokeWeight() just before the end of the
* draw() loop. By default, the grid will run through
* the origin (0,0,0) of the sketch along the XZ
* plane and the axes icon will be offset from the
* origin. Both the grid and axes icon will be sized
* according to the current canvas size. Note that
* because the grid runs parallel to the default
* camera view, it is often helpful to use debugMode
* along with orbitControl to allow full view of the
* grid.
* @param [gridSize] size of one side of the grid
* @param [gridDivisions] number of divisions in the
* grid
* @param [axesSize] size of axes icon
*/
debugMode(
gridSize?: number,
gridDivisions?: number,
gridXOff?: number,
gridYOff?: number,
gridZOff?: number,
axesSize?: number,
axesXOff?: number,
axesYOff?: number,
axesZOff?: number
): void;
/**
* Turns off debugMode() in a 3D sketch.
*/
noDebugMode(): void;
}
/**
* Turns off debugMode() in a 3D sketch.
*/
noDebugMode(): void;
}
}
types/p5/src/webgl/light.d.ts
Vendored
+163 -196
View File
@@ -1,212 +1,179 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Creates an ambient light with a color
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
* @param [alpha] the alpha value
* @chainable
*/
ambientLight(
v1: number,
v2: number,
v3: number,
alpha?: number
): p5;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Creates an ambient light with a color
* @param v1 red or hue value relative to the current
* color range
* @param v2 green or saturation value relative to
* the current color range
* @param v3 blue or brightness value relative to the
* current color range
* @param [alpha] the alpha value
* @chainable
*/
ambientLight(v1: number, v2: number, v3: number, alpha?: number): p5;
/**
* Creates an ambient light with a color
* @param value a color string
* @chainable
*/
ambientLight(
value: string
): p5;
/**
* Creates an ambient light with a color
* @param value a color string
* @chainable
*/
ambientLight(value: string): p5;
/**
* Creates an ambient light with a color
* @param gray a gray value
* @param [alpha] the alpha value
* @chainable
*/
ambientLight(
gray: number,
alpha?: number
): p5;
/**
* Creates an ambient light with a color
* @param gray a gray value
* @param [alpha] the alpha value
* @chainable
*/
ambientLight(gray: number, alpha?: number): p5;
/**
* Creates an ambient light with a color
* @param values an array containing the
* red,green,blue & and alpha components of the color
* @chainable
*/
ambientLight(
values: number[]
): p5;
/**
* Creates an ambient light with a color
* @param values an array containing the
* red,green,blue & and alpha components of the color
* @chainable
*/
ambientLight(values: number[]): p5;
/**
* Creates an ambient light with a color
* @param color the ambient light color
* @chainable
*/
ambientLight(
color: Color
): p5;
/**
* Creates an ambient light with a color
* @param color the ambient light color
* @chainable
*/
ambientLight(color: Color): p5;
/**
* Creates a directional light with a color and a
* direction
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param position the direction of the light
* @chainable
*/
directionalLight(
v1: number,
v2: number,
v3: number,
position: Vector
): p5;
/**
* Creates a directional light with a color and a
* direction
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param position the direction of the light
* @chainable
*/
directionalLight(v1: number, v2: number, v3: number, position: Vector): p5;
/**
* Creates a directional light with a color and a
* direction
* @param color color Array, CSS color string, or
* p5.Color value
* @param x x axis direction
* @param y y axis direction
* @param z z axis direction
* @chainable
*/
directionalLight(
color:
| number[]
| string
| Color,
x: number,
y: number,
z: number
): p5;
/**
* Creates a directional light with a color and a
* direction
* @param color color Array, CSS color string, or
* p5.Color value
* @param x x axis direction
* @param y y axis direction
* @param z z axis direction
* @chainable
*/
directionalLight(color: number[] | string | Color, x: number, y: number, z: number): p5;
/**
* Creates a directional light with a color and a
* direction
* @param color color Array, CSS color string, or
* p5.Color value
* @param position the direction of the light
* @chainable
*/
directionalLight(
color:
| number[]
| string
| Color,
position: Vector
): p5;
/**
* Creates a directional light with a color and a
* direction
* @param color color Array, CSS color string, or
* p5.Color value
* @param position the direction of the light
* @chainable
*/
directionalLight(color: number[] | string | Color, position: Vector): p5;
/**
* Creates a directional light with a color and a
* direction
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param x x axis direction
* @param y y axis direction
* @param z z axis direction
* @chainable
*/
directionalLight(
v1: number,
v2: number,
v3: number,
x: number,
y: number,
z: number
): p5;
/**
* Creates a directional light with a color and a
* direction
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param x x axis direction
* @param y y axis direction
* @param z z axis direction
* @chainable
*/
directionalLight(v1: number, v2: number, v3: number, x: number, y: number, z: number): p5;
/**
* Creates a point light with a color and a light
* position
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param x x axis position
* @param y y axis position
* @param z z axis position
* @chainable
*/
pointLight(
v1: number,
v2: number,
v3: number,
x: number,
y: number,
z: number
): p5;
/**
* Creates a point light with a color and a light
* position
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param x x axis position
* @param y y axis position
* @param z z axis position
* @chainable
*/
pointLight(v1: number, v2: number, v3: number, x: number, y: number, z: number): p5;
/**
* Creates a point light with a color and a light
* position
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param position the position of the light
* @chainable
*/
pointLight(
v1: number,
v2: number,
v3: number,
position: Vector
): p5;
/**
* Creates a point light with a color and a light
* position
* @param v1 red or hue value (depending on the
* current color mode),
* @param v2 green or saturation value
* @param v3 blue or brightness value
* @param position the position of the light
* @chainable
*/
pointLight(v1: number, v2: number, v3: number, position: Vector): p5;
/**
* Creates a point light with a color and a light
* position
* @param color color Array, CSS color string, or
* p5.Color value
* @param x x axis position
* @param y y axis position
* @param z z axis position
* @chainable
*/
pointLight(
color:
| number[]
| string
| Color,
x: number,
y: number,
z: number
): p5;
/**
* Creates a point light with a color and a light
* position
* @param color color Array, CSS color string, or
* p5.Color value
* @param x x axis position
* @param y y axis position
* @param z z axis position
* @chainable
*/
pointLight(color: number[] | string | Color, x: number, y: number, z: number): p5;
/**
* Creates a point light with a color and a light
* position
* @param color color Array, CSS color string, or
* p5.Color value
* @param position the position of the light
* @chainable
*/
pointLight(
color:
| number[]
| string
| Color,
position: Vector
): p5;
}
/**
* Creates a point light with a color and a light
* position
* @param color color Array, CSS color string, or
* p5.Color value
* @param position the position of the light
* @chainable
*/
pointLight(color: number[] | string | Color, position: Vector): p5;
/**
* Sets the default ambient and directional light.
* The defaults are ambientLight(128, 128, 128) and
* directionalLight(128, 128, 128, 0, 0, -1). Lights
* need to be included in the draw() to remain
* persistent in a looping program. Placing them in
* the setup() of a looping program will cause them
* to only have an effect the first time through the
* loop.
* @chainable
*/
lights(): p5;
/**
* Sets the falloff rates for point lights. It
* affects only the elements which are created after
* it in the code. The default value is
* lightFalloff(1.0, 0.0, 0.0), and the parameters
* are used to calculate the falloff with the
* following equation: d = distance from light
* position to vertex position
*
* falloff = 1 / (CONSTANT + d * LINEAR + ( d * d ) *
* QUADRATIC)
* @param constant constant value for determining
* falloff
* @param linear linear value for determining falloff
* @param quadratic quadratic value for determining
* falloff
* @chainable
*/
lightFalloff(constant: number, linear: number, quadratic: number): p5;
}
}
types/p5/src/webgl/loading.d.ts
Vendored
+68 -70
View File
@@ -1,76 +1,74 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Load a 3d model from an OBJ file. One of the
* limitations of the OBJ format is that it doesn't
* have a built-in sense of scale. This means that
* models exported from different programs might be
* very different sizes. If your model isn't
* displaying, try calling loadModel() with the
* normalized parameter set to true. This will resize
* the model to a scale appropriate for p5. You can
* also make additional changes to the final size of
* your model with the scale() function.
* @param path Path of the model to be loaded
* @param normalize If true, scale the model to a
* standardized size when loading
* @param [successCallback] Function to be called
* once the model is loaded. Will be passed the 3D
* model object.
* @param [failureCallback] called with event error
* if the image fails to load.
* @return the p5.Geometry object
*/
loadModel(
path: string,
normalize: boolean,
successCallback?: (
p1: Geometry
) => any,
failureCallback?: (
p1: Event
) => any
): Geometry;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Load a 3d model from an OBJ or STL file. One of
* the limitations of the OBJ and STL format is that
* it doesn't have a built-in sense of scale. This
* means that models exported from different programs
* might be very different sizes. If your model isn't
* displaying, try calling loadModel() with the
* normalized parameter set to true. This will resize
* the model to a scale appropriate for p5. You can
* also make additional changes to the final size of
* your model with the scale() function.
*
* Also, the support for colored STL files is not
* present. STL files with color will be rendered
* without color properties.
* @param path Path of the model to be loaded
* @param normalize If true, scale the model to a
* standardized size when loading
* @param [successCallback] Function to be called
* once the model is loaded. Will be passed the 3D
* model object.
* @param [failureCallback] called with event error
* if the model fails to load.
* @return the p5.Geometry object
*/
loadModel(
path: string,
normalize: boolean,
successCallback?: (p1: Geometry) => any,
failureCallback?: (p1: Event) => any
): Geometry;
/**
* Load a 3d model from an OBJ file. One of the
* limitations of the OBJ format is that it doesn't
* have a built-in sense of scale. This means that
* models exported from different programs might be
* very different sizes. If your model isn't
* displaying, try calling loadModel() with the
* normalized parameter set to true. This will resize
* the model to a scale appropriate for p5. You can
* also make additional changes to the final size of
* your model with the scale() function.
* @param path Path of the model to be loaded
* @param [successCallback] Function to be called
* once the model is loaded. Will be passed the 3D
* model object.
* @param [failureCallback] called with event error
* if the image fails to load.
* @return the p5.Geometry object
*/
loadModel(
path: string,
successCallback?: (
p1: Geometry
) => any,
failureCallback?: (
p1: Event
) => any
): Geometry;
/**
* Load a 3d model from an OBJ or STL file. One of
* the limitations of the OBJ and STL format is that
* it doesn't have a built-in sense of scale. This
* means that models exported from different programs
* might be very different sizes. If your model isn't
* displaying, try calling loadModel() with the
* normalized parameter set to true. This will resize
* the model to a scale appropriate for p5. You can
* also make additional changes to the final size of
* your model with the scale() function.
*
* Also, the support for colored STL files is not
* present. STL files with color will be rendered
* without color properties.
* @param path Path of the model to be loaded
* @param [successCallback] Function to be called
* once the model is loaded. Will be passed the 3D
* model object.
* @param [failureCallback] called with event error
* if the model fails to load.
* @return the p5.Geometry object
*/
loadModel(
path: string,
successCallback?: (p1: Geometry) => any,
failureCallback?: (p1: Event) => any
): Geometry;
/**
* Render a 3d model to the screen.
* @param model Loaded 3d model to be rendered
*/
model(
model: Geometry
): void;
}
/**
* Render a 3d model to the screen.
* @param model Loaded 3d model to be rendered
*/
model(model: Geometry): void;
}
}
types/p5/src/webgl/material.d.ts
Vendored
+157 -136
View File
@@ -1,148 +1,169 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Loads a custom shader from the provided vertex and
* fragment shader paths. The shader files are loaded
* asynchronously in the background, so this method
* should be used in preload(). For now, there are
* three main types of shaders. p5 will automatically
* supply appropriate vertices, normals, colors, and
* lighting attributes if the parameters defined in
* the shader match the names.
* @param [vertFilename] path to file containing
* vertex shader source code
* @param [fragFilename] path to file containing
* fragment shader source code
* @return a shader object created from the provided
* vertex and fragment shader files.
*/
loadShader(
vertFilename?: string,
fragFilename?: string
): Shader;
createShader(
vertSrc: string,
fragSrc: string
): Shader;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Loads a custom shader from the provided vertex and
* fragment shader paths. The shader files are loaded
* asynchronously in the background, so this method
* should be used in preload(). For now, there are
* three main types of shaders. p5 will automatically
* supply appropriate vertices, normals, colors, and
* lighting attributes if the parameters defined in
* the shader match the names.
* @param vertFilename path to file containing vertex
* shader source code
* @param fragFilename path to file containing
* fragment shader source code
* @param [callback] callback to be executed after
* loadShader completes. On success, the Shader
* object is passed as the first argument.
* @param [errorCallback] callback to be executed
* when an error occurs inside loadShader. On error,
* the error is passed as the first argument.
* @return a shader object created from the provided
* vertex and fragment shader files.
*/
loadShader(
vertFilename: string,
fragFilename: string,
callback?: (...args: any[]) => any,
errorCallback?: (...args: any[]) => any
): Shader;
createShader(vertSrc: string, fragSrc: string): Shader;
/**
* The shader() function lets the user provide a
* custom shader to fill in shapes in WEBGL mode.
* Users can create their own shaders by loading
* vertex and fragment shaders with loadShader().
* @param [s] the desired p5.Shader to use for
* rendering shapes.
* @chainable
*/
shader(
s?: Shader
): p5;
/**
* The shader() function lets the user provide a
* custom shader to fill in shapes in WEBGL mode.
* Users can create their own shaders by loading
* vertex and fragment shaders with loadShader().
* @param [s] the desired p5.Shader to use for
* rendering shapes.
* @chainable
*/
shader(s?: Shader): p5;
/**
* Normal material for geometry. You can view all
* possible materials in this example.
* @chainable
*/
normalMaterial(): p5;
/**
* This function restores the default shaders in
* WEBGL mode. Code that runs after resetShader()
* will not be affected by previously defined
* shaders. Should be run after shader().
* @chainable
*/
resetShader(): p5;
/**
* Texture for geometry. You can view other possible
* materials in this example.
* @param tex 2-dimensional graphics to render as
* texture
* @chainable
*/
texture(
tex:
| Image
| MediaElement
| Graphics
): p5;
/**
* Normal material for geometry. You can view all
* possible materials in this example.
* @chainable
*/
normalMaterial(): p5;
/**
* Sets the coordinate space for texture mapping. The
* default mode is IMAGE which refers to the actual
* coordinates of the image. NORMAL refers to a
* normalized space of values ranging from 0 to 1.
* This function only works in WEBGL mode. With
* IMAGE, if an image is 100 x 200 pixels, mapping
* the image onto the entire size of a quad would
* require the points (0,0) (100, 0) (100,200)
* (0,200). The same mapping in NORMAL is (0,0) (1,0)
* (1,1) (0,1).
* @param mode either IMAGE or NORMAL
*/
textureMode(
mode: TEXTURE_MODE
): void;
/**
* Texture for geometry. You can view other possible
* materials in this example.
* @param tex 2-dimensional graphics to render as
* texture
* @chainable
*/
texture(tex: Image | MediaElement | Graphics): p5;
/**
* Ambient material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param v1 gray value, red or hue value (depending
* on the current color mode),
* @param [v2] green or saturation value
* @param [v3] blue or brightness value
* @param [a] opacity
* @chainable
*/
ambientMaterial(
v1: number,
v2?: number,
v3?: number,
a?: number
): p5;
/**
* Sets the coordinate space for texture mapping. The
* default mode is IMAGE which refers to the actual
* coordinates of the image. NORMAL refers to a
* normalized space of values ranging from 0 to 1.
* This function only works in WEBGL mode. With
* IMAGE, if an image is 100 x 200 pixels, mapping
* the image onto the entire size of a quad would
* require the points (0,0) (100, 0) (100,200)
* (0,200). The same mapping in NORMAL is (0,0) (1,0)
* (1,1) (0,1).
* @param mode either IMAGE or NORMAL
*/
textureMode(mode: TEXTURE_MODE): void;
/**
* Ambient material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param color color, color Array, or CSS color
* string
* @chainable
*/
ambientMaterial(
color:
| number[]
| string
| Color
): p5;
/**
* Sets the global texture wrapping mode. This
* controls how textures behave when their uv's go
* outside of the 0 - 1 range. There are three
* options: CLAMP, REPEAT, and MIRROR. CLAMP causes
* the pixels at the edge of the texture to extend to
* the bounds REPEAT causes the texture to tile
* repeatedly until reaching the bounds MIRROR works
* similarly to REPEAT but it flips the texture with
* every new tile
*
* REPEAT & MIRROR are only available if the texture
* is a power of two size (128, 256, 512, 1024,
* etc.).
*
* This method will affect all textures in your
* sketch until a subsequent textureWrap call is
* made.
*
* If only one argument is provided, it will be
* applied to both the horizontal and vertical axes.
* @param wrapX either CLAMP, REPEAT, or MIRROR
* @param [wrapY] either CLAMP, REPEAT, or MIRROR
*/
textureWrap(wrapX: WRAP_X, wrapY?: WRAP_Y): void;
/**
* Specular material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param v1 gray value, red or hue value (depending
* on the current color mode),
* @param [v2] green or saturation value
* @param [v3] blue or brightness value
* @param [a] opacity
* @chainable
*/
specularMaterial(
v1: number,
v2?: number,
v3?: number,
a?: number
): p5;
/**
* Ambient material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param v1 gray value, red or hue value (depending
* on the current color mode),
* @param [v2] green or saturation value
* @param [v3] blue or brightness value
* @param [a] opacity
* @chainable
*/
ambientMaterial(v1: number, v2?: number, v3?: number, a?: number): p5;
/**
* Specular material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param color color Array, or CSS color string
* @chainable
*/
specularMaterial(
color:
| number[]
| string
| Color
): p5;
}
/**
* Ambient material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param color color, color Array, or CSS color
* string
* @chainable
*/
ambientMaterial(color: number[] | string | Color): p5;
/**
* Specular material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param v1 gray value, red or hue value (depending
* on the current color mode),
* @param [v2] green or saturation value
* @param [v3] blue or brightness value
* @param [a] opacity
* @chainable
*/
specularMaterial(v1: number, v2?: number, v3?: number, a?: number): p5;
/**
* Specular material for geometry with a given color.
* You can view all possible materials in this
* example.
* @param color color Array, or CSS color string
* @chainable
*/
specularMaterial(color: number[] | string | Color): p5;
/**
* Sets the amount of gloss in the surface of shapes.
* Used in combination with specularMaterial() in
* setting the material properties of shapes. The
* default and minimum value is 1.
* @param shine Degree of Shininess. Defaults to 1.
* @chainable
*/
shininess(shine: number): p5;
}
}
types/p5/src/webgl/p5.Camera.d.ts
Vendored
+163 -193
View File
@@ -1,208 +1,178 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Camera {
/**
* Sets a perspective projection for a p5.Camera
* object and sets parameters for that projection
* according to perspective() syntax.
*/
perspective(): void;
declare module '../../index' {
class Camera {
/**
* Sets a perspective projection for a p5.Camera
* object and sets parameters for that projection
* according to perspective() syntax.
*/
perspective(): void;
/**
* Sets an orthographic projection for a p5.Camera
* object and sets parameters for that projection
* according to ortho() syntax.
*/
ortho(): void;
/**
* Sets an orthographic projection for a p5.Camera
* object and sets parameters for that projection
* according to ortho() syntax.
*/
ortho(): void;
/**
* Panning rotates the camera view to the left and
* right.
* @param angle amount to rotate camera in current
* angleMode units. Greater than 0 values rotate
* counterclockwise (to the left).
*/
pan(
angle: number
): void;
/**
* Panning rotates the camera view to the left and
* right.
* @param angle amount to rotate camera in current
* angleMode units. Greater than 0 values rotate
* counterclockwise (to the left).
*/
pan(angle: number): void;
/**
* Tilting rotates the camera view up and down.
* @param angle amount to rotate camera in current
* angleMode units. Greater than 0 values rotate
* counterclockwise (to the left).
*/
tilt(
angle: number
): void;
/**
* Tilting rotates the camera view up and down.
* @param angle amount to rotate camera in current
* angleMode units. Greater than 0 values rotate
* counterclockwise (to the left).
*/
tilt(angle: number): void;
/**
* Reorients the camera to look at a position in
* world space.
* @param x x position of a point in world space
* @param y y position of a point in world space
* @param z z position of a point in world space
*/
lookAt(
x: number,
y: number,
z: number
): void;
/**
* Reorients the camera to look at a position in
* world space.
* @param x x position of a point in world space
* @param y y position of a point in world space
* @param z z position of a point in world space
*/
lookAt(x: number, y: number, z: number): void;
/**
* Sets a camera's position and orientation. This is
* equivalent to calling camera() on a p5.Camera
* object.
*/
camera(): void;
/**
* Sets a camera's position and orientation. This is
* equivalent to calling camera() on a p5.Camera
* object.
*/
camera(): void;
/**
* Move camera along its local axes while maintaining
* current camera orientation.
* @param x amount to move along camera's left-right
* axis
* @param y amount to move along camera's up-down
* axis
* @param z amount to move along camera's
* forward-backward axis
*/
move(
x: number,
y: number,
z: number
): void;
/**
* Move camera along its local axes while maintaining
* current camera orientation.
* @param x amount to move along camera's left-right
* axis
* @param y amount to move along camera's up-down
* axis
* @param z amount to move along camera's
* forward-backward axis
*/
move(x: number, y: number, z: number): void;
/**
* Set camera position in world-space while
* maintaining current camera orientation.
* @param x x position of a point in world space
* @param y y position of a point in world space
* @param z z position of a point in world space
*/
setPosition(
x: number,
y: number,
z: number
): void;
}
interface p5InstanceExtensions {
/**
* Sets the camera position for a 3D sketch.
* Parameters for this function define the position
* for the camera, the center of the sketch (where
* the camera is pointing), and an up direction (the
* orientation of the camera). When called with no
* arguments, this function creates a default camera
* equivalent to camera(0, 0, (height/2.0) /
* tan(PI*30.0 / 180.0), 0, 0, 0, 0, 1, 0);
* @param [x] camera position value on x axis
* @param [y] camera position value on y axis
* @param [z] camera position value on z axis
* @param [centerX] x coordinate representing center
* of the sketch
* @param [centerY] y coordinate representing center
* of the sketch
* @param [centerZ] z coordinate representing center
* of the sketch
* @param [upX] x component of direction 'up' from
* camera
* @param [upY] y component of direction 'up' from
* camera
* @param [upZ] z component of direction 'up' from
* camera
* @chainable
*/
camera(
x?: number,
y?: number,
z?: number,
centerX?: number,
centerY?: number,
centerZ?: number,
upX?: number,
upY?: number,
upZ?: number
): p5;
/**
* Set camera position in world-space while
* maintaining current camera orientation.
* @param x x position of a point in world space
* @param y y position of a point in world space
* @param z z position of a point in world space
*/
setPosition(x: number, y: number, z: number): void;
}
interface p5InstanceExtensions {
/**
* Sets the camera position for a 3D sketch.
* Parameters for this function define the position
* for the camera, the center of the sketch (where
* the camera is pointing), and an up direction (the
* orientation of the camera). When called with no
* arguments, this function creates a default camera
* equivalent to camera(0, 0, (height/2.0) /
* tan(PI*30.0 / 180.0), 0, 0, 0, 0, 1, 0);
* @param [x] camera position value on x axis
* @param [y] camera position value on y axis
* @param [z] camera position value on z axis
* @param [centerX] x coordinate representing center
* of the sketch
* @param [centerY] y coordinate representing center
* of the sketch
* @param [centerZ] z coordinate representing center
* of the sketch
* @param [upX] x component of direction 'up' from
* camera
* @param [upY] y component of direction 'up' from
* camera
* @param [upZ] z component of direction 'up' from
* camera
* @chainable
*/
camera(
x?: number,
y?: number,
z?: number,
centerX?: number,
centerY?: number,
centerZ?: number,
upX?: number,
upY?: number,
upZ?: number
): p5;
/**
* Sets a perspective projection for the camera in a
* 3D sketch. This projection represents depth
* through foreshortening: objects that are close to
* the camera appear their actual size while those
* that are further away from the camera appear
* smaller. The parameters to this function define
* the viewing frustum (the truncated pyramid within
* which objects are seen by the camera) through
* vertical field of view, aspect ratio (usually
* width/height), and near and far clipping planes.
* When called with no arguments, the defaults
* provided are equivalent to perspective(PI/3.0,
* width/height, eyeZ/10.0, eyeZ10.0), where eyeZ is
* equal to ((height/2.0) / tan(PI60.0/360.0));
* @param [fovy] camera frustum vertical field of
* view, from bottom to top of view, in angleMode
* units
* @param [aspect] camera frustum aspect ratio
* @param [near] frustum near plane length
* @param [far] frustum far plane length
* @chainable
*/
perspective(
fovy?: number,
aspect?: number,
near?: number,
far?: number
): p5;
/**
* Sets a perspective projection for the camera in a
* 3D sketch. This projection represents depth
* through foreshortening: objects that are close to
* the camera appear their actual size while those
* that are further away from the camera appear
* smaller. The parameters to this function define
* the viewing frustum (the truncated pyramid within
* which objects are seen by the camera) through
* vertical field of view, aspect ratio (usually
* width/height), and near and far clipping planes.
* When called with no arguments, the defaults
* provided are equivalent to perspective(PI/3.0,
* width/height, eyeZ/10.0, eyeZ10.0), where eyeZ is
* equal to ((height/2.0) / tan(PI60.0/360.0));
* @param [fovy] camera frustum vertical field of
* view, from bottom to top of view, in angleMode
* units
* @param [aspect] camera frustum aspect ratio
* @param [near] frustum near plane length
* @param [far] frustum far plane length
* @chainable
*/
perspective(fovy?: number, aspect?: number, near?: number, far?: number): p5;
/**
* Sets an orthographic projection for the camera in
* a 3D sketch and defines a box-shaped viewing
* frustum within which objects are seen. In this
* projection, all objects with the same dimension
* appear the same size, regardless of whether they
* are near or far from the camera. The parameters to
* this function specify the viewing frustum where
* left and right are the minimum and maximum x
* values, top and bottom are the minimum and maximum
* y values, and near and far are the minimum and
* maximum z values. If no parameters are given, the
* default is used: ortho(-width/2, width/2,
* -height/2, height/2).
* @param [left] camera frustum left plane
* @param [right] camera frustum right plane
* @param [bottom] camera frustum bottom plane
* @param [top] camera frustum top plane
* @param [near] camera frustum near plane
* @param [far] camera frustum far plane
* @chainable
*/
ortho(
left?: number,
right?: number,
bottom?: number,
top?: number,
near?: number,
far?: number
): p5;
/**
* Sets an orthographic projection for the camera in
* a 3D sketch and defines a box-shaped viewing
* frustum within which objects are seen. In this
* projection, all objects with the same dimension
* appear the same size, regardless of whether they
* are near or far from the camera. The parameters to
* this function specify the viewing frustum where
* left and right are the minimum and maximum x
* values, top and bottom are the minimum and maximum
* y values, and near and far are the minimum and
* maximum z values. If no parameters are given, the
* default is used: ortho(-width/2, width/2,
* -height/2, height/2).
* @param [left] camera frustum left plane
* @param [right] camera frustum right plane
* @param [bottom] camera frustum bottom plane
* @param [top] camera frustum top plane
* @param [near] camera frustum near plane
* @param [far] camera frustum far plane
* @chainable
*/
ortho(left?: number, right?: number, bottom?: number, top?: number, near?: number, far?: number): p5;
/**
* Creates a new p5.Camera object and tells the
* renderer to use that camera. Returns the p5.Camera
* object.
* @return The newly created camera object.
*/
createCamera(): Camera;
/**
* Creates a new p5.Camera object and tells the
* renderer to use that camera. Returns the p5.Camera
* object.
* @return The newly created camera object.
*/
createCamera(): Camera;
/**
* Sets rendererGL's current camera to a p5.Camera
* object. Allows switching between multiple cameras.
* @param cam p5.Camera object
*/
setCamera(
cam: Camera
): void;
}
/**
* Sets rendererGL's current camera to a p5.Camera
* object. Allows switching between multiple cameras.
* @param cam p5.Camera object
*/
setCamera(cam: Camera): void;
}
}
types/p5/src/webgl/p5.Geometry.d.ts
Vendored
+40 -46
View File
@@ -1,54 +1,48 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Geometry {
/**
* p5 Geometry class
*
* @param [detailX] number of vertices on horizontal
* surface
* @param [detailY] number of vertices on horizontal
* surface
* @param [callback] function to call upon object
* instantiation.
*/
constructor(
detailX?: number,
detailY?: number,
callback?: (
...args: any[]
) => any
);
computeFaces(): Geometry;
declare module '../../index' {
class Geometry {
/**
* p5 Geometry class
*
* @param [detailX] number of vertices on horizontal
* surface
* @param [detailY] number of vertices on horizontal
* surface
* @param [callback] function to call upon object
* instantiation.
*/
constructor(detailX?: number, detailY?: number, callback?: (...args: any[]) => any);
computeFaces(): Geometry;
/**
* computes smooth normals per vertex as an average
* of each face.
* @chainable
*/
computeNormals(): Geometry;
/**
* computes smooth normals per vertex as an average
* of each face.
* @chainable
*/
computeNormals(): Geometry;
/**
* Averages the vertex normals. Used in curved
* surfaces
* @chainable
*/
averageNormals(): Geometry;
/**
* Averages the vertex normals. Used in curved
* surfaces
* @chainable
*/
averageNormals(): Geometry;
/**
* Averages pole normals. Used in spherical
* primitives
* @chainable
*/
averagePoleNormals(): Geometry;
/**
* Averages pole normals. Used in spherical
* primitives
* @chainable
*/
averagePoleNormals(): Geometry;
/**
* Modifies all vertices to be centered within the
* range -100 to 100.
* @chainable
*/
normalize(): Geometry;
}
/**
* Modifies all vertices to be centered within the
* range -100 to 100.
* @chainable
*/
normalize(): Geometry;
}
}
types/p5/src/webgl/p5.RendererGL.d.ts
Vendored
+103 -88
View File
@@ -1,93 +1,108 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
interface p5InstanceExtensions {
/**
* Set attributes for the WebGL Drawing context. This
* is a way of adjusting ways that the WebGL renderer
* works to fine-tune the display and performance.
* This should be put in setup(). The available
* attributes are: alpha - indicates if the canvas
* contains an alpha buffer default is true
*
*
* depth - indicates whether the drawing buffer has a
* depth buffer of at least 16 bits - default is true
*
*
* stencil - indicates whether the drawing buffer has
* a stencil buffer of at least 8 bits
*
*
* antialias - indicates whether or not to perform
* anti-aliasing default is false
*
*
* premultipliedAlpha - indicates that the page
* compositor will assume the drawing buffer contains
* colors with pre-multiplied alpha default is false
*
*
* preserveDrawingBuffer - if true the buffers will
* not be cleared and and will preserve their values
* until cleared or overwritten by author (note that
* p5 clears automatically on draw loop) default is
* true
*
*
* perPixelLighting - if true, per-pixel lighting
* will be used in the lighting shader. default is
* false
* @param key Name of attribute
* @param value New value of named attribute
*/
setAttributes(
key: string,
value: boolean
): void;
declare module '../../index' {
interface p5InstanceExtensions {
/**
* Set attributes for the WebGL Drawing context. This
* is a way of adjusting how the WebGL renderer works
* to fine-tune the display and performance. Note
* that this will reinitialize the drawing context if
* called after the WebGL canvas is made.
*
*
* If an object is passed as the parameter, all
* attributes not declared in the object will be set
* to defaults.
*
*
* The available attributes are:
*
* alpha - indicates if the canvas contains an alpha
* buffer default is true
*
*
* depth - indicates whether the drawing buffer has a
* depth buffer of at least 16 bits - default is true
*
*
* stencil - indicates whether the drawing buffer has
* a stencil buffer of at least 8 bits
*
*
* antialias - indicates whether or not to perform
* anti-aliasing default is false
*
*
* premultipliedAlpha - indicates that the page
* compositor will assume the drawing buffer contains
* colors with pre-multiplied alpha default is false
*
*
* preserveDrawingBuffer - if true the buffers will
* not be cleared and and will preserve their values
* until cleared or overwritten by author (note that
* p5 clears automatically on draw loop) default is
* true
*
*
* perPixelLighting - if true, per-pixel lighting
* will be used in the lighting shader. default is
* false
* @param key Name of attribute
* @param value New value of named attribute
*/
setAttributes(key: string, value: boolean): void;
/**
* Set attributes for the WebGL Drawing context. This
* is a way of adjusting ways that the WebGL renderer
* works to fine-tune the display and performance.
* This should be put in setup(). The available
* attributes are: alpha - indicates if the canvas
* contains an alpha buffer default is true
*
*
* depth - indicates whether the drawing buffer has a
* depth buffer of at least 16 bits - default is true
*
*
* stencil - indicates whether the drawing buffer has
* a stencil buffer of at least 8 bits
*
*
* antialias - indicates whether or not to perform
* anti-aliasing default is false
*
*
* premultipliedAlpha - indicates that the page
* compositor will assume the drawing buffer contains
* colors with pre-multiplied alpha default is false
*
*
* preserveDrawingBuffer - if true the buffers will
* not be cleared and and will preserve their values
* until cleared or overwritten by author (note that
* p5 clears automatically on draw loop) default is
* true
*
*
* perPixelLighting - if true, per-pixel lighting
* will be used in the lighting shader. default is
* false
* @param obj object with key-value pairs
*/
setAttributes(
obj: object
): void;
}
/**
* Set attributes for the WebGL Drawing context. This
* is a way of adjusting how the WebGL renderer works
* to fine-tune the display and performance. Note
* that this will reinitialize the drawing context if
* called after the WebGL canvas is made.
*
*
* If an object is passed as the parameter, all
* attributes not declared in the object will be set
* to defaults.
*
*
* The available attributes are:
*
* alpha - indicates if the canvas contains an alpha
* buffer default is true
*
*
* depth - indicates whether the drawing buffer has a
* depth buffer of at least 16 bits - default is true
*
*
* stencil - indicates whether the drawing buffer has
* a stencil buffer of at least 8 bits
*
*
* antialias - indicates whether or not to perform
* anti-aliasing default is false
*
*
* premultipliedAlpha - indicates that the page
* compositor will assume the drawing buffer contains
* colors with pre-multiplied alpha default is false
*
*
* preserveDrawingBuffer - if true the buffers will
* not be cleared and and will preserve their values
* until cleared or overwritten by author (note that
* p5 clears automatically on draw loop) default is
* true
*
*
* perPixelLighting - if true, per-pixel lighting
* will be used in the lighting shader. default is
* false
* @param obj object with key-value pairs
*/
setAttributes(obj: object): void;
}
}
types/p5/src/webgl/p5.Shader.d.ts
Vendored
+18 -25
View File
@@ -1,29 +1,22 @@
// This file was auto-generated. Please do not edit it.
import * as p5 from "../../index";
import * as p5 from '../../index';
declare module "../../index" {
class Shader {
/**
* Wrapper around gl.uniform functions. As we store
* uniform info in the shader we can use that to do
* type checking on the supplied data and call the
* appropriate function.
* @param uniformName the name of the uniform in the
* shader program
* @param data the data to be associated with that
* uniform; type varies (could be a single numerical
* value, array, matrix, or texture / sampler
* reference)
* @chainable
*/
setUniform(
uniformName: string,
data:
| object
| number
| boolean
| number[]
): Shader;
}
declare module '../../index' {
class Shader {
/**
* Wrapper around gl.uniform functions. As we store
* uniform info in the shader we can use that to do
* type checking on the supplied data and call the
* appropriate function.
* @param uniformName the name of the uniform in the
* shader program
* @param data the data to be associated with that
* uniform; type varies (could be a single numerical
* value, array, matrix, or texture / sampler
* reference)
* @chainable
*/
setUniform(uniformName: string, data: object | number | boolean | number[]): Shader;
}
}
types/p5/test/index.ts
+2
View File
@@ -32,3 +32,5 @@ function s(
const myp5 = new p5(
s
);
myp5.createGraphics(10, 10).ellipse(5, 5, 5);
types/p5/tsconfig.json
+1
View File
@@ -34,6 +34,7 @@
"src/core/shape/vertex.d.ts",
"src/core/structure.d.ts",
"src/core/transform.d.ts",
"src/data/local_storage.d.ts",
"src/data/p5.TypedDict.d.ts",
"src/events/acceleration.d.ts",
"src/events/keyboard.d.ts",