Options
Menu

Class DefaultRenderer

The DefaultRenderer class provides the default rendering method. It renders the scene graph objects using the materials assigned to them.

class

away.render.DefaultRenderer

Hierarchy

Implements

  • IRenderer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new DefaultRenderer(stage?: Stage, forceSoftware?: boolean, profile?: ContextGLProfile, mode?: ContextMode): DefaultRenderer

  • Creates a new DefaultRenderer object.

    Parameters

    • Default value stage: Stage = null
    • Default value forceSoftware: boolean = false
    • Default value profile: ContextGLProfile = ContextGLProfile.BASELINE
    • Default value mode: ContextMode = ContextMode.AUTO

    Returns DefaultRenderer

Properties

_cameraTransform

_cameraTransform: Matrix3D

_depthPrepass

_depthPrepass: boolean

_disableClear

_disableClear: boolean

_disableColor

_disableColor: boolean

_height

_height: number

Protected _materialGroup

_materialGroup: MaterialGroupBase

_pBackBufferInvalid

_pBackBufferInvalid: boolean

_pBlendedRenderableHead

_pBlendedRenderableHead: GL_RenderableBase

_pContext

_pContext: IContextGL

_pDepthRender

_pDepthRender: BitmapImage2D

_pDepthTextureInvalid

_pDepthTextureInvalid: boolean

_pFilter3DRenderer

_pFilter3DRenderer: Filter3DRenderer

_pNumElements

_pNumElements: number

_pOpaqueRenderableHead

_pOpaqueRenderableHead: GL_RenderableBase

_pRequireDepthRender

_pRequireDepthRender: boolean

_pRttBufferManager

_pRttBufferManager: RTTBufferManager

_pScissorRect

_pScissorRect: Rectangle

_pStage

_pStage: Stage

_renderBlended

_renderBlended: boolean

_width

_width: number

renderableSorter

renderableSorter: IEntitySorter

shareContext

shareContext: boolean

Defers control of ContextGL clear() and present() calls to Stage, enabling multiple Stage frameworks to share the same ContextGL object.

textureRatioX

textureRatioX: number

textureRatioY

textureRatioY: number

Static _iCollectionMark

_iCollectionMark: number

Static entityNames

entityNames: Array<string>

Static renderableNames

renderableNames: Array<string>

Accessors

_iBackgroundAlpha

  • get (): number
  • set (value: number): void

Private _iBackgroundB

  • get (): number
  • set (value: number): void

  • The background color's blue component, used when clearing.

    Returns number

  • The background color's blue component, used when clearing.

    Parameters

    • value: number

    Returns void

Private _iBackgroundG

  • get (): number
  • set (value: number): void

  • The background color's green component, used when clearing.

    Returns number

  • The background color's green component, used when clearing.

    Parameters

    • value: number

    Returns void

Private _iBackgroundR

  • get (): number
  • set (value: number): void

  • The background color's red component, used when clearing.

    Returns number

  • The background color's red component, used when clearing.

    Parameters

    • value: number

    Returns void

antiAlias

  • get (): number
  • set (value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

context

  • get (): IContextGL

cullPlanes

  • get (): Array<Plane3D>
  • set (value: Array<Plane3D>): void

depthPrepass

  • get (): boolean
  • set (value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

depthRenderer

disableClear

  • get (): boolean
  • set (value: boolean): void

disableColor

  • get (): boolean
  • set (value: boolean): void

distanceRenderer

filters3d

  • Returns Array<Filter3DBase>

  • Parameters

    Returns void

height

  • get (): number
  • set (value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

numElements

  • get (): number

renderBlended

  • get (): boolean
  • set (value: boolean): void

scissorRect

  • get (): Rectangle

  • A scissor rectangle equivalent of the view size and position.

    Returns Rectangle

stage

  • get (): Stage

  • The Stage that will provide the ContextGL used for rendering.

    Returns Stage

viewPort

  • get (): Rectangle

  • A viewPort rectangle equivalent of the Stage size and position.

    Returns Rectangle

width

  • get (): number
  • set (value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

x

  • get (): number
  • set (value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

y

  • get (): number
  • set (value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

Methods

_iRender

  • _iRender(projection: ProjectionBase, view: IView, target?: ImageBase, scissorRect?: Rectangle, surfaceSelector?: number): void

  • Renders the potentially visible geometry to the back buffer or texture.

    Parameters

    • projection: ProjectionBase
    • view: IView
    • Default value target: ImageBase = null

      An option target texture to render to.

    • Default value scissorRect: Rectangle = null
    • Default value surfaceSelector: number = 0

      The index of a CubeTexture's face to render to.

    Returns void

_iRenderCascades

  • _iRenderCascades(projection: ProjectionBase, view: IView, target: ImageBase, numCascades: number, scissorRects: Array<Rectangle>, projections: Array<ProjectionBase>): void

  • Parameters

    • projection: ProjectionBase
    • view: IView
    • target: ImageBase
    • numCascades: number
    • scissorRects: Array<Rectangle>
    • projections: Array<ProjectionBase>

    Returns void

_renderMasks

  • _renderMasks(projection: ProjectionBase, masks: IEntity[]): void

  • Parameters

    • projection: ProjectionBase
    • masks: IEntity[]

    Returns void

activatePass

  • activatePass(pass: IPass, projection: ProjectionBase): void

  • Parameters

    • pass: IPass
    • projection: ProjectionBase

    Returns void

addEventListener

  • addEventListener(type: string, listener: function): void

  • Add an event listener

    method

    addEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns void

applyDirectionalLight

  • applyDirectionalLight(entity: IEntity): void

applyEntity

  • applyEntity(entity: IEntity): void

  • Parameters

    • entity: IEntity

    Returns void

applyLightProbe

  • applyLightProbe(entity: IEntity): void

applyPointLight

  • applyPointLight(entity: IEntity): void

applyRenderable

  • applyRenderable(renderable: IRenderable): void

  • Parameters

    • renderable: IRenderable

    Returns void

deactivatePass

  • deactivatePass(pass: IPass): void

dispatchEvent

  • dispatchEvent(event: EventBase): void

  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void

drawRenderables

  • drawRenderables(projection: ProjectionBase, renderableGL: GL_RenderableBase): void

  • Draw a list of renderables.

    Parameters

    • projection: ProjectionBase
    • renderableGL: GL_RenderableBase

    Returns void

enterNode

  • enterNode(node: INode): boolean

  • Parameters

    • node: INode

    Returns boolean

hasEventListener

  • hasEventListener(type: string, listener?: function): boolean

  • check if an object has an event listener assigned to it

    method

    hasListener

    Parameters

    • type: string
    • Optional listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns boolean

onViewportUpdated

  • onViewportUpdated(event: StageEvent): void

pDraw

  • pDraw(projection: ProjectionBase): void

  • Performs the actual drawing of geometry to the target.

    Parameters

    • projection: ProjectionBase

    Returns void

pExecuteRender

  • pExecuteRender(projection: ProjectionBase, view: IView, target?: ImageBase, scissorRect?: Rectangle, surfaceSelector?: number): void

  • Parameters

    • projection: ProjectionBase
    • view: IView
    • Default value target: ImageBase = null
    • Default value scissorRect: Rectangle = null
    • Default value surfaceSelector: number = 0

    Returns void

pRenderDepthPrepass

  • pRenderDepthPrepass(view: IView): void

  • Parameters

    • view: IView

    Returns void

pRenderSceneDepthToTexture

  • pRenderSceneDepthToTexture(view: IView): void

  • Parameters

    • view: IView

    Returns void

pUpdateBackBuffer

  • pUpdateBackBuffer(): void

  • Updates the backbuffer dimensions.

    Returns void

queueSnapshot

  • queueSnapshot(bmd: BitmapImage2D): void

removeEventListener

  • removeEventListener(type: string, listener: function): void

  • Remove an event listener

    method

    removeEventListener

    Parameters

    • type: string
    • listener: function
        • (event: EventBase): void

        • Parameters

          • event: EventBase

          Returns void

    Returns void

render

  • render(view: IView): void

  • Parameters

    • view: IView

    Returns void

Static addEntityName

  • addEntityName(name: string): string

  • Parameters

    • name: string

    Returns string

Static addRenderableName

  • addRenderableName(name: string): string

  • Parameters

    • name: string

    Returns string

Generated using TypeDoc