API:Prim.blit: Difference between revisions

From Spherical
Jump to navigation Jump to search
Created page with "{{subst:functemp|preamble=Draws the specified texture as a plain image.|function=blit|object=Prim|returns=|params=surface,x,y,texture,mask}}"
 
No edit summary
 
Line 1: Line 1:
Draws the specified texture as a plain image onto ''surface''.


===== Usage =====


Draws the specified texture as a plain image.
'''Prim.blit'''(''surface'', ''x'', ''y'', ''texture'' [, ''mask'']);


__TOC__
__TOC__


==Usage==
=== Parameters ===
{{Usage|returns=|object=Prim|func=blit|params=surface,x,y,texture,mask}}


* '''param1''' type. param1 description
:{| class="wikitable"
* '''param2''' type. param2 description
!Name
* '''paramN''' type. paramN description
!Type
!Default Value
!Description
|-
|''<tt>surface</tt>''
|style="text-align: center;"|''Surface''
|''n/a (Required)''
|The surface object that ''texture'' will be drawn onto
|-
|''<tt>x</tt>''
|style="text-align: center;"|''number''
|''n/a (Required)''
|The position on the x axis.
|-
|''<tt>y</tt>''
|style="text-align: center;"|''number''
|''n/a (Required)''
|The position on the y axis.
|-
|''<tt>texture</tt>''
|style="text-align: center;"|''Texture''
|''n/a (Required)''
|The texture to be drawn.
|-
|''<tt>mask</tt>''
|style="text-align: center;"|''[[Color]]''
|<tt>Color.White</tt>
|The mask that will be applied
|}


==Examples==
==See also==
(examples with syntaxhighlighted code)
* [[API:Prim.blitSection|Prim.blitSection()]]


==Notes==
[[Category:Sphere 2 API]]
(notes)
 
==See also==
* see also
* see also
* see also
* etc

Latest revision as of 21:29, 3 January 2019

Draws the specified texture as a plain image onto surface.

Usage
Prim.blit(surface, x, y, texture [, mask]);

Parameters

Name Type Default Value Description
surface Surface n/a (Required) The surface object that texture will be drawn onto
x number n/a (Required) The position on the x axis.
y number n/a (Required) The position on the y axis.
texture Texture n/a (Required) The texture to be drawn.
mask Color Color.White The mask that will be applied

See also