| Package | starling.display |
| Class | public class Image |
| Inheritance | Image  Quad DisplayObject EventDispatcher Object |
| Subclasses | HitImage, MovieClip |
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
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| color : uint Returns the color of the quad, or of vertex 0 if vertices have different colors. | Quad | |
| height : Number The height of the object in pixels. | DisplayObject | |
| name : String The name of the display object (default: null). | DisplayObject | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| smoothing : String The smoothing filter that is used for the texture. | Image | ||
| stage : 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 | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : 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 | ||
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number The width of the object in pixels. | DisplayObject | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
Creates a quad with a texture mapped onto it. | Image | ||
| addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
| 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 | ||
| 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 | ||
| getTransformationMatrix(targetSpace:DisplayObject):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| getVertexAlpha(vertexID:int):Number Returns the alpha value of a vertex at a certain index. | Quad | |
| getVertexColor(vertexID:int):uint Returns the color of a vertex at a certain index. | Quad | |
| globalToLocal(globalPoint:Point):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| 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 | |
| localToGlobal(localPoint:Point):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
registerPrograms(target:Starling):void [static] Registers the vertex and fragment programs required in the 'render' method at a
Starling object. | Image | ||
| removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | |
| removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
| 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 | ||
| setVertexAlpha(vertexID:int, alpha:Number):void Sets the alpha value of a vertex at a certain index. | Quad | |
| setVertexColor(vertexID:int, color:uint):void Sets the color of a vertex at a certain index. | Quad | |
| Method | Defined By | ||
|---|---|---|---|
| createIndexBuffer():void Creates the index buffer at the current render context. | Quad | |
| createVertexBuffer():void 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 | ||
setupVertexDataByTexture(texture:Texture):void | Image | ||
| smoothing | property |
Hide Inherited Public Properties
Show Inherited Public Propertiessmoothing:StringThe smoothing filter that is used for the texture.
The default value is bilinear.
public function get smoothing():String public function set smoothing(value:String):voidSee also
| texture | property |
texture:TextureThe texture that is displayed on the quad.
public function get texture():Texture public function set texture(value:Texture):void| vertexData | property |
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.
public function get vertexData():VertexData| Image | () | Constructor |
public function Image(texture:Texture)Creates a quad with a texture mapped onto it.
Parameterstexture:Texture |
| dispose | () | method |
override public function dispose():voidDisposes vertex- and index-buffer, but does NOT dispose the texture!
| fromBitmap | () | method |
public static function fromBitmap(bitmap:Bitmap):ImageCreates an Image with a texture that is created from a bitmap object.
Parameters
bitmap:Bitmap |
Image |
| getProgramName | () | method |
public static function getProgramName(mipMap:Boolean = true, repeat:Boolean = false, smoothing:String = bilinear):StringGet 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) |
String |
| getTexCoords | () | method |
public function getTexCoords(vertexID:int):PointGets the texture coordinates of a vertex. Coordinates are in the range [0, 1].
Parameters
vertexID:int |
Point |
| registerPrograms | () | method |
public static function registerPrograms(target:Starling):voidRegisters 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):voidRenders 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):voidSets 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):voidPATCH: 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 |