Apollolux: /* Initializers */ GetTileImage

2013-06-04T05:16:55Z

Initializers: GetTileImage

← Older revision		Revision as of 05:16, 4 June 2013
Line 6:		Line 6:
	* [[API:LoadImage\|LoadImage]](''filename''): Load an image from ''filename''.		* [[API:LoadImage\|LoadImage]](''filename''): Load an image from ''filename''.
	* [[API:GrabImage\|GrabImage]](''x'', ''y'', ''width'', ''height''): Grab the screen contents at (''x'', ''y'', ''width'', ''height'') and store it in a new Image object.		* [[API:GrabImage\|GrabImage]](''x'', ''y'', ''width'', ''height''): Grab the screen contents at (''x'', ''y'', ''width'', ''height'') and store it in a new Image object.
	* [[API:GetTileImage\|GetTileImage]]()		* [[API:GetTileImage\|GetTileImage]](''tile''): Get the [[API:Image\|Image]] of ''tile'' in the current map tileset.
	* [[API:Surface/createImage\|Surface.createImage]](): Create a new [[API:Surface\|Surface]] using the picture data in the image.		* [[API:Surface/createImage\|Surface.createImage]](): Create a new [[API:Surface\|Surface]] using the picture data in the image.

Line 14:		Line 14:
	* [[API:GetSystemUpArrow\|GetSystemUpArrow]](): Get the up-pointing arrow image that comes with the Sphere engine.		* [[API:GetSystemUpArrow\|GetSystemUpArrow]](): Get the up-pointing arrow image that comes with the Sphere engine.
	* [[API:GetSystemDownArrow\|GetSystemDownArrow]](): Get the down-pointing arrow image that comes with the Sphere engine.		* [[API:GetSystemDownArrow\|GetSystemDownArrow]](): Get the down-pointing arrow image that comes with the Sphere engine.


	==Methods==		==Methods==

Apollolux: created from http://web.archive.org/web/20120828115544/http://www.spheredev.org/wiki/Object-Image

2013-06-04T05:14:56Z

created from http://web.archive.org/web/20120828115544/http://www.spheredev.org/wiki/Object-Image

New page

The Image object holds an image in memory to be used for drawing.

__TOC__

==Initializers==
* [[API:LoadImage|LoadImage]](''filename''): Load an image from ''filename''.
* [[API:GrabImage|GrabImage]](''x'', ''y'', ''width'', ''height''): Grab the screen contents at (''x'', ''y'', ''width'', ''height'') and store it in a new Image object.
* [[API:GetTileImage|GetTileImage]]()
* [[API:Surface/createImage|Surface.createImage]](): Create a new [[API:Surface|Surface]] using the picture data in the image.

=== System images ===

* [[API:GetSystemArrow|GetSystemArrow]](): Get the right-pointing arrow image that comes with the Sphere engine.
* [[API:GetSystemUpArrow|GetSystemUpArrow]](): Get the up-pointing arrow image that comes with the Sphere engine.
* [[API:GetSystemDownArrow|GetSystemDownArrow]](): Get the down-pointing arrow image that comes with the Sphere engine.

==Methods==

* [[API:Image/clone|Image.clone]](): returns a copy of an existing image object
* [[API:Image/blit|Image.blit]](''x'', ''y''): Draw the image with the top-left corner at (''x'', ''y'').
* [[API:Image/blitMask|Image.blitMask]](''x'', ''y'', ''mask''): Draw the image at (''x'', ''y'') with ''mask'' as the tinting color.
* [[API:Image/rotateBlit|Image.rotateBlit]](''center_x'', ''center_y'', ''angle''): Draw the image centered at (''center_x'', ''center_y''), rotated by ''angle'' radians.
* [[API:Image/rotateBlitMask|Image.rotateBlitMask]](''center_x'', ''center_y'', ''angle'', ''mask''): [[API:Image/rotateBlit|rotateBlit]] + mask.
* [[API:Image/zoomBlit|Image.zoomBlit]](''x'', ''y'', ''factor''): Draw the image zoomed by ''factor'' with the top-left corner at (''x'', ''y'').
* [[API:Image/zoomBlitMask|Image.zoomBlitMask]](''x'', ''y'', ''factor'', ''mask''): [[API:Image/zoomBlit|zoomBlit]] + mask.
* [[API:Image/transformBlit|Image.transformBlit]](''x1'', ''y1'', ''x2'', ''y2'', ''x3'', ''y3'', ''x4'', ''y4''): Draw the image with top-left (''x1'', ''y1''), top-right (''x2'', ''y2''), bottom-right (''x3'', ''y3'') and bottom-left (''x4'', ''y4'').
* [[API:Image/transformBlitMask|Image.transformBlitMask]](''x1'', ''y1'', ''x2'', ''y2'', ''x3'', ''y3'', ''x4'', ''y4'', ''mask''): Draw the image stretched to fit 4 coordinates clockwise from the top-left, with a masking color.
* [[API:Image/createSurface|Image.createSurface]](): Create a new [[API:Surface|Surface]] using the picture data in the image.

==Members==
* '''width''' The width of the image, in pixels.
* '''height''' The height of the image, in pixels.

==Notes==
Operations cannot be performed on an Image object, so if you need to change the image you should use a [[API:Surface|Surface]] instead.

==See also==
* Sphere [[API:Surface|Surface]] object

{{API:Image/navbox}}
[[Category:Objects]]

Legacy:Image - Revision history

Apollolux: /* Initializers */ GetTileImage

Apollolux: created from http://web.archive.org/web/20120828115544/http://www.spheredev.org/wiki/Object-Image