p5 2.0.0 → 2.0.2

package/types/webgl/p5.Texture.d.ts

@@ -0,0 +1,61 @@
+// This file is auto-generated from JSDoc documentation
+
+import p5 from 'p5';
+
+declare module 'p5' {
+/**
+ * Initializes common texture parameters, creates a gl texture,
+ * tries to upload the texture for the first time if data is
+ * already available.
+ *
+ */
+function init(data: any): void;
+
+/**
+ * Checks if the source data for this texture has changed (if it's
+ * easy to do so) and reuploads the texture if necessary. If it's not
+ * possible or to expensive to do a calculation to determine wheter or
+ * not the data has occurred, this method simply re-uploads the texture.
+ *
+ */
+function update(): void;
+
+/**
+ * Binds the texture to the appropriate GL target.
+ *
+ */
+function bindTexture(): void;
+
+/**
+ * Unbinds the texture from the appropriate GL target.
+ *
+ */
+function unbindTexture(): void;
+
+/**
+ * Sets how a texture is be interpolated when upscaled or downscaled.
+ * Nearest filtering uses nearest neighbor scaling when interpolating
+ * Linear filtering uses WebGL's linear scaling when interpolating
+ *
+ * @param Specifies the texture filtering when
+ * textures are shrunk. Options are LINEAR or NEAREST
+ * @param Specifies the texture filtering when
+ * textures are magnified. Options are LINEAR or NEAREST
+ * @todo implement mipmapping filters
+ */
+function setInterpolation(downScale: string, upScale: string): void;
+
+/**
+ * Sets the 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. REPEAT & MIRROR are only available if the texture
+ * is a power of two size (128, 256, 512, 1024, etc.).
+ *
+ * @param Controls the horizontal texture wrapping behavior
+ * @param Controls the vertical texture wrapping behavior
+ */
+function setWrapMode(wrapX: string, wrapY: string): void;
+
+}
+
+export default function p5_Texture(p5: any, fn: any): void;

package/types/webgl/text.d.ts

@@ -0,0 +1,74 @@
+// This file is auto-generated from JSDoc documentation
+
+import p5 from 'p5';
+
+declare module 'p5' {
+/**
+ * @param the x positions of points in the curve
+ * @param the y positions of points in the curve
+ * @param the curve information
+ * 
+ * adds a curve to the rows & columns that it intersects with
+ */
+function push(xs: number[], ys: number[], v: object): void;
+
+/**
+ * @param the value to scale
+ * 
+ * converts a floating-point number in the range 0-1 to a byte 0-255
+ */
+function byte(v: number): void;
+
+/**
+ * @param writes the next pixel into an indexed ImageData
+ */
+function setPixel(imageInfo: object, r: number, g: number, b: number, a: number): void;
+
+/**
+ * @param the list of values to compare
+ * @param the initial minimum value
+ * @param the initial maximum value
+ * 
+ * find the minimum & maximum value in a list of values
+ */
+function minMax(rg: number[], min: number, max: number): void;
+
+/**
+ * @param the value to clamp
+ * @param the minimum value
+ * @param the maxmimum value
+ * 
+ * clamps a value between a minimum & maximum value
+ */
+function clamp(v: number, min: number, max: number): void;
+
+/**
+ * @returns an array of cubics whose quadratic approximations
+ * closely match the civen cubic.
+ * 
+ * converts a cubic curve to a list of quadratics.
+ */
+function cubicToQuadratics(x0: number, y0: number, cx0: number, cy0: number, cx1: number, cy1: number, x1: number, y1: number): Cubic[];
+
+/**
+ * @param add a straight line to the row/col grid of a glyph
+ */
+function pushLine(x0: number, y0: number, x1: number, y1: number): void;
+
+/**
+ * @return true if the two points are sufficiently close
+ * 
+ * tests if two points are close enough to be considered the same
+ */
+function samePoint(x0: number, y0: number, x1: number, y1: number): boolean;
+
+/**
+ * @return lays out the curves in a dimension (row or col) into two
+ * images, one for the indices of the curves themselves, and
+ * one containing the offset and length of those index spans.
+ */
+function layout(dimImageInfos: ImageInfo[], cellImageInfos: ImageInfo[]): object;
+
+}
+
+export default function text(p5: any, fn: any): void;

package/src/README.md

@@ -1,27 +0,0 @@
-# Organization
-
-The p5.js source code is organized into subdirectories which are roughly conceptually equivalent to third-party addons, except that these "addons" are actually just shipped as part of the p5.js library because the functionality they provide is so useful and central to p5's goal of building art projects for the web.
-
-The `src/core` directory is the primary exception to this. It contains most of the internal logic of p5.js — the code which orchestrates everything else. It is possible to create optimized minimalist [custom builds](/contributor_docs/custom_p5_build.md) of the p5.js library which only include specific desired modules. In such a custom build, the contents of the core directory would be the only hard requirement, and everything else would be optional.
-
-[JSDoc](https://jsdoc.app/) [module](https://jsdoc.app/tags-module.html) annotations are used throughout the codebase, but they primarily organize the public-facing [p5 reference manual](https://p5js.org/reference/), which is built automatically from the source code. These annotations structure the *expressive and creative API* of p5, and consequently they might not always align exactly with the *source code structure*.
-
-The `app.js` file is simply an index of all the other modules which exports the p5 constructor function.
-
-# APIs
-
-p5.js seeks to create a toolkit for working with the web technologies that are most valuable for building art projects. For both expressive and pedagogical reasons, p5.js values (but does not necessarily always achieve lol!) clarity in its APIs. These are guidelines, and in practice there may be occasional exceptions.
-
-## Public
-
-Public APIs which are exposed to users of the p5.js library during the course of working on sketches and projects should use short, clear, declarative function names. `circle()` is preferable to `new Circle()`. If the name of a public API function is longer than one or two words, it may be worth carefully considering whether the API should be restructured into something more creative, expressive, or intuitive.
-
-## Native
-
-Native APIs provided by the browser can sometimes be aliased in the style of public APIs to provide a more creative, expressive, or intuitive interface than the native implementation. For example, `print()` is easier to explain than `console.log()`. Idiomatic JavaScript is generally preferable, so aliasing in this manner needs to have tremendous creative or pedagogical benefits.
-
-Native browser functionality is also often aliased with properties on the `p5` object. This allows the library to consistently point toward the same reference, but in most cases this practice should not be considered part of the public API even though those properties are exposed to the user.
-
-## Internal
-
-Internal APIs which are not exposed to the user but are used for coordination within the library should generally take the form of constructor functions which can be exported across module boundaries. Those constructors are often attached to the `p5` constructor as a form of namespacing, but otherwise do not meaningfully act as methods that reference the host object. In cases where a `p5` object is needed inside a constructor, an instance will be explicitly passed as an input argument.

package/src/accessibility/index.js

@@ -1,13 +0,0 @@
-import describe from './describe.js';
-import gridOutput from './gridOutput.js';
-import textOutput from './textOutput.js';
-import outputs from './outputs.js';
-import colorNamer from './color_namer.js';
-
-export default function(p5){
-  p5.registerAddon(describe);
-  p5.registerAddon(gridOutput);
-  p5.registerAddon(textOutput);
-  p5.registerAddon(outputs);
-  p5.registerAddon(colorNamer);
-}

package/src/app.js

@@ -1,61 +0,0 @@
-// core
-import p5 from './core/main';
-
-// shape
-import shape from './shape';
-shape(p5);
-
-//accessibility
-import accessibility from './accessibility';
-accessibility(p5);
-
-// color
-import color from './color';
-color(p5);
-
-// core
-// currently, it only contains the test for parameter validation
-import friendlyErrors from './core/friendly_errors';
-friendlyErrors(p5);
-
-// data
-import data from './data';
-data(p5);
-
-// DOM
-import dom from './dom';
-dom(p5);
-
-// events
-import events from './events';
-events(p5);
-
-// image
-import image from './image';
-image(p5);
-
-// io
-import io from './io';
-io(p5);
-
-// math
-import math from './math';
-math(p5);
-
-// utilities
-import utilities from './utilities';
-utilities(p5);
-
-// webgl
-import webgl from './webgl';
-webgl(p5);
-
-// typography
-import type from './type'
-type(p5);
-
-import { waitForDocumentReady, waitingForTranslator, _globalInit } from './core/init';
-Promise.all([waitForDocumentReady(), waitingForTranslator]).then(_globalInit);
-
-export default p5;
-

package/src/color/index.js

@@ -1,9 +0,0 @@
-import creatingReading from './creating_reading.js';
-import p5color from './p5.Color.js';
-import setting from './setting.js';
-
-export default function(p5){
-  p5.registerAddon(creatingReading);
-  p5.registerAddon(p5color);
-  p5.registerAddon(setting);
-}

package/src/color/p5.Color.culori.js

@@ -1,66 +0,0 @@
-class Color {
-  _color;
-  maxes;
-  mode;
-  array;
-
-  static addColorMode(mode, definition){
-
-  }
-
-  constructor(vals){
-
-  }
-
-  toString(){
-
-  }
-
-  setRed(new_red){
-
-  }
-
-  setGreen(new_green){
-
-  }
-
-  setBlue(new_blue){
-
-  }
-
-  setAlpha(new_alpha){
-
-  }
-
-  _getRed(){
-
-  }
-
-  _getGreen(){
-
-  }
-
-  _getBlue(){
-
-  }
-
-  _getAlpha(){
-
-  }
-
-  _getHue(){
-
-  }
-
-  _getSaturation(){
-
-  }
-
-  _getBrightness(){
-
-  }
-
-  _getLightness(){
-
-  }
-}