Packageaway3d.core.render
Classpublic class RendererBase
InheritanceRendererBase Inheritance Object
Subclasses DefaultRenderer, DepthRenderer, PositionRenderer

RendererBase forms an abstract base class for classes that are used in the rendering pipeline to render geometry to the back buffer or a texture.



Public Properties
 PropertyDefined By
  antiAlias : uint
RendererBase
  backgroundImageRenderer : BackgroundImageRenderer
[read-only]
RendererBase
  renderableSorter : EntitySorterBase
RendererBase
  swapBackBuffer : Boolean
Indicates whether or not the back buffer should be swapped when rendering is complete.
RendererBase
Protected Properties
 PropertyDefined By
  _antiAlias : uint
RendererBase
  _backgroundAlpha : Number = 1
RendererBase
  _backgroundB : Number = 0
RendererBase
  _backgroundG : Number = 0
RendererBase
  _backgroundR : Number = 0
RendererBase
  _context : Context3D
RendererBase
  _renderTarget : TextureBase
RendererBase
  _renderTargetSurface : int
RendererBase
  _renderToTexture : Boolean
RendererBase
  _shareContext : Boolean = false
RendererBase
  _stage3DProxy : Stage3DProxy
RendererBase
  _swapBackBuffer : Boolean = true
RendererBase
  _textureRatioX : Number = 1
RendererBase
  _textureRatioY : Number = 1
RendererBase
  _viewHeight : Number
RendererBase
  _viewWidth : Number
RendererBase
Public Methods
 MethodDefined By
  
RendererBase(renderToTexture:Boolean = false)
Creates a new RendererBase object.
RendererBase
  
queueSnapshot(bmd:BitmapData):void
RendererBase
Protected Methods
 MethodDefined By
  
draw(entityCollector:EntityCollector, target:TextureBase):void
Performs the actual drawing of geometry to the target.
RendererBase
  
executeRender(entityCollector:EntityCollector, target:TextureBase = null, scissorRect:Rectangle = null, surfaceSelector:int = 0):void
Renders the potentially visible geometry to the back buffer or texture.
RendererBase
  
RendererBase
Property Detail
_antiAliasproperty
protected var _antiAlias:uint

_backgroundAlphaproperty 
protected var _backgroundAlpha:Number = 1

_backgroundBproperty 
protected var _backgroundB:Number = 0

_backgroundGproperty 
protected var _backgroundG:Number = 0

_backgroundRproperty 
protected var _backgroundR:Number = 0

_contextproperty 
protected var _context:Context3D

_renderTargetproperty 
protected var _renderTarget:TextureBase

_renderTargetSurfaceproperty 
protected var _renderTargetSurface:int

_renderToTextureproperty 
protected var _renderToTexture:Boolean

_shareContextproperty 
protected var _shareContext:Boolean = false

_stage3DProxyproperty 
protected var _stage3DProxy:Stage3DProxy

_swapBackBufferproperty 
protected var _swapBackBuffer:Boolean = true

_textureRatioXproperty 
protected var _textureRatioX:Number = 1

_textureRatioYproperty 
protected var _textureRatioY:Number = 1

_viewHeightproperty 
protected var _viewHeight:Number

_viewWidthproperty 
protected var _viewWidth:Number

antiAliasproperty 
antiAlias:uint


Implementation
    public function get antiAlias():uint
    public function set antiAlias(value:uint):void
backgroundproperty 
background:Texture2DBase


Implementation
    arcane function get background():Texture2DBase
    arcane function set background(value:Texture2DBase):void
backgroundAlphaproperty 
backgroundAlpha:Number


Implementation
    arcane function get backgroundAlpha():Number
    arcane function set backgroundAlpha(value:Number):void
backgroundBproperty 
backgroundB:Number


Implementation
    arcane function get backgroundB():Number
    arcane function set backgroundB(value:Number):void
backgroundGproperty 
backgroundG:Number


Implementation
    arcane function get backgroundG():Number
    arcane function set backgroundG(value:Number):void
backgroundImageRendererproperty 
backgroundImageRenderer:BackgroundImageRenderer  [read-only]


Implementation
    public function get backgroundImageRenderer():BackgroundImageRenderer
backgroundRproperty 
backgroundR:Number


Implementation
    arcane function get backgroundR():Number
    arcane function set backgroundR(value:Number):void
renderableSorterproperty 
renderableSorter:EntitySorterBase


Implementation
    public function get renderableSorter():EntitySorterBase
    public function set renderableSorter(value:EntitySorterBase):void
renderToTextureproperty 
renderToTexture:Boolean  [read-only]


Implementation
    arcane function get renderToTexture():Boolean
shareContextproperty 
shareContext:Boolean


Implementation
    arcane function get shareContext():Boolean
    arcane function set shareContext(value:Boolean):void
stage3DProxyproperty 
stage3DProxy:Stage3DProxy


Implementation
    arcane function get stage3DProxy():Stage3DProxy
    arcane function set stage3DProxy(value:Stage3DProxy):void
swapBackBufferproperty 
swapBackBuffer:Boolean

Indicates whether or not the back buffer should be swapped when rendering is complete.


Implementation
    public function get swapBackBuffer():Boolean
    public function set swapBackBuffer(value:Boolean):void
textureRatioXproperty 
textureRatioX:Number


Implementation
    arcane function get textureRatioX():Number
    arcane function set textureRatioX(value:Number):void
textureRatioYproperty 
textureRatioY:Number


Implementation
    arcane function get textureRatioY():Number
    arcane function set textureRatioY(value:Number):void
viewHeightproperty 
viewHeight:Number


Implementation
    arcane function get viewHeight():Number
    arcane function set viewHeight(value:Number):void
viewWidthproperty 
viewWidth:Number


Implementation
    arcane function get viewWidth():Number
    arcane function set viewWidth(value:Number):void
Constructor Detail
RendererBase()Constructor
public function RendererBase(renderToTexture:Boolean = false)

Creates a new RendererBase object.

Parameters
renderToTexture:Boolean (default = false)
Method Detail
createEntityCollector()method
arcane function createEntityCollector():EntityCollector

Returns
EntityCollector
draw()method 
protected function draw(entityCollector:EntityCollector, target:TextureBase):void

Performs the actual drawing of geometry to the target.

Parameters

entityCollector:EntityCollector — The EntityCollector object containing the potentially visible geometry.
 
target:TextureBase

executeRender()method 
protected function executeRender(entityCollector:EntityCollector, target:TextureBase = null, scissorRect:Rectangle = null, surfaceSelector:int = 0):void

Renders the potentially visible geometry to the back buffer or texture. Only executed if everything is set up.

Parameters

entityCollector:EntityCollector — The EntityCollector object containing the potentially visible geometry.
 
target:TextureBase (default = null) — An option target texture to render to.
 
scissorRect:Rectangle (default = null) — The index of a CubeTexture's face to render to.
 
surfaceSelector:int (default = 0) — Additional clear mask information, in case extra clear channels are to be omitted.

executeRenderToTexturePass()method 
protected function executeRenderToTexturePass(entityCollector:EntityCollector):void

Parameters

entityCollector:EntityCollector

queueSnapshot()method 
public function queueSnapshot(bmd:BitmapData):void

Parameters

bmd:BitmapData

render()method 
arcane function render(entityCollector:EntityCollector, target:TextureBase = null, scissorRect:Rectangle = null, surfaceSelector:int = 0):void

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

Parameters

entityCollector:EntityCollector — The EntityCollector object containing the potentially visible geometry.
 
target:TextureBase (default = null) — An option target texture to render to.
 
scissorRect:Rectangle (default = null) — The index of a CubeTexture's face to render to.
 
surfaceSelector:int (default = 0) — Additional clear mask information, in case extra clear channels are to be omitted.