ZXGFX Class Reference

Public Member Functions


Detailed Description

ZX Spectrum SCREEN converter to PNG or animated GIF file

Some code parts taken from:

Author:
Andrew nyuk Marinov (aka.nyuk@gmail.com) 0.5 (2010-03-14)

Member Function Documentation

download ( filename  ) 

Generate image and force download

generate (  ) 

Generate image and return it

getBorders (  ) 

Return all available borders sizes

Returns:
array
getHiddenColors (  ) 

Return all available colors for 'showHiddenPixels' mode

Return array with all available colors for image with transparent pixels. One color format: array('R' => int R, 'G' => int G, 'B' => int B)

Returns:
array Colors array
getOutputType (  ) 

Return output type

Returns:
string with 'png' or 'gif'
getPalettes (  ) 

Return all available palettes

Returns:
array Palettes array
loadData ( data  ) 

Load source image

Parameters:
string SCR/IMG/MGS data
Returns:
string Type of image. If type not detected return false
save ( path  ) 

Generate image and save it on server

setBorder ( str = ''  ) 

Set border size

Parameters:
$str string is none, small, media
Returns:
void
setBorderColor ( color = 0  ) 

Set border color

Parameters:
$color integer from 0 to 7
Returns:
void
setFilters ( filter = '',
value = 0 
)

Set output filter

Parameters:
string Filter name
unknown_type Filter value
Returns:
void
setHiddenColor ( color_index = 0  ) 

Set color for 'showHiddenPixels' mode (INK=PAPER)

Parameters:
int Index of color in 'hidden_colors' array. Or transparen if 0.
Returns:
int color
setOption ( option_name,
value = false 
)

Set option

Parameters:
$option_name 
$value 
Returns:
void
setOutputScale ( scale = 1  ) 

Set output image scale

Parameters:
$scale integer of 1, 2, 3
Returns:
void
setOutputType ( type  ) 

Force output type

Parameters:
$type string with 'png' or 'gif'
Returns:
void
setPalette ( str = ''  ) 

Set given palette as work palette

Parameters:
$str string palette name
Returns:
void
show (  ) 

Generate image and show


Generated on Sun Mar 14 09:50:18 2010 for ZXGFX by  doxygen 1.6.1