Class Material

constructor

• new Material(): Material

• Create a new default material with diffuse white colour, all all default properties

  Returns Material

additiveBlend

alphaCutoff

0.0
Copy

ambient

diffuse

[1, 1, 1]
Copy

OptionaldiffuseTex

"1 pixel white texture"
Copy

emissive

OptionalnormalTex

"1 pixel white texture"
Copy

opacity

1.0
Copy

reflectivity

0.0
Copy

shininess

20
Copy

specular

[0, 0, 0]
Copy

OptionalspecularTex

"1 pixel white texture"
Copy

uniforms

• get uniforms(): UniformSet

• Return the base set of uniforms for this material

  Returns UniformSet

  UniformSet object with all material properties

StaticBLACK

• get BLACK(): Material

• Create a simple diffuse black Material

  Returns Material

StaticBLUE

• get BLUE(): Material

• Create a simple diffuse blue Material

  Returns Material

StaticCYAN

• get CYAN(): Material

• Create a simple diffuse cyan Material

  Returns Material

StaticGREEN

• get GREEN(): Material

• Create a simple diffuse green Material

  Returns Material

StaticMAGENTA

• get MAGENTA(): Material

• Create a simple diffuse magenta Material

  Returns Material

StaticRED

• get RED(): Material

• Create a simple diffuse red Material

  Returns Material

StaticWHITE

• get WHITE(): Material

• Create a simple diffuse white Material

  Returns Material

StaticYELLOW

• get YELLOW(): Material

• Create a simple diffuse yellow Material

  Returns Material

addNormalTexture

• addNormalTexture(url: string, filter?: boolean, flipY?: boolean): void

• Add a normal texture map to existing material, probably created with createBasicTexture

  Parameters

  • url: string
  • filter: boolean = true
  • flipY: boolean = false

  Returns void

addSpecularTexture

• addSpecularTexture(url: string, filter?: boolean, flipY?: boolean): void

• Add a specular texture map to existing material, probably created with createBasicTexture

  Parameters

  • url: string
  • filter: boolean = true
  • flipY: boolean = false

  Returns void

apply

• apply(programInfo: ProgramInfo, uniformSuffix?: string): void

• Adds this material to a program, as a set of uniforms

  Parameters

  • programInfo: ProgramInfo

    ProgramInfo object to update with uniforms
  • uniformSuffix: string = ''

    Optional suffix to add to uniform names

  Returns void

clone

• clone(): Material

• Clone this material, returns a new material with the same properties

  Returns Material

StaticcreateBasicTexture

• createBasicTexture(
      src: string | ArrayBufferView<ArrayBufferLike>,
      filter?: boolean,
      flipY?: boolean,
      extraOptions?: TextureOptions,
  ): Material

• Create a new Material with a texture map loaded from a URL/filepath or Buffer

  Parameters

  • src: string | ArrayBufferView<ArrayBufferLike>

    URL or filename path of texture image, or ArrayBufferView holding texture
  • filter: boolean = true

    Enable texture filtering and mipmaps (default true)
  • flipY: boolean = false

    Flip the texture vertically (default false)
  • extraOptions: TextureOptions = {}

    Extra options to pass to twgl.createTexture, see https://twgljs.org/docs/module-twgl.html#.TextureOptions

  Returns Material

StaticcreateSolidColour

• createSolidColour(r: number, g: number, b: number): Material

• Create a basic Material with a solid/flat diffuse colour

  Parameters

  • r: number

    Red component, 0.0 to 1.0
  • g: number

    Green component, 0.0 to 1.0
  • b: number

    Blue component, 0.0 to 1.0

  Returns Material

StaticfromMtl

• fromMtl(
      rawMtl: MtlMaterial,
      basePath: string,
      filter?: boolean,
      flipY?: boolean,
  ): Material

• Create a new material from a raw MTL material. Users are not expected to call this directly as it is used internally by the OBJ parser

  Parameters

  • rawMtl: MtlMaterial

    Raw MTL material
  • basePath: string

    Base path for locating & loading textures in MTL file
  • filter: boolean = true

    Apply texture filtering to textures, default: true
  • flipY: boolean = false

    Flip the Y axis of textures, default: false

  Returns Material