StereoscopicInterlacePostProcessI

StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • new StereoscopicInterlacePostProcessI(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean): StereoscopicInterlacePostProcessI
  • Initializes a StereoscopicInterlacePostProcessI

    Parameters

    • name: string

      The name of the effect.

    • rigCameras: Camera[]

      The rig cameras to be appled to the post process

    • isStereoscopicHoriz: boolean

      If the rendered results are horizontal or vertical

    • isStereoscopicInterlaced: boolean

      If the rendered results are alternate line interlaced

    • Optional samplingMode: number

      The sampling mode to be used when computing the pass. (default: 0)

    • Optional engine: Engine

      The engine which the post process will be applied. (default: current engine)

    • Optional reusable: boolean

      If the post process can be reused on the same frame. (default: false)

    Returns StereoscopicInterlacePostProcessI

Properties

adaptScaleToCurrentViewport

Find examples in Playground
adaptScaleToCurrentViewport: boolean

Modify the scale of the post process to be the same as the viewport (default: false)

alphaConstants

Find examples in Playground
alphaConstants: Color4

Sets the setAlphaBlendConstants of the babylon engine

alphaMode

Find examples in Playground
alphaMode: number

Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)

alwaysForcePOT

Find examples in Playground
alwaysForcePOT: boolean

Force textures to be a power of two (default: false)

animations

Find examples in Playground
animations: Animation[]

Animations to be used for the post processing

autoClear

Find examples in Playground
autoClear: boolean

If the buffer needs to be cleared before applying the post process. (default: true) Should be set to false if shader will overwrite all previous pixels.

clearColor

Find examples in Playground
clearColor: Color4

Clear color to use when screen clearing

enablePixelPerfectMode

Find examples in Playground
enablePixelPerfectMode: boolean

Enable Pixel Perfect mode where texture is not scaled to be power of 2. Can only be used on a single postprocess or on the last one of a chain. (default: false)

forceFullscreenViewport

Find examples in Playground
forceFullscreenViewport: boolean

Force the postprocess to be applied without taking in account viewport

height

Find examples in Playground
height: number

Height of the texture to apply the post process on

inspectableCustomProperties

Find examples in Playground
inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

https://doc.babylonjs.com/how_to/debug_layer#extensibility

name

Find examples in Playground
name: string

Name of the PostProcess.

nodeMaterialSource

Find examples in Playground
nodeMaterialSource: Nullable<NodeMaterial>

Gets the node material used to create this postprocess (null if the postprocess was manually created)

onActivateObservable

Find examples in Playground
onActivateObservable: Observable<Camera>

An event triggered when the postprocess is activated.

onAfterRenderObservable

Find examples in Playground
onAfterRenderObservable: Observable<Effect>

An event triggered after rendering the postprocess

onApplyObservable

Find examples in Playground
onApplyObservable: Observable<Effect>

An event triggered when the postprocess applies its effect.

onBeforeRenderObservable

Find examples in Playground
onBeforeRenderObservable: Observable<Effect>

An event triggered before rendering the postprocess

onSizeChangedObservable

Find examples in Playground
onSizeChangedObservable: Observable<PostProcess>

An event triggered when the postprocess changes its size.

renderTargetSamplingMode

Find examples in Playground
renderTargetSamplingMode: number

Sampling mode used by the shader See https://doc.babylonjs.com/classes/3.1/texture

scaleMode

Find examples in Playground
scaleMode: number

Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)

Value Type Description
1 SCALEMODE_FLOOR engine.scalemode_floor
2 SCALEMODE_NEAREST engine.scalemode_nearest
3 SCALEMODE_CEILING engine.scalemode_ceiling

uniqueId

Find examples in Playground
uniqueId: number

Gets or sets the unique id of the post process

width

Find examples in Playground
width: number

Width of the texture to apply the post process on

Accessors

aspectRatio

Find examples in Playground
  • get aspectRatio(): number

inputTexture

Find examples in Playground
  • The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.

    Returns InternalTexture

  • The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.

    Parameters

    Returns any

isSupported

Find examples in Playground
  • get isSupported(): boolean

onActivate

Find examples in Playground
  • set onActivate(callback: Nullable<function>): any

onAfterRender

Find examples in Playground
  • set onAfterRender(callback: function): any

onApply

Find examples in Playground
  • set onApply(callback: function): any

onBeforeRender

Find examples in Playground
  • set onBeforeRender(callback: function): any

onSizeChanged

Find examples in Playground
  • set onSizeChanged(callback: function): any

samples

Find examples in Playground
  • get samples(): number
  • set samples(n: number): any

texelSize

Find examples in Playground

Methods

activate

Find examples in Playground
  • Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable. When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.

    Parameters

    • camera: Nullable<Camera>

      The camera that will be used in the post process. This camera will be used when calling onActivateObservable.

    • Optional sourceTexture: Nullable<InternalTexture>

      The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)

    • Optional forceDepthStencil: boolean

      If true, a depth and stencil buffer will be generated. (default: false)

    Returns InternalTexture

    The target texture that was bound to be written to.

apply

Find examples in Playground

dispose

Find examples in Playground
  • dispose(camera?: Camera): void

getCamera

Find examples in Playground

getClassName

Find examples in Playground
  • getClassName(): string

getEffect

Find examples in Playground

getEffectName

Find examples in Playground
  • getEffectName(): string

getEngine

Find examples in Playground

isReady

Find examples in Playground
  • isReady(): boolean

isReusable

Find examples in Playground
  • isReusable(): boolean

markTextureDirty

Find examples in Playground
  • markTextureDirty(): void

restoreDefaultInputTexture

Find examples in Playground
  • restoreDefaultInputTexture(): void

shareOutputWith

Find examples in Playground

updateEffect

Find examples in Playground
  • updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: function, onError?: function, vertexUrl?: string, fragmentUrl?: string): void
  • Updates the effect with the current post process compile time values and recompiles the shader.

    Parameters

    • Optional defines: Nullable<string>

      Define statements that should be added at the beginning of the shader. (default: null)

    • Optional uniforms: Nullable<string[]>

      Set of uniform variables that will be passed to the shader. (default: null)

    • Optional samplers: Nullable<string[]>

      Set of Texture2D variables that will be passed to the shader. (default: null)

    • Optional indexParameters: any

      The index parameters to be used for babylons include syntax "#include[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx

    • Optional onCompiled: function

      Called when the shader has been compiled.

        • Parameters

          Returns void

    • Optional onError: function

      Called if there is an error when compiling a shader.

        • (effect: Effect, errors: string): void
        • Parameters

          • effect: Effect
          • errors: string

          Returns void

    • Optional vertexUrl: string

      The url of the vertex shader to be used (default: the one given at construction time)

    • Optional fragmentUrl: string

      The url of the fragment shader to be used (default: the one given at construction time)

    Returns void

useOwnOutput

Find examples in Playground
  • useOwnOutput(): void
  • Reverses the effect of calling shareOutputWith and returns the post process back to its original state. This should be called if the post process that shares output with this post process is disabled/disposed.

    Returns void

Generated using TypeDoc