<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Material] →
<h1>[name]</h1>
<p class="desc">A material for drawing wireframe-style geometries.</p>
<h2>Code Example</h2>
<code>
const material = new THREE.LineBasicMaterial( {
color: 0xffffff,
linewidth: 1,
linecap: 'round', //ignored by WebGLRenderer
linejoin: 'round' //ignored by WebGLRenderer
} );
</code>
<h2>Examples</h2>
<p>
[example:webgl_buffergeometry_drawrange WebGL / buffergeometry / drawrange]<br />
[example:webgl_buffergeometry_lines WebGL / buffergeometry / lines]<br />
[example:webgl_buffergeometry_lines_indexed WebGL / buffergeometry / lines / indexed]<br />
[example:webgl_decals WebGL / decals]<br />
[example:webgl_geometry_nurbs WebGL / geometry / nurbs]<br />
[example:webgl_geometry_shapes WebGL / geometry / shapes]<br />
[example:webgl_geometry_spline_editor WebGL / geometry / spline / editor]<br />
[example:webgl_interactive_buffergeometry WebGL / interactive / buffergeometry]<br />
[example:webgl_interactive_voxelpainter WebGL / interactive / voxelpainter]<br />
[example:webgl_lines_colors WebGL / lines / colors]<br />
[example:webgl_lines_dashed WebGL / lines / dashed]<br />
[example:webgl_lines_sphere WebGL / lines / sphere]<br />
[example:webgl_materials WebGL / materials]<br />
[example:physics_ammo_rope physics / ammo / rope]
</p>
<h2>Constructor</h2>
<h3>[name]( [param:Object parameters] )</h3>
<p>
[page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
The exception is the property [page:Hexadecimal color], which can be passed in as a hexadecimal
string and is `0xffffff` (white) by default. [page:Color.set]( color ) is called internally.
</p>
<h2>Properties</h2>
<p>See the base [page:Material] class for common properties.</p>
<h3>[property:Color color]</h3>
<p>[page:Color] of the material, by default set to white (0xffffff).</p>
<h3>[property:Boolean fog]</h3>
<p>Whether the material is affected by fog. Default is `true`.</p>
<h3>[property:Float linewidth]</h3>
<p>
Controls line thickness. Default is `1`.<br /><br />
Due to limitations of the [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf OpenGL Core Profile]
with the [page:WebGLRenderer WebGL] renderer on most platforms linewidth will
always be 1 regardless of the set value.
</p>
<h3>[property:String linecap]</h3>
<p>
Define appearance of line ends. Possible values are 'butt', 'round' and 'square'.
Default is 'round'.<br /><br />
This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap 2D Canvas lineCap]
property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
</p>
<h3>[property:String linejoin]</h3>
<p>
Define appearance of line joints. Possible values are 'round', 'bevel' and 'miter'. Default is 'round'. <br /><br />
This corresponds to the [link:https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineJoin 2D Canvas lineJoin]
property and it is ignored by the [page:WebGLRenderer WebGL] renderer.
</p>
<h2>Methods</h2>
<p>See the base [page:Material] class for common methods.</p>
<h2>Source</h2>
<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>