home *** CD-ROM | disk | FTP | other *** search
Text File | 1996-06-03 | 73.6 KB | 2,954 lines |
- TABLE OF CONTENTS
-
- photogenics/ABOUT
- photogenics/ADDSPACE
- photogenics/ADDTEXT
- photogenics/ADDTEXTDO
- photogenics/ADDTEXTFONT
- photogenics/ALPHA
- photogenics/ALPHATOPAINT
- photogenics/ASKBOOLEAN
- photogenics/ASKDRAWER
- photogenics/ASKFILE
- photogenics/ASKNUMBER
- photogenics/ASKSAVEFILE
- photogenics/ASKSIZE
- photogenics/ASKSTRING
- photogenics/ASKTWONUMBERS
- photogenics/BRUSH
- photogenics/BRUSHSIZE
- photogenics/BUFFER
- photogenics/CLEAR
- photogenics/CLEARPAINT
- photogenics/CLONE
- photogenics/CLOSE
- photogenics/CLOSEPROGRESS
- photogenics/COLOUR
- photogenics/COMPOSE
- photogenics/CROP
- photogenics/DEPTH
- photogenics/EFFECT
- photogenics/EFFECTAREA
- photogenics/EFFECTPAINT
- photogenics/ELLIPSE
- photogenics/ELLIPSEFILL
- photogenics/FILLIMAGE
- photogenics/FIX
- photogenics/FIXKEEP
- photogenics/GETLINE
- photogenics/GETPAINTMODE
- photogenics/GETTRANSLINE
- photogenics/HEIGHT
- photogenics/HELP
- photogenics/INVERTALPHA
- photogenics/INVERTPAINT
- photogenics/KPRINTF
- photogenics/LINE
- photogenics/LISTBRUSHES
- photogenics/LISTEFFECTS
- photogenics/LISTLOADERS
- photogenics/LISTMODES
- photogenics/LISTSAVERS
- photogenics/LOAD
- photogenics/LOADHIDE
- photogenics/LOADHIDEGIO
- photogenics/LOADGIO
- photogenics/LOADVIRT
- photogenics/MODEOPTS
- photogenics/NEW
- photogenics/NEWVIRT
- photogenics/OPENPROGRESS
- photogenics/PAINTMODE
- photogenics/PAINTTOALPHA
- photogenics/PGSTOBACK
- photogenics/PGSTOFRONT
- photogenics/PLOT
- photogenics/PRESSURE
- photogenics/QUIT
- photogenics/RECT
- photogenics/RECTFILL
- photogenics/REDRAW
- photogenics/RELEASELINE
- photogenics/RELEASETRANSLINE
- photogenics/RENAME
- photogenics/RESIZETILED
- photogenics/ROTATE
- photogenics/SAVE
- photogenics/SAVECLIP
- photogenics/SCALE
- photogenics/SECONDARY
- photogenics/SELECTSIM
- photogenics/SETALPHA
- photogenics/SETIMAGE
- photogenics/SETPROGRESS
- photogenics/SETSECONDARY
- photogenics/SHEAR
- photogenics/SHOWERROR
- photogenics/SHOWMESSAGE
- photogenics/TRANSFIX
- photogenics/TRANSGRAD
- photogenics/TRANSPARENCY
- photogenics/UNDO
- photogenics/VCLIP
- photogenics/WARPER
- photogenics/WIDTH
- photogenics/ABOUT
-
- NAME
- ABOUT - Display the Photogenics About requester.
-
- SYNOPSIS
- ABOUT
-
- FUNCTION
- The About requester is displayed and script execution
- paused until the requester is closed.
-
- INPUTS
- None
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* show about requester */
- address PHOTOGENICS.1
- ABOUT
-
- BUGS
-
- photogenics/ADDSPACE
-
- NAME
- ADDSPACE - Add space to the edges of an image.
-
- SYNOPSIS
- ADDSPACE buffer top left bottom right
-
- FUNCTION
- Adds more space to the outside of the image (borders).
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- top - number of pixels to add to the top.
-
- left - number of pixels to add to the left.
-
- bottom - number of pixels to add to the bottom.
-
- right - number of pixels to add to the right.
-
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/ADDTEXT
-
- NAME
- ADDTEXT - Select the text for use in AddText.
-
- SYNOPSIS
- ADDTEXT buffer x y justify text
-
- FUNCTION
- Sets the text used in ADDTEXT to the selected font
- parameters.
-
- INPUTS
-
- buffer - the image buffer to draw text into.
-
- x - the x coordinate of the top left hand corner.
- y - the y coordinate of the top left hand corner.
- justify - how to justify the text:
- 0 - left
- 1 - right
- 2 - center
-
- text - the text to print. Use newline characters
- to split the line up.
-
-
- RETURNS
-
- NOTES
- This doesn't actually draw the text. You need to issue an
- ADDTEXTDO command to draw, once ADDTEXT and ADDTEXTFONT
- are set.
-
- SEE ALSO
- ADDTEXT ADDTEXTDO
- EXAMPLE
-
- BUGS
- photogenics/ADDTEXTDO
-
- NAME
- ADDTEXTDO - Perform an addtext operation
-
- SYNOPSIS
- ADDTEXTDO buffer
-
- FUNCTION
- Applies the AddText operation previously set up
- with ADDTEXTFONT and ADDTEXT
-
- INPUTS
-
- buffer - Pointer to the buffer. Must be the same as used
- in ADDTEXT.
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- ADDTEXT ADDTEXTFONT
- EXAMPLE
-
- BUGS
- photogenics/ADDTEXTFONT
-
- NAME
- ADDTEXTFONT - Select the font for use in AddText
-
- SYNOPSIS
- ADDTEXTFONT fontname fontsize fontstyle
-
- FUNCTION
- Sets the font used in ADDTEXT to the selected font
- parameters.
-
- INPUTS
-
- fontname - Name of the font. Must be in quotes, and
- end with .font
-
- fontsize - The font size (vertical), eg. 8
-
- fontstyle - The style of the font (eg whether it is bold
- or normal). use 0 for default style. See
- Amiga RKM's for more information on font
- styles.
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- ADDTEXT ADDTEXTDO
- EXAMPLE
-
- BUGS
- photogenics/ALPHA
-
- NAME
- ALPHA - Return a pointer to the current alpha channel
- image.
-
- SYNOPSIS
- ALPHA
-
- FUNCTION
- Return a pointer to the current alpha image, if one
- is selected within Photogenics.
-
- INPUTS
-
- RETURNS
- Buffer is a unique pointer to the alpha image buffer.
- This result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was no alpha image.
-
- NOTES
-
-
- SEE ALSO
- BUFFER SECONDARY
-
- EXAMPLE
-
- BUGS
- photogenics/ALPHATOPAINT
-
- NAME
- ALPHATOPAINT - Moves the Alpha Channel to the paintlayer.
-
-
- SYNOPSIS
- ALPHATOPAINT buffer
-
- FUNCTION
- The Alpha channel, if one is selected, is moved into
- the paintlayer for the currently selected image (it
- is converted to greyscale).
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO, NEW, etc.
-
- RETURNS
-
-
- NOTES
-
- SEE ALSO
- PAINTTOALPHA
- EXAMPLE
-
- BUGS
- photogenics/ASKBOOLEAN
-
- NAME
- ASKBOOLEAN - Ask a 'yes'/'no' type question.
-
- SYNOPSIS
- result ASKBOOLEAN title prompt gadget1 gadget2
-
- FUNCTION
- A requester is displayed.
-
- INPUTS
- title - the title for the message requester
- (eg. "Continue Request")
-
- prompt - the text required inside the requester
- (eg. "Do you wish to continue:")
-
- gadget1- the text for gadget1
- (eg "Yes please!")
-
- gadget2- the text for gadget2
- (eg "Sorry, no.")
-
- RETURNS
- result - a string containing the resultant number.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
-
-
- photogenics/ASKDRAWER
-
- NAME
- ASKDRAWER - Ask the user to select a drawer.
-
- SYNOPSIS
- result ASKDRAWER title drawer
-
- FUNCTION
- A directory requester is displayed and a directory requested.
-
- INPUTS
- title - the title for the file requester
- (eg. "'File Request'")
-
- drawer - the default path for the file requester
-
- RETURNS
- result - a string containing the directory selected.
-
- NOTES
-
- SEE ALSO
- ASKFILE ASKSAVEFILE
- EXAMPLE
-
- BUGS
-
- photogenics/ASKFILE
-
- NAME
- ASKFILE - Ask the user to select a file.
-
- SYNOPSIS
- result ASKFILE title drawer
-
- FUNCTION
- A file requester is displayed and a filename requested.
-
- INPUTS
- title - the title for the file requester
- (eg. "'File Request'")
-
- drawer - the default path for the file requester
-
- RETURNS
- result - a string containing the filename selected.
-
- NOTES
-
- SEE ALSO
- ASKSAVEFILE ASKDRAWER
- EXAMPLE
-
- BUGS
-
- photogenics/ASKNUMBER
-
- NAME
- ASKNUMBER - Ask the user to select a number.
-
- SYNOPSIS
- result ASKNUMBER title prompt min max
-
- FUNCTION
- A number requester is displayed.
-
- INPUTS
- title - the title for the message requester
- (eg. "Age Request")
-
- prompt - the text required inside the requester
- (eg. "Please enter your age:")
-
- min - the minimum value for the result.
- (eg. "3")
-
- max - the maximum value for the result.
- (eg. "133")
-
- RETURNS
- result - a string containing the resultant number.
-
- NOTES
-
- SEE ALSO
- ASKTWONUMBERS
- EXAMPLE
-
- BUGS
-
- photogenics/ASKSAVEFILE
-
- NAME
- ASKSAVEFILE - Ask the user to select a file (for save).
-
- SYNOPSIS
- result ASKSAVEFILE title drawer
-
- FUNCTION
- A file requester (of the black-background Save variety)
- is displayed and a filename requested.
-
- INPUTS
- title - the title for the file requester
- (eg. "'File Request'")
-
- drawer - the default path for the file requester
-
- RETURNS
- result - a string containing the filename selected.
-
- NOTES
-
- SEE ALSO
- ASKFILE ASKDRAWER
- EXAMPLE
-
- BUGS
-
- photogenics/ASKSIZE
-
- NAME
- ASKSIZE - Ask for an image size.
-
- SYNOPSIS
- result ASKSIZE title def_x def_y
-
- FUNCTION
- An Image dimensions requester (like the one used
- for New Image) is displayed.
-
- The size selected is returned in result.
-
- INPUTS
- title - the title for the message requester
- (eg. "'Size for new Thing'")
-
- def_x - The default setting for the x slider.
-
- def_y - The default setting for the y slider.
-
- RETURNS
- result - a string containing the dimensions selected
- seperated by a space.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/ASKSTRING
-
- NAME
- ASKSTRING - Ask the user to enter a string.
-
- SYNOPSIS
- result ASKSTRING title prompt
-
- FUNCTION
- A string requester is displayed.
-
- INPUTS
- title - the title for the message requester
- (eg. "Name Request")
- prompt - the text required inside the requester
- (eg. "Please enter your name:")
- RETURNS
- result - a string containing the resultant string.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/ASKTWONUMBERS
-
- NAME
- ASKTWONUMBERS - Ask for two numbers.
-
- SYNOPSIS
- result ASKTWONUMBERS title prompt min max prompt2 min2 max2
-
- FUNCTION
- A number requester is displayed.
-
- INPUTS
- title - the title for the message requester
- (eg. "'Age Request'")
-
- prompt - the text required inside the requester
- (eg. "'Please enter your age:'")
-
- min - the minimum value for the result.
- (eg. "3")
-
- max - the maximum value for the result.
- (eg. "133")
-
- prompt2 - the text required inside the requester
- (eg. "'Please enter your shoesize:'")
-
- min - the minimum value for the result.
- (eg. "1")
-
- max - the maximum value for the result.
- (eg. "50")
-
- RETURNS
- result - a string containing the resultant numbers
- seperated by a space.
-
- NOTES
-
- SEE ALSO
- ASKNUMBER
- EXAMPLE
-
- BUGS
- photogenics/BRUSH
-
- NAME
- BRUSH - Sets the current brush for painting operations
-
- SYNOPSIS
- BRUSH brushname
-
-
- FUNCTION
- The brush is selected as the brush for further painting
- operations.
-
- INPUTS
- brushname - the name of the brush, in quotes.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Set brush to AirBrush. */
- address PHOTOGENICS.1
- BRUSH "AirBrush"
- BUGS
- photogenics/BRUSHSIZE
-
- NAME
- BRUSHSIZE - Sets the current brush size
-
- SYNOPSIS
- BRUSHSIZE size
-
-
- FUNCTION
- The brush is resized to the selected size
-
- INPUTS
- size - the requested size, in pixels.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/BUFFER
-
- NAME
- BUFFER - Return a pointer to the currently selected buffer.
-
- SYNOPSIS
- BUFFER
-
-
- FUNCTION
- If a buffer is selected inside Photogenics, the buffer
- number is returned.
-
- INPUTS
- None
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This
- result is used as a pointer to
- the image for all further operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
- This is useful if you wish to write an effect macro to
- apply to the current image within Photogenics.
-
- SEE ALSO
-
- EXAMPLE
- /* fill current buffer */
- option results
- address PHOTOGENICS.1
- BUFFER
- FILLIMAGE result
- BUGS
- photogenics/CLEAR
-
- NAME
- CLEAR - Clear the image.
-
- SYNOPSIS
- CLEAR buffer r g b
-
- FUNCTION
- Clear the image buffer to the RGB value supplied.
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- r - red component (0 to 255)
- g - green component (0 to 255)
- b - blue component (0 to 255)
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- Doesn't currently work for virtual images.
- photogenics/CLEARPAINT
-
- NAME
- CLEARPAINT - Clears the paint layer
-
- SYNOPSIS
- CLEARPAINT buffer
-
- FUNCTION
- Clears the paintlayer attached to the buffer.
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
-
- photogenics/CLONE
-
- NAME
- CLONE - Clone an image.
-
- SYNOPSIS
- CLONE buffer
-
- FUNCTION
- Clones a photogenics image buffer. A new buffer pointer
- is returned.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
- A new buffer pointer for the cloned image.
- NOTES
- The name of the cloned image is automatically created
- using the same algorithmn that Workbench uses for copies
- of files.
- (filename, Copy of Filename, Copy 2 of Filename, etc.)
-
- SEE ALSO
-
- EXAMPLE
- /* free the current buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- CLOSE result
- BUGS
- You cannot currently clone virtual images.
- photogenics/CLOSE
-
- NAME
- CLOSE - Close an image.
-
- SYNOPSIS
- CLOSE buffer
-
- FUNCTION
- Close a Photogenics image buffer, freeing its memory and
- losing any unsaved changes.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* free the current buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- CLOSE result
- BUGS
- photogenics/CLOSEPROGRESS
-
- NAME
- CLOSEPROGRESS - Close the progress meter.
-
- SYNOPSIS
- CLOSEPROGRESS
-
- FUNCTION
- Closes the Progress meter.
-
- INPUTS
-
- RETURNS
-
- NOTES
- It is *absolutely* imperative that you always
- CLOSEPROGRESS before ending a script where you have called OPENPROGRESS
-
- SEE ALSO
- OPENPROGRESS SETPROGRESS
- EXAMPLE
-
- BUGS
- photogenics/COLOUR
-
- NAME
- COLOUR - set the colour.
-
- SYNOPSIS
- COLOUR buffer RGB r g b
-
- FUNCTION
- Set the RGB values for the current paint colour for the
- selected buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RGB - a string to indicate the colour model (in this
- case, "RGB")
-
- r - red value (0 to 255)
-
- g - green value (0 to 255)
-
- b - blue value (0 to 255)
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* free the current buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- CLOSE result
- BUGS
- photogenics/COMPOSE
-
- NAME
- COMPOSE - Compose one image into another.
-
-
- SYNOPSIS
- COMPOSE - main second x y x1 y1 settings
-
- FUNCTION
- The second image is composed into the main buffer at
- the coordinates given using the selected settings.
-
- INPUTS
- main - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO, NEW, etc.
-
- second - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO, NEW, etc.
-
- x - left side rectangle
- y - top of rectangle
- x1 - right side of rectangle
- y1 - bottom of rectangle
-
- settings - a number:
-
- 0 - standard compose
- 1 - Brightness Key mode set.
- 2 - Transparent Black mode set.
- 3 - Transparent Colour mode set.
-
- RETURNS
-
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- Doesn't currently allow other paintmodes to be used.
- This will be fixed soon.
- photogenics/CROP
-
- NAME
- CROP - Crop an image.
-
- SYNOPSIS
- CROP buffer x y width height
-
- FUNCTION
- Crops an image buffer to the rectangle with top left
- coordinate x,y, width pixels wide and height pixels high.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x coord for top left corner of new rectangle.
-
- y - y coord for top left corner of new rectangle.
-
- width - width of new image in pixels
-
- height - height of new image in pixels
-
-
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- HEIGHT
-
- EXAMPLE
- /* crop the current buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- CROP result 10 10 50 50
- BUGS
- photogenics/DEPTH
-
- NAME
- DEPTH - Returns the number of bits per pixel in the image
-
- SYNOPSIS
- DEPTH <buffer>
-
- FUNCTION
- The number of bits per pixel of the image is returned.
-
- INPUTS
- buffer = a pointer to the buffer returned by NEW, LOAD
- or LOADGIO
-
- RETURNS
- result is the bits per pixel value
-
- NOTES
- Currently only 24-bit buffers are supported, so 24 is
- always returned. Future versions will support other bit
- depths.
-
- SEE ALSO
-
- BUGS
- photogenics/EFFECT
-
- NAME
- EFFECT - Apply an effect to an image.
-
- SYNOPSIS
- EFFECT buffer effect [parameters]
-
- FUNCTION
- The selected effect is appled to the whole image.
-
- INPUTS
- buffer - A valid buffer OR virtual image pointer.
- effect - The name of the effect (without .efx)
- parameters - Optional parameters (see effect docs)
-
- RETURNS
-
- NOTES
- Always keep the effect name in quotes, or AREXX
- will upper-case it and Photogenics won't be able to
- find it.
-
- SEE ALSO
- EFFECTPAINT EFFECTAREA
- EXAMPLE
-
- BUGS
- photogenics/EFFECTAREA
-
- NAME
- EFFECTAREA - Apply an effect to a selected region of an
- image.
-
- SYNOPSIS
- EFFECTAREA buffer effect [parameters]
-
- FUNCTION
- The selected effect is appled to the chosen region
- of the image.
-
- INPUTS
- buffer - A valid buffer or a virtual image pointer.
- effect - The name of the effect (without .efx)
- parameters - Optional parameters (see effect docs)
-
- RETURNS
-
- NOTES
- Always keep the effect name in quotes, or AREXX
- will upper-case it and Photogenics won't be able to
- find it.
-
- SEE ALSO
- EFFECT EFFECTAREA
- EXAMPLE
-
- BUGS
- photogenics/EFFECTPAINT
-
- NAME
- EFFECTPAINT - Apply an effect to the paintlayer of an image.
-
- SYNOPSIS
- EFFECTPAINT buffer effect [parameters]
-
- FUNCTION
- The selected effect is appled to the paintlayer of an
- image.
-
- INPUTS
- buffer - A valid buffer.
- effect - The name of the effect (without .efx)
- parameters - Optional parameters (see effect docs)
-
- RETURNS
-
- NOTES
- Always keep the effect name in quotes, or AREXX
- will upper-case it and Photogenics won't be able to
- find it.
-
- SEE ALSO
- EFFECT EFFECTAREA
- EXAMPLE
-
- BUGS
- photogenics/ELLIPSE
-
- NAME
- ELLIPSE
-
- SYNOPSIS
- ELLIPSE buffer x y w h
-
- FUNCTION
- Draws an ellipse (or circle) into buffer using the current
- brush tool, center at x,y, width w and height h.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- w - width
- h - height
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/ELLIPSEFILL
-
- NAME
- ELLIPSEFILL
-
- SYNOPSIS
- ELLIPSEFILL buffer x y w h
-
- FUNCTION
- Draws a filled ellipse (or circle) into buffer.
- Center at x,y, width w and height h.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- w - width
- h - height
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/FILLIMAGE
-
- NAME
- FILLIMAGE - Fill the paintlayer on an image buffer.
-
- SYNOPSIS
- FILLIMAGE <buffer>
-
- FUNCTION
- The paintlayer (the 8-bit transparency channel you paint
- into) is filled with a solid colour (or a gradient pattern
- depending on the currently selected gradient).
-
- INPUTS
- buffer = a pointer to the buffer returned by NEW, LOAD or
- LOADGIO
-
- RETURNS
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Open an image and fill the paintlayer */
- options results
- address PHOTOGENICS.1
- LOAD "ram:text.jpg"
- FILLIMAGE result
-
- BUGS
- photogenics/FIX
-
- NAME
- FIX
-
- SYNOPSIS
- FIX buffer
-
- FUNCTION
- Makes changes applied to buffer permanent.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* fix changes in the currently selected buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- FIX result
- BUGS
-
- photogenics/FIXKEEP - Apply paintlayer changes, but keep paintlayer.
-
- NAME
- FIXKEEP
-
- SYNOPSIS
- FIXKEEP buffer
-
- FUNCTION
- Makes changes applied via the paintlayer permanent,
- but unlike FIX the contents of the paintlayer are not
- cleared, so further operations can be carried out.
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
-
- photogenics/GETLINE
-
- NAME
- GETLINE - return the address of a 24-bit data line
-
- SYNOPSIS
- GETLINE buffer y
-
- FUNCTION
- A powerful function which must be used with care.
- GETLINE provides access to the 24-bit internal data
- stored in Photogenics.
-
- This returns the address of the 24-bit data, which you
- can then manipulate as you wish.
-
- The data is stored in RGBRGBRGB... format, with 1 byte
- per colour component, three bytes per pixel, no pad data.
-
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- y - The line (0<=y<height) to access.
-
- RETURNS
- The address of the RGB data.
-
- NOTES
- ALWAYS RELEASELINE after you have finished accessing the
- data.
-
- DO NOT ATTEMPT any other photogenics operations that alter
- the image data (FIX, SCALE, CROP, etc.) while you have
- a line locked.
-
- DO NOT GETLINE MORE LINES AT A TIME THAN YOU NEED,
- although it is safe to allocate more than one at a time,
- as long as they are all released when finished with.
-
- NEVER access the data after RELEASELINE has been called.
-
-
-
- SEE ALSO
- RELEASELINE
-
- EXAMPLE
-
- BUGS
- Does not support Virtual Images yet.
- photogenics/GETPAINTMODE
-
- NAME
- GETPAINTMODE - return the paintmode for a buffer.
-
- SYNOPSIS
- GETPAINTMODE buffer
-
- FUNCTION
- Get the paintmode currently selected for this buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
-
- RETURNS
- The name of the paintmode.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/GETTRANSLINE
-
- NAME
- GETTRANSLINE - return the address of 8-bit trans line
-
- SYNOPSIS
- GETTRANSLINE buffer y
-
- FUNCTION
- A powerful function which must be used with care.
- GETLINE provides access to the 8-bit internal data
- for the paintlayer stored in Photogenics.
-
- This returns the address of the 8-bit data, which you
- can then manipulate as you wish.
-
- The data is stored with 1 byte per pixel, no pad data.
-
- 0 is transparent, 255 is opaque (assuming the transparency
- slider is set to 0%)
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- y - The line (0<=y<height) to access.
-
- RETURNS
- The address of the paintlayer data.
-
- NOTES
- ALWAYS RELEASEPAINTLINE after you have finished accessing
- the data.
-
- DO NOT ATTEMPT any other photogenics operations that alter
- the image data (FIX, SCALE, CROP, etc.) while you have
- a line locked.
-
- DO NOT GETTRANSLINE MORE LINES AT A TIME THAN YOU NEED,
- although it is safe to allocate more than one at a time,
- as long as they are all released when finished with.
-
- NEVER access the data after RELEASETRANSLINE has been called.
-
-
-
- SEE ALSO
- RELEASETRANSLINE
-
- EXAMPLE
-
- BUGS
- photogenics/HEIGHT
-
- NAME
- HEIGHT - return the height of the image.
-
- SYNOPSIS
- HEIGHT buffer
-
- FUNCTION
- Used to determine the height of a Photogenics image buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
- height in pixels.
-
- NOTES
-
- SEE ALSO
- WIDTH
-
- EXAMPLE
- /* display the height of the currently selected buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- HEIGHT result
- say "Image is " || result || " pixels high"
- BUGS
- photogenics/HELP
-
- NAME
- HELP
-
- SYNOPSIS
- HELP
-
- FUNCTION
- Open the Photogenics on-line help.
-
- INPUTS
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/INVERTALPHA
-
- NAME
- INVERTALPHA - Inverts the Alpha Channel image.
-
-
- SYNOPSIS
- INVERTALPHA
-
- FUNCTION
- The Alpha Channel is inverted.
-
- INPUTS
-
- RETURNS
-
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/INVERTPAINT
-
- NAME
- INVERTPAINT - Inverts the paintlayer on an image.
-
-
- SYNOPSIS
- INVERTPAINT buffer
-
- FUNCTION
- The paintlayer is inverted.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO, NEW, etc.
-
- RETURNS
-
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/KPRINTF
-
- NAME
- KPRINTF
-
- SYNOPSIS
- KPRINTF string
-
- FUNCTION
- Prints a string to the serial port. This is
- useful for debugging purposes.
-
- INPUTS
- string - A string.
-
- RETURNS
-
- NOTES
- Written for our own debugging purposes. You may find
- this a useful way to monitor script process (if you
- have a serial terminal attached to your Amiga serial
- port.)
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/LINE
-
- NAME
- LINE
-
- SYNOPSIS
- LINE buffer x y x1 y1
-
- FUNCTION
- Draws a line in the current brush into the image starting
- at coordinates x,y and ending at x1,y1
-
- This is the equivelant of a single click on the image at the
- given coordinates with the standard drawing tool.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- x1 - x1 position where 0<=x1<WIDTH
- y1 - y1 position where 0<=y1<HEIGHT
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/LISTBRUSHES
-
- NAME
- LISTBRUSHES
-
- SYNOPSIS
- result LISTBRUSHES
-
- FUNCTION
- Return a list of all the brushes currently available in
- Photogenics.
-
- INPUTS
-
- RETURNS
- A string containing all available brushes, each
- seperated by a space.
- NOTES
-
- SEE ALSO
- LISTSAVERS LISTLOADERS LISTEFFECTS LISTMODES
- EXAMPLE
-
- BUGS
- photogenics/LISTEFFECTS
-
- NAME
- LISTEFFECTS
-
- SYNOPSIS
- result LISTEFFECTS
-
- FUNCTION
- Return a list of all the effects currently available in
- Photogenics.
-
- INPUTS
-
- RETURNS
- A string containing all available effects, each
- seperated by a space.
- NOTES
-
- SEE ALSO
- LISTSAVERS LISTMODES LISTLOADERS
- EXAMPLE
-
- BUGS
- photogenics/LISTLOADERS
-
- NAME
- LISTLOADERS
-
- SYNOPSIS
- result LISTLOADERS
-
- FUNCTION
- Return a list of all the loaders currently available in
- Photogenics.
-
- INPUTS
-
- RETURNS
- A string containing all available loaders, each
- seperated by a space.
- NOTES
-
- SEE ALSO
- LISTSAVERS LISTMODES LISTEFFECTS
- EXAMPLE
-
- BUGS
- photogenics/LISTMODES
-
- NAME
- LISTMODES
-
- SYNOPSIS
- result LISTMODES
-
- FUNCTION
- Return a list of all the paintmodes currently available in
- Photogenics.
-
- INPUTS
-
- RETURNS
- A string containing all available paintmodes, each
- seperated by a space.
- NOTES
-
- SEE ALSO
- LISTSAVERS LISTLOADERS LISTEFFECTS
- EXAMPLE
-
- BUGS
- photogenics/LISTSAVERS
-
- NAME
- LISTSAVERS
-
- SYNOPSIS
- result LISTSAVERS
-
- FUNCTION
- Return a list of all the savers currently available in
- Photogenics.
-
- INPUTS
-
- RETURNS
- A string containing all available savers, each
- seperated by a space.
- NOTES
-
- SEE ALSO
- LISTLOADERS LISTMODES LISTEFFECTS
- EXAMPLE
-
- BUGS
- photogenics/LOAD
-
- NAME
- LOAD - Load an image file
-
- SYNOPSIS
- LOAD filename
-
- FUNCTION
- Photogenics attempts to load a file.
-
- INPUTS
- filename - The name of the file to load.
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This
- result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
- It is *slightly* faster and more memory efficient to use
- LOADGIO and specify the GIO type if you know what type of
- file you are loading (for example if converting a batch of
- JPEG files). Otherwise use LOAD, which avoids having to
- specify the file type and will automatically detect the
- filetype (where possible). You will also need to use LOADGIO
- if you wish to pass ARexx parameters to the loader
- (to override requesters, for example)
-
-
- SEE ALSO
- LOADGIO
-
- EXAMPLE
- /* Open an image */
- address PHOTOGENICS.1
- LOAD "ram:text.jpg"
-
- BUGS
- photogenics/LOADGIO
-
- NAME
- LOADGIO - Load an image using a specific GIO import filter..
-
- SYNOPSIS
- LOADGIO loadername [filename] [options]
-
- FUNCTION
- Photogenics attempts to load/create a new image using the
- import filter specified in loadername (the .GIO suffix
- must not be used). If a disk file is being loaded, the
- filename must be specified. Each GIO has different options,
- and these may need to be specified. See the arexx
- documentation for the GIO files to determine what
- options are needed.
-
- INPUTS
- loadername - The name of the GIO to use (the .GIO suffix must
- not be used).
-
- filename - The name of the file to load. Only required
- on GIOS that load from disk files.
-
- options - The options required by the GIO. These vary,
- some GIOS have no options.
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This
- result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
- It is *slightly* faster and more memory efficient to use
- LOADGIO and specify the GIO type if you know what type of
- file you are loading (for example if converting a batch of
- JPEG files). Otherwise use LOAD, which avoids having to
- specify the file type and will automatically detect
- the filetype (where possible).
-
- SEE ALSO
- LOAD LOADHIDEGIO
-
- EXAMPLE
- /* Open an image */
- address PHOTOGENICS.1
- LOADGIO "JPEG" "ram:text.jpg"
-
- BUGS
- photogenics/LOADHIDE
-
- NAME
- LOADHIDE - Load an image file (but don't open a window)
-
- SYNOPSIS
- LOADHIDE filename
-
- FUNCTION
- Photogenics attempts to load a file.
-
- INPUTS
- filename - The name of the file to load.
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This
- result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
- It is *slightly* faster and more memory efficient to use
- LOADGIO and specify the GIO type if you know what type of
- file you are loading (for example if converting a batch of
- JPEG files). Otherwise use LOAD, which avoids having to
- specify the file type and will automatically detect the
- filetype (where possible). You will also need to use LOADGIO
- if you wish to pass ARexx parameters to the loader
- (to override requesters, for example)
-
-
- SEE ALSO
- LOAD LOADGIO LOADHIDEGIO
-
- EXAMPLE
- /* Open an image */
- address PHOTOGENICS.1
- LOADHIDE "ram:text.jpg"
-
- BUGS
- photogenics/LOADHIDEGIO
-
- NAME
- LOADHIDEGIO - Load a hidden image using GIO import filter.
-
- SYNOPSIS
- LOADHIDEGIO loadername [filename] [options]
-
- FUNCTION
- Photogenics attempts to load/create a new image using the
- import filter specified in loadername (the .GIO suffix
- must not be used). If a disk file is being loaded, the
- filename must be specified. Each GIO has different options,
- and these may need to be specified. See the arexx
- documentation for the GIO files to determine what
- options are needed.
-
- Unlike LOADGIO, the image does not have a new window
- created for it (it is hidden, as in the Open As/Hidden
- menu item in Photogenics)
-
-
- INPUTS
- loadername - The name of the GIO to use (the .GIO suffix must
- not be used).
-
- filename - The name of the file to load. Only required
- on GIOS that load from disk files.
-
- options - The options required by the GIO. These vary,
- some GIOS have no options.
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This
- result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was any problems preventing the image loading.
-
- NOTES
- It is *slightly* faster and more memory efficient to use
- LOADGIO and specify the GIO type if you know what type of
- file you are loading (for example if converting a batch of
- JPEG files). Otherwise use LOAD, which avoids having to
- specify the file type and will automatically detect
- the filetype (where possible).
-
- SEE ALSO
- LOAD LOADHIDEGIO
-
- EXAMPLE
- /* Open an image */
- address PHOTOGENICS.1
- LOADHIDEGIO "JPEG" "ram:text.jpg"
-
- BUGS
- photogenics/LOADVIRT
-
- NAME
- LOADVIRT - Load an image file as a virtual image
-
- SYNOPSIS
- LOADVIRT filename
-
- FUNCTION
- Photogenics attempts to load a file as a virtual image.
-
- INPUTS
- filename - The name of the file to load.
-
- RETURNS
- Buffer is a unique pointer to the virtual image buffer.
- This result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image loading.
-
- NOTES
-
- SEE ALSO
- LOAD
-
- EXAMPLE
-
- BUGS
- photogenics/MODEOPTS
-
- NAME
- MODEOPTS - Change the options for the paintmode.
-
- SYNOPSIS
- MODEOPTS buffer options
-
- FUNCTION
- Change the mode options for the paintmode selected on the
- chosen buffer.
-
- INPUTS
- buffer - pointer to image buffer.
-
- options - a variety of options, depending on the
- paintmode.
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- BUGS
- photogenics/NEW
-
- NAME
- NEW
-
- SYNOPSIS
- NEW x y r g b
-
- FUNCTION
- Create a new image, size x,y colour rgb.
-
- INPUTS
- x - x dimension (in pixels). Must be >4 and < 32768
- y - y dimension (in pixels). Must be >4 and < 32768
- r - red component (0 to 255)
- g - red component (0 to 255)
- b - red component (0 to 255)
-
-
- RETURNS
- Buffer is a unique pointer to the image buffer. This result
- is used as a lock on the image for all further operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image creation.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Create a new image */
- address PHOTOGENICS.1
- NEW 320 256 200 100 50
-
- BUGS
- photogenics/NEWVIRT
-
- NAME
- NEWVIRT
-
- SYNOPSIS
- NEWVIRT x y
-
- FUNCTION
- Create a new virtual image, size x,y.
-
- INPUTS
- x - x dimension (in pixels). Must be >4 and < 32768
- y - y dimension (in pixels). Must be >4 and < 32768
-
-
- RETURNS
- A unique pointer to the virtual image buffer. This result
- is used as a lock on the image for all further operations.
-
- rc = 0 on success, 1 if there was any problems preventing
- the image creation.
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Create a new virtualimage */
- address PHOTOGENICS.1
- NEWVIRT 320 256 200 100 50
-
- BUGS
-
- photogenics/OPENPROGRESS
-
- NAME
- OPENPROGRESS
-
- SYNOPSIS
- OPENPROGRESS title text
-
- FUNCTION
- In complex arexx scripts a progress meter can be
- displayed. While this is active no standard Photogenics
- requesters will be opened (eg other progress meters) and
- image windows will not be opened.
-
- INPUTS
- title - The title for the progress meter.
- text - the default text inside the progress meter.
-
- RETURNS
-
- NOTES
- The progress meter is not actually displayed until the
- first call to SETPROGRESS. If you want a progress meter
- displayed immediately, issue SETPROGRESS "" 0 after the
- OPENPROGRESS call.
-
- SEE ALSO
- SETPROGRESS CLOSEPROGRESS
-
- EXAMPLE
- /* display a progress requester */
- options results
- address PHOTOGENICS.1
- OPENPROGRESS "Progress" "'Default text in progress meter'"
- SETPROGRESS "" 0
- < do something >
- SETPROGRESS "" 50
- < do something else >
- SETPROGRESS "" 100
- < finished >
- CLOSEPROGRESS
-
- BUGS
- Spaces in strings are best dealt with by enclosing text in
- double quotes , eg. "'xx xx xx'"
-
- photogenics/PAINTMODE
-
- NAME
- PAINTMODE - Select a new paintmode to use with the
- currently selected buffer.
-
- SYNOPSIS
- PAINTMODE <buffer> <paintmode>
-
- FUNCTION
- A new paintmode is selected for the chosen buffer.
-
- INPUTS
- buffer - A buffer pointer previously returned by NEW,
- BUFFER, LOADGIO, LOAD, etc.
-
- paintmode - The name of the paintmode to select.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Change the paintmode to Negative */
- options results
- address PHOTOGENICS.1
- BUFFER
- PAINTMODE result "Negative"
- BUGS
- photogenics/PAINTTOALPHA
-
- NAME
- PAINTTOALPHA - Move paintlayer to Alpha.
-
-
- SYNOPSIS
- PAINTTOALPHA buffer
-
- FUNCTION
- The paintlayer is transferred from the current image to
- a new alpha channel buffer.
-
- INPUTS
- buffer - A buffer pointer previously returned by NEW,
- BUFFER, LOADGIO, LOAD, etc.
-
- RETURNS
-
-
- NOTES
- Follow this with an ALPHA command to get the ID of
- the Alpha Channel it creates.
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/PGSTOBACK
-
- NAME
- PGSTOBACK
-
- SYNOPSIS
- PGSTOBACK - Send Photogenics screen to back.
-
- FUNCTION
- The Photogenics screen is sent to the back of the visible
- screen list, hiding behind other open screens.
-
- INPUTS
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- BUGS
- photogenics/PGSTOFRONT
-
- NAME
- PGSTOFRONT
-
- SYNOPSIS
- PGSTOFRONT - Send Photogenics screen to front.
-
- FUNCTION
- The Photogenics screen is sent to the front of the visible
- screen list..
-
- INPUTS
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- BUGS
-
- photogenics/PLOT
-
- NAME
- PLOT
-
- SYNOPSIS
- PLOT buffer x y
-
- FUNCTION
- Draw the current brush into the image at co-ordinates x,y
- This is the equivelant of a single click on the image at the
- given coordinates with the standard drawing tool.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/PRESSURE
-
- NAME
- PRESSURE
-
- SYNOPSIS
- PRESSURE val
-
- FUNCTION
- Sets the brush pressure (in percent)
-
- INPUTS
- val - the pressure required (1 to 100)
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/QUIT
-
- NAME
- QUIT
-
- SYNOPSIS
- QUIT
-
- FUNCTION
- Quits Photogenics
-
- INPUTS
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/RECT
-
- NAME
- RECT
-
- SYNOPSIS
- RECT buffer x y x1 y1
-
- FUNCTION
- Draws a rectangle into buffer using the current brush tool.
- Top left corner = x,y. Bottom right corner = x1,y1
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- x1 - x1 position where 0<=x1<WIDTH
- y1 - y1 position where 0<=y1<HEIGHT
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/RECTFILL
-
- NAME
- RECTFILL
-
- SYNOPSIS
- RECTFILL buffer x y x1 y1
-
- FUNCTION
- Draws a filled rectangle into buffer
- Top left corner = x,y. Bottom right corner = x1,y1
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- x1 - x1 position where 0<=x1<WIDTH
- y1 - y1 position where 0<=y1<HEIGHT
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/REDRAW
-
- NAME
- REDRAW
-
- SYNOPSIS
- REDRAW buffer
-
- FUNCTION
- Redraw the window display for a buffer.
-
- INPUTS
- buffer - pointer to a buffer (returned by NEW, etc.)
-
- RETURNS
-
- NOTES
- Should be used if you access the buffer via
- GETLINE/RELEASELINE, and at the end of scripts after
- you have finished processing while redraw has been
- turned off (with OPENPROGRESS, for example)
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/RELEASELINE
-
- NAME
- RELEASELINE - releases a lock on the 24-bit data.
-
- SYNOPSIS
- RELEASELINE buffer y
-
- FUNCTION
- Call this when you have finished manipulating data
- accesssed by GETLINE.
-
- To refresh the Photogenics window after this,
- call REDRAW buffer
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- y - The line (0<=y<height) to access.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- GETLINE
-
- EXAMPLE
-
- BUGS
- Does not support Virtual Images yet.
- photogenics/RELEASETRANSLINE
-
- NAME
- RELEASETRANSLINE - releases a lock on the 8-bit data.
-
- SYNOPSIS
- RELEASETRANSLINE buffer y
-
- FUNCTION
- Call this when you have finished manipulating data
- accesssed by GETTRANSLINE.
-
- To refresh the Photogenics window after this,
- call REDRAW buffer
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- y - The line (0<=y<height) to access.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- GETTRANSLINE
-
- EXAMPLE
-
- BUGS
- photogenics/RENAME
-
- NAME
- RENAME
-
- SYNOPSIS
- RENAME buffer newname
-
- FUNCTION
- Renames a buffer, or virtual image with the new title.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO, NEW, NEWVIRT, LOADVIRT, etc.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/RESIZETILED
-
- NAME
- RESIZETILED - Resize an image, tiling the original.
-
- SYNOPSIS
- RESIZETILED buffer newx newy
-
- FUNCTION
- Resizes an image buffer to new size of newx newy,
- the original image is tiled to fit the new space.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- newx - new width for image.
-
- newy - new height for image.
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/ROTATE
-
- NAME
- ROTATE
-
- SYNOPSIS
- ROTATE buffer angle
-
- FUNCTION
- Rotate a Photogenics image buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- angle - Angle from 0 to 360 degrees.
-
- RETURNS
-
- NOTES
- Image is scaled to fit the minimum dimensions of the
- rotated image. No image data is lost off the sides, so if
- you need to keep the resultant image the same size either
- crop the new area off, or see the Perspective effect
- (use it to rotate in the z axis only)
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/SAVE
-
- NAME
- SAVE - Save an image file
-
- SYNOPSIS
- SAVE <buffer> <gioname> <filename> [<options>]
-
- FUNCTION
- Save the buffer from Photogenics using the gio specified.
-
- INPUTS
- <buffer> - the buffer ID returned by BUFFER, NEW, LOAD,
- LOADGIO, SCALE, etc.
-
- <gioname> - The name of the GIO (without the .gio
- extension) you wish to save with.
-
-
- <filename> - The name of the file to save. Pass an
- empty string for savers such as ShowHam8 which
- do not require a filename.
-
- <options> - Any options required by the GIO. These
- differ from saver to saver, please consult the GIO docs for further
- information.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
- LOAD, LOADGIO
-
- EXAMPLE
- /* Save the current image */
- options results
- address PHOTOGENICS.1
- BUFFER
- SAVE result "JPEG" "ram:test.jpg" 90 /* 90 is the
- quality
- field for JPEG saves */
- BUGS
- photogenics/SAVECLIP
-
- NAME
- SAVECLIP
-
- SYNOPSIS
- SAVECLIP buffer
-
- FUNCTION
- Saves a clip back to the virtual image it was clipped
- from.
-
- INPUTS
- buffer - pointer to a buffer clipped from a Virtual Image
- (created with the VBUFF function)
- RETURNS
-
- NOTES
- Only works if the image was clipped from a virtual image,
- of course! You don't need to tell it where it was clipped
- from, it's got a good memory :-)
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/SCALE
-
- NAME
- SCALE
-
- SYNOPSIS
- SCALE buffer newx newy <SMOOTH | NORMAL>
-
- FUNCTION
- Scales an image buffer to new size of newx newy.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- newx - new width for image.
-
- newy - new height for image.
-
- NORMAL - use simple (fast) scaling.
- SMOOTH - use smooth (interpolated) scaling.
-
- one of NORMAL or SMOOTH is required.
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* scale the current buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- SCALE result 150 150 SMOOTH
- BUGS
- photogenics/SECONDARY
-
- NAME
- SECONDARY - Return a pointer to the current secondary
- image.
-
- SYNOPSIS
- SECONDARY
-
- FUNCTION
- Return a pointer to the current secondary image, if one
- is selected within Photogenics.
-
- INPUTS
-
- RETURNS
- Buffer is a unique pointer to the secondary image buffer.
- This result is used as a lock on the image for all further
- operations.
-
- rc = 0 on success, 1 if there was no secondary image.
-
- NOTES
-
-
- SEE ALSO
- BUFFER ALPHA
-
- EXAMPLE
-
- BUGS
- photogenics/SELECTSIM
-
- NAME
- SELECTSIM
-
- SYNOPSIS
- SELECTSIM buffer tolerance smooth r g b
-
- FUNCTION
- Select all regions of the image matching the
- r g b values provided within the tolerance given,
- using the smoothness factor depending on their distance
- from the given RGB value.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- tolerance - How close a match you require (0 to 255)
- smoothness - how smooth you want it (1 to 100)
-
- r - red (0 to 255)
- g - green (0 to 255)
- b - blue (0 to 255)
-
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- Don't set smoothness to zero. Bad things might happen.
- photogenics/SETALPHA
-
- NAME
- SETALPHA - Select as Alpha Channel
-
- SYNOPSIS
- SETALPHA buffer
-
- FUNCTION
- Select the image as the alpha channel
-
- INPUTS
- buffer - pointer to image buffer.
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- BUGS
- photogenics/SETIMAGE
-
- NAME
- SETIMAGE - Select as Alpha Channel
-
- SYNOPSIS
- SETIMAGE buffer
-
- FUNCTION
- Select the image as a normal image (Cancels alpha and/or
- secondary setting)
-
- INPUTS
- buffer - pointer to image buffer.
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- BUGS
- photogenics/SETPROGRESS
-
- NAME
- SETPROGRESS - Set the state of the progress meter.
-
- SYNOPSIS
- SETPROGRESS text percent
-
- FUNCTION
- Sets the state of the progress meter.
-
- INPUTS
- text - new text for the progress meter (use "" to
- keep the current text)
-
- percent - new position for the progress meter (from 0 to
- 100)
-
- RETURNS
-
- NOTES
- Must be done after OPENPROGRESS, and before CLOSEPROGRESS!
- SEE ALSO
- OPENPROGRESS CLOSEPROGRESS
- BUGS
- photogenics/SETSECONDARY
-
- NAME
- SETSECONDARY - Select as Alpha Channel
-
- SYNOPSIS
- SETSECONDARY buffer
-
- FUNCTION
- Select the image as the secondary image.
-
- INPUTS
- buffer - pointer to image buffer.
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- BUGS
- photogenics/SHEAR
-
- NAME
- SHEAR
-
- SYNOPSIS
- SHEAR buffer xshift yshift
-
- FUNCTION
- Shear a Photogenics image buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- xshift - amount to shift in x dimension (+ve or -ve)
-
- yshift - amount to shift in y dimension (+ve or -ve)
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/SHOWERROR
-
- NAME
- SHOWERROR
-
- SYNOPSIS
- SHOWERROR string
-
- FUNCTION
- An error requester containing 'string' is displayed and script execution paused until
- the requester is closed.
-
- INPUTS
- string - ascii text
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* show an error requester */
- address PHOTOGENICS.1
- SHOWERROR "Not enough memory to continue"
- BUGS
-
- photogenics/SHOWMESSAGE
-
- NAME
- SHOWMESSAGE
-
- SYNOPSIS
- SHOWMESSAGE title string
-
- FUNCTION
- A message requester containing 'string' is displayed and script execution paused until
- the requester is closed.
-
- INPUTS
- title - the title for the message requester
- string - the ascii text for the message body text (may use
- /n character for line feed)
-
- RETURNS
- 0
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* show an error requester */
- address PHOTOGENICS.1
- SHOWMESSAGE "Ready" "Press OK to continue with script"
-
- BUGS
-
- photogenics/TRANSFIX - Fix the paintlayer to the current transparency
- levels.
-
- NAME
- TRANSFIX
-
- SYNOPSIS
- TRANSFIX buffer
-
- FUNCTION
- The transparency level is set back to 100%, but the
- paintlayer is altered so it matches the previous
- appearance with the old transparency level.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/TRANSGRAD
-
- NAME
- TRANSGRAD - Set the gradient type for transparency fills.
-
- SYNOPSIS
- TRANSGRAD mode
-
- FUNCTION
- The gradient type is selected for FILLSCREEN, RECTFILL,
- ELLIPSEFILL and other Photogenics operations.
-
- INPUTS
- mode -
- 0 - Normal
- 1 - Left to Right
- 2 - Right to Left
- 3 - Top to Bottom
- 4 - Bottom to Top
- 5 - Rectangle
- 6 - Reverse Rectangle
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/TRANSPARENCY
-
- NAME
- TRANSPARENCY
-
- SYNOPSIS
- TRANSPARENCY buffer value
-
- FUNCTION
- Set the value for the paintlayer transparency.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- value - the transparency value from 0 (transparent) to
- 100 (opaque)
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/UNDO
-
- NAME
- UNDO
-
- SYNOPSIS
- UNDO buffer
-
- FUNCTION
- Undo fixed changes to a buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
-
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* undo changes to the currently selected buffer */
- options results
- address PHOTOGENICS.1
- BUFFER
- UNDO result
- BUGS
- photogenics/VCLIP
-
- NAME
- VCLIP
-
- SYNOPSIS
- VCLIP vimage x y x1 y1
-
- FUNCTION
- Clips out an area of a Virtual Image into a new
- (non-virtual) buffer. This buffer is returned and can be
- acted on.
-
- INPUTS
- vimage - pointer to a virtual buffer
-
- x - x position where 0<=x<WIDTH
- y - y position where 0<=y<HEIGHT
- x1 - x1 position where 0<=x1<WIDTH
- y1 - y1 position where 0<=y1<HEIGHT
-
- RETURNS
- buffer - a pointer to the buffer (non-virtual) containing
- the clipped region.
- NOTES
-
- SEE ALSO
-
- EXAMPLE
-
- BUGS
- photogenics/WARPER
-
- NAME
- WARPER - Distort an image with the Photogenics warper tool.
-
- SYNOPSIS
- WARPER <buffer> <x> <y> <w> <h> <cx> <cy> <factor> <twirl>
-
- FUNCTION
- Photogenics will warp the area of the image with the
- specified parameters.
-
- INPUTS
- <buffer> - a pointer previously returned by NEW, BUFFER,
- LOAD, LOADGIO, etc.
-
- <x> - The X coordinate of the center of the oval to
- warp.
-
- <y> - The Y coordinate of the center of the oval to
- warp.
-
- <w> - The width of the oval being warped.
-
- <h> - The height of the oval being warped.
-
- <cx> - The new center point x for the oval being warped.
-
- <cy> - The new center point y for the oval being warped.
-
- <factor> - The warp factor: 0 is normal, +ve bulges the
- image, -ve pinches the image.
-
- <twirl> - The amount of twirl to apply, in degress.
-
- RETURNS
- Eventually... :-)
- NOTES
-
- SEE ALSO
-
- EXAMPLE
- /* Warp an image */
- options results
- address PHOTOGENICS.1
- BUFFER
- WARPER result 100 50 30 30 120 70 0 60
-
- BUGS
-
- photogenics/WIDTH
-
- NAME
- WIDTH
-
- SYNOPSIS
- WIDTH buffer
-
- FUNCTION
- Used to determine the width of a Photogenics image buffer.
-
- INPUTS
- buffer - pointer to a buffer returned by BUFFER, LOAD,
- LOADGIO or NEW
-
- RETURNS
- width in pixels.
-
- NOTES
-
- SEE ALSO
- HEIGHT
-
- EXAMPLE
- /* display the width of the currently selected buffer
- options results
- address PHOTOGENICS.1
- BUFFER
- WIDTH result
- say "Image is " || result || " pixels wide"
- BUGS
-