Options
Menu

Class Stage

Stage provides a proxy class to handle the creation and attachment of the Context (and in turn the back buffer) it uses. Stage should never be created directly, but requested through StageManager.

see

away.managers.StageManager

Hierarchy

  • EventDispatcher

Implements

  • IAbstractionPool

Index

Constructors

constructor

  • Parameters

    • container: HTMLCanvasElement
    • stageIndex: number
    • stageManager: StageManager
    • Default value forceSoftware: boolean = false
    • Default value profile: ContextGLProfile = ContextGLProfile.BASELINE

    Returns Stage

Properties

globalDisableMipmap

globalDisableMipmap: boolean

globalDisableSmooth

globalDisableSmooth: boolean

Accessors

antiAlias

  • get (): number
  • set (antiAlias: number): void
  • The antiAliasing of the Stage.

    Returns number

  • The antiAliasing of the Stage.

    Parameters

    • antiAlias: number

    Returns void

bufferClear

  • get (): boolean
  • set (newBufferClear: boolean): void
  • The freshly cleared state of the backbuffer before any rendering

    Returns boolean

  • The freshly cleared state of the backbuffer before any rendering

    Parameters

    • newBufferClear: boolean

    Returns void

color

  • get (): number
  • set (color: number): void
  • The background color of the Stage.

    Returns number

  • The background color of the Stage.

    Parameters

    • color: number

    Returns void

container

  • get (): HTMLElement
  • Returns HTMLElement

context

  • The Context object associated with the given stage object.

    Returns IContextGL

enableDepthAndStencil

  • get (): boolean
  • set (enableDepthAndStencil: boolean): void
  • Returns boolean

  • Parameters

    • enableDepthAndStencil: boolean

    Returns void

height

  • get (): number
  • set (val: number): void
  • The height of the gl canvas

    Returns number

  • The height of the gl canvas

    Parameters

    • val: number

    Returns void

profile

renderSurfaceSelector

  • get (): number
  • Returns number

renderTarget

  • get (): ImageBase
  • Returns ImageBase

scissorRect

  • get (): Rectangle
  • set (value: Rectangle): void
  • Returns Rectangle

  • Parameters

    • value: Rectangle

    Returns void

stageIndex

  • get (): number
  • The index of the Stage which is managed by this instance of StageProxy.

    Returns number

usesSoftwareRendering

  • get (): boolean
  • Indicates whether the Stage managed by this proxy is running in software mode. Remember to wait for the CONTEXT_CREATED event before checking this property, as only then will it be guaranteed to be accurate.

    Returns boolean

viewPort

  • get (): Rectangle
  • A viewPort rectangle equivalent of the Stage size and position.

    Returns Rectangle

visible

  • get (): boolean
  • set (val: boolean): void
  • Returns boolean

  • Parameters

    • val: boolean

    Returns void

width

  • get (): number
  • set (val: number): void
  • The width of the gl canvas

    Returns number

  • The width of the gl canvas

    Parameters

    • val: number

    Returns void

x

  • get (): number
  • set (val: number): void
  • The x position of the gl canvas

    Returns number

  • The x position of the gl canvas

    Parameters

    • val: number

    Returns void

y

  • get (): number
  • set (val: number): void
  • The y position of the gl canvas

    Returns number

  • The y position of the gl canvas

    Parameters

    • val: number

    Returns void

Methods

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

clear

  • clear(): void
  • Returns void

clearAbstraction

  • clearAbstraction(asset: IAsset): void
  • Parameters

    • asset: IAsset

    Returns void

configureBackBuffer

  • configureBackBuffer(backBufferWidth: number, backBufferHeight: number, antiAlias: number, enableDepthAndStencil: boolean): void
  • Configures the back buffer associated with the Stage object.

    Parameters

    • backBufferWidth: number

      The width of the backbuffer.

    • backBufferHeight: number

      The height of the backbuffer.

    • antiAlias: number

      The amount of anti-aliasing to use.

    • enableDepthAndStencil: boolean

      Indicates whether the back buffer contains a depth and stencil buffer.

    Returns void

dispatchEvent

  • dispatchEvent(event: EventBase): void
  • Dispatch an event

    method

    dispatchEvent

    Parameters

    • event: EventBase

    Returns void

dispose

  • dispose(): void
  • Disposes the Stage object, freeing the Context attached to the Stage.

    Returns void

getAbstraction

  • getAbstraction(asset: IAsset): AbstractionBase
  • Parameters

    • asset: IAsset

    Returns AbstractionBase

getProgramData

  • getProgramData(vertexString: string, fragmentString: string): ProgramData
  • Parameters

    • vertexString: string
    • fragmentString: string

    Returns ProgramData

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

recoverFromDisposal

  • recoverFromDisposal(): boolean
  • Returns boolean

registerProgram

  • Parameters

    Returns 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

requestContext

  • Requests a Context object to attach to the managed gl canvas.

    Parameters

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

    Returns void

setRenderTarget

  • setRenderTarget(target: ImageBase, enableDepthAndStencil?: boolean, surfaceSelector?: number): void
  • Parameters

    • target: ImageBase
    • Default value enableDepthAndStencil: boolean = false
    • Default value surfaceSelector: number = 0

    Returns void

setSamplerState

  • setSamplerState(index: number, repeat: boolean, smooth: boolean, mipmap: boolean): void
  • Parameters

    • index: number
    • repeat: boolean
    • smooth: boolean
    • mipmap: boolean

    Returns void

setVertexBuffer

  • setVertexBuffer(index: number, buffer: IVertexBuffer, size: number, dimensions: number, offset: number, unsigned?: boolean): void
  • Parameters

    • index: number
    • buffer: IVertexBuffer
    • size: number
    • dimensions: number
    • offset: number
    • Default value unsigned: boolean = false

    Returns void

unRegisterProgram

  • Parameters

    Returns void

Static registerAbstraction

  • registerAbstraction(gl_assetClass: GL_IAssetClass, assetClass: IAssetClass): void
  • Parameters

    Returns void

Generated using TypeDoc