GODPAPER | All Packages | All Classes | Index | Frames No Frames |
Image

Package | starling.display
Class | public class Image
Inheritance | Image Quad DisplayObject EventDispatcher Object
Subclasses | Image, 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
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number [override] The opacity of the object. | Quad
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | 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
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | 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
|  | premultipliedAlpha : Boolean [read-only] Indicates if the rgb values are stored premultiplied with the alpha value; this can affect the rendering. | Quad
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | 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
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | 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 the stage. | DisplayObject
|  | texture : Texture The texture that is displayed on the quad. | Image
|  | tinted : Boolean [read-only] Returns true if the quad (or any of its vertices) is non-white or non-opaque. | Quad
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | 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

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | mVertexData : VertexData The raw vertex data of the quad. | Quad

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Image(texture:Texture) Creates a quad with a texture mapped onto it. | Image
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system of the object. | DisplayObject
|  | copyVertexDataTo(targetData:VertexData, targetVertexID:int = 0):void [override] Copies the raw vertex data to a VertexData instance. | Image
|  | copyVertexDataTransformedTo(targetData:VertexData, targetVertexID:int = 0, matrix:Matrix = null):void [override] Transforms the vertex positions of the raw vertex data by a certain matrix and copies the result to another VertexData instance. | Image
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered listeners for the given type. | EventDispatcher
|  | dispose():void Disposes all resources of the display object. | DisplayObject
|  | fromBitmap(bitmap:Bitmap, generateMipMaps:Boolean = true, scale:Number = 1):Image [static] Creates an Image with a texture that is created from a bitmap object. | Image
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | Quad
|  | getTexCoords(vertexID:int, resultPoint:Point = null):Point Gets the texture coordinates of a vertex. | Image
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):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, resultPoint:Point = null):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, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | readjustSize():void Readjusts the dimensions of the image according to its current texture. | Image
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, parentAlpha: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
|  | setTexCoordsTo(vertexID:int, u:Number, v:Number):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

Protected Methods

| Method | Defined By
--- | --- | ---
|  | onVertexDataChanged():void [override] Call this method after manually changing the contents of 'mVertexData'. | Image

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | touch | Dispatched when an object is touched. | DisplayObject

Property Detail

smoothing | property

`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

starling.textures.TextureSmoothing

texture | property |

`texture:Texture`

The texture that is displayed on the quad.

Implementation
`public function get texture():Texture`
`public function set texture(value:Texture):void`
Constructor Detail

Image | () | Constructor

`public function Image(texture:Texture)`

Creates a quad with a texture mapped onto it.

Parameters

| `texture:Texture`

Method Detail

copyVertexDataTo | () | method

`override public function copyVertexDataTo(targetData:VertexData, targetVertexID:int = 0):void`

Copies the raw vertex data to a VertexData instance. The texture coordinates are already in the format required for rendering.

Parameters

| `targetData:VertexData`
| `targetVertexID:int` (default = `0`)``

copyVertexDataTransformedTo | () | method |

`override public function copyVertexDataTransformedTo(targetData:VertexData, targetVertexID:int = 0, matrix:Matrix = null):void`

Transforms the vertex positions of the raw vertex data by a certain matrix and copies the result to another VertexData instance. The texture coordinates are already in the format required for rendering.

Parameters

| `targetData:VertexData`
| `targetVertexID:int` (default = `0`)``
| `matrix:Matrix` (default = `null`)``

fromBitmap | () | method |

`public static function fromBitmap(bitmap:Bitmap, generateMipMaps:Boolean = true, scale:Number = 1):Image`

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

Parameters

| `bitmap:Bitmap`
| `generateMipMaps:Boolean` (default = `true`)``
| `scale:Number` (default = `1`)``

Returns

| `Image`

getTexCoords | () | method |

`public function getTexCoords(vertexID:int, resultPoint:Point = null):Point`

Gets the texture coordinates of a vertex. Coordinates are in the range [0, 1]. If you pass a 'resultPoint', the result will be stored in this point instead of creating a new object.

Parameters

| `vertexID:int`
| `resultPoint:Point` (default = `null`)``

Returns

| `Point`

onVertexDataChanged | () | method |

`override protected function onVertexDataChanged():void`

Call this method after manually changing the contents of 'mVertexData'.

readjustSize | () | method |

`public function readjustSize():void`

Readjusts the dimensions of the image according to its current texture. Call this method to synchronize image and texture size after assigning a texture with a different size.

render | () | method |

`override public function render(support:RenderSupport, parentAlpha: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.
| `parentAlpha: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`

setTexCoordsTo | () | method |

`public function setTexCoordsTo(vertexID:int, u:Number, v:Number):void`

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

Parameters

| `vertexID:int`
| `u:Number`
| `v:Number`

Thu Jan 16 2014, 01:11 PM +08:00