Class: VideoMaterial ​

Video Material Do not compute light, only read pixel color from a Video source

Hierarchy ​

• MaterialBase

  ↳ VideoMaterial

Constructors ​

• constructor

Accessors ​

• rectClip
• envMap
• shadowMap
• shaderState
• normalMapYFlip
• baseMap
• normalMap
• emissiveMap
• emissiveColor
• emissiveIntensity
• envIntensity
• normalScale
• alphaCutoff
• irradianceMap
• irradianceDepthMap
• baseColor
• uvTransform_1
• uvTransform_2
• sort
• shaderID
• blendMode
• transparent
• frontFace
• doubleSide
• cullMode
• depthBias
• depthCompare

Methods ​

• debug
• setDefine
• hasPass
• addPass
• removePass
• destroy
• clone
• setShader
• getShader

Properties ​

• name
• instanceID
• isPassMaterial
• receiveEnv
• renderPasses
• enable
• renderShader

Constructors ​

constructor ​

• new VideoMaterial()

Create new VideoMaterial

Overrides ​

MaterialBase.constructor

Defined in ​

packages/media-extention/VideoMaterial.ts:15

Accessors ​

rectClip ​

• get rectClip(): Vector4

Get the clip rect area

Returns ​

Vector4

Defined in ​

packages/media-extention/VideoMaterial.ts:47

• set rectClip(value): void

Set the clip rect area

Parameters ​

Returns ​

void

Defined in ​

packages/media-extention/VideoMaterial.ts:40

envMap ​

• set envMap(texture): void

Set no envMap

Parameters ​

Returns ​

void

Overrides ​

MaterialBase.envMap

Defined in ​

packages/media-extention/VideoMaterial.ts:54

shadowMap ​

• set shadowMap(texture): void

Set no shadowMap

Parameters ​

Returns ​

void

Overrides ​

MaterialBase.shadowMap

Defined in ​

packages/media-extention/VideoMaterial.ts:61

shaderState ​

• get shaderState(): ShaderState

Returns ​

ShaderState

Inherited from ​

MaterialBase.shaderState

Defined in ​

src/materials/MaterialBase.ts:44

• set shaderState(value): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.shaderState

Defined in ​

src/materials/MaterialBase.ts:48

normalMapYFlip ​

• get normalMapYFlip(): boolean

Returns ​

boolean

Inherited from ​

MaterialBase.normalMapYFlip

Defined in ​

src/materials/MaterialBase.ts:53

• set normalMapYFlip(value): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.normalMapYFlip

Defined in ​

src/materials/MaterialBase.ts:57

baseMap ​

• get baseMap(): Texture

Get base map(main map)

Returns ​

Texture

Inherited from ​

MaterialBase.baseMap

Defined in ​

src/materials/MaterialBase.ts:90

• set baseMap(texture): void

Set base map(main map)

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.baseMap

Defined in ​

src/materials/MaterialBase.ts:81

normalMap ​

• get normalMap(): Texture

Get normal map

Returns ​

Texture

Inherited from ​

MaterialBase.normalMap

Defined in ​

src/materials/MaterialBase.ts:97

• set normalMap(texture): void

Set normal map

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.normalMap

Defined in ​

src/materials/MaterialBase.ts:104

emissiveMap ​

• get emissiveMap(): Texture

Get emissive map

Returns ​

Texture

Inherited from ​

MaterialBase.emissiveMap

Defined in ​

src/materials/MaterialBase.ts:112

• set emissiveMap(value): void

Set emissive map

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.emissiveMap

Defined in ​

src/materials/MaterialBase.ts:151

emissiveColor ​

• get emissiveColor(): Color

Get emissive color

Returns ​

Color

Inherited from ​

MaterialBase.emissiveColor

Defined in ​

src/materials/MaterialBase.ts:119

• set emissiveColor(value): void

Set emissive color

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.emissiveColor

Defined in ​

src/materials/MaterialBase.ts:126

emissiveIntensity ​

• get emissiveIntensity(): number

Get emissive intensity

Returns ​

number

Inherited from ​

MaterialBase.emissiveIntensity

Defined in ​

src/materials/MaterialBase.ts:142

• set emissiveIntensity(value): void

Set emissive intensity

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.emissiveIntensity

Defined in ​

src/materials/MaterialBase.ts:134

envIntensity ​

• get envIntensity(): number

Get envionment effect intensity

Returns ​

number

Inherited from ​

MaterialBase.envIntensity

Defined in ​

src/materials/MaterialBase.ts:161

• set envIntensity(value): void

Set envionment effect intensity

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.envIntensity

Defined in ​

src/materials/MaterialBase.ts:168

normalScale ​

• get normalScale(): number

Get normal strength

Returns ​

number

Inherited from ​

MaterialBase.normalScale

Defined in ​

src/materials/MaterialBase.ts:176

• set normalScale(value): void

Set normal strength

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.normalScale

Defined in ​

src/materials/MaterialBase.ts:183

alphaCutoff ​

• get alphaCutoff(): number

Get alphaCutoff, channel transparency threshold parameter

Returns ​

number

Inherited from ​

MaterialBase.alphaCutoff

Defined in ​

src/materials/MaterialBase.ts:191

• set alphaCutoff(value): void

Set alphaCutoff, channel transparency threshold parameter

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.alphaCutoff

Defined in ​

src/materials/MaterialBase.ts:198

irradianceMap ​

• get irradianceMap(): Texture

Get irradiance map

Returns ​

Texture

Inherited from ​

MaterialBase.irradianceMap

Defined in ​

src/materials/MaterialBase.ts:214

• set irradianceMap(value): void

Set irradiance map

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.irradianceMap

Defined in ​

src/materials/MaterialBase.ts:221

irradianceDepthMap ​

• get irradianceDepthMap(): Texture

Get irradiance depth map

Returns ​

Texture

Inherited from ​

MaterialBase.irradianceDepthMap

Defined in ​

src/materials/MaterialBase.ts:229

• set irradianceDepthMap(value): void

Set irradiance depth map

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.irradianceDepthMap

Defined in ​

src/materials/MaterialBase.ts:236

baseColor ​

• get baseColor(): Color

Get base color(tint color)

Returns ​

Color

Inherited from ​

MaterialBase.baseColor

Defined in ​

src/materials/MaterialBase.ts:244

• set baseColor(value): void

Set base color(tint color)

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.baseColor

Defined in ​

src/materials/MaterialBase.ts:251

uvTransform_1 ​

• get uvTransform_1(): Vector4

Get uvTransform_1

Returns ​

Vector4

Inherited from ​

MaterialBase.uvTransform_1

Defined in ​

src/materials/MaterialBase.ts:260

• set uvTransform_1(value): void

Set uvTransform_1

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.uvTransform_1

Defined in ​

src/materials/MaterialBase.ts:267

uvTransform_2 ​

• get uvTransform_2(): Vector4

Get uvTransform_2

Returns ​

Vector4

Inherited from ​

MaterialBase.uvTransform_2

Defined in ​

src/materials/MaterialBase.ts:275

• set uvTransform_2(value): void

Set uvTransform_2

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.uvTransform_2

Defined in ​

src/materials/MaterialBase.ts:282

sort ​

• get sort(): number

Returns ​

number

Inherited from ​

MaterialBase.sort

Defined in ​

src/materials/MaterialPass.ts:23

• set sort(value): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.sort

Defined in ​

src/materials/MaterialPass.ts:27

shaderID ​

• get shaderID(): string

Returns ​

string

Inherited from ​

MaterialBase.shaderID

Defined in ​

src/materials/MaterialPass.ts:31

• set shaderID(value): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.shaderID

Defined in ​

src/materials/MaterialPass.ts:35

blendMode ​

• get blendMode(): BlendMode

Get blend mode, see BlendMode

Returns ​

BlendMode

Inherited from ​

MaterialBase.blendMode

Defined in ​

src/materials/MaterialPass.ts:53

• set blendMode(value): void

Set blend mode, see BlendMode

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.blendMode

Defined in ​

src/materials/MaterialPass.ts:60

transparent ​

• get transparent(): boolean

Get whether use transparent mode to render

Returns ​

boolean

Inherited from ​

MaterialBase.transparent

Defined in ​

src/materials/MaterialPass.ts:68

• set transparent(value): void

Set whether use transparent mode to render

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.transparent

Defined in ​

src/materials/MaterialPass.ts:75

frontFace ​

• get frontFace(): GPUFrontFace

Return GPUFrontFace

Returns ​

GPUFrontFace

Inherited from ​

MaterialBase.frontFace

Defined in ​

src/materials/MaterialPass.ts:82

• set frontFace(value): void

Set GPUFrontFace

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.frontFace

Defined in ​

src/materials/MaterialPass.ts:89

doubleSide ​

• get doubleSide(): boolean

Get whether use double side to render object

Returns ​

boolean

Inherited from ​

MaterialBase.doubleSide

Defined in ​

src/materials/MaterialPass.ts:96

• set doubleSide(value): void

Set whether use double side to render object

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.doubleSide

Defined in ​

src/materials/MaterialPass.ts:103

cullMode ​

• get cullMode(): GPUCullMode

get cull mode, see GPUCullMode

Returns ​

GPUCullMode

Inherited from ​

MaterialBase.cullMode

Defined in ​

src/materials/MaterialPass.ts:110

• set cullMode(value): void

set cull mode, see GPUCullMode

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.cullMode

Defined in ​

src/materials/MaterialPass.ts:117

depthBias ​

• get depthBias(): number

Returns ​

number

Inherited from ​

MaterialBase.depthBias

Defined in ​

src/materials/MaterialPass.ts:121

• set depthBias(value): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.depthBias

Defined in ​

src/materials/MaterialPass.ts:125

depthCompare ​

• get depthCompare(): GPUCompareFunction

get depth compare mode, see GPUCompareFunction

Returns ​

GPUCompareFunction

Inherited from ​

MaterialBase.depthCompare

Defined in ​

src/materials/MaterialPass.ts:132

• set depthCompare(value): void

set depth compare mode, see GPUCompareFunction

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.depthCompare

Defined in ​

src/materials/MaterialPass.ts:139

Methods ​

debug ​

▸ debug(): void

Start debug GUI

Returns ​

void

Overrides ​

MaterialBase.debug

Defined in ​

packages/media-extention/VideoMaterial.ts:68

setDefine ​

▸ setDefine(define, bool): void

Enable/Disable the definition of shaders

Memberof

MaterialBase

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.setDefine

Defined in ​

src/materials/MaterialBase.ts:309

hasPass ​

▸ hasPass(passType): boolean

Parameters ​

Returns ​

boolean

Inherited from ​

MaterialBase.hasPass

Defined in ​

src/materials/MaterialBase.ts:313

addPass ​

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

Parameters ​

Returns ​

MaterialPass[]

Inherited from ​

MaterialBase.addPass

Defined in ​

src/materials/MaterialBase.ts:317

removePass ​

▸ removePass(passType, index): void

Parameters ​

Returns ​

void

Inherited from ​

MaterialBase.removePass

Defined in ​

src/materials/MaterialBase.ts:333

destroy ​

▸ destroy(): void

destroy self

Returns ​

void

Inherited from ​

MaterialBase.destroy

Defined in ​

src/materials/MaterialBase.ts:346

clone ​

▸ clone(): any

clone one material

Returns ​

any

Material

Inherited from ​

MaterialBase.clone

Defined in ​

src/materials/MaterialBase.ts:355

setShader ​

▸ setShader(vs, fs): RenderShader

Parameters ​

Returns ​

RenderShader

Inherited from ​

MaterialBase.setShader

Defined in ​

src/materials/MaterialPass.ts:39

getShader ​

▸ getShader(): RenderShader

Returns ​

RenderShader

Inherited from ​

MaterialBase.getShader

Defined in ​

src/materials/MaterialPass.ts:46

Properties ​

name ​

• name: string

name of this material

Inherited from ​

MaterialBase.name

Defined in ​

src/materials/MaterialBase.ts:23

instanceID ​

• instanceID: string

Material Unique Identifier

Inherited from ​

MaterialBase.instanceID

Defined in ​

src/materials/MaterialBase.ts:29

isPassMaterial ​

• isPassMaterial: boolean = false

is PassMaterial

Inherited from ​

MaterialBase.isPassMaterial

Defined in ​

src/materials/MaterialBase.ts:34

receiveEnv ​

• receiveEnv: boolean = true

Whether to receive environment effect

Inherited from ​

MaterialBase.receiveEnv

Defined in ​

src/materials/MaterialBase.ts:39

renderPasses ​

• renderPasses: Map<RendererType, MaterialPass[]>

Inherited from ​

MaterialBase.renderPasses

Defined in ​

src/materials/MaterialPass.ts:8

enable ​

• enable: boolean = true

whether the pass is enable

Inherited from ​

MaterialBase.enable

Defined in ​

src/materials/MaterialPass.ts:13

renderShader ​

• renderShader: RenderShader

Inherited from ​

MaterialBase.renderShader

Defined in ​

src/materials/MaterialPass.ts:15