Class FilmGrain

Hierarchy (View Summary)

ASinglePassPostEffect
- FilmGrain

Constructors

constructor

new FilmGrain(redGPUContext: RedGPUContext): FilmGrain
Parameters
- redGPUContext: RedGPUContext
Returns FilmGrain
Overrides ASinglePassPostEffect.constructor
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:49

Properties

`Static`HEAVY

HEAVY: {
    coloredGrain: number;
    filmGrainIntensity: number;
    filmGrainResponse: number;
    filmGrainScale: number;
    grainSaturation: number;
} = HEAVY

`Static`MEDIUM

MEDIUM: {
    coloredGrain: number;
    filmGrainIntensity: number;
    filmGrainResponse: number;
    filmGrainScale: number;
    grainSaturation: number;
} = MEDIUM

`Static`SUBTLE

SUBTLE: {
    coloredGrain: number;
    filmGrainIntensity: number;
    filmGrainResponse: number;
    filmGrainScale: number;
    grainSaturation: number;
} = SUBTLE

`Static`VINTAGE

VINTAGE: {
    coloredGrain: number;
    filmGrainIntensity: number;
    filmGrainResponse: number;
    filmGrainScale: number;
    grainSaturation: number;
} = VINTAGE

Accessors

coloredGrain

get coloredGrain(): number
Returns number
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:87
set coloredGrain(value: number): void
Parameters
- value: number
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:91

filmGrainIntensity

get filmGrainIntensity(): number
Returns number
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:60
set filmGrainIntensity(value: number): void
Parameters
- value: number
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:64

filmGrainResponse

get filmGrainResponse(): number
Returns number
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:69
set filmGrainResponse(value: number): void
Parameters
- value: number
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:73

filmGrainScale

get filmGrainScale(): number
Returns number
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:78
set filmGrainScale(value: number): void
Parameters
- value: number
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:82

grainSaturation

get grainSaturation(): number
Returns number
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:96
set grainSaturation(value: number): void
Parameters
- value: number
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:100

outputTextureView

get outputTextureView(): GPUTextureView[]
Returns GPUTextureView[]
Inherited from ASinglePassPostEffect.outputTextureView
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:108

redGPUContext

get redGPUContext(): RedGPUContext
Returns RedGPUContext
Inherited from ASinglePassPostEffect.redGPUContext
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:57

shaderInfo

get shaderInfo(): any
Returns any
Inherited from ASinglePassPostEffect.shaderInfo
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:65

storageInfo

get storageInfo(): any
Returns any
Inherited from ASinglePassPostEffect.storageInfo
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:61

systemUuniformsInfo

get systemUuniformsInfo(): any
Returns any
Inherited from ASinglePassPostEffect.systemUuniformsInfo
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:79

uniformBuffer

get uniformBuffer(): UniformBuffer
Returns UniformBuffer
Inherited from ASinglePassPostEffect.uniformBuffer
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:70

uniformsInfo

get uniformsInfo(): any
Returns any
Inherited from ASinglePassPostEffect.uniformsInfo
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:74

useDepthTexture

get useDepthTexture(): boolean
Returns boolean
Inherited from ASinglePassPostEffect.useDepthTexture
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:49
set useDepthTexture(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ASinglePassPostEffect.useDepthTexture
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:53

videoMemorySize

get videoMemorySize(): number
Returns number
Inherited from ASinglePassPostEffect.videoMemorySize
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:45

WORK_SIZE_X

get WORK_SIZE_X(): number
Returns number
Inherited from ASinglePassPostEffect.WORK_SIZE_X
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:84
set WORK_SIZE_X(value: number): void
Parameters
- value: number
Returns void
Inherited from ASinglePassPostEffect.WORK_SIZE_X
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:88

WORK_SIZE_Y

get WORK_SIZE_Y(): number
Returns number
Inherited from ASinglePassPostEffect.WORK_SIZE_Y
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:92
set WORK_SIZE_Y(value: number): void
Parameters
- value: number
Returns void
Inherited from ASinglePassPostEffect.WORK_SIZE_Y
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:96

WORK_SIZE_Z

get WORK_SIZE_Z(): number
Returns number
Inherited from ASinglePassPostEffect.WORK_SIZE_Z
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:100
set WORK_SIZE_Z(value: number): void
Parameters
- value: number
Returns void
Inherited from ASinglePassPostEffect.WORK_SIZE_Z
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:104

Methods

applyPreset

applyPreset(
    preset:
        | {
            coloredGrain: number;
            filmGrainIntensity: number;
            filmGrainResponse: number;
            filmGrainScale: number;
            grainSaturation: number;
        }
        | {
            coloredGrain: number;
            filmGrainIntensity: number;
            filmGrainResponse: number;
            filmGrainScale: number;
            grainSaturation: number;
        }
        | {
            coloredGrain: number;
            filmGrainIntensity: number;
            filmGrainResponse: number;
            filmGrainScale: number;
            grainSaturation: number;
        }
        | {
            coloredGrain: number;
            filmGrainIntensity: number;
            filmGrainResponse: number;
            filmGrainScale: number;
            grainSaturation: number;
        },
): void
Parameters
- preset:
      | {
          coloredGrain: number;
          filmGrainIntensity: number;
          filmGrainResponse: number;
          filmGrainScale: number;
          grainSaturation: number;
      }
      | {
          coloredGrain: number;
          filmGrainIntensity: number;
          filmGrainResponse: number;
          filmGrainScale: number;
          grainSaturation: number;
      }
      | {
          coloredGrain: number;
          filmGrainIntensity: number;
          filmGrainResponse: number;
          filmGrainScale: number;
          grainSaturation: number;
      }
      | {
          coloredGrain: number;
          filmGrainIntensity: number;
          filmGrainResponse: number;
          filmGrainScale: number;
          grainSaturation: number;
      }
Returns void
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:105

clear

clear(): void
Returns void
Inherited from ASinglePassPostEffect.clear
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:116

execute

execute(gpuDevice: GPUDevice, width: number, height: number): void
Parameters
- gpuDevice: GPUDevice
- width: number
- height: number
Returns void
Inherited from ASinglePassPostEffect.execute
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:163

getOutputTextureView

getOutputTextureView(): GPUTextureView
Returns GPUTextureView
Inherited from ASinglePassPostEffect.getOutputTextureView
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:112

init

init(
    redGPUContext: RedGPUContext,
    name: string,
    computeCodes: { msaa: string; nonMsaa: string },
    bindGroupLayout?: GPUBindGroupLayout,
): void
Parameters
- redGPUContext: RedGPUContext
- name: string
- computeCodes: { msaa: string; nonMsaa: string }
- OptionalbindGroupLayout: GPUBindGroupLayout
Returns void
Inherited from ASinglePassPostEffect.init
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:124

render

render(
    view: View3D,
    width: number,
    height: number,
    ...sourceTextureView: any[],
): GPUTextureView
Parameters
- view: View3D
- width: number
- height: number
- ...sourceTextureView: any[]
Returns GPUTextureView
Inherited from ASinglePassPostEffect.render
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:174

update

update(deltaTime: number): void
Parameters
- deltaTime: number
Returns void
Overrides ASinglePassPostEffect.update
- Defined in src/postEffect/effects/filmGrain/FilmGrain.ts:114

updateUniform

updateUniform(key: string, value: number | boolean | number[]): void
Parameters
- key: string
- value: number | boolean | number[]
Returns void
Inherited from ASinglePassPostEffect.updateUniform
- Defined in src/postEffect/core/ASinglePassPostEffect.ts:286

Class FilmGrain

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FilmGrain

Properties

StaticHEAVY

StaticMEDIUM

StaticSUBTLE

StaticVINTAGE

Accessors

coloredGrain

Returns number

Parameters

Returns void

filmGrainIntensity

Returns number

Parameters

Returns void

filmGrainResponse

Returns number

Parameters

Returns void

filmGrainScale

Returns number

Parameters

Returns void

grainSaturation

Returns number

Parameters

Returns void

outputTextureView

Returns GPUTextureView[]

redGPUContext

Returns RedGPUContext

shaderInfo

Returns any

storageInfo

Returns any

systemUuniformsInfo

Returns any

uniformBuffer

Returns UniformBuffer

uniformsInfo

Returns any

useDepthTexture

Returns boolean

Parameters

Returns void

videoMemorySize

Returns number

WORK_SIZE_X

Returns number

Parameters

Returns void

WORK_SIZE_Y

Returns number

Parameters

Returns void

WORK_SIZE_Z

Returns number

Parameters

Returns void

Methods

applyPreset

Parameters

Returns void

clear

Returns void

execute

Parameters

Returns void

getOutputTextureView

Returns GPUTextureView

`Static`HEAVY

`Static`MEDIUM

`Static`SUBTLE

`Static`VINTAGE