SpriteMaterial - Verge3D User Manual - Soft8Soft
Description: Learn how to use SpriteMaterial in your interactive 3D apps made with Verge3D

Material →

# SpriteMaterial

A material for a use with a Sprite.

## Code Example

`const map = new v3d.TextureLoader().load('mysprite.png'); const material = new v3d.SpriteMaterial({ map: map, color: 0xffffff }); const sprite = new v3d.Sprite(material); sprite.scale.set(200, 200, 1) app.scene.add(sprite);`

## Constructor

### SpriteMaterial(parameters : 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 Material) can be passed in here.

The exception is the property color, which can be passed in as a hexadecimal string and is `0xffffff` (white) by default. Color.set(color) is called internally.

SpriteMaterials are not clipped by using Material.clippingPlanes.

## Properties

See the base Material class for inherited properties.

### # .color : Color

Color of the material, by default set to white (`0xffffff`). The .map is multiplied by the color.

### # .fog : Boolean

Whether the material is affected by fog. Default is `true`.

### # .isSpriteMaterial : Boolean

Read-only flag to check if a given object is of type SpriteMaterial.

### # .map : Texture

The color map. May optionally include an alpha channel, typically combined with .transparent or .alphaTest. Default is `null`.

### # .rotation : Float

The rotation of the sprite in radians. Default is `0`.

### # .sizeAttenuation : Boolean

Whether the size of the sprite is attenuated by the camera depth (perspective cameras only). Default is `true`.

### # .transparent : Boolean

Defines whether this material is transparent. Default is `true`.

## Methods

See the base Material class for inherited methods.

## Source

For more info on how to obtain the source code of this module see this page.