Skip to content

Commit 0a9ef5e

Browse files
committed
last descriptions
1 parent 13c42e1 commit 0a9ef5e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

js/artoolkit.api.js

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1245,6 +1245,7 @@
12451245
Draw the black and white image and debug markers to the ARController canvas.
12461246
12471247
See setDebugMode.
1248+
@return 0 (void)
12481249
*/
12491250
ARController.prototype.debugDraw = function () {
12501251
var debugBuffer = new Uint8ClampedArray(Module.HEAPU8.buffer, this._bwpointer, this.framesize);
@@ -1276,6 +1277,11 @@
12761277

12771278
// private methods
12781279

1280+
/**
1281+
This function init the ArController with the necessary parmeters and variables.
1282+
Don't call directly this but instead instantiate a new ArController.
1283+
@return {number} 0 (void)
1284+
*/
12791285
ARController.prototype._initialize = function () {
12801286
this.id = artoolkit.setup(this.width, this.height, this.cameraParam.id);
12811287

@@ -1306,10 +1312,18 @@
13061312
}.bind(this), 1);
13071313
};
13081314

1315+
/**
1316+
Init the necessary kpm handle for NFT and the settings for the CPU.
1317+
@return {number} 0 (void)
1318+
*/
13091319
ARController.prototype._initNFT = function () {
13101320
artoolkit.setupAR2(this.id);
13111321
};
13121322

1323+
/**
1324+
Copy the Image data to the HEAP for the debugSetup function.
1325+
@return {number} 0 (void)
1326+
*/
13131327
ARController.prototype._copyImageToHeap = function (image) {
13141328
if (!image) {
13151329
image = this.image;
@@ -1355,7 +1369,11 @@
13551369
return false;
13561370
};
13571371

1358-
1372+
/**
1373+
Draw a square black border around the detect marker with
1374+
red circle in the center. Used for debugging porpouse in debugSetup.
1375+
@return {number} 0 (void)
1376+
*/
13591377
ARController.prototype._debugMarker = function (marker) {
13601378
var vertex, pos;
13611379
vertex = marker.vertex;

0 commit comments

Comments
 (0)