Interface Material

interface, represents material interface

Hierarchy

Material

Index

Methods

addImage addParameter findParameter getCurrentTopology getImages getName getParameters getSamplers getState removeImage removeParameter setState setTopology

Methods

addImage

addImage(sampler, Image): void
add Image sampler, after what you'll can get acess to Image and sampler in shader by formula: ImageIndex = i * 2. samplerIndex = i * 2 + 1. Where i is Image index in Images list (which you can get by getImages call). Note that you need to export Images samplers in shader manually and sampler name in name must match with sampler name in material.
Parameters
- sampler: string
  
  sampler name
- Image: BanubaSDK.Image
  
  sampler Image
Returns void

addParameter

addParameter(parameter): void
adds shader Parameter to Parameters list, after what you'll can get access to this Parameter in shader by it's name. Type of Parameter in shader will match with type of Parameter, except int, float, vector2, vector3, this types will be replaces on Vec4, which x component will have needed value, other components will be filled by garbage.
Parameters
- parameter: Parameter
  
  Parameter to add
Returns void

findParameter

findParameter(name): Parameter
find Parameter by name
Parameters
- name: string
  
  name
Returns Parameter
Parameter or null

getCurrentTopology

getCurrentTopology(): GeometryTopology
Returns GeometryTopology
current geometry topology

getImages

getImages(): Vector<BanubaSDK.Image>
Returns Vector<BanubaSDK.Image>
list of samplers Images

getName

getName(): string
Returns string
material name

getParameters

getParameters(): Vector<Parameter>
Returns Vector<Parameter>
list of shader Parameters

getSamplers

getSamplers(): Vector<string>
Returns Vector<string>
list of samplers name

getState

getState(): State
Returns State
render state

removeImage

removeImage(sampler): void
removes Image from list (if exist). Will be ignored if effect was activated.
Parameters
- sampler: string
  
  sampler name
Returns void

removeParameter

removeParameter(parameter): void
removes Parameter from list.
Parameters
- parameter: Parameter
  
  Parameter to remove
Returns void

setState

setState(state): void
sets render state
Parameters
- state: State
  
  render state
Returns void

setTopology

setTopology(topology): void
set material geometry topology.
Parameters
- topology: GeometryTopology
  
  geometry topology type.Can be trianglesList, linesList, pointsList. Default: trianglesList
Returns void