Class: ChromaKeyMaterial

ChromaKey Material Do not compute light, only read pixel color from a video source with a background color filter

Hierarchy

• Material

  ↳ ChromaKeyMaterial

Constructors

• constructor

Properties

• instanceID
• name
• enable

Accessors

• baseMap
• baseColor
• rectClip
• keyColor
• colorCutoff
• colorFeathering
• maskFeathering
• sharpening
• despoil
• despoilLuminanceAdd
• shader
• doubleSide
• castShadow
• acceptShadow
• castReflection
• blendMode
• depthCompare
• transparent
• cullMode
• depthWriteEnabled
• useBillboard

Methods

• debug
• getPass
• getAllPass
• clone
• destroy
• setDefine
• setTexture
• setStorageBuffer
• setUniformBuffer
• setUniformFloat
• setUniformVector2
• setUniformVector3
• setUniformVector4
• setUniformColor
• getUniformFloat
• getUniformV2
• getUniformV3
• getUniformV4
• getUniformColor
• getTexture
• getStorageBuffer
• getStructStorageBuffer
• getUniformBuffer
• applyUniform

Constructors

constructor

• new ChromaKeyMaterial(): ChromaKeyMaterial

Create new ChromaKey material

Returns

ChromaKeyMaterial

Overrides

Material.constructor

Defined in

packages/media-extention/ChromaKeyMaterial.ts:13

Properties

instanceID

• instanceID: string

Material Unique Identifier

Inherited from

Material.instanceID

Defined in

src/materials/Material.ts:19

---

name

• name: string

name of this material

Inherited from

Material.name

Defined in

src/materials/Material.ts:25

---

enable

• enable: boolean = true

Inherited from

Material.enable

Defined in

src/materials/Material.ts:27

Accessors

baseMap

• get baseMap(): Texture

Returns

Texture

Defined in

packages/media-extention/ChromaKeyMaterial.ts:57

• set baseMap(value): void

Parameters

Name	Type
value	Texture

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:53

---

baseColor

• get baseColor(): Color

get base color (tint color)

Returns

Color

Defined in

packages/media-extention/ChromaKeyMaterial.ts:71

• set baseColor(color): void

set base color (tint color)

Parameters

Name	Type
color	Color

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:64

---

rectClip

• get rectClip(): Vector4

Get current clip rect area

Returns

Vector4

Defined in

packages/media-extention/ChromaKeyMaterial.ts:85

• set rectClip(value): void

Set the clip rect area

Parameters

Name	Type
value	Vector4

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:78

---

keyColor

• get keyColor(): Color

Get the chromakey color

Returns

Color

Defined in

packages/media-extention/ChromaKeyMaterial.ts:99

• set keyColor(value): void

Set the chromakey color

Parameters

Name	Type
value	Color

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:92

---

colorCutoff

• get colorCutoff(): number

Get the color cutoff factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:113

• set colorCutoff(value): void

Set the color cutoff factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:106

---

colorFeathering

• get colorFeathering(): number

Get the color feather factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:127

• set colorFeathering(value): void

Set the color feather factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:120

---

maskFeathering

• get maskFeathering(): number

Get the mask feather factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:141

• set maskFeathering(value): void

Set the mask feather factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:134

---

sharpening

• get sharpening(): number

Get the sharpen factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:155

• set sharpening(value): void

Set the sharpen factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:148

---

despoil

• get despoil(): number

Get the despoil factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:169

• set despoil(value): void

Set the despoil factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:162

---

despoilLuminanceAdd

• get despoilLuminanceAdd(): number

Get the despoil luminance factor

Returns

number

Defined in

packages/media-extention/ChromaKeyMaterial.ts:183

• set despoilLuminanceAdd(value): void

Set the despoil luminance factor

Parameters

Name	Type
value	number

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:176

---

shader

• get shader(): Shader

Returns

Shader

Inherited from

Material.shader

Defined in

src/materials/Material.ts:41

• set shader(shader): void

Parameters

Name	Type
shader	Shader

Returns

void

Inherited from

Material.shader

Defined in

src/materials/Material.ts:36

---

doubleSide

• get doubleSide(): boolean

Returns

boolean

Inherited from

Material.doubleSide

Defined in

src/materials/Material.ts:45

• set doubleSide(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.doubleSide

Defined in

src/materials/Material.ts:49

---

castShadow

• get castShadow(): boolean

Returns

boolean

Inherited from

Material.castShadow

Defined in

src/materials/Material.ts:53

• set castShadow(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.castShadow

Defined in

src/materials/Material.ts:57

---

acceptShadow

• get acceptShadow(): boolean

Returns

boolean

Inherited from

Material.acceptShadow

Defined in

src/materials/Material.ts:64

• set acceptShadow(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.acceptShadow

Defined in

src/materials/Material.ts:68

---

castReflection

• get castReflection(): boolean

Returns

boolean

Inherited from

Material.castReflection

Defined in

src/materials/Material.ts:77

• set castReflection(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.castReflection

Defined in

src/materials/Material.ts:81

---

blendMode

• get blendMode(): BlendMode

Returns

BlendMode

Inherited from

Material.blendMode

Defined in

src/materials/Material.ts:85

• set blendMode(value): void

Parameters

Name	Type
value	BlendMode

Returns

void

Inherited from

Material.blendMode

Defined in

src/materials/Material.ts:89

---

depthCompare

• get depthCompare(): GPUCompareFunction

Returns

GPUCompareFunction

Inherited from

Material.depthCompare

Defined in

src/materials/Material.ts:93

• set depthCompare(value): void

Parameters

Name	Type
value	GPUCompareFunction

Returns

void

Inherited from

Material.depthCompare

Defined in

src/materials/Material.ts:97

---

transparent

• get transparent(): boolean

Returns

boolean

Inherited from

Material.transparent

Defined in

src/materials/Material.ts:102

• set transparent(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.transparent

Defined in

src/materials/Material.ts:106

---

cullMode

• get cullMode(): GPUCullMode

Returns

GPUCullMode

Inherited from

Material.cullMode

Defined in

src/materials/Material.ts:113

• set cullMode(value): void

Parameters

Name	Type
value	GPUCullMode

Returns

void

Inherited from

Material.cullMode

Defined in

src/materials/Material.ts:117

---

depthWriteEnabled

• get depthWriteEnabled(): boolean

Returns

boolean

Inherited from

Material.depthWriteEnabled

Defined in

src/materials/Material.ts:128

• set depthWriteEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.depthWriteEnabled

Defined in

src/materials/Material.ts:132

---

useBillboard

• set useBillboard(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

Material.useBillboard

Defined in

src/materials/Material.ts:136

Methods

debug

▸ debug(): void

Show a debug GUI

Returns

void

Defined in

packages/media-extention/ChromaKeyMaterial.ts:190

---

getPass

▸ getPass(passType): RenderShaderPass[]

get render pass by renderType

Parameters

Name	Type
passType	PassType

Returns

RenderShaderPass[]

Inherited from

Material.getPass

Defined in

src/materials/Material.ts:145

---

getAllPass

▸ getAllPass(): RenderShaderPass[]

get all color render pass

Returns

RenderShaderPass[]

Inherited from

Material.getAllPass

Defined in

src/materials/Material.ts:153

---

clone

▸ clone(): Material

clone one material

Returns

Material

Material

Inherited from

Material.clone

Defined in

src/materials/Material.ts:161

---

destroy

▸ destroy(force): void

Parameters

Name	Type
force	boolean

Returns

void

Inherited from

Material.destroy

Defined in

src/materials/Material.ts:168

---

setDefine

▸ setDefine(define, value): void

Parameters

Name	Type
define	string
value	boolean

Returns

void

Inherited from

Material.setDefine

Defined in

src/materials/Material.ts:174

---

setTexture

▸ setTexture(propertyName, texture): void

Parameters

Name	Type
propertyName	string
texture	Texture

Returns

void

Inherited from

Material.setTexture

Defined in

src/materials/Material.ts:178

---

setStorageBuffer

▸ setStorageBuffer(propertyName, buffer): void

Parameters

Name	Type
propertyName	string
buffer	StorageGPUBuffer

Returns

void

Inherited from

Material.setStorageBuffer

Defined in

src/materials/Material.ts:182

---

setUniformBuffer

▸ setUniformBuffer(propertyName, buffer): void

Parameters

Name	Type
propertyName	string
buffer	UniformGPUBuffer

Returns

void

Inherited from

Material.setUniformBuffer

Defined in

src/materials/Material.ts:186

---

setUniformFloat

▸ setUniformFloat(propertyName, value): void

Parameters

Name	Type
propertyName	string
value	number

Returns

void

Inherited from

Material.setUniformFloat

Defined in

src/materials/Material.ts:191

---

setUniformVector2

▸ setUniformVector2(propertyName, value): void

Parameters

Name	Type
propertyName	string
value	Vector2

Returns

void

Inherited from

Material.setUniformVector2

Defined in

src/materials/Material.ts:195

---

setUniformVector3

▸ setUniformVector3(propertyName, value): void

Parameters

Name	Type
propertyName	string
value	Vector3

Returns

void

Inherited from

Material.setUniformVector3

Defined in

src/materials/Material.ts:199

---

setUniformVector4

▸ setUniformVector4(propertyName, value): void

Parameters

Name	Type
propertyName	string
value	Vector4

Returns

void

Inherited from

Material.setUniformVector4

Defined in

src/materials/Material.ts:203

---

setUniformColor

▸ setUniformColor(propertyName, value): void

Parameters

Name	Type
propertyName	string
value	Color

Returns

void

Inherited from

Material.setUniformColor

Defined in

src/materials/Material.ts:207

---

getUniformFloat

▸ getUniformFloat(str): any

Parameters

Name	Type
str	string

Returns

any

Inherited from

Material.getUniformFloat

Defined in

src/materials/Material.ts:211

---

getUniformV2

▸ getUniformV2(str): Vector2

Parameters

Name	Type
str	string

Returns

Vector2

Inherited from

Material.getUniformV2

Defined in

src/materials/Material.ts:215

---

getUniformV3

▸ getUniformV3(str): Vector3

Parameters

Name	Type
str	string

Returns

Vector3

Inherited from

Material.getUniformV3

Defined in

src/materials/Material.ts:219

---

getUniformV4

▸ getUniformV4(str): Vector4

Parameters

Name	Type
str	string

Returns

Vector4

Inherited from

Material.getUniformV4

Defined in

src/materials/Material.ts:223

---

getUniformColor

▸ getUniformColor(str): Color

Parameters

Name	Type
str	string

Returns

Color

Inherited from

Material.getUniformColor

Defined in

src/materials/Material.ts:227

---

getTexture

▸ getTexture(str): Texture

Parameters

Name	Type
str	string

Returns

Texture

Inherited from

Material.getTexture

Defined in

src/materials/Material.ts:231

---

getStorageBuffer

▸ getStorageBuffer(str): StorageGPUBuffer

Parameters

Name	Type
str	string

Returns

StorageGPUBuffer

Inherited from

Material.getStorageBuffer

Defined in

src/materials/Material.ts:235

---

getStructStorageBuffer

▸ getStructStorageBuffer(str): GPUBufferBase

Parameters

Name	Type
str	string

Returns

GPUBufferBase

Inherited from

Material.getStructStorageBuffer

Defined in

src/materials/Material.ts:239

---

getUniformBuffer

▸ getUniformBuffer(str): GPUBufferBase

Parameters

Name	Type
str	string

Returns

GPUBufferBase

Inherited from

Material.getUniformBuffer

Defined in

src/materials/Material.ts:243

---

applyUniform

▸ applyUniform(): void

Returns

void

Inherited from

Material.applyUniform

Defined in

src/materials/Material.ts:247