Skip to content

Latest commit

 

History

History
138 lines (102 loc) · 3.18 KB

materials.md

File metadata and controls

138 lines (102 loc) · 3.18 KB

This is the technical documentation for Tangram’s materials. For a conceptual overview of the material system, see the Materials Overview.

material

Optional parameter. Begins a material block under a named style.

styles:
    water:
        base: polygons
        animated: true
        material:
            ambient: .7
            diffuse: [0,0,1]
            specular: white

material properties

diffuse

Optional parameter. Can be a number from 0-1, [R, G, B], hex-color, css color name, or texture. Defaults to the geometry's color value.

styles:
    red-wall:
        base: polygons
        material:
            diffuse: red

ambient

Optional parameter. Can be a number from 0-1, [R, G, B], hex-color, css color name, or texture. Defaults to the diffuse value.

styles:
    surface:
        base: polygons
        material:
            ambient: .7

specular

Optional parameter. Can be a number from 0-1, [R, G, B], hex-color, css color name, or texture. Defaults to [1.0, 1.0, 1.0].

styles:
    water:
        base: polygons
        material:
            ambient: .7
            diffuse: [0,0,1]
            specular: white
            shininess: 2.0

shininess

Optional number. Defaults to 0.2.

styles:
    water:
        base: polygons
        material:
            ambient: .7
            diffuse: [0,0,1]
            specular: white
            shininess: 2.0

normal

Optional parameter. Begins a normal texture block. Requires texture and mapping parameters. All the mapping parameters may be applied to this object except mapping: spheremap. No default.

material:
    ambient: .7
    normal:
        texture: materials/bricks.png
        mapping: uv

Textures

ambient, diffuse and specular properties can be defined as a texture map instead of a color. When a texture is used in this way, a number of other parameters may be used to modify its display.

texture

Optional named texture, URL, or texture object. No default.

For more, see textures#texture.

mapping

Optional string, one of uv, planar, triplanar, or spheremap. Default is triplanar for normal textures and spheremap for all others.

The spheremap mapping can't be used with a normal map.

material:
    diffuse:
        texture: ./material/rock.jpg
        mapping: uv

scale

Optional number or 2D vector. number or [x,y]. Defaults to [1,1].

Sets a scaling value for the texture. Does not work with uv mapping.

material:
    diffuse:
        texture: ./material/rock.jpg
        mapping: planar
        scale: 2.0

amount

Optional number or 3D vector. number or [r,g,b]. Defaults to 1.

This value is a multiplier on the effect of the texture – it can be thought of as the texture's opacity.

material:
    ambient: .5
    diffuse:
        texture: ./material/rock.jpg
        mapping: uv
        scale: 2.0
        amount: 0.5

See also: texture parameters.