Skip to content

Commit ade8c09

Browse files
author
Nikos M
committed
api-reference update
1 parent 087c62c commit ade8c09

2 files changed

Lines changed: 22 additions & 22 deletions

File tree

api-reference.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,18 +110,18 @@ Randomly displaces each vertex in all 3 axes
110110

111111

112112

113-
###DisplaceMap (BitmapDisplacement) Modifier
113+
###DisplaceMap (BitmapDisplacement) Modifier
114+
115+
Displaces vertices based on RGB values of bitmapData pixels.
116+
117+
BitmapDisplacement is inspired by both the AS3 built-in DisplacementMapFilter. It allows
118+
to use color values for each channels of a bitmap to modify the position of vertices in a mesh.
119+
120+
The displacement takes place along the cardinal axes, and each axis is mapped to a
121+
channel in the bitmap: X for Red, Y for Green and Z for Blue.
122+
123+
@author Bartek Drozdz
114124

115-
Displaces vertices based on RGB values of bitmapData pixels.
116-
117-
BitmapDisplacement is inspired by both the AS3 built-in DisplacementMapFilter. It allows
118-
to use color values for each channels of a bitmap to modify the position of vertices in a mesh.
119-
120-
The displacement takes place along the cardinal axes, and each axis is mapped to a
121-
channel in the bitmap: X for Red, Y for Green and Z for Blue.
122-
123-
@author Bartek Drozdz
124-
125125

126126

127127

src/modifiers/DisplaceMap.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
**/
77

88
/**[DOC_MD]
9-
* ###DisplaceMap (BitmapDisplacement) Modifier
9+
* ###DisplaceMap (BitmapDisplacement) Modifier
1010
*
11-
* Displaces vertices based on RGB values of bitmapData pixels.
12-
*
13-
* BitmapDisplacement is inspired by both the AS3 built-in DisplacementMapFilter. It allows
14-
* to use color values for each channels of a bitmap to modify the position of vertices in a mesh.
15-
*
16-
* The displacement takes place along the cardinal axes, and each axis is mapped to a
17-
* channel in the bitmap: X for Red, Y for Green and Z for Blue.
18-
*
19-
* @author Bartek Drozdz
20-
*
11+
* Displaces vertices based on RGB values of bitmapData pixels.
12+
*
13+
* BitmapDisplacement is inspired by both the AS3 built-in DisplacementMapFilter. It allows
14+
* to use color values for each channels of a bitmap to modify the position of vertices in a mesh.
15+
*
16+
* The displacement takes place along the cardinal axes, and each axis is mapped to a
17+
* channel in the bitmap: X for Red, Y for Green and Z for Blue.
18+
*
19+
* @author Bartek Drozdz
20+
*
2121
[/DOC_MD]**/
2222

2323
(function(MOD3, undef){

0 commit comments

Comments
 (0)