Class: SMap_Canvas
Source Location: /SMap.php
Class SMap_Canvas
Property Summary
| resource |
$img |
Image bitmap resource |
| integer |
$imgRefCount |
Keep track of references to the image resource |
| object |
$tile |
The tile which this canvas is drawing |
Method Summary
| static
integer
|
fontHeight() |
Find a font height in pixels |
| static
integer
|
fontWidth() |
Find a font width in pixels |
| SMap_Canvas |
__construct() |
Create a canvas which fits the current tile |
| integer |
allocColor() |
Allocate a color for an image |
| void |
composite() |
Composite another canvas atop this one |
| boolean |
load() |
Load an image from file |
| resource |
loadRaw() |
Load an image from file |
| mixed |
__get() |
Access useful vars read-only |
Properties
Image bitmap resource
API Tags:
Keep track of references to the image resource
API Tags:
The tile which this canvas is drawing
API Tags:
Methods
static integer fontHeight(
integer
$font, string
$str
)
|
|
Find a font height in pixels
Parameters:
|
integer |
$font: |
Font resource |
|
string |
$str: |
Text to measure |
API Tags:
| Return: | Font height in pixels |
| Access: | public |
static integer fontWidth(
integer
$font, string
$str
)
|
|
Find a font width in pixels
Parameters:
|
integer |
$font: |
Font resource |
|
string |
$str: |
Text to measure |
API Tags:
| Return: | Font width in pixels |
| Access: | public |
Create a canvas which fits the current tile
Parameters:
Redefined in descendants as:
Destroy image also
"If I go down, I'm taking this image with me!" "Don't do it man! Noooooooo!!!!"
integer allocColor(
array
$color
)
|
|
Allocate a color for an image
Parameters:
|
array |
$color: |
Color in RGB or RGBA |
API Tags:
| Return: | A color handle |
| Access: | public |
Allocate an image
Allocates a true color image and initialazes it to be clear.
API Tags:
| Return: | A GD image resource |
| Access: | protected |
Composite another canvas atop this one
Parameters:
API Tags:
void compositeRes(
resource
$res,
$dstX,
$dstY,
$dstW,
$dstH
)
|
|
Composite an image resource
Parameters:
|
resource |
$res: |
|
|
|
$dstX: |
|
|
|
$dstY: |
|
|
|
$dstW: |
|
|
|
$dstH: |
|
API Tags:
void display(
integer
$fmt
)
|
|
Display an image
Parameters:
|
integer |
$fmt: |
Requested format |
API Tags:
Redefined in descendants as:
void filledPolygon(
array
&$pts, integer
$numPts, integer
$col
)
|
|
Draw a filled polygon
Parameters:
|
array |
&$pts: |
Pairs of points |
|
integer |
$numPts: |
Number of points |
|
integer |
$col: |
Color to draw |
API Tags:
void filledRectangle(
integer
$x1, integer
$y1, integer
$x2, integer
$y2, integer
$col
)
|
|
Draw a filled rectangle
Parameters:
|
integer |
$x1: |
Upper left corner X |
|
integer |
$y1: |
Upper left corner Y |
|
integer |
$x2: |
Lower right corner X |
|
integer |
$y2: |
Lower right corner Y |
|
integer |
$col: |
Color handle |
API Tags:
void line(
integer
$begX, integer
$begY, integer
$endX, integer
$endY, integer
$col
)
|
|
Draw a line
Parameters:
|
integer |
$begX: |
Beginning X |
|
integer |
$begY: |
Beginning Y |
|
integer |
$endX: |
Ending X |
|
integer |
$endY: |
Ending Y |
|
integer |
$col: |
Color handle |
API Tags:
boolean load(
integer
$ftype, string
$fname, integer
$dstX, integer
$dstY, integer
$srcX, integer
$srcY, integer
$width, integer
$height
)
|
|
Load an image from file
Parameters:
|
integer |
$ftype: |
File type |
|
string |
$fname: |
File name |
|
integer |
$dstX: |
Place at X |
|
integer |
$dstY: |
Place at Y |
|
integer |
$srcX: |
Load from X |
|
integer |
$srcY: |
Load from Y |
|
integer |
$width: |
Load width |
|
integer |
$height: |
Load height |
API Tags:
resource loadRaw(
integer
$ftype, string
$fname, integer
$srcX, integer
$srcY, integer
$width, integer
$height
)
|
|
Load an image from file
Parameters:
|
integer |
$ftype: |
File type |
|
string |
$fname: |
File name |
|
integer |
$srcX: |
Load from X |
|
integer |
$srcY: |
Load from Y |
|
integer |
$width: |
Load width |
|
integer |
$height: |
Load height |
API Tags:
void polygon(
array
&$pts, integer
$numPts, integer
$col
)
|
|
Draw a polygon
Parameters:
|
array |
&$pts: |
Pairs of points |
|
integer |
$numPts: |
Number of points |
|
integer |
$col: |
Color to draw |
API Tags:
void rectangle(
integer
$x1, integer
$y1, integer
$x2, integer
$y2, integer
$col
)
|
|
Draw a rectangle
Parameters:
|
integer |
$x1: |
Upper left corner X |
|
integer |
$y1: |
Upper left corner Y |
|
integer |
$x2: |
Lower right corner X |
|
integer |
$y2: |
Lower right corner Y |
|
integer |
$col: |
Color handle |
API Tags:
void setPixel(
integer
$x, integer
$y, integer
$col
)
|
|
Set a single pixel
Parameters:
|
integer |
$x: |
X dim |
|
integer |
$y: |
Y dim |
|
integer |
$col: |
Color handle |
API Tags:
void str(
float
$ang, resource
$font, integer
$x, integer
$y, integer
$text,
$col
)
|
|
Draw a string
Parameters:
|
float |
$ang: |
Angle to draw the text at |
|
resource |
$font: |
Font to use |
|
integer |
$x: |
X Position to draw text |
|
integer |
$y: |
Y Position to draw text |
|
integer |
$text: |
Color to draw |
|
|
$col: |
|
API Tags:
mixed __get(
string
$nm
)
|
|
Access useful vars read-only
Creates the image resource on demand
Parameters:
|
string |
$nm: |
Name of member |
API Tags:
|
|
