notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documenting 'int mode' arg to click() functions in Magic tool API docs.

Browse source
This commit is contained in:
William Kendrick 2008-07-10 06:58:32 +00:00
parent fdb90e51aa
commit 8623bfb428
2 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
magic/docs/README.txt
View file

@ -313,11 +313,14 @@ Interfaces
whenever the user picks a new color while such a tool is whenever the user picks a new color while such a tool is
currently active.) currently active.)
* void click(magic_api * api, int which, SDL_Surface * snapshot, * void click(magic_api * api, int which, int mode,
SDL_Surface * canvas, int x, int y, SDL_Rect * update_rect) SDL_Surface * snapshot, SDL_Surface * canvas, int x, int y,
SDL_Rect * update_rect)
The plugin should apply the appropriate 'Magic' tool on the The plugin should apply the appropriate 'Magic' tool on the
'canvas' surface. The (x,y) coordinates are where the mouse was 'canvas' surface. The (x,y) coordinates are where the mouse was
(within the canvas) when the mouse button was clicked. (within the canvas) when the mouse button was clicked, and you
are told which 'mode' your tool is in (i.e., 'MODE_PAINT' or
'MODE_FULLSCREEN).
The plugin should report back what part of the canvas was The plugin should report back what part of the canvas was
affected, by filling in the (x,y) and (w,h) elements of affected, by filling in the (x,y) and (w,h) elements of

5
magic/docs/html/README.html
View file

@ -401,12 +401,15 @@ then the names of your functions must begin with "<code><b>zoom_</b></code>"
<br> <br>
<li><code><b>void click(magic_api&nbsp;*&nbsp;api, int&nbsp;which, <li><code><b>void click(magic_api&nbsp;*&nbsp;api, int&nbsp;which,
int&nbsp;mode,
SDL_Surface&nbsp;*&nbsp;snapshot, SDL_Surface&nbsp;*&nbsp;canvas, SDL_Surface&nbsp;*&nbsp;snapshot, SDL_Surface&nbsp;*&nbsp;canvas,
int&nbsp;x, int&nbsp;y, SDL_Rect&nbsp;*&nbsp;update_rect) int&nbsp;x, int&nbsp;y, SDL_Rect&nbsp;*&nbsp;update_rect)
</b></code><br> </b></code><br>
The plugin should apply the appropriate 'Magic' tool on the The plugin should apply the appropriate 'Magic' tool on the
'<code>canvas</code>' surface. The (x,y) coordinates are where the '<code>canvas</code>' surface. The (x,y) coordinates are where the
mouse was (within the canvas) when the mouse button was clicked.<br> mouse was (within the canvas) when the mouse button was clicked, and
you are told which 'mode' your tool is in (i.e.,
'<code>MODE_PAINT</code>' or '<code>MODE_FULLSCREEN</code>).<br>
<br> <br>
The plugin should report back what part of the canvas was affected, by The plugin should report back what part of the canvas was affected, by
filling in the (x,y) and (w,h) elements of '<code>update_rect</code>'.<br> filling in the (x,y) and (w,h) elements of '<code>update_rect</code>'.<br>