User:Flying Jester/SpriteBatch API - Revision history

Flying Jester at 19:30, 25 November 2013

2013-11-25T19:30:11Z

Flying Jester at 19:29, 25 November 2013

2013-11-25T19:29:09Z

Flying Jester at 04:04, 25 November 2013

2013-11-25T04:04:12Z

Flying Jester at 04:01, 25 November 2013

2013-11-25T04:01:03Z

Flying Jester: Created page with "This page is draft of the SpriteBatch API for TurboSphere. ==Variables== POINT LINE TRIANGLE RECTANGLE POLYGON CIRCLE FILLED OUTLINED GRADIENT OUTLINED_GRADIENT *B..."

2013-11-25T03:50:54Z

Created page with "This page is draft of the SpriteBatch API for TurboSphere. ==Variables== *POINT *LINE *TRIANGLE *RECTANGLE *POLYGON *CIRCLE *FILLED *OUTLINED *GRADIENT *OUTLINED_GRADIENT *B..."

New page

This page is draft of the SpriteBatch API for TurboSphere.

==Variables==

*POINT
*LINE
*TRIANGLE
*RECTANGLE
*POLYGON
*CIRCLE
*FILLED
*OUTLINED
*GRADIENT
*OUTLINED_GRADIENT
*BLIT
*ROTATE_BLIT
*ZOOM_BLIT
*STRETCH_BLIT
*TRANSFORM_BLIT

==Objects==

* SpriteBatch()
; Creates a new SpriteBatch object.

* spritebatch.addTexture(tex)
; Clones 'tex' into one of the spritebatch's buffers. 'tex' can be a Surface or Image. Any modifications to 'tex' after being cloned are not reflected by the copy in 'spritebatch'.

* spritebatch.addOperation(primitive, type, ...)
; Adds an operation to 'spritebatch'. Primitives can be

*# POINT
*# LINE
*# TRIANGLE
*# RECTANGLE
*# POLYGON
*# CIRCLE

;Types can be

*# FILLED
*# OUTLINED
*# GRADIENT
*# OUTLINED_GRADIENT

;Function signatures are:

*#* spritebatch.addOperation(POINT, type, x, y, [[API:Color|color]] ...)
*#* spritebatch.addOperation(LINE, type, x1, y1, x2, y2, [[API:Color|color]] ...)
*#* spritebatch.addOperation(TRIANGLE, type, x1, y1, x2, y2, x3, y3, [[API:Color|color]] ...)
*#* spritebatch.addOperation(RECTANGLE, type, x, y, w, h [[API:Color|color]] ...)
*#* spritebatch.addOperation(POLYGON, type, xs, ys, [[API:Color|color]] ...)
*#* spritebatch.addOperation(CIRCLE, type, x, y, r, [[API:Color|color]] ...)

;'color' is defined by 'type'.

*#* FILLED or OUTLINED: one color.
*#* GRADIENT or OUTLINED_GRADIENT: one color argument for each vertex.

* spritebatch.getImages()
; Returns an array of added [[API:Image|images]] or surfaces (which are converted to images by adding them to the spritebatch) held in the buffer(s) of 'spritebatch'. These can be blit to the screen.

* spritebatch.getOperations()
; Returns an array of added drawing operations.

* spritebatch.pushTexture(tex, mode, ..., [', [[API:Color|mask]]'])
; Pushes a texture drawing operation for 'spritebatch' to perform when it draws. 'tex' is the index of the texture to draw. 'mode' can be:

*# BLIT
*# ROTATE_BLIT
*# ZOOM_BLIT
*# STRETCH_BLIT
*# TRANSFORM_BLIT

;Function signatures are:

*#* spritebatch.pushTexture(tex, BLIT, x, y, [', [[API:Color|mask]]'])
*#* spritebatch.pushTexture(tex, ROTATE_BLIT, x, y, a [', [[API:Color|mask]]'])
*#* spritebatch.pushTexture(tex, ZOOM_BLIT, x, y, f [', [[API:Color|mask]]'])
*#* spritebatch.pushTexture(tex, STRETCH_BLIT, x, y, xf, yf [', [[API:Color|mask]]'])
*#* spritebatch.pushTexture(tex, TRANSFORM_BLIT, x1, y1, x2, y2, x3, y3, x4, y4 [', [[API:Color|mask]]'])

@@ Line 23: / Line 23: @@
 * SpriteBatch()
 :: Creates a new SpriteBatch object.
 * spritebatch.addTexture(tex)
@@ Line 91: / Line 93: @@
 :: Removes operation at 'index'. If 'num' is specified, removes 'num' operations starting at 'index'. If 'index' is negative, it is treated as that many items from the end of the operation list. If 'num' is negative, 'num' operations preceding 'index' are removed.
-==Functions==
+===Drawing Control===
 * spritebatch.draw()

← Older revision		Revision as of 19:29, 25 November 2013
Line 90:		Line 90:
	* spritebatch.spliceOperation(index ['', num''])		* spritebatch.spliceOperation(index ['', num''])
	:: Removes operation at 'index'. If 'num' is specified, removes 'num' operations starting at 'index'. If 'index' is negative, it is treated as that many items from the end of the operation list. If 'num' is negative, 'num' operations preceding 'index' are removed.		:: Removes operation at 'index'. If 'num' is specified, removes 'num' operations starting at 'index'. If 'index' is negative, it is treated as that many items from the end of the operation list. If 'num' is negative, 'num' operations preceding 'index' are removed.
		+
		+	==Functions==
		+
		+	* spritebatch.draw()
		+	:: Draws 'spritebatch'. All operations in its list will be performed.
		+
		+	* spritebatch.setOffset(x, y)
		+	::Specifies an offset for drawing 'spritebatch'.
		+
		+	* spritebatch.setRotation(a)
		+	::Sets a rotation angle for 'spritebatch'
		+
		+	* spritebatch.setScale(f)
		+	::Sets a scaling factor for 'spritebatch'

@@ Line 30: / Line 30: @@
 :: Returns an array of added [[API:Image|images]] or surfaces (which are converted to images by adding them to the spritebatch) held in the buffer(s) of 'spritebatch'. These can be blit to the screen.
-* spritebatch.pushTexture(tex, mode, ..., [', [[API:Color|mask]]'])
+* spritebatch.pushTexture(tex, mode, ..., ['', [[API:Color|mask]]''])
 :: Pushes a texture drawing operation for 'spritebatch' to perform when it draws. 'tex' is the index of the texture to draw. 'mode' can be:
@@ Line 41: / Line 41: @@
 :: Function signatures are:
-*#* spritebatch.pushTexture(tex, BLIT, x, y, [', [[API:Color|mask]]'])
+*#* spritebatch.pushTexture(tex, BLIT, x, y, ['', [[API:Color|mask]]''])
-*#* spritebatch.pushTexture(tex, ROTATE_BLIT, x, y, a [', [[API:Color|mask]]'])
+*#* spritebatch.pushTexture(tex, ROTATE_BLIT, x, y, a ['', [[API:Color|mask]]''])
-*#* spritebatch.pushTexture(tex, ZOOM_BLIT, x, y, f [', [[API:Color|mask]]'])
+*#* spritebatch.pushTexture(tex, ZOOM_BLIT, x, y, f ['', [[API:Color|mask]]''])
-*#* spritebatch.pushTexture(tex, STRETCH_BLIT, x, y, xf, yf [', [[API:Color|mask]]'])
+*#* spritebatch.pushTexture(tex, STRETCH_BLIT, x, y, xf, yf ['', [[API:Color|mask]]''])
-*#* spritebatch.pushTexture(tex, TRANSFORM_BLIT, x1, y1, x2, y2, x3, y3, x4, y4 [', [[API:Color|mask]]'])
+*#* spritebatch.pushTexture(tex, TRANSFORM_BLIT, x1, y1, x2, y2, x3, y3, x4, y4 ['', [[API:Color|mask]]''])
-* spritebatch.insertTexture(index, tex, mode, ..., [', [[API:Color|mask]]'])
+* spritebatch.insertTexture(index, tex, mode, ..., ['', [[API:Color|mask]]''])
 :: Same as pushTexture, but inserts operation at 'index' in the list of operations to perform.
@@ Line 88: / Line 88: @@
 :: Removes the last operation from 'spritebatch'.
-* spritebatch.spliceOperation(index [', num'])
+* spritebatch.spliceOperation(index ['', num''])
 :: Removes operation at 'index'. If 'num' is specified, removes 'num' operations starting at 'index'. If 'index' is negative, it is treated as that many items from the end of the operation list. If 'num' is negative, 'num' operations preceding 'index' are removed.