@tmrw-realityos/charm

---

@tmrw-realityos/charm / Material

Class: Material

Defined in: packages/charm/src/scene/material.ts:37

Constructors

Constructor

new Material(): Material

Defined in: packages/charm/src/scene/material.ts:77

Returns

Material

Properties

alphaCutoff

alphaCutoff: number = 0.5

Defined in: packages/charm/src/scene/material.ts:55

---

alphaMode

alphaMode: eAlphaType = eAlphaType.OPAQUE

Defined in: packages/charm/src/scene/material.ts:47

---

baseColor

baseColor: vec4

Defined in: packages/charm/src/scene/material.ts:50

---

clearcoatFactor

clearcoatFactor: number = 0.0

Defined in: packages/charm/src/scene/material.ts:65

---

clearcoatNormalFactor

clearcoatNormalFactor: number = 1.0

Defined in: packages/charm/src/scene/material.ts:67

---

clearcoatRoughnessFactor

clearcoatRoughnessFactor: number = 0.0

Defined in: packages/charm/src/scene/material.ts:66

---

dataBufferF32

dataBufferF32: undefined | Float32Array<ArrayBufferLike>

Defined in: packages/charm/src/scene/material.ts:70

---

dataBufferU32

dataBufferU32: undefined | Uint32Array<ArrayBufferLike>

Defined in: packages/charm/src/scene/material.ts:71

---

detailFactor

detailFactor: number = 0.0

Defined in: packages/charm/src/scene/material.ts:60

---

displacementFactor

displacementFactor: number = 0.0

Defined in: packages/charm/src/scene/material.ts:59

---

doubleSided

doubleSided: boolean = false

Defined in: packages/charm/src/scene/material.ts:48

---

emissiveColor

emissiveColor: vec3

Defined in: packages/charm/src/scene/material.ts:54

---

has_changed

has_changed: boolean = true

Defined in: packages/charm/src/scene/material.ts:45

---

index

index: number = -1

Defined in: packages/charm/src/scene/material.ts:43

---

indexInBuffer

indexInBuffer: number = -1

Defined in: packages/charm/src/scene/material.ts:44

---

lastFrameUpdated

lastFrameUpdated: number = -1

Defined in: packages/charm/src/scene/material.ts:72

---

metallicFactor

metallicFactor: number = 1.0

Defined in: packages/charm/src/scene/material.ts:52

---

model

model: string = "pbr"

Defined in: packages/charm/src/scene/material.ts:42

---

name

name: string = ""

Defined in: packages/charm/src/scene/material.ts:41

---

normalFactor

normalFactor: number = 1.0

Defined in: packages/charm/src/scene/material.ts:56

---

normalTextureScale

normalTextureScale: number = 1.0

Defined in: packages/charm/src/scene/material.ts:62

---

occlusionFactor

occlusionFactor: number = 1.0

Defined in: packages/charm/src/scene/material.ts:57

---

occlusionTextureStrength

occlusionTextureStrength: number = 1.0

Defined in: packages/charm/src/scene/material.ts:63

---

roughnessFactor

roughnessFactor: number = 1.0

Defined in: packages/charm/src/scene/material.ts:53

---

specularColor

specularColor: vec4

Defined in: packages/charm/src/scene/material.ts:51

---

textures

textures: (undefined | TextureInfo)[]

Defined in: packages/charm/src/scene/material.ts:75

---

transmissionFactor

transmissionFactor: number = 0.0

Defined in: packages/charm/src/scene/material.ts:58

---

channels

static channels: typeof eTextureChannel = eTextureChannel

Defined in: packages/charm/src/scene/material.ts:39

Accessors

color

Get Signature

get color(): vec4

Defined in: packages/charm/src/scene/material.ts:88

Returns

vec4

Set Signature

set color(v): void

Defined in: packages/charm/src/scene/material.ts:82

Parameters

v

vec3 | vec4 | number[]

Returns

void

---

opacity

Get Signature

get opacity(): number

Defined in: packages/charm/src/scene/material.ts:92

Returns

number

Set Signature

set opacity(v): void

Defined in: packages/charm/src/scene/material.ts:96

Parameters

v

number

Returns

void

Methods

setTexture()

setTexture(channel, texture): undefined | TextureInfo

Defined in: packages/charm/src/scene/material.ts:101

Parameters

channel

eTextureChannel

texture

undefined | null | string

Returns

undefined | TextureInfo

---

setTextureTransform()

setTextureTransform(channel, tileX, tileY, offsetX, offsetY, angle): void

Defined in: packages/charm/src/scene/material.ts:130

Parameters

channel

eTextureChannel

tileX

number

tileY

number

offsetX

number = 0

offsetY

number = 0

angle

number = 0

Returns

void