Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NgxPassComponent

The Pass component.

See the ngx3js docs page for details. See the ngx effect page for a live demo.

Three Type Type Key Acceptable Input
AdaptiveToneMappingPass AdaptiveToneMappingPass, AdaptiveToneMapping adaptive, resolution
AfterimagePass AfterimagePass, Afterimage damp
BloomPass BloomPass, Bloom strength, kernelSize, sigma, resolution
BokehPass BokehPass, Bokeh focus, aspect, aperture, maxblur, width, height
CubeTexturePass CubeTexturePass, CubeTexture effectCamera, envMap, opacity
DotScreenPass DotScreenPass, DotScreen centerX, centerY, angle, scale
FilmPass FilmPass, Film noiseIntensity, scanlinesIntensity, scanlinesCount, grayscale
GlitchPass GlitchPass, Glitch dtSize, goWild
HalftonePass HalftonePass, Halftone size
ClearMaskPass ClearMaskPass, ClearMask
MaskPass MaskPass, Mask effectScene, effectCamera, inverse
OutlinePass OutlinePass, Outline effectScene, effectCamera, patternTexture, selectedObjects, visibleEdgeColor, hiddenEdgeColor, edgeGlow, usePatternTexture, edgeThickness, edgeStrength, downSampleRatio, pulsePeriod
RenderPass RenderPass, Render effectScene, effectCamera
SAOPass SAOPass, SAO effectScene, effectCamera, depthTexture, useNormals, width, height, output, saoBias, saoIntensity, saoScale, saoKernelRadius, saoMinResolution, saoBlur, saoBlurRadius, saoBlurStdDev, saoBlurDepthCutoff
SavePass SavePass, Save renderTarget
NgxShaderCopyPass CopyPass, Copy textureId
NgxShaderRGBShiftPass ShaderRGBShiftPass, RGBShift textureId, uniforms
NgxShaderBleachBypassPass BleachBypassPass, BleachBypass textureId, uniforms
NgxShaderSepiaPass SepiaPass, Sepia textureId, uniforms
NgxShaderVignettePass VignettePass, Vignette textureId, uniforms
NgxShaderGammaCorrectionPass GammaCorrectionPass, GammaCorrection textureId, uniforms
NgxShaderFXAAPass FXAAPass, FXAA textureId, uniforms
NgxShaderPixelPass PixelPass, Pixel textureId, uniforms
NgxShaderLuminosityPass LuminosityPass, Luminosity textureId, uniforms
NgxShaderDotScreenPass DotScreenPass, DotScreen textureId, uniforms
NgxShaderSobelOperatorPass SobelOperatorPass, SobelOperator textureId, uniforms
NgxShaderMaterialPass MaterialPass, Material textureId, uniforms
ShaderPass ShaderPass, Shader textureId, shader, uniforms
SMAAPass SMAAPass, SMAA textureId, uniforms
SSAARenderPass SSAARenderPass, SSAARender effectScene, effectCamera, clearColor, clearAlpha, sampleLevel, unbiased
SSAOPass SSAOPass, SSAO effectScene, effectCamera, kernelRadius, minDistance, maxDistance
TAARenderPass TAARenderPass, TAARender effectScene, effectCamera, clearColor, clearAlpha, sampleLevel, unbiased, accumulate
TexturePass TexturePass, Texture effectCamera, effectScene, opacity
UnrealBloomPass UnrealBloomPass, UnrealBloom width, height, strength, radius, threshold
SSRPass SSRPass, SSR mesh, effectScene, effectCamera, selects,
SSRrPass SSRrPass, SSRr effectScene, effectCamera, selects
LUTPass LUTPass, LUT intensity
ClearPass ClearPass, Clear clearColor, clearAlpha
<ngx3js-composer>
<ngx3js-pass [type]="'RenderPass'"></ngx3js-pass>
<ngx3js-pass
[type]="'FilmPass'"
[noiseIntensity]="0.35" [scanlinesIntensity]="0.75"
[scanlinesCount]="2048" [grayscale]="false"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'" [shader]="'CopyShader'"
></ngx3js-pass>
<ngx3js-pass [type]="'bloom'" [strength]="0.75"></ngx3js-pass>
<ngx3js-pass
[type]="'film'"
[noiseIntensity]="0.5"
[scanlinesIntensity]="0.5" [scanlinesCount]="1448"
[grayscale]="false"
></ngx3js-pass>
<ngx3js-pass
[type]="'shader'"
[shader]="'focus'"
[uniforms]="{ screenWidth: 2048, screenHeight: 2048 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'DotScreen'"
[uniforms]="{ scale: 2 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'RGBShift'"
[uniforms]="{ amount: 0.0015 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'BleachBypassShader'"
[uniforms]="{ opacity: 0.95 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'SepiaShader'"
[uniforms]="{ amount: 0.9 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'VignetteShader'"
[uniforms]="{ offset: 0.95, darkness: 1.6 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'GammaCorrectionShader'"
></ngx3js-pass>
<ngx3js-pass
[type]="'BloomPass'"
[strength]="0.5"
></ngx3js-pass>
<ngx3js-pass
[type]="'FilmPass'"
[noiseIntensity]="0.35"
[scanlinesIntensity]="0.025"
[scanlinesCount]="648"
[grayscale]="false"
></ngx3js-pass>
<ngx3js-pass
[type]="'FilmPass'"
[noiseIntensity]="0.35"
[scanlinesIntensity]="0.5"
[scanlinesCount]="2048"
[grayscale]="true"
></ngx3js-pass>
<ngx3js-pass
[type]="'DotScreenPass'"
[centerX]="0"
[centerY]="0"
[angle]="28"
[scale]="0.8"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'HorizontalBlurShader'"
[uniforms]="{ h: 2 / 400 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'VerticalBlurShader'"
[uniforms]="{ v: 2 / 400 }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'ColorifyShader'"
[uniforms]="{ color: '0xffc0c0' }"
></ngx3js-pass>
<ngx3js-pass
[type]="'ShaderPass'"
[shader]="'ColorifyShader'"
[uniforms]="{ color: '0xffb0b0' }"
></ngx3js-pass>
<ngx3js-pass [type]="'ClearMaskPass'"></ngx3js-pass>
<ngx3js-pass [type]="'MaskPass'"></ngx3js-pass>
<ngx3js-pass
[type]="'MaskPass'"
[inverse]="true"
></ngx3js-pass>
<ngx3js-pass
[type]="'RenderPass'"
[scene]="sceneBG"
[camera]="cameraOrtho"
></ngx3js-pass>
<ngx3js-pass
[type]="'RenderPass'"
[clear]="false"
[scene]="scene"
[camera]="camera"
></ngx3js-pass>
</ngx3js-composer>

Hierarchy

Implements

  • OnInit

Index

Constructors

constructor

Properties

Protected OBJECT_ATTR

OBJECT_ATTR: string[] = ...

Object attr of abstract subscribe component

Protected _changeList

_changeList: string[] = null

Change list of abstract subscribe component

Protected _needUpdate

_needUpdate: boolean = true

Need update of abstract subscribe component

accumulate

accumulate: boolean = null

The accumulate of pass component

adaptive

adaptive: boolean = null

The adaptive of pass component

angle

angle: number = null

The angle of pass component

aperture

aperture: number = null

The aperture of pass component

aspect

aspect: number = null

The aspect of pass component

bloomTexture

bloomTexture: any = null

The bloomTexture of pass component

camera

camera: any = null

The camera of pass component

centerX

centerX: number = null

The centerX of pass component

centerY

centerY: number = null

The centerY of pass component

clear

clear: boolean = null

The clear of pass component

clearAlpha

clearAlpha: number = null

The clearAlpha of pass component

clearColor

clearColor: INgxColor = null

The clearColor of pass component

damp

damp: number = null

The damp of pass component

debug

debug: boolean = false

Debug this Object

depthTexture

depthTexture: boolean = null

The depthTexture of pass component

downSampleRatio

downSampleRatio: number = null

The downSampleRatio of pass component

dtSize

dtSize: number = null

The dtSize of pass component

edgeGlow

edgeGlow: number = null

The edgeGlow of pass component

edgeStrength

edgeStrength: number = null

The edgeStrength of pass component

edgeThickness

edgeThickness: number = null

The edgeThickness of pass component

enabled

enabled: boolean = true

Enabled or Not

encoding

encoding: string = null

THREE.LinearEncoding is the default. See the texture constants page for details of other formats. Note that if this value is changed on a texture after the material has been used, it is necessary to trigger a Material.needsUpdate for this value to be realized in the shader.

Three Type Value String(case insensitive)
THREE.LinearEncoding LinearEncoding ,
THREE.sRGBEncoding sRGBEncoding ,
THREE.GammaEncoding GammaEncoding ,
THREE.RGBEEncoding RGBEEncoding ,
THREE.LogLuvEncoding LogLuvEncoding ,
THREE.RGBM7Encoding RGBM7Encoding ,
THREE.RGBM16Encoding RGBM16Encoding ,
THREE.RGBDEncoding RGBDEncoding ,

envMap

The envMap of pass component

focus

focus: number = null

The focus of pass component

fragmentShader

fragmentShader: string = null

The fragmentShader of pass component

goWild

goWild: boolean = null

The goWild of pass component

grayscale

grayscale: boolean = null

The grayscale of pass component

height

height: number = null

The size of height

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

hiddenEdgeColor

hiddenEdgeColor: INgxColor = null

The hiddenEdgeColor of pass component

Protected id

id: string = ''

The Id of abstract subscribe component

intensity

intensity: number = null

The intensity of pass component

inverse

inverse: boolean = null

The inverse of pass component

kernelRadius

kernelRadius: number = null

The kernelRadius of pass component

kernelSize

kernelSize: number = null

The kernelSize of pass component

lut

lut: string = null

The Input of pass component

Notice - case insensitive.

map

map: any = null

The map of pass component

materialShader

materialShader: string = null

The Input of pass component

Notice - case insensitive.

maxDistance

maxDistance: number = null

The maxDistance of pass component

maxblur

maxblur: number = null

The maxblur of pass component

mesh

mesh: any = null

Define whether the material uses morphTargets. Default is false.

minDistance

minDistance: number = null

The minDistance of pass component

morphTargets

morphTargets: boolean = null

Define whether the material uses morphTargets. Default is false.

needsSwap

needsSwap: boolean = null

The needsSwap of pass component

noiseIntensity

noiseIntensity: number = null

The noiseIntensity of pass component

onDestory

onDestory: EventEmitter<NgxPassComponent> = ...

Will be called when before destory. The argument will be the loaded self

onLoad

onLoad: EventEmitter<NgxPassComponent> = ...

Will be called when load completes. The argument will be the loaded self

opacity

opacity: number = null

The opacity of pass component

output

output: string = null

The Input of pass component

Notice - case insensitive.

overrideMaterial

overrideMaterial: I3JS.Material = null

The overrideMaterial of pass component

overrideParams

overrideParams: {} = null

The override params

Type declaration

  • [key: string]: any

params

params: BokehPassParamters = null

The params of pass component

Protected parent

parent: any = null

The Parent of abstract subscribe component

patternTexture

patternTexture: I3JS.Texture | NgxTextureComponent = null

The patternTexture of pass component

pulsePeriod

pulsePeriod: number = null

The pulsePeriod of pass component

radius

radius: number = null

The radius of pass component

refer

refer: NgxPassComponent = null

The refer of pass component

renderTarget

renderTarget: I3JS.WebGLRenderTarget = null

The renderTarget of pass component

renderToScreen

renderToScreen: boolean = null

The renderToScreen of pass component

resolution

resolution: number = null

The resolution of pass component

sampleLevel

sampleLevel: number = null

The sampleLevel of pass component

saoBias

saoBias: number = null

The saoBias of pass component

saoBlur

saoBlur: boolean = null

The saoBlur of pass component

saoBlurDepthCutoff

saoBlurDepthCutoff: number = null

The saoBlurDepthCutoff of pass component

saoBlurRadius

saoBlurRadius: number = null

The saoBlurRadius of pass component

saoBlurStdDev

saoBlurStdDev: number = null

The saoBlurStdDev of pass component

saoIntensity

saoIntensity: number = null

The saoIntensity of pass component

saoKernelRadius

saoKernelRadius: number = null

The saoKernelRadius of pass component

saoMinResolution

saoMinResolution: number = null

The saoMinResolution of pass component

saoScale

saoScale: number = null

The saoScale of pass component

scale

scale: number = null

The scale of pass component

scanlinesCount

scanlinesCount: number = null

The scanlinesCount of pass component

scanlinesIntensity

scanlinesIntensity: number = null

The scanlinesIntensity of pass component

scene

scene: any = null

The scene of pass component

selectedObjects

selectedObjects: any[] = null

The selectedObjects of pass component

selects

Define whether the material uses morphTargets. Default is false.

Protected selfAny

selfAny: any = ...

shader

shader: string = null

The Input of pass component

Notice - case insensitive.

sigma

sigma: number = null

The sigma of pass component

size

The size of pass component

strength

strength: number = null

The strength of pass component

Protected subscribeType

subscribeType: string = null

Subscribe type of abstract subscribe component

texture

texture: I3JS.Texture | NgxTextureComponent = null

The texture of pass component

textureId

textureId: string = null

The textureId of pass component

threshold

threshold: number = null

The threshold of pass component

tween

tween: {} = null

Tween animation params

Type declaration

  • [key: string]: any

type

type: string = ''

The Input of pass component

unbiased

unbiased: boolean = null

The unbiased of pass component

uniforms

uniforms: {} = null

The uniforms of pass component

Type declaration

  • [key: string]: any

use2DLut

use2DLut: boolean = null

The use2DLut of pass component

useNormals

useNormals: boolean = null

The useNormals of pass component

usePatternTexture

usePatternTexture: boolean = null

The usePatternTexture of pass component

userData

userData: any = null

An object that can be used to store custom data about the Object3D. It should not hold references to functions as these will not be cloned.

vertexShader

vertexShader: string = null

The vertexShader of pass component

visibleEdgeColor

visibleEdgeColor: INgxColor = null

The visibleEdgeColor of pass component

width

width: number = null

The size of width

  • type number fixed size
  • type string with include % relative size from renderer size for example in case renderer = 1024 '100%' = 1024, '50%' = 512, '50%-10' = 502, '50%+30' = 542

windowExport

windowExport: string = null

Export this Object to window global variables

Accessors

needUpdate

  • set needUpdate(value: boolean): void
  • Sets need update

    Parameters

    • value: boolean

    Returns void

Methods

addChanges

  • addChanges(key: string | string[] | SimpleChanges): void

applyChanges

  • applyChanges(changes: string[]): void

Protected callOnLoad

  • callOnLoad(): void

Protected checkChanges

  • checkChanges(changes: SimpleChanges): SimpleChanges

Protected clearChanges

  • clearChanges(): void

Protected consoleLog

  • consoleLog(key: string, object: any, level?: string): void

Protected consoleLogTime

  • consoleLogTime(key: string, object: any, repeat?: number): void

Protected destroyLocalComponent

  • destroyLocalComponent(key: string): void

dispose

  • dispose(): void

Protected getChanges

  • getChanges(): string[]

getId

  • getId(): string

getObject

  • getObject<T>(): T

getPass

  • getPass<T>(): T

getSubscribe

  • getSubscribe(): Observable<string[]>

Protected getTimeout

  • getTimeout(timeDelay?: number): Promise<void>

getUserData

  • getUserData(): {}

Protected initLocalComponent

  • initLocalComponent<T>(key: string, component: T): T

Protected isIdEuals

  • isIdEuals(id: string): boolean

ngAfterContentInit

  • ngAfterContentInit(): void

ngOnChanges

  • ngOnChanges(changes: SimpleChanges): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated. default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

    Parameters

    • changes: SimpleChanges

      The changed properties.

    Returns void

ngOnDestroy

  • ngOnDestroy(): void

ngOnInit

  • ngOnInit(): void
  • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

    Returns void

resetTween

  • resetTween(): void

runSubscribeNext

  • runSubscribeNext(key: string | string[]): void

setEffectComposer

Protected setObject

  • setObject(obj: any): void

setParent

  • setParent(parent: any): boolean

setScene

setSubscribeNext

  • setSubscribeNext(key: string | string[]): void

setSubscribeType

  • setSubscribeType(subscribeType: string): void

setTween

  • setTween(tweenData: {}): void

setTweenTarget

  • setTweenTarget(tweenTarget: any): void

setUserData

  • setUserData(key: string, value: any): void

Protected subscribeListQuery

  • subscribeListQuery(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeListQueryChange

  • subscribeListQueryChange(queryList: QueryList<any>, subscribeKey: string, changeKey: string): void

Protected subscribeRefer

  • subscribeRefer(key: string, subscription: Subscription): void

Protected subscribeReferList

  • subscribeReferList(key: string, subscription: Subscription): void

Protected unSubscribeRefer

  • unSubscribeRefer(key: string): void

Protected unSubscribeReferList

  • unSubscribeReferList(key: string): void

Protected unSubscription

  • unSubscription(subscriptions: Subscription[]): Subscription[]

updateInputParams

  • updateInputParams(params: {}, firstChange?: boolean, changes?: SimpleChanges, type?: string): void

Generated using TypeDoc