postprocessing - v7.0.0-beta.16
    Preparing search index...

    Class GeometryPass

    A geometry pass.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    alpha: boolean

    Controls whether color buffers should use an alpha channel.

    Disabling alpha enables small internal float formats for reduced memory consumption.

    depthBuffer: boolean

    Determines whether a depth buffer should be created.

    true
    
    disposables: Set<Disposable>

    A collection of objects that will be disposed when this pass is disposed.

    IO resources, materials and subpasses will be disposed separately and don't need to be added.

    frameBufferType: TextureDataType

    The texture data type used for color buffers.

    Disabling alpha enables small internal float formats for reduced memory consumption.

    gBufferConfig: GBufferConfig

    A G-Buffer configuration.

    id: number

    An identifier.

    input: Input

    The input resources of this pass.

    materials: Set<null>

    A collection of fullscreen materials that are used by this pass.

    This only needs to be filled if multiple fullscreen materials are used. The initial fullscreenMaterial will automatically be added.

    output: Output

    The output resources of this pass.

    resolution: Resolution

    The current resolution.

    scissor: Scissor

    A rectangular area inside the viewport. Fragments that are outside the area will not be rendered.

    Scissor.enabled to enable the scissor.

    selection: Selection

    An object selection.

    stencilBuffer: boolean

    Determines whether a stencil buffer should be created.

    false
    
    viewport: Viewport

    The viewport.

    Viewport.enabled to enable the viewport.

    Accessors

    • get attached(): boolean

      Indicates whether this pass is currently attached to another pass or a render pipeline.

      Returns boolean

    • set attached(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get autoSRGB(): boolean

      Controls automatic sRGB encoding for low precision output buffers.

      Returns boolean

      true
      
    • set autoSRGB(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get autoSyncDefaultBuffers(): boolean

      Controls whether the settings of the input and output default buffers should be synchronized.

      Returns boolean

      true
      
    • set autoSyncDefaultBuffers(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get enabled(): boolean

      Indicates whether this pass is enabled.

      Returns boolean

      true
      
    • set enabled(value: boolean): void

      Indicates whether this pass is enabled.

      Parameters

      • value: boolean

      Returns void

      true
      

    Methods

    • Checks if the current renderer supports all features that are required by this pass.

      Override this method to check if the current device supports the necessary features. This method should throw an error if the requirements are not met.

      Returns void

      If the device doesn't meet the requirements.

    • Checks if this pass uses convolution shaders.

      Only works on passes that use a FullscreenMaterial.

      Parameters

      • recursive: boolean

        Controls whether subpasses should be checked recursively.

      Returns boolean

      True if the pass uses convolution shaders.

    • Performs tasks when a child node is removed from the current scene.

      Note: This method will only be called for child nodes and not for the scene itself.

      Parameters

      • object: Object3D

        The child node that was removed.

      Returns void

    • Defines all possible G-Buffer texture configs and updates the G-Buffer.

      Returns void