Skip to content

Commit 0d1573c

Browse files
author
Adam Ferriss
committed
Add documentation for settings method
1 parent 80570ea commit 0d1573c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/webgl/p5.Texture.js

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,26 @@ import * as constants from '../core/constants';
1919
* object containing the image data to store in the texture.
2020
* @param {Object} [settings] optional A javascript object containing texture
2121
* settings.
22+
* @param {Number} [settings.format] optional The internal color component
23+
* format for the texture. Possible values for format include gl.RGBA,
24+
* gl.RGB, gl.ALPHA, gl.LUMINANCE, gl.LUMINANCE_ALPHA. Defaults to gl.RBGA
25+
* @param {Number} [settings.minFilter] optional The texture minification
26+
* filter setting. Possible values are gl.NEAREST or gl.LINEAR. Defaults
27+
* to gl.LINEAR. Note, Mipmaps are not implemented in p5.
28+
* @param {Number} [settings.magFilter] optional The texture magnification
29+
* filter setting. Possible values are gl.NEAREST or gl.LINEAR. Defaults
30+
* to gl.LINEAR. Note, Mipmaps are not implemented in p5.
31+
* @param {Number} [settings.wrapS] optional The texture wrap settings for
32+
* the s coordinate, or x axis. Possible values are gl.CLAMP_TO_EDGE,
33+
* gl.REPEAT, and gl.MIRRORED_REPEAT. The mirror settings are only available
34+
* when using a power of two sized texture. Defaults to gl.CLAMP_TO_EDGE
35+
* @param {Number} [settings.wrapT] optional The texture wrap settings for
36+
* the t coordinate, or y axis. Possible values are gl.CLAMP_TO_EDGE,
37+
* gl.REPEAT, and gl.MIRRORED_REPEAT. The mirror settings are only available
38+
* when using a power of two sized texture. Defaults to gl.CLAMP_TO_EDGE
39+
* @param {Number} [settings.dataType] optional The data type of the texel
40+
* data. Possible values are gl.UNSIGNED_BYTE or gl.FLOAT. There are more
41+
* formats that are not implemented in p5. Defaults to gl.UNSIGNED_BYTE.
2242
*/
2343
p5.Texture = function(renderer, obj, settings) {
2444
this._renderer = renderer;

0 commit comments

Comments
 (0)