This class inherits from the BaseRenderTarget class. BaseRenderTarget class is not available for creation and is used like the base class for DepthStencilRenderTarget class to provide access to targetTexture, inputTexture and maskTexture properties.

interface DepthStencilRenderTarget {
    clearDepthValue: number;
    clearStencilValue: number;
    depthClearOption: DepthClearOption;
    inputTexture: Texture;
    maskTexture: Texture;
    stencilClearOption: StencilClearOption;
    targetTexture: Texture;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

clearDepthValue: number

Float value in range [0.0..1.0] used in depth buffer clear operation in "CustomValue" mode. The initial value is 1.0.

clearStencilValue: number

Unsigned int value in range [0..0xFF] used in stencil buffer clear operation in "CustomValue" mode. The initial value is 0.

depthClearOption: DepthClearOption

The same as "depthClearOption" property of DepthStencilRenderTargetProvider. But if Camera's depth clear option property is set to "CustomValue" or "CustomTexture" then this has priority over depth/stencil provider settings.

inputTexture: Texture

Color texture used in clear color operation in "CustomTexture" mode.

maskTexture: Texture

Texture used like a color mask for target texture.

stencilClearOption: StencilClearOption

The same as "stencilClearOption" property of DepthStencilRenderTargetProvider. But if Camera's stencil clear option property is set to "CustomValue" or "CustomTexture" then this has priority over depth/stencil provider settings.

targetTexture: Texture

Render target texture. Camera will render scene color values to this texture.

Methods

  • 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