Preparing search index...

    Class RenderTargetProvider

    Controls a camera texture resource. Can be accessed through Texture.control on a Camera texture. For more information, see the Camera and Layers guide.

    Hierarchy (View Summary)

    Index

    Properties

    antialiasingMode: AntialiasingMode

    The anti-aliasing technique applied on the render target.

    Lens Scripting Version 305

    RenderTargetProvider.AntialiasingMode.Disabled
    
    antialiasingQuality: AntialiasingQuality

    The quality of the anti-aliasing technique applied on the render target.

    Lens Scripting Version 305

    RenderTargetProvider.AntialiasingQuality.Default
    
    clearColor: vec4

    When clearColorEnabled is true and inputTexture is null, this color is used to clear this RenderTarget the first time it is drawn to each frame.

    (0, 0, 0, 1)
    
    clearColorEnabled: boolean

    If true, the color on this RenderTarget will be cleared the first time it is drawn to each frame. inputTexture will be used to clear it unless it is null, in which case clearColor is used instead.

    clearColorOption: ClearColorOption

    Sets the clear color option.

    Lens Scripting Version 141

    ClearColorOption.Background
    
    clearDepthEnabled: boolean

    If true, the depth buffer will be cleared on this RenderTarget the first time it is drawn to each frame.

    true
    
    depthBufferUsage: DepthBufferUsage

    Controls the depth buffer usage strategy for this render target.

    Lens Scripting Version 336

    RenderTargetProvider.DepthBufferUsage.Auto
    
    inputTexture: Texture

    When clearColorEnabled is true, this texture is used to clear this RenderTarget the first time it is drawn to each frame. If this texture is null, clearColor will be used instead.

    null
    
    mipmapsEnabled: boolean

    If true, mipmaps will be generated for this render target.

    false
    
    msaaStrategy: MSAAStrategy

    How MSAA should be applied on the render target.

    Lens Scripting Version 305

    RenderTargetProvider.MSAAStrategy.OnlyWhenRequired
    
    outputResolution: OutputResolution

    Controls the resolution source for this render target.

    Lens Scripting Version 336

    RenderTargetProvider.OutputResolution.Custom
    
    resolution: vec2

    When useScreenResolution is false, controls the horizontal and vertical resolution of the Render Target.

    (0, 0)
    
    resolutionScale: number

    When Use Screen Resolution is enabled, this scales the render target resolution relative to the device resolution.

    Lens Scripting Version 190

    1
    
    sliceCount: number

    sliceCount refers to the number of slices in a texture array or 3D texture.

    Lens Scripting Version 336

    textureType: TextureType

    The texture type of the render target.

    RenderTargetProvider.TextureType.Texture2D
    
    useScreenResolution: boolean

    If true, the Render Target's resolution will match the device's screen resolution.

    false
    

    Methods

    • Returns the texture's aspect ratio, which is calculated as width / height.

      Returns number

    • Returns the width of the texture in pixels.

      Returns number

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean