Class: ImageMaterial ​

ImageMaterial Do not compute light, only read pixel color from a Image source

Hierarchy ​

• Material

  ↳ ImageMaterial

Constructors ​

• constructor

Properties ​

• name
• instanceID
• enable

Accessors ​

• baseMap
• baseColor
• rectClip
• depthCompare
• defaultPass
• doubleSide
• castShadow
• blendMode
• transparent
• cullMode

Methods ​

• debug
• hasPass
• getPass
• getAllPass
• addPass
• removePass
• clone
• destroy

Constructors ​

constructor ​

• new ImageMaterial()

Create a new ImageMaterial

Overrides ​

Material.constructor

Defined in ​

packages/media-extention/ImageMaterial.ts:15

Properties ​

name ​

• name: string

name of this material

Inherited from ​

Material.name

Defined in ​

src/materials/Material.ts:11

instanceID ​

• instanceID: string

Material Unique Identifier

Inherited from ​

Material.instanceID

Defined in ​

src/materials/Material.ts:17

enable ​

• enable: boolean = true

Inherited from ​

Material.enable

Defined in ​

src/materials/Material.ts:19

Accessors ​

baseMap ​

• get baseMap(): Texture

Returns ​

Texture

Defined in ​

packages/media-extention/ImageMaterial.ts:42

• set baseMap(value): void

Parameters ​

Returns ​

void

Defined in ​

packages/media-extention/ImageMaterial.ts:38

baseColor ​

• get baseColor(): Color

get base color (tint color)

Returns ​

Color

Defined in ​

packages/media-extention/ImageMaterial.ts:56

• set baseColor(color): void

set base color (tint color)

Parameters ​

Returns ​

void

Defined in ​

packages/media-extention/ImageMaterial.ts:49

rectClip ​

• get rectClip(): Vector4

Get the clip rect area

Returns ​

Vector4

Defined in ​

packages/media-extention/ImageMaterial.ts:70

• set rectClip(value): void

Set the clip rect area

Parameters ​

Returns ​

void

Defined in ​

packages/media-extention/ImageMaterial.ts:63

depthCompare ​

• get depthCompare(): GPUCompareFunction

Returns ​

GPUCompareFunction

Inherited from ​

Material.depthCompare

Defined in ​

src/materials/Material.ts:31

• set depthCompare(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.depthCompare

Defined in ​

src/materials/Material.ts:35

defaultPass ​

• get defaultPass(): RenderShader

Returns ​

RenderShader

Inherited from ​

Material.defaultPass

Defined in ​

src/materials/Material.ts:40

• set defaultPass(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.defaultPass

Defined in ​

src/materials/Material.ts:44

doubleSide ​

• get doubleSide(): boolean

Returns ​

boolean

Inherited from ​

Material.doubleSide

Defined in ​

src/materials/Material.ts:49

• set doubleSide(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.doubleSide

Defined in ​

src/materials/Material.ts:53

castShadow ​

• get castShadow(): boolean

Returns ​

boolean

Inherited from ​

Material.castShadow

Defined in ​

src/materials/Material.ts:57

• set castShadow(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.castShadow

Defined in ​

src/materials/Material.ts:62

blendMode ​

• get blendMode(): BlendMode

Returns ​

BlendMode

Inherited from ​

Material.blendMode

Defined in ​

src/materials/Material.ts:67

• set blendMode(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.blendMode

Defined in ​

src/materials/Material.ts:72

transparent ​

• get transparent(): boolean

Returns ​

boolean

Inherited from ​

Material.transparent

Defined in ​

src/materials/Material.ts:78

• set transparent(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.transparent

Defined in ​

src/materials/Material.ts:83

cullMode ​

• get cullMode(): GPUCullMode

Returns ​

GPUCullMode

Inherited from ​

Material.cullMode

Defined in ​

src/materials/Material.ts:91

• set cullMode(value): void

Parameters ​

Returns ​

void

Inherited from ​

Material.cullMode

Defined in ​

src/materials/Material.ts:96

Methods ​

debug ​

▸ debug(): void

Start debug GUI

Returns ​

void

Defined in ​

packages/media-extention/ImageMaterial.ts:77

hasPass ​

▸ hasPass(passType): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

Material.hasPass

Defined in ​

src/materials/Material.ts:105

getPass ​

▸ getPass(passType): RenderShader[]

get render pass by renderType

Parameters ​

Returns ​

RenderShader[]

Inherited from ​

Material.getPass

Defined in ​

src/materials/Material.ts:114

getAllPass ​

▸ getAllPass(): RenderShader[]

get all color render pass

Returns ​

RenderShader[]

Inherited from ​

Material.getAllPass

Defined in ​

src/materials/Material.ts:122

addPass ​

▸ addPass(passType, pass, index?): RenderShader[]

Parameters ​

Returns ​

RenderShader[]

Inherited from ​

Material.addPass

Defined in ​

src/materials/Material.ts:126

removePass ​

▸ removePass(passType, index): void

Parameters ​

Returns ​

void

Inherited from ​

Material.removePass

Defined in ​

src/materials/Material.ts:145

clone ​

▸ clone(): any

clone one material

Returns ​

any

Material

Inherited from ​

Material.clone

Defined in ​

src/materials/Material.ts:158

destroy ​

▸ destroy(force): void

Parameters ​

Returns ​

void

Inherited from ​

Material.destroy

Defined in ​

src/materials/Material.ts:162