Packageflare.core
Classpublic class Texture3D
InheritanceTexture3D Inheritance flash.events.EventDispatcher
Implements ILibraryExternalItem

The Textrue3D class contains information on material textures.



Public Properties
 PropertyDefined By
  bitmapData : BitmapData
BitmapData object that contains the texture data.
Texture3D
  bytesLoaded : uint
[read-only]
Texture3D
  bytesTotal : uint
[read-only]
Texture3D
  filterMode : String = linear
Defines how the texture will be sampled when it needs to be streched on the screen.
Texture3D
  loaded : Boolean
Returns if the texture was succesfull loaded.
Texture3D
  mipLevelsCallback : Function
Allow you to define a custom function to generate and upload the MIP levels.
Texture3D
  mipMode : String = miplinear
Defines if the texture will use mip mapping and how it will be applyied.
Texture3D
  name : String
The name of the texture.
Texture3D
  optimizeForRenderToTexture : Boolean
[read-only] Returns whatever the texture is optimized for dynamic rendering.
Texture3D
  request : *
Gets a reference to the request object.
Texture3D
  scene : Scene3D
Returns a reference where the texture context is.
Texture3D
  texture : TextureBase
Texture object that contains the texture data on graphics card.
Texture3D
  typeMode : String = 2d
Defines the type of the texture.
Texture3D
  wrapMode : String = repeat
Defines how the texture will be sampled outside the normalized coordinates (0-1).
Texture3D
Public Methods
 MethodDefined By
  
Texture3D(request:*, optimizeForRenderToTexture:Boolean = false, format:String)
Creates a new texture.
Texture3D
  
close():void
Terminates the loading proccess.
Texture3D
  
dispose():void
Eliminates all the resources associated to the texture.
Texture3D
  
download():void
Download the texture from the graphics card.
Texture3D
  
load():void
Loads the texture if it is an external resource..
Texture3D
  
upload(scene:Scene3D = null):Boolean
Upload the texture to the graphics card.
Texture3D
Public Constants
 ConstantDefined By
  FILTER_LINEAR : String = linear
[static]
Texture3D
  FILTER_NEAREST : String = nearest
[static]
Texture3D
  FORMAT_CUBEMAP : String = cubemap
[static]
Texture3D
  FORMAT_RGBA : String = rgba
[static]
Texture3D
  MIP_LINEAR : String = miplinear
[static]
Texture3D
  MIP_NEAREST : String = mipnearest
[static]
Texture3D
  MIP_NONE : String = mipnone
[static]
Texture3D
  TYPE_2D : String = 2d
[static]
Texture3D
  TYPE_CUBE : String = cube
[static]
Texture3D
  WRAP_CLAMP : String = clamp
[static]
Texture3D
  WRAP_REPEAT : String = repeat
[static]
Texture3D
Property Detail
bitmapDataproperty
public var bitmapData:BitmapData

BitmapData object that contains the texture data.

bytesLoadedproperty 
bytesLoaded:uint  [read-only]


Implementation
    public function get bytesLoaded():uint
bytesTotalproperty 
bytesTotal:uint  [read-only]


Implementation
    public function get bytesTotal():uint
filterModeproperty 
public var filterMode:String = linear

Defines how the texture will be sampled when it needs to be streched on the screen. This property should be defined before the shader compilation. Setting to Texture3D.FILTER_NEAREST will take the nearest pixel. Setting to Texture3D.FILTER_LINEAR will take an interpolation between the nearest pixels.

loadedproperty 
loaded:Boolean

Returns if the texture was succesfull loaded.


Implementation
    public function get loaded():Boolean
    public function set loaded(value:Boolean):void
mipLevelsCallbackproperty 
public var mipLevelsCallback:Function

Allow you to define a custom function to generate and upload the MIP levels.

mipModeproperty 
public var mipMode:String = miplinear

Defines if the texture will use mip mapping and how it will be applyied. This property should be defined before the shader compilation. Setting to Texture3D.MIP_NEAREST, uses the pixel from the nearest mipmap level. Setting to Texture3D.MIP_LINEAR uses the pixel from two nearest mipmap levels, and interpolates linearly. Setting to Texture3D.MIP_NONE will disable mip mode for the texture.

nameproperty 
public var name:String

The name of the texture.

optimizeForRenderToTextureproperty 
optimizeForRenderToTexture:Boolean  [read-only]

Returns whatever the texture is optimized for dynamic rendering.


Implementation
    public function get optimizeForRenderToTexture():Boolean
requestproperty 
request:*

Gets a reference to the request object.


Implementation
    public function get request():*
    public function set request(value:any):void
sceneproperty 
scene:Scene3D

Returns a reference where the texture context is.


Implementation
    public function get scene():Scene3D
    public function set scene(value:Scene3D):void
textureproperty 
public var texture:TextureBase

Texture object that contains the texture data on graphics card.

typeModeproperty 
public var typeMode:String = 2d

Defines the type of the texture.

wrapModeproperty 
public var wrapMode:String = repeat

Defines how the texture will be sampled outside the normalized coordinates (0-1). This property should be defined before the shader compilation. Setting to WRAP_REPEAT, the texture will repeat to the infinity. Setting to WRAP_CLAMP, the last pixel of the texture image stretches to the infinity.

Constructor Detail
Texture3D()Constructor
public function Texture3D(request:*, optimizeForRenderToTexture:Boolean = false, format:String)

Creates a new texture. The 'request' parameter can be a url string path, URLRequest, or BitmapData. If a path is set for the texture, the Texture3D object will start its loading process. If no path is set for the texture, a BitmapData object that has been directly loaded can be specified.

Parameters
request:* — It can be texture file path or BitmapData object.
 
optimizeForRenderToTexture:Boolean (default = false)
 
format:String (default = NaN)
Method Detail
close()method
public function close():void

Terminates the loading proccess.

dispose()method 
public function dispose():void

Eliminates all the resources associated to the texture. The texture will be unusable after dispose.

download()method 
public function download():void

Download the texture from the graphics card.

load()method 
public function load():void

Loads the texture if it is an external resource..

upload()method 
public function upload(scene:Scene3D = null):Boolean

Upload the texture to the graphics card.

Parameters

scene:Scene3D (default = null) — The scene to use as a context.

Returns
Boolean — true if was uploaded, false otherwise.
Constant Detail
FILTER_LINEARConstant
public static const FILTER_LINEAR:String = linear

FILTER_NEARESTConstant 
public static const FILTER_NEAREST:String = nearest

FORMAT_CUBEMAPConstant 
public static const FORMAT_CUBEMAP:String = cubemap

FORMAT_RGBAConstant 
public static const FORMAT_RGBA:String = rgba

MIP_LINEARConstant 
public static const MIP_LINEAR:String = miplinear

MIP_NEARESTConstant 
public static const MIP_NEAREST:String = mipnearest

MIP_NONEConstant 
public static const MIP_NONE:String = mipnone

TYPE_2DConstant 
public static const TYPE_2D:String = 2d

TYPE_CUBEConstant 
public static const TYPE_CUBE:String = cube

WRAP_CLAMPConstant 
public static const WRAP_CLAMP:String = clamp

WRAP_REPEATConstant 
public static const WRAP_REPEAT:String = repeat