Packagestarling.display
Classpublic class Image
InheritanceImage Inheritance Quad Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Subclasses HitImage, MovieClip

An Image is a quad with a texture mapped onto it.

The Image class is the Starling equivalent of Flash's Bitmap class. Instead of BitmapData, Starling uses textures to represent the pixels of an image. To display a texture, you have to map it onto a quad - and that's what the Image class is for.

As "Image" inherits from "Quad", you can give it a color. For each pixel, the resulting color will be the result of the multiplication of the color of the texture with the color of the quad. That way, you can easily tint textures with a certain color. Furthermore, images allow the manipulation of texture coordinates. That way, you can move a texture inside an image without changing any vertex coordinates of the quad. You can also use this feature as a very efficient way to create a rectangular mask.

See also

starling.textures.Texture
Quad


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedcolor : uint
Returns the color of the quad, or of vertex 0 if vertices have different colors.
Quad
 Inheritedheight : Number
The height of the object in pixels.
DisplayObject
 Inheritedname : String
The name of the display object (default: null).
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 Inheritedroot : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
  smoothing : String
The smoothing filter that is used for the texture.
Image
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to a stage.
DisplayObject
  texture : Texture
The texture that is displayed on the quad.
Image
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
[read-only] The transformation matrix of the object relative to its parent.
DisplayObject
  vertexData : VertexData
[override] [read-only] Returns a 'VertexData' object with the raw data of the object required for rendering.
Image
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
The width of the object in pixels.
DisplayObject
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedmIndexBuffer : IndexBuffer3D
The index buffer object used to render the quad.
Quad
 InheritedmVertexBuffer : VertexBuffer3D
The vertex buffer object containing the vertex data of the quad.
Quad
 InheritedmVertexData : VertexData
The raw vertex data of the quad.
Quad
Public Methods
 MethodDefined By
  
Image(texture:Texture)
Creates a quad with a texture mapped onto it.
Image
 Inherited
addEventListener(type:String, listener:Function):void
Registers an event listener at a certain object.
EventDispatcher
 Inherited
dispatchEvent(event:Event):void
[override] Dispatches an event to all objects that have registered for events of the same type.
DisplayObject
  
dispose():void
[override] Disposes vertex- and index-buffer, but does NOT dispose the texture!
Image
  
fromBitmap(bitmap:Bitmap):Image
[static] Creates an Image with a texture that is created from a bitmap object.
Image
 Inherited
getBounds(targetSpace:DisplayObject):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
Quad
  
getProgramName(mipMap:Boolean = true, repeat:Boolean = false, smoothing:String = bilinear):String
[static] Get the name of the Shader program that is used for rendering.
Image
  
getTexCoords(vertexID:int):Point
Gets the texture coordinates of a vertex.
Image
 Inherited
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
getVertexAlpha(vertexID:int):Number
Returns the alpha value of a vertex at a certain index.
Quad
 Inherited
getVertexColor(vertexID:int):uint
Returns the color of a vertex at a certain index.
Quad
 Inherited
globalToLocal(globalPoint:Point):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
 Inherited
hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.
DisplayObject
 Inherited
localToGlobal(localPoint:Point):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
  
[static] Registers the vertex and fragment programs required in the 'render' method at a Starling object.
Image
 Inherited
removeEventListener(type:String, listener:Function):void
Removes an event listener from the object.
EventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all event listeners with a certain type, or all of them if type is null.
EventDispatcher
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one.
DisplayObject
  
render(support:RenderSupport, alpha:Number):void
[override] Renders the display object with the help of a support object.
Image
  
setTexCoords(vertexID:int, coords:Point):void
Sets the texture coordinates of a vertex.
Image
 Inherited
setVertexAlpha(vertexID:int, alpha:Number):void
Sets the alpha value of a vertex at a certain index.
Quad
 Inherited
setVertexColor(vertexID:int, color:uint):void
Sets the color of a vertex at a certain index.
Quad
Protected Methods
 MethodDefined By
 Inherited
Creates the index buffer at the current render context.
Quad
 Inherited
Creates the vertex buffer from the raw vertex data at the current render context.
Quad
  
setupVertexData(width:Number, height:Number, color:uint = 0xffffff):void
[override] PATCH: Sets up the vertex data on the Quad.
Image
  
Image
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
 InheritedDispatched when an object is touched.DisplayObject
Public Constants
 ConstantDefined By
 InheritedPROGRAM_NAME : String = quad
[static] The name of the shader program used when a quad is rendered.
Quad
Property Detail
smoothingproperty
smoothing:String

The smoothing filter that is used for the texture.

The default value is bilinear.


Implementation
    public function get smoothing():String
    public function set smoothing(value:String):void

See also

textureproperty 
texture:Texture

The texture that is displayed on the quad.


Implementation
    public function get texture():Texture
    public function set texture(value:Texture):void
vertexDataproperty 
vertexData:VertexData  [read-only] [override]

Returns a 'VertexData' object with the raw data of the object required for rendering. The texture coordinates are already in their refined format.


Implementation
    public function get vertexData():VertexData
Constructor Detail
Image()Constructor
public function Image(texture:Texture)

Creates a quad with a texture mapped onto it.

Parameters
texture:Texture
Method Detail
dispose()method
override public function dispose():void

Disposes vertex- and index-buffer, but does NOT dispose the texture!

fromBitmap()method 
public static function fromBitmap(bitmap:Bitmap):Image

Creates an Image with a texture that is created from a bitmap object.

Parameters

bitmap:Bitmap

Returns
Image
getProgramName()method 
public static function getProgramName(mipMap:Boolean = true, repeat:Boolean = false, smoothing:String = bilinear):String

Get the name of the Shader program that is used for rendering. The program is registered under that name at the current Starling object.

Parameters

mipMap:Boolean (default = true)
 
repeat:Boolean (default = false)
 
smoothing:String (default = bilinear)

Returns
String
getTexCoords()method 
public function getTexCoords(vertexID:int):Point

Gets the texture coordinates of a vertex. Coordinates are in the range [0, 1].

Parameters

vertexID:int

Returns
Point
registerPrograms()method 
public static function registerPrograms(target:Starling):void

Registers the vertex and fragment programs required in the 'render' method at a Starling object. You don't have to call this method manually.

Parameters

target:Starling

render()method 
override public function render(support:RenderSupport, alpha:Number):void

Renders the display object with the help of a support object. Never call this method directly, except from within another render method.

Parameters

support:RenderSupport — Provides utility functions for rendering.
 
alpha:Number — The accumulated alpha value from the object's parent up to the stage.

setTexCoords()method 
public function setTexCoords(vertexID:int, coords:Point):void

Sets the texture coordinates of a vertex. Coordinates are in the range [0, 1].

Parameters

vertexID:int
 
coords:Point

setupVertexData()method 
override protected function setupVertexData(width:Number, height:Number, color:uint = 0xffffff):void

PATCH: Sets up the vertex data on the Quad. Useful for reseting the size of the quad.

Parameters

width:Number
 
height:Number
 
color:uint (default = 0xffffff)

setupVertexDataByTexture()method 
protected function setupVertexDataByTexture(texture:Texture):void

Parameters

texture:Texture