indrajith/RCBASIC4
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #15 from arc1tec4/dev

Browse Source 
createsprite doc
This commit is contained in:
Rodney Cunningham
2024-11-12 23:21:34 -05:00
committed by GitHub
parent 229aebfec3 0b132399fc
commit 5719ad1dbd
3 changed files with 71 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
doc/doc_files/createsprite.html
View File

@@ -9,7 +9,42 @@
<body> <body>
<p><h2>function CreateSprite( img ) </h2></p> <p><h2>function CreateSprite( img ) </h2></p>
<p> <p>
Returns new sprite This function returns a new sprite which you can place in a variable for use in your program.
</p>
<p>
Here is an example of opening a sprite canvas layer, creating a sprite, setting it's position and finally displaying it.
</p>
<p id="rc_code"><code>
isFullScreen&nbsp;=&nbsp;<span class="rc_keyword">false</span>&nbsp;<br>
vSync&nbsp;=&nbsp;<span class="rc_keyword">true</span>&nbsp;<br>
winWidth&nbsp;=&nbsp;<span class="rc_number">640</span>&nbsp;<br>
winHeight&nbsp;=&nbsp;<span class="rc_number">480</span>&nbsp;<br>
canViewPortX&nbsp;=&nbsp;<span class="rc_number">0</span>&nbsp;<br>
canViewPortY&nbsp;=&nbsp;<span class="rc_number">0</span>&nbsp;<br>
&nbsp;&nbsp;<br>
OpenWindow<b>(</b><span class="rc_string">"CreateSprite"</span>,&nbsp;winWidth,&nbsp;winHeight,&nbsp;isFullScreen,&nbsp;vSync<b>)</b>&nbsp;<br>
sCanvas&nbsp;=&nbsp;OpenCanvasSpriteLayer<b>(</b>canViewPortX,&nbsp;canViewPortY,&nbsp;winWidth,&nbsp;winHeight<b>)</b>&nbsp;<br>
Canvas<b>(</b>sCanvas<b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
<span class="rc_keyword">DIM</span>&nbsp;eye&nbsp;<br>
<span class="rc_keyword">DIM</span>&nbsp;eyeW&nbsp;<br>
<span class="rc_keyword">DIM</span>&nbsp;eyeH&nbsp;<br>
&nbsp;&nbsp;<br>
eye&nbsp;=&nbsp;LoadImage<b>(</b><span class="rc_string">"theEye.png"</span><b>)</b>&nbsp;<br>
GetImageSize<b>(</b>eye,&nbsp;eyeW,&nbsp;eyeH<b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
eyeSprite&nbsp;=&nbsp;CreateSprite<b>(</b>eye,&nbsp;eyeW,&nbsp;eyeH<b>)</b>&nbsp;<br>
SetSpritePosition<b>(</b>eyeSprite,&nbsp;<span class="rc_number">100</span>,&nbsp;<span class="rc_number">100</span><b>)</b>&nbsp;<br>
&nbsp;&nbsp;<br>
<span class="rc_keyword">While</span>&nbsp;<span class="rc_keyword">Not</span>&nbsp;Key<b>(</b>K_ESCAPE<b>)</b>&nbsp;<br>
<span class="rc_comment">'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called. </span><br>
Update<b>(</b><b>)</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="rc_comment">'Update automatically deals with drawing the sprites on the sprite canvas. </span><br>
<span class="rc_keyword">Wend</span>&nbsp;<br>
</code></p>
<p><img src="images/theEye.png" ></p>
<br><p>Related:
<a href="opencanvasspritelayer.html">OpenCanvasSpriteLayer</a>
<a href="setspriteposition.html">SetSpritePosition</a>
</p> </p>
<p> <p>

BIN
doc/doc_files/images/theEye.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 888 B

36
doc/files/createsprite.txt
View File

@@ -1,4 +1,38 @@
#title CreateSprite [RCBasic Doc] #title CreateSprite [RCBasic Doc]
#header function CreateSprite( img ) #header function CreateSprite( img )
Returns new sprite This function returns a new sprite which you can place in a variable for use in your program.
Here is an example of opening a sprite canvas layer, creating a sprite, setting it's position and finally displaying it.
#code
isFullScreen = false
vSync = true
winWidth = 640
winHeight = 480
canViewPortX = 0
canViewPortY = 0
OpenWindow("CreateSprite", winWidth, winHeight, isFullScreen, vSync)
sCanvas = OpenCanvasSpriteLayer(canViewPortX, canViewPortY, winWidth, winHeight)
Canvas(sCanvas)
DIM eye
DIM eyeW
DIM eyeH
eye = LoadImage("theEye.png")
GetImageSize(eye, eyeW, eyeH)
eyeSprite = CreateSprite(eye, eyeW, eyeH)
SetSpritePosition(eyeSprite, 100, 100)
While Not Key(K_ESCAPE)
'ClearCanvas() For a sprite layer canvas, you don't need to call ClearCanvas. It's automatically called.
Update() 'Update automatically deals with drawing the sprites on the sprite canvas.
Wend
#/code
#image "images/theEye.png"
#ref OpenCanvasSpriteLayer SetSpritePosition