Packageaway3d.core.render
Classpublic class RendererBase
SubclassesDefaultRenderer, DepthRenderer, HitTestRenderer, 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
The amount of anti-aliasing to use.
RendererBase
  swapBackBuffer : Boolean
Indicates whether or not the back buffer should be swapped when rendering is complete.
RendererBase
Protected Properties
 PropertyDefined by
  _backBufferInvalid : Boolean
RendererBase
  _backgroundB : Number = 0
RendererBase
  _backgroundG : Number = 0
RendererBase
  _backgroundR : Number = 0
RendererBase
  _context : Context3D
RendererBase
  _contextIndex : int = -1
RendererBase
  _renderableSorter : EntitySorterBase
RendererBase
  _stage3DProxy : Stage3DProxy
RendererBase
  _viewPortHeight : Number = 1
RendererBase
  _viewPortWidth : Number = 1
RendererBase
  _viewPortX : Number = 0
RendererBase
  _viewPortY : Number = 0
RendererBase
Public Methods
 MethodDefined by
  
RendererBase
(antiAlias:uint = 0, enableDepthAndStencil:Boolean = true, renderMode:String = "auto")
Creates a new RendererBase object.
RendererBase
Protected Methods
 MethodDefined by
  
draw(entityCollector:EntityCollector):void
Performs the actual drawing of geometry to the target.
RendererBase
  
executeRender(entityCollector:EntityCollector, target:TextureBase = null, surfaceSelector:int = 0, additionalClearMask:int = 7):void
Renders the potentially visible geometry to the back buffer or texture.
RendererBase
  
Updates the viewport dimensions;
RendererBase
Property detail
antiAliasproperty
antiAlias:uint  [read-write]

The amount of anti-aliasing to use.

Implementation
    public function get antiAlias():uint
    public function set antiAlias(value:uint):void
backBufferHeightproperty 
backBufferHeight:int  [read-write]Implementation
    arcane function get backBufferHeight():int
    arcane function set backBufferHeight(value:int):void
_backBufferInvalidproperty 
protected var _backBufferInvalid:Boolean
backBufferWidthproperty 
backBufferWidth:int  [read-write]Implementation
    arcane function get backBufferWidth():int
    arcane function set backBufferWidth(value:int):void
_backgroundBproperty 
protected var _backgroundB:Number = 0
backgroundBproperty 
backgroundB:Number  [read-write]Implementation
    arcane function get backgroundB():Number
    arcane function set backgroundB(value:Number):void
_backgroundGproperty 
protected var _backgroundG:Number = 0
backgroundGproperty 
backgroundG:Number  [read-write]Implementation
    arcane function get backgroundG():Number
    arcane function set backgroundG(value:Number):void
_backgroundRproperty 
protected var _backgroundR:Number = 0
backgroundRproperty 
backgroundR:Number  [read-write]Implementation
    arcane function get backgroundR():Number
    arcane function set backgroundR(value:Number):void
_contextproperty 
protected var _context:Context3D
_contextIndexproperty 
protected var _contextIndex:int = -1
_renderableSorterproperty 
protected var _renderableSorter:EntitySorterBase
_stage3DProxyproperty 
protected var _stage3DProxy:Stage3DProxy
stage3DProxyproperty 
stage3DProxy:Stage3DProxy  [read-write]Implementation
    arcane function get stage3DProxy():Stage3DProxy
    arcane function set stage3DProxy(value:Stage3DProxy):void
swapBackBufferproperty 
swapBackBuffer:Boolean  [read-write]

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
_viewPortHeightproperty 
protected var _viewPortHeight:Number = 1
viewPortHeightproperty 
viewPortHeight:Number  [read-write]Implementation
    arcane function get viewPortHeight():Number
    arcane function set viewPortHeight(value:Number):void
_viewPortWidthproperty 
protected var _viewPortWidth:Number = 1
viewPortWidthproperty 
viewPortWidth:Number  [read-write]Implementation
    arcane function get viewPortWidth():Number
    arcane function set viewPortWidth(value:Number):void
_viewPortXproperty 
protected var _viewPortX:Number = 0
viewPortXproperty 
viewPortX:Number  [read-write]Implementation
    arcane function get viewPortX():Number
    arcane function set viewPortX(value:Number):void
_viewPortYproperty 
protected var _viewPortY:Number = 0
viewPortYproperty 
viewPortY:Number  [read-write]Implementation
    arcane function get viewPortY():Number
    arcane function set viewPortY(value:Number):void
Constructor detail
RendererBase()constructor
public function RendererBase(antiAlias:uint = 0, enableDepthAndStencil:Boolean = true, renderMode:String = "auto")Parameters
antiAlias:uint (default = 0) — Indicates whether semi-transparent objects should be rendered.
 
enableDepthAndStencil:Boolean (default = true) — The amount of anti-aliasing to be used.
 
renderMode:String (default = "auto") — The render mode to be used.
Init Parameters
Method detail
draw()method
protected function draw(entityCollector:EntityCollector):void

Performs the actual drawing of geometry to the target.

Parameters
entityCollector:EntityCollector — The EntityCollector object containing the potentially visible geometry.
executeRender()method 
protected function executeRender(entityCollector:EntityCollector, target:TextureBase = null, surfaceSelector:int = 0, additionalClearMask:int = 7):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.
 
surfaceSelector:int (default = 0) — The index of a CubeTexture's face to render to.
 
additionalClearMask:int (default = 7) — Additional clear mask information, in case extra clear channels are to be omitted.
render()method 
arcane function render(entityCollector:EntityCollector, target:TextureBase = null, surfaceSelector:int = 0, additionalClearMask:int = 7):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.
 
surfaceSelector:int (default = 0) — The index of a CubeTexture's face to render to.
 
additionalClearMask:int (default = 7) — Additional clear mask information, in case extra clear channels are to be omitted.
updateViewPort()method 
protected function updateViewPort():void

Updates the viewport dimensions;

Wiki link
Click to go to the wiki page for 'away3d.core.render.RendererBase'

Code examples

Comments