home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 1 / Amiga Tools.iso / egs-tools / egs_dev-disk / egsdocs / egsgfx.doc < prev    next >
Encoding:
Text File  |  1994-06-06  |  28.7 KB  |  1,234 lines
  1. TABLE OF CONTENTS
  2.  
  3. egsgfx.library/EG_AreaCircle
  4. egsgfx.library/EG_AreaCurve
  5. egsgfx.library/EG_AreaCurveL
  6. egsgfx.library/EG_AreaDraw
  7. egsgfx.library/EG_AreaEnd
  8. egsgfx.library/EG_AreaMove
  9. egsgfx.library/EG_CheckRectangle
  10. egsgfx.library/EG_CloseFont
  11. egsgfx.library/EG_CopyBitMapRastPort
  12. egsgfx.library/EG_CopyRectangle
  13. egsgfx.library/EG_CreateRastPort
  14. egsgfx.library/EG_CreateSubRastPort
  15. egsgfx.library/EG_Curve
  16. egsgfx.library/EG_CurveL
  17. egsgfx.library/EG_DeleteRastPort
  18. egsgfx.library/EG_Draw
  19. egsgfx.library/EG_Ellipse
  20. egsgfx.library/EG_FillMask
  21. egsgfx.library/EG_FillMaskSeg
  22. egsgfx.library/EG_Flood
  23. egsgfx.library/EG_GetBoundingBox
  24. egsgfx.library/EG_InitArea
  25. egsgfx.library/EG_InstallClipRegion
  26. egsgfx.library/EG_Move
  27. egsgfx.library/EG_MoveSubRastPort
  28. egsgfx.library/EG_OpenFont
  29. egsgfx.library/EG_ReadPixel
  30. egsgfx.library/EG_RectFill
  31. egsgfx.library/EG_RemoveClipRegion
  32. egsgfx.library/EG_ScrollRaster
  33. egsgfx.library/EG_ScrollRasterNoClear
  34. egsgfx.library/EG_SetAPen
  35. egsgfx.library/EG_SetBPen
  36. egsgfx.library/EG_SetDrMd
  37. egsgfx.library/EG_SetFont
  38. egsgfx.library/EG_SetMask
  39. egsgfx.library/EG_SetSoftStyle
  40. egsgfx.library/EG_SizeSubRastPort
  41. egsgfx.library/EG_StdFont
  42. egsgfx.library/EG_Text
  43. egsgfx.library/EG_TextLength
  44. egsgfx.library/EG_WritePixel
  45. egsgfx.library/EG_ZoomBitMapRastPort
  46. egsgfx.library/EG_ZoomFillMaskSeg
  47.  
  48. egsgfx.library/EG_AreaCircle                     egsgfx.library/EG_AreaCircle
  49.  
  50.    NAME
  51.     EG_AreaCircle -- draw a filled circle
  52.  
  53.    SYNOPSIS
  54.     EG_AreaCircle(rast, x, y, r)
  55.                   A0    D0 D1 D2
  56.  
  57.     void EG_AreaCircle(EG_RastPortPtr, WORD, WORD, WORD)
  58.  
  59.    FUNCTION
  60.     Draws a filled circle in the aPen color. This function requiers a
  61.     tmpRas bitmap. If there is none, it allocates one and frees it
  62.     afterwards. This allocation requires time, which can be saved by
  63.     allocating an own tmpRas bitmap for the RastPort.
  64.  
  65.    INPUTS
  66.     rast         - RastPort in which to draw
  67.     x, y         - centre of the circle
  68.     r            - radius
  69.  
  70.    RESULT
  71.  
  72.    SEE ALSO
  73.     EG_AreaCurve(), EG_AreaEllipse(), EG_AreaMove(), EG_AreaEnd()
  74.  
  75.  
  76. egsgfx.library/EG_AreaCurve                       egsgfx.library/EG_AreaCurve
  77.  
  78.    NAME
  79.     EG_AreaCurve -- draw a filled bezier curve
  80.  
  81.    SYNOPSIS
  82.     EG_AreaCurve(rast, x2, y2, x3, y3, x4, y4)
  83.                  A0    D0  D1  D2  D3  D4  D5
  84.  
  85.     void EG_AreaCurve(EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  86.  
  87.    FUNCTION
  88.     Adds a bezier curve to a filled object (see also AreaMove, AreaDraw
  89.     and AreaEnd). The curve is halved until the pieces are smaller then
  90.     the limit given in the RastPort. Then the pieces are drawn using
  91.     AreaDraw. This function requiers a large areaInfo structure. The
  92.     current area cursor in the RastPort is the starting location, the
  93.     point x4/y4 is the end location.
  94.  
  95.    INPUTS
  96.     rast         - destination RastPort
  97.     x2, y2       - direction at curve start
  98.     x3, y3       - direction at curve end
  99.     x4, y4       - endpoint
  100.  
  101.    RESULT
  102.  
  103.    SEE ALSO
  104.  
  105.  
  106. egsgfx.library/EG_AreaCurveL                     egsgfx.library/EG_AreaCurveL
  107.  
  108.    NAME
  109.     EG_AreaCurveL -- draw a filled bezier curve
  110.  
  111.    SYNOPSIS
  112.     EG_AreaCurveL(rast, x2, y2, x3, y3, x4, y4)
  113.                   A0    D0  D1  D2  D3  D4  D5
  114.  
  115.     void EG_AreaCurveL(EG_RastPortPtr, LONG, LONG, LONG, LONG, WORD, WORD)
  116.  
  117.    FUNCTION
  118.     Adds a bezier curve to a filled object (see also AreaMove, AreaDraw
  119.     and AreaEnd). The curve is halved until the pieces are smaller then
  120.     the limit given in the RastPort. Then the pieces are drawn using
  121.     AreaDraw. This function requiers a large areaInfo structure. The
  122.     current area cursor in the RastPort is the starting location, the
  123.     point x4/y4 is the end location. The values of x2 to y3 are 32 bit
  124.     fractionals with the fractional part starting at bit 16. This
  125.     function is usefull to draw small curves very accurate.
  126.  
  127.    INPUTS
  128.     rast         - destination RastPort
  129.     x2, y2       - direction at curve start (multiplied by 65536)
  130.     x3, y3       - direction at curve end (multiplied by 65536)
  131.     x4, y4       - endpoint
  132.  
  133.    RESULT
  134.  
  135.    EXAMPLE
  136.     This function can be used to draw a filled ellipse.
  137.  
  138.     x, y   : median
  139.     a, b   : halfaxis
  140.  
  141.     AreaMove(rast, x, y-b);
  142.     AreaCurveL(rast, 36194*a, 0, 0, -36194*b, x+a, y);
  143.     AreaCurveL(rast, 0, 36194*b, 36194*a, 0, x, y+b);
  144.     AreaCurveL(rast, -36194*a, 0, 0, 36194*b, x-a, y);
  145.     AreaCurveL(rast, 0, -36194*b, -36194*a, 0, x, y-b);
  146.     AreaEnd(rast);
  147.  
  148.    SEE ALSO
  149.  
  150.  
  151. egsgfx.library/EG_AreaDraw                         egsgfx.library/EG_AreaDraw
  152.  
  153.    NAME
  154.     EG_AreaDraw -- draw a edge of a filled polygon
  155.  
  156.    SYNOPSIS
  157.     EG_AreaDraw(rast, x, y)
  158.                 A0    D0 D1
  159.  
  160.     void EG_AreaDraw(EG_RastPortPtr, WORD, WORD)
  161.  
  162.    FUNCTION
  163.     Adds an edge to a filled polygon (see also AreaMove, AreaCurve and
  164.     AreaEnd). The polygon is drawn using AreaEnd. This function requires
  165.     a areaInfo structure attached to the RastPort.
  166.  
  167.    INPUTS
  168.     rast         - destination RastPort
  169.     x, y         - end of line, startpoint is current areacursor location.
  170.  
  171.    RESULT
  172.  
  173.    SEE ALSO
  174.  
  175.  
  176. egsgfx.library/EG_AreaEnd                           egsgfx.library/EG_AreaEnd
  177.  
  178.    NAME
  179.     EG_AreaEnd -- end area polygon definition and draw
  180.  
  181.    SYNOPSIS
  182.     EG_AreaEnd(rast)
  183.                A0
  184.  
  185.     void EG_AreaEnd(EG_RastPortPtr)
  186.  
  187.    FUNCTION
  188.     Ends an open area polygon and draws it, using the aPen color. This
  189.     function needs a tmpRas bitmap. If there is none the function creates
  190.     one and frees it afterwards.
  191.  
  192.    INPUTS
  193.     rast         - destination RastPort
  194.  
  195.    RESULT
  196.  
  197.    SEE ALSO
  198.  
  199.  
  200. egsgfx.library/EG_AreaMove                         egsgfx.library/EG_AreaMove
  201.  
  202.    NAME
  203.     EG_AreaMove -- begin new area polygon
  204.  
  205.    SYNOPSIS
  206.     EG_AreaMove(rast, x, y)
  207.                 A0    D0 D1
  208.  
  209.     void EG_AreaMove(EG_RastPortPtr, WORD, WORD)
  210.  
  211.    FUNCTION
  212.     Moves the area cursor to a new starting location. Closes an open
  213.     polygon. You can draw several polygons with one AreaEnd. If the
  214.     polygons intersect each other the intersection will be excluded
  215.     (exclusiv or). This can be used to draw free areas in polygons.
  216.  
  217.    INPUTS
  218.     rast         - destination RastPort
  219.     x, y         - absolut coordinates to move to
  220.  
  221.    RESULT
  222.  
  223.    SEE ALSO
  224.  
  225.  
  226. egsgfx.library/EG_CheckRectangle             egsgfx.library/EG_CheckRectangle
  227.  
  228.    NAME
  229.     EG_CheckRectangle -- checks if rectangle in inside current clipping area
  230.  
  231.    SYNOPSIS
  232.     EG_CheckRectangle(rast, cliprect)
  233.                       A0    A1
  234.  
  235.     BOOL EG_CheckRectangle(EG_RastPortPtr, EB_ClipRectPtr)
  236.  
  237.    FUNCTION
  238.     Checks the rect against the current clipping region and finds out if
  239.     the area specified in rect is completely clipped out or not. This is
  240.     useful during refresh of windows where some areas could take a long
  241.     time to refresh. If this function, however, returns FALSE, there is
  242.     no need to refresh the rectangle in question. This function is quite
  243.     fast, and compared to e.g. loading a bitmap from disk or rendering
  244.     text or graphic elements, the time is well spent.
  245.  
  246.    INPUTS
  247.     rast         - RastPort in question
  248.     cliprect     - rectangle to check
  249.  
  250.    RESULT
  251.     TRUE    - if at least one pixel in the specified rectangle is
  252.           writable, and updating the area will have an effect.
  253.     FALSE   - if the entire area specified in rect is clipped out, and
  254.           rendering into the area will have no effect at all.
  255.  
  256.    SEE ALSO
  257.  
  258.  
  259. egsgfx.library/EG_CloseFont                       egsgfx.library/EG_CloseFont
  260.  
  261.    NAME
  262.     EG_CloseFont -- close a font
  263.  
  264.    SYNOPSIS
  265.     EG_CloseFont(font)
  266.                  A0
  267.  
  268.     void EG_CloseFont(EG_EFontPtr)
  269.  
  270.    FUNCTION
  271.     Close a font which was opened using EG_OpenFont().
  272.  
  273.    INPUTS
  274.     font         - the font to close, must have been opened using
  275.                EG_OpenFond()
  276.  
  277.    RESULT
  278.  
  279.    SEE ALSO
  280.  
  281.  
  282. egsgfx.library/EG_CopyBitMapRastPort     egsgfx.library/EG_CopyBitMapRastPort
  283.  
  284.    NAME
  285.     EG_CopyBitMapRastPort -- copy rectangle of a bitmap into a RastPort
  286.  
  287.    SYNOPSIS
  288.     EG_CopyBitMapRastPort(src, rast, xs, ys, w, h, xd, yd)
  289.                           A0   A1    D0  D1  D2 D3 D4  D5
  290.  
  291.     void EG_CopyBitMapRastPort(E_EBitMapPtr, EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  292.  
  293.    FUNCTION
  294.     Copies a rectangluar area from a bitmap into a RastPort. Clipping is
  295.     done for the destination RastPort as specified.
  296.  
  297.    INPUTS
  298.     src          - source bitmap
  299.     rast         - destination RastPort
  300.     xs, ys       - starting location in the bitmap
  301.     w, h         - dimensions of the rectangle
  302.     xd, yd       - destination location in the RastPort
  303.  
  304.    RESULT
  305.  
  306.    SEE ALSO
  307.  
  308.  
  309. egsgfx.library/EG_CopyRectangle               egsgfx.library/EG_CopyRectangle
  310.  
  311.    NAME
  312.     EG_CopyRectangle -- copy rectangle of a RastPort into a RastPort
  313.  
  314.    SYNOPSIS
  315.     EG_CopyRectangle(src, dst, xs, ys, w, h, dx, dy)
  316.                      A0   A1   D0  D1  D2 D3 D4  D5
  317.  
  318.     void EG_CopyRectangle(EG_RastPortPtr, EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  319.  
  320.    FUNCTION
  321.     Copies a rectangluar area from a RastPort into a RastPort. Clipping
  322.     is done for the destination RastPort as specified. The source should
  323.     not exceed the limits of its RastPort. The two RastPorts may be
  324.     identical
  325.  
  326.    INPUTS
  327.     src          - source RastPort
  328.     rast         - destination RastPort
  329.     xs, ys       - starting location in the source RastPort
  330.     w, h         - dimensions of the rectangle
  331.     xd, yd       - destination location in the destination RastPort
  332.  
  333.    RESULT
  334.  
  335.    SEE ALSO
  336.  
  337.  
  338. egsgfx.library/EG_CreateRastPort             egsgfx.library/EG_CreateRastPort
  339.  
  340.    NAME
  341.     EG_CreateRastPort -- create a RastPort
  342.  
  343.    SYNOPSIS
  344.     EG_CreateRastPort(layer, screen, map)
  345.                       A0     A1      A2
  346.  
  347.     EG_RastPortPtr EG_CreateRastPort(EL_LayerPtr, E_EScreenPtr, E_EBitMapPtr)
  348.  
  349.    FUNCTION
  350.     Creates a RastPort for a layer, a screen or a bitmap. If a screen is
  351.     specified, it is used for MouseOn/MouseOff. If neither a layer nor a
  352.     map is specified, the destination bitmap will be that of the screen.
  353.     A layer and a bitmap exclude each other.
  354.  
  355.     You are allowed to use several RastPorts for one object in order to
  356.     work more independent.  If layers are used then even several tasks
  357.     may use the same RastPort simultaneously.
  358.  
  359.    INPUTS
  360.     layer        - layer on which to create or NULL, for a non layer
  361.                RastPort
  362.     screen       - screen, on which the RastPort resides or NULL, if the
  363.                RastPort is not on a screen
  364.     map          - bitmap on which the RastPort exists or NULL
  365.  
  366.    RESULT
  367.  
  368.    SEE ALSO
  369.  
  370.  
  371. egsgfx.library/EG_CreateSubRastPort       egsgfx.library/EG_CreateSubRastPort
  372.  
  373.    NAME
  374.     EG_CreateSubRastPort -- create secondary rast port
  375.  
  376.    SYNOPSIS
  377.     EG_CreateSubRastPort(super, x, y, w, h)
  378.                          A0     D0 D1 D2 D3
  379.  
  380.     EG_RastPortPtr EG_CreateSubRastPort(EG_RastPortPtr, WORD, WORD, WORD, WORD)
  381.  
  382.    FUNCTION
  383.     Creates a secondary RastPort inside an other RastPort. If the sub
  384.     rastport is larger than the source RastPort, it can be scrolled. Subrastports
  385.     are organized as a tree, so a subrastport may have any number of own
  386.     subrastports and so on. All rendering in the subrastport is done
  387.     with out interfering with it's super RastPort.
  388.  
  389.    INPUTS
  390.     super        - the parent RastPort
  391.     x            - left edge of the sub RastPort
  392.     y            - top edge of the sub RastPort
  393.     w            - witdh of the sub RastPort
  394.     h            - height of the sub RastPort
  395.  
  396.    RESULT
  397.     A subrastport to the super RastPort
  398.  
  399.    SEE ALSO
  400.  
  401.  
  402. egsgfx.library/EG_Curve                               egsgfx.library/EG_Curve
  403.  
  404.    NAME
  405.     EG_Curve -- draw a bezier curve
  406.  
  407.    SYNOPSIS
  408.     EG_Curve(rast, x2, y2, x3, y3, x4, y4)
  409.              A0    D0  D1  D2  D3  D4  D5
  410.  
  411.     void EG_Curve(EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  412.  
  413.    FUNCTION
  414.     Draws a bezier curve. The curve is halfed until the pieces are
  415.     smaller as in the RastPort defined. Then the curve is drawn using
  416.     draw. The current cursor in the RastPort is the starting location,
  417.     the point x4/y4 is the end location. The point x2/y2 is a relative
  418.     vector to the starting point, x3/y3 is a relative vector to the
  419.     ending point. This to vectors specify the curves dirction.
  420.  
  421.    INPUTS
  422.     rast         - destination RastPort
  423.     x2, y2       - direction at curve start
  424.     x3, y3       - direction at curve end
  425.     x4, y4       - endpoint
  426.  
  427.    RESULT
  428.  
  429.    SEE ALSO
  430.  
  431.  
  432. egsgfx.library/EG_CurveL                             egsgfx.library/EG_CurveL
  433.  
  434.    NAME
  435.     EG_CurveL -- draw a bezier curve
  436.  
  437.    SYNOPSIS
  438.     EG_CurveL(rast, x2, y2, x3, y3, x4, y4)
  439.               A0    D0  D1  D2  D3  D4  D5
  440.  
  441.     void EG_CurveL(EG_RastPortPtr, LONG, LONG, LONG, LONG, WORD, WORD)
  442.  
  443.    FUNCTION
  444.     Draws a bezier curve. The curve is halfed until the pieces are
  445.     smaller as in the RastPort defined. Then the curve is drawn using
  446.     draw. The current cursor in the RastPort is the starting location,
  447.     the point x4/y4 is the end location. The point x2/y2 is a relative
  448.     vector to the starting point, x3/y3 is a relative vector to the
  449.     ending point. This to vectors specify the curves dirction. The values
  450.     of x2 to y3 must be given as a 32 bit fractional number with the
  451.     fractional part starting at bit 16. This is usefull to draw small
  452.     curves very accurate.
  453.  
  454.    INPUTS
  455.     rast         - destination RastPort
  456.     x2, y2       - direction at curve start (multipiled by 65536)
  457.     x3, y3       - direction at curve end (multipiled by 65536)
  458.     x4, y4       - endpoint
  459.  
  460.    RESULT
  461.  
  462.    SEE ALSO
  463.  
  464.  
  465. egsgfx.library/EG_DeleteRastPort             egsgfx.library/EG_DeleteRastPort
  466.  
  467.    NAME
  468.     EG_DeleteRastPort -- deletes a RastPort
  469.  
  470.    SYNOPSIS
  471.     EG_DeleteRastPort(rast)
  472.                       A0
  473.  
  474.     void EG_DeleteRastPort(EG_RastPortPtr)
  475.  
  476.    FUNCTION
  477.     Deletes a RastPort which was created by EG_CreateRastPort() or
  478.     EG_CreateSubRastPort().
  479.  
  480.    INPUTS
  481.     rast         - the RastPort to delete
  482.  
  483.    RESULT
  484.  
  485.    SEE ALSO
  486.  
  487.  
  488. egsgfx.library/EG_Draw                                 egsgfx.library/EG_Draw
  489.  
  490.    NAME
  491.     EG_Draw -- draws a line
  492.  
  493.    SYNOPSIS
  494.     EG_Draw(rast, x, y)
  495.             A0    D0 D1
  496.  
  497.     void EG_Draw(EG_RastPortPtr, WORD, WORD)
  498.  
  499.    FUNCTION
  500.     Draws a line from the current cursor location to x, y. The cursor
  501.     location becomes x, y. The line is clipped according to the RastPort.
  502.  
  503.    INPUTS
  504.     rast         - destination RastPort
  505.     x, y         - coordinates of last point
  506.  
  507.    RESULT
  508.  
  509.    SEE ALSO
  510.  
  511.  
  512. egsgfx.library/EG_Ellipse                           egsgfx.library/EG_Ellipse
  513.  
  514.    NAME
  515.     EG_Ellipse -- draws an ellipse
  516.  
  517.    SYNOPSIS
  518.     EG_Ellipse(rast, x, y, a, b)
  519.                A0    D0 D1 D2 D3
  520.  
  521.     void EG_Ellipse(EG_RastPortPtr, WORD, WORD, WORD, WORD)
  522.  
  523.    FUNCTION
  524.     Draws an ellipse, around x, y the horizontal halfaxis is a, the
  525.     vertical is b. This function uses EG_CurveL(), so the resolution of the
  526.     ellipse depends on the curvStep field of the RastPort.
  527.  
  528.    INPUTS
  529.     rast         - destination RastPort
  530.     x, y         - centerpoint
  531.     a            - horizontal halfaxis
  532.     b            - vertical halfaxis
  533.  
  534.    RESULT
  535.  
  536.    SEE ALSO
  537.  
  538.  
  539. egsgfx.library/EG_FillMask                         egsgfx.library/EG_FillMask
  540.  
  541.    NAME
  542.     EG_FillMask -- copies a one bit deep bitmap to a RastPort
  543.  
  544.    SYNOPSIS
  545.     EG_FillMask(rast, src, xd, yd)
  546.                 A0    A1   D0  D1
  547.  
  548.     void EG_FillMask(EG_RastPortPtr, E_EBitMapPtr, WORD, WORD)
  549.  
  550.    FUNCTION
  551.     Copies a one bitplane deep bitmap into a RastPort, using aPen and
  552.     bPen, or aPen and transparency.
  553.  
  554.    INPUTS
  555.     rast         - destination RastPort
  556.     src          - source bitmap
  557.     xd, yd       - destination location
  558.  
  559.    RESULT
  560.  
  561.    SEE ALSO
  562.  
  563.  
  564. egsgfx.library/EG_FillMaskSeg                   egsgfx.library/EG_FillMaskSeg
  565.  
  566.    NAME
  567.     EG_FillMaskSeg -- copies a rectangle of an one bit deep bitmap to a RastPort
  568.  
  569.    SYNOPSIS
  570.     EG_FillMaskSeg(rast, src, xs, ys, w, h, xd, yd)
  571.                    A0    A1   D0  D1  D2 D3 D4  D5
  572.  
  573.     void EG_FillMaskSeg(EG_RastPortPtr, E_EBitMapPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  574.  
  575.    FUNCTION
  576.     Copies a rectangle out of an one bitplane deep bitmap into a
  577.     rastport, using aPen and bPen, or aPen and transparency.
  578.  
  579.    INPUTS
  580.     rast         - destination RastPort
  581.     src          - source bitmap
  582.     xs, ys       - starting locations in source bitmap
  583.     w, h         - size of rectangular area
  584.     xd, yd       - destination location
  585.  
  586.    RESULT
  587.  
  588.    SEE ALSO
  589.  
  590.  
  591. egsgfx.library/EG_Flood                               egsgfx.library/EG_Flood
  592.  
  593.    NAME
  594.     EG_Flood -- Flood RastPort like areafill.
  595.  
  596.    SYNOPSIS
  597.     EG_Flood(rast, x, y, mode)
  598.              A0    D0 D1 D2
  599.  
  600.     void EG_Flood(EG_RastPortPtr, WORD, WORD, ULONG)
  601.  
  602.    FUNCTION
  603.     Fill all adjacent pixels to (x,y) if they are: Mode 0: Different
  604.     color than APen Mode 1: The same color as the pixel at (x,y)
  605.  
  606.    INPUTS
  607.     rp           - destination rast port
  608.     x, y         - coordinate in RastPort to start the flood fill at.
  609.     mode         - 0 fill all adjacent pixels searching for border
  610.              of color APen.
  611.                1 fill all adjacent pixels that have same pen number
  612.              as the one at x, y.
  613.  
  614.    NOTE
  615.     Having a temporary rast in the RastPort, will speed up the flood fill.
  616.  
  617.    RESULT
  618.  
  619.    SEE ALSO
  620.  
  621.  
  622. egsgfx.library/EG_GetBoundingBox             egsgfx.library/EG_GetBoundingBox
  623.  
  624.    NAME
  625.     EG_GetBoundingBox -- get a active area bounding box
  626.  
  627.    SYNOPSIS
  628.     EG_GetBoundingBox(rast, rect)
  629.                       A0    A1
  630.  
  631.     BOOL EG_GetBoundingBox(EG_RastPortPtr, EB_ClipRectPtr)
  632.  
  633.    FUNCTION
  634.     Calculates a bounding box of the active drawing area. This is
  635.     usefull for refreshes, in order to check which regions of the
  636.     rastport have to be refreshed.
  637.  
  638.    INPUTS
  639.     rast         - the RastPort to check in
  640.     rect         - pointer to a cliprect, that is filled with the
  641.                coordinates of the bounding box
  642.  
  643.    RESULT
  644.     TRUE, if the drawing area is not empty
  645.  
  646.    SEE ALSO
  647.  
  648.  
  649. egsgfx.library/EG_InitArea                         egsgfx.library/EG_InitArea
  650.  
  651.    NAME
  652.     EG_InitArea -- init area info structure
  653.  
  654.    SYNOPSIS
  655.     EG_InitArea(info, buffer, size)
  656.                 A0    A1      D0
  657.  
  658.     EG_AreaInfoPtr EG_InitArea(EG_AreaInfoPtr, EG_PolyPtr, WORD)
  659.  
  660.    FUNCTION
  661.     Initializes an areainfo structure.
  662.  
  663.    INPUTS
  664.     info         - unintialized areainfo structure
  665.     buffer       - pointer to a memory area for areapolygon vertices
  666.     size         - number of vertices that can be stored in this buffer
  667.  
  668.    RESULT
  669.     initialized area info structure, that can be assigned to a RastPort
  670.  
  671.    SEE ALSO
  672.  
  673.  
  674. egsgfx.library/EG_InstallClipRegion       egsgfx.library/EG_InstallClipRegion
  675.  
  676.    NAME
  677.     EG_InstallClipRegion -- installs a clip region
  678.  
  679.    SYNOPSIS
  680.     EG_InstallClipRegion(rast, rect)
  681.                          A0    A1
  682.  
  683.     void EG_InstallClipRegion(EG_RastPortPtr, EB_ClipRectPtr)
  684.  
  685.    FUNCTION
  686.     ClipRegions describe which regions of a RastPort may be written
  687.     into.
  688.  
  689.     If a RastPort has no ClipRegion (only possible for unlayered
  690.     RastPorts) there might be some drawing outside the BitMap.  On the
  691.     other hand, drawing without clipping is slightly faster.
  692.  
  693.     If the RastPort uses a layer an additional ClipRegion restricts the
  694.     ordinary rectangular drawing region.
  695.  
  696.     A RastPort's ClipRegion consists of a list of ClipRects.  This list
  697.     is not changed by the EGSGfx library, i.e. a constant list is
  698.     allowed.
  699.  
  700.     Before deleting a RastPort its ClipRegion should be removed.
  701.  
  702.     The ClipRegion must not be changed while it is connected to the
  703.     RastPort.
  704.  
  705.     The old ClipRegion gets lost, so it should be removed using
  706.     EB_RemoveClipRegin before, or cached in a variable.
  707.  
  708.    INPUTS
  709.     rast         - destination rast port
  710.     rect         - list of cliprects defining the region
  711.  
  712.    RESULT
  713.  
  714.    SEE ALSO
  715.  
  716.  
  717. egsgfx.library/EG_Move                                 egsgfx.library/EG_Move
  718.  
  719.    NAME
  720.     EG_Move -- move graphics cursor
  721.  
  722.    SYNOPSIS
  723.     EG_Move(rast, x, y)
  724.             A0    D0 D1
  725.  
  726.     void EG_Move(EG_RastPortPtr, WORD, WORD)
  727.  
  728.    FUNCTION
  729.     Moves the graphic cursor to x, y.
  730.  
  731.    INPUTS
  732.     rast         - destination RastPort
  733.     x, y         - new cursor location
  734.  
  735.    RESULT
  736.  
  737.    SEE ALSO
  738.  
  739.  
  740. egsgfx.library/EG_MoveSubRastPort           egsgfx.library/EG_MoveSubRastPort
  741.  
  742.    NAME
  743.     EG_MoveSubRastPort -- move a sub RastPort
  744.  
  745.    SYNOPSIS
  746.     EG_MoveSubRastPort(rast, dx, dy)
  747.                        A0    D0  D1
  748.  
  749.     void EG_MoveSubRastPort(EG_RastPortPtr, WORD, WORD)
  750.  
  751.    FUNCTION
  752.     Moves a subrastport in its parents RastPort. This can be used to
  753.     actually move the RastPort, if it is totaly visible, or to scroll
  754.     it inside it's super RastPort if the subrastport is larger.
  755.  
  756.    INPUTS
  757.     rast         - the rasport to move
  758.     dx, dy       - relative coordinates to move
  759.  
  760.    RESULT
  761.  
  762.    SEE ALSO
  763.  
  764.  
  765. egsgfx.library/EG_OpenFont                         egsgfx.library/EG_OpenFont
  766.  
  767.    NAME
  768.     EG_OpenFont -- opens a font
  769.  
  770.    SYNOPSIS
  771.     EG_OpenFont(attr)
  772.                 A0
  773.  
  774.     EG_EFontPtr EG_OpenFont(struct TextAttr *)
  775.  
  776.    FUNCTION
  777.     Opens a diskfont, and does some additional work, to optimize text
  778.     rendering.
  779.  
  780.    INPUTS
  781.     attr         - TextAttr structure known from graphics
  782.  
  783.    RESULT
  784.     an open font (EG_EFont) or NULL if not successfull
  785.  
  786.    SEE ALSO
  787.  
  788.  
  789. egsgfx.library/EG_ReadPixel                       egsgfx.library/EG_ReadPixel
  790.  
  791.    NAME
  792.     EG_ReadPixel -- reads a pixel
  793.  
  794.    SYNOPSIS
  795.     EG_ReadPixel(rast, x, y)
  796.                  A0    D0 D1
  797.  
  798.     ULONG EG_ReadPixel(EG_RastPortPtr, WORD, WORD)
  799.  
  800.    FUNCTION
  801.     Returns a pixels color.
  802.  
  803.    INPUTS
  804.     rast         - source rast port
  805.     x, y         - location to look at
  806.  
  807.    RESULT
  808.     color or -1 if the color can not be find
  809.  
  810.    SEE ALSO
  811.  
  812.  
  813. egsgfx.library/EG_RectFill                         egsgfx.library/EG_RectFill
  814.  
  815.    NAME
  816.     EG_RectFill -- fill rectangular area
  817.  
  818.    SYNOPSIS
  819.     EG_RectFill(rast, x, y, w, h)
  820.                 A0    D0 D1 D2 D3
  821.  
  822.     void EG_RectFill(EG_RastPortPtr, WORD, WORD, WORD, WORD)
  823.  
  824.    FUNCTION
  825.     Fills a rectangular area according to the actual drawmode and aPen.
  826.  
  827.    INPUTS
  828.     rast         - destination rast port
  829.     x, y         - top left coordinate
  830.     w, h         - with and height of the rectangle
  831.  
  832.    RESULT
  833.  
  834.    SEE ALSO
  835.  
  836.  
  837. egsgfx.library/EG_RemoveClipRegion         egsgfx.library/EG_RemoveClipRegion
  838.  
  839.    NAME
  840.     EG_RemoveClipRegion -- remove clipregion
  841.  
  842.    SYNOPSIS
  843.     EG_RemoveClipRegion(rast)
  844.                         A0
  845.  
  846.     EB_ClipRectPtr EG_RemoveClipRegion(EG_RastPortPtr)
  847.  
  848.    FUNCTION
  849.     Removes the current clip region from a RastPort, and returns it. All
  850.     later graphics operations are only clipped using layer information.
  851.  
  852.    INPUTS
  853.     rast         - the RastPort to remove the clipregion
  854.  
  855.    RESULT
  856.     the old clipregion
  857.  
  858.    SEE ALSO
  859.  
  860.  
  861. egsgfx.library/EG_ScrollRaster                 egsgfx.library/EG_ScrollRaster
  862.  
  863.    NAME
  864.     EG_ScrollRaster -- scroll rectangular area in a RastPort
  865.  
  866.    SYNOPSIS
  867.     EG_ScrollRaster(rast, xs, ys, w, h, dx, dy)
  868.                     A0    D0  D1  D2 D3 D4  D5
  869.  
  870.     void EG_ScrollRaster(EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  871.  
  872.    FUNCTION
  873.     Scrolls a rectangular area in a RastPort. Modifies the damage list of
  874.     a layer if necessary and sends a refresh message.
  875.  
  876.    INPUTS
  877.     rast         - destination RastPort
  878.     xs, ys       - upper left edge
  879.     w, h         - size of rectangular area
  880.     dx, dy       - destination and amount in which to scroll
  881.  
  882.    RESULT
  883.  
  884.    SEE ALSO
  885.  
  886.  
  887. egsgfx.library/EG_ScrollRasterNoClear   egsgfx.library/EG_ScrollRasterNoClear
  888.  
  889.    NAME
  890.     EG_ScrollRasterNoClear -- scroll rectangle but do not clear
  891.  
  892.    SYNOPSIS
  893.     EG_ScrollRasterNoClear(rast, xs, ys, w, h, dx, dy)
  894.                            A0    D0  D1  D2 D3 D4  D5
  895.  
  896.     void EG_ScrollRasterNoClear(EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD)
  897.  
  898.    FUNCTION
  899.     Like EG_ScrollRaster(), but does not clear the newly exposed regions.
  900.  
  901.    INPUTS
  902.     rast         - destination RastPort
  903.     xs, ys       - upper left edge
  904.     w, h         - size of rectangular area
  905.     dx, dy       - destination and amount in which to scroll
  906.  
  907.    RESULT
  908.  
  909.    SEE ALSO
  910.  
  911.  
  912. egsgfx.library/EG_SetAPen                           egsgfx.library/EG_SetAPen
  913.  
  914.    NAME
  915.     EG_SetAPen -- modifies froeground pen
  916.  
  917.    SYNOPSIS
  918.     EG_SetAPen(rast, color)
  919.                A0    D0
  920.  
  921.     void EG_SetAPen(EG_RastPortPtr, ULONG)
  922.  
  923.    FUNCTION
  924.     Modifies the color of the froeground pen.
  925.  
  926.    INPUTS
  927.     rast         - destination RastPort
  928.     color        - new a pen
  929.  
  930.    RESULT
  931.  
  932.    SEE ALSO
  933.  
  934.  
  935. egsgfx.library/EG_SetBPen                           egsgfx.library/EG_SetBPen
  936.  
  937.    NAME
  938.     EG_SetBPen -- modifies background pen
  939.  
  940.    SYNOPSIS
  941.     EG_SetBPen(rast, color)
  942.                A0    D0
  943.  
  944.     void EG_SetBPen(EG_RastPortPtr, ULONG)
  945.  
  946.    FUNCTION
  947.     Modifies the color of the background pen.
  948.  
  949.    INPUTS
  950.     rast         - destination RastPort
  951.     color        - new b pen
  952.  
  953.    RESULT
  954.  
  955.    SEE ALSO
  956.  
  957.  
  958. egsgfx.library/EG_SetDrMd                           egsgfx.library/EG_SetDrMd
  959.  
  960.    NAME
  961.     EG_SetDrMd -- modifies the current drawmode
  962.  
  963.    SYNOPSIS
  964.     EG_SetDrMd(rast, mode)
  965.                A0    D0
  966.  
  967.     void EG_SetDrMd(EG_RastPortPtr, UBYTE)
  968.  
  969.    FUNCTION
  970.     Modifies the current drawmode to mode.
  971.  
  972.    INPUTS
  973.     rast         - destination RastPort
  974.     mode         - new draw mode
  975.  
  976.    RESULT
  977.  
  978.    SEE ALSO
  979.  
  980.  
  981. egsgfx.library/EG_SetFont                           egsgfx.library/EG_SetFont
  982.  
  983.    NAME
  984.     EG_SetFont -- defines current font
  985.  
  986.    SYNOPSIS
  987.     EG_SetFont(rast, font)
  988.                A0    A1
  989.  
  990.     void EG_SetFont(EG_RastPortPtr, EG_EFontPtr)
  991.  
  992.    FUNCTION
  993.     Sets a new font for a RastPort. This has to be a EG_EFont, which has
  994.     been opened using EG_OpenFont().
  995.  
  996.    INPUTS
  997.     rast         - destination RastPort
  998.     font         - new font to use
  999.  
  1000.    RESULT
  1001.  
  1002.    SEE ALSO
  1003.  
  1004.  
  1005. egsgfx.library/EG_SetMask                           egsgfx.library/EG_SetMask
  1006.  
  1007.    NAME
  1008.     EG_SetMask -- obsolete
  1009.  
  1010.    SYNOPSIS
  1011.     EG_SetMask(rast, mask)
  1012.                A0    D0
  1013.  
  1014.     void EG_SetMask(EG_RastPortPtr, ULONG)
  1015.  
  1016.    FUNCTION
  1017.                                            ???
  1018.    INPUTS
  1019.     rast         - RastPort for Mask
  1020.     mask         - Mask
  1021.  
  1022.    RESULT
  1023.  
  1024.    SEE ALSO
  1025.  
  1026.  
  1027. egsgfx.library/EG_SetSoftStyle                 egsgfx.library/EG_SetSoftStyle
  1028.  
  1029.    NAME
  1030.     EG_SetSoftStyle --
  1031.  
  1032.    SYNOPSIS
  1033.     EG_SetSoftStyle(rast, style, mask)
  1034.                     A0    D0     D1
  1035.  
  1036.     UBYTE EG_SetSoftStyle(EG_RastPortPtr, UBYTE, UBYTE)
  1037.  
  1038.    FUNCTION
  1039.     Sets a text softwarestyle for an RastPort.
  1040.  
  1041.    INPUTS
  1042.     rast         - destination RastPort
  1043.     style        - new values
  1044.     nask         - mask for bits to change
  1045.  
  1046.    RESULT
  1047.  
  1048.    SEE ALSO
  1049.  
  1050.  
  1051. egsgfx.library/EG_SizeSubRastPort           egsgfx.library/EG_SizeSubRastPort
  1052.  
  1053.    NAME
  1054.     EG_SizeSubRastPort -- change the size of a subrastport
  1055.  
  1056.    SYNOPSIS
  1057.     EG_SizeSubRastPort(rast, dx, dy)
  1058.                        A0    D0  D1
  1059.  
  1060.     void EG_SizeSubRastPort(EG_RastPortPtr, WORD, WORD)
  1061.  
  1062.    FUNCTION
  1063.     Change the size of a subrastport
  1064.  
  1065.    INPUTS
  1066.     rast         - the RastPort to change
  1067.     dx, dy       - relative size changes
  1068.  
  1069.    RESULT
  1070.  
  1071.    SEE ALSO
  1072.  
  1073.  
  1074. egsgfx.library/EG_StdFont                           egsgfx.library/EG_StdFont
  1075.  
  1076.    NAME
  1077.     EG_StdFont --
  1078.  
  1079.    SYNOPSIS
  1080.     EG_StdFont()
  1081.  
  1082.  
  1083.     EG_EFontPtr EG_StdFont(void)
  1084.  
  1085.    FUNCTION
  1086.     The EGSBlit library has a special font which can be written
  1087.     extremely quick.  That font (8 by 10 Pixels non-proportional) should
  1088.     be used whenever fast text output is wanted.  As it must not be
  1089.     opened by EG_OpenFont(), a handle to it is obtained by EG_StdFont().
  1090.  
  1091.  
  1092.    INPUTS
  1093.  
  1094.    RESULT
  1095.     E_FontPtr to the standard font
  1096.  
  1097.    SEE ALSO
  1098.  
  1099.  
  1100. egsgfx.library/EG_Text                                 egsgfx.library/EG_Text
  1101.  
  1102.    NAME
  1103.     EG_Text -- render text into a RastPort
  1104.  
  1105.    SYNOPSIS
  1106.     EG_Text(rast, text, len)
  1107.             A0    A1    D0
  1108.  
  1109.     void EG_Text(EG_RastPortPtr, char *, WORD)
  1110.  
  1111.    FUNCTION
  1112.     Renders a text into a RastPort at the current cursorposition, using
  1113.     current font and drawmode. After this operation the graphiccursor is
  1114.     located at the end of the text.
  1115.  
  1116.    INPUTS
  1117.     rast         - destination RastPort
  1118.     text         - pointer to first character of text
  1119.     len          - number of characters
  1120.  
  1121.    RESULT
  1122.  
  1123.    SEE ALSO
  1124.  
  1125.  
  1126. egsgfx.library/EG_TextLength                     egsgfx.library/EG_TextLength
  1127.  
  1128.    NAME
  1129.     EG_TextLength -- evaluates the width of a text
  1130.  
  1131.    SYNOPSIS
  1132.     EG_TextLength(rast, text, len)
  1133.                   A0    A1    D0
  1134.  
  1135.     ULONG EG_TextLength(EG_RastPortPtr, char *, WORD)
  1136.  
  1137.    FUNCTION
  1138.     Evaluates the width of a text, as if it would be rendered using
  1139.     EG_Text().
  1140.  
  1141.    INPUTS
  1142.     rast         - destination RastPort
  1143.     text         - pointer to first character of text
  1144.     len          - number of characters
  1145.  
  1146.    RESULT
  1147.     width in pixels
  1148.  
  1149.    SEE ALSO
  1150.  
  1151.  
  1152. egsgfx.library/EG_WritePixel                     egsgfx.library/EG_WritePixel
  1153.  
  1154.    NAME
  1155.     EG_WritePixel -- writes a pixel
  1156.  
  1157.    SYNOPSIS
  1158.     EG_WritePixel(rast, x, y)
  1159.                   A0    D0 D1
  1160.  
  1161.     void EG_WritePixel(EG_RastPortPtr, WORD, WORD)
  1162.  
  1163.    FUNCTION
  1164.     Writes a pixel in to RastPort, using the current drawmode and aPen.
  1165.  
  1166.    INPUTS
  1167.     rast         - destination RastPort
  1168.     x, y         - pixel coordinates to draw at
  1169.  
  1170.    RESULT
  1171.  
  1172.    SEE ALSO
  1173.  
  1174.  
  1175. egsgfx.library/EG_ZoomBitMapRastPort     egsgfx.library/EG_ZoomBitMapRastPort
  1176.  
  1177.    NAME
  1178.     EG_ZoomBitMapRastPort -- zoom bitmap into RastPort
  1179.  
  1180.    SYNOPSIS
  1181.     EG_ZoomBitMapRastPort(src, rast, xs, ys, w, h, xd, yd, zoom)
  1182.                           A0   A1    D0  D1  D2 D3 D4  D5  D6
  1183.  
  1184.     void EG_ZoomBitMapRastPort(E_EBitMapPtr, EG_RastPortPtr, WORD, WORD, WORD, WORD, WORD, WORD, WORD)
  1185.  
  1186.    FUNCTION
  1187.                                              ???
  1188.  
  1189.    INPUTS
  1190.         src          -  bitmap of the screen
  1191.     rast         -
  1192.     xs           -
  1193.     ys           -
  1194.     w            -
  1195.     h            -
  1196.     xd           -
  1197.     yd           -
  1198.     zoom         -
  1199.  
  1200.    RESULT
  1201.  
  1202.    SEE ALSO
  1203.  
  1204.  
  1205. egsgfx.library/EG_ZoomFillMaskSeg           egsgfx.library/EG_ZoomFillMaskSeg
  1206.  
  1207.    NAME
  1208.     EG_ZoomFillMaskSeg --
  1209.  
  1210.    SYNOPSIS
  1211.     EG_ZoomFillMaskSeg(rast, src, xs, ys, w, h, xd, yd, zoom)
  1212.                        A0    A1   D0  D1  D2 D3 D4  D5  D6
  1213.  
  1214.     void EG_ZoomFillMaskSeg(EG_RastPortPtr, E_EBitMapPtr, WORD, WORD, WORD, WORD, WORD, WORD, WORD)
  1215.  
  1216.    FUNCTION
  1217.                                                 ???
  1218.    INPUTS
  1219.     rast         -
  1220.     src          -
  1221.     xs           -
  1222.     ys           -
  1223.     w            -
  1224.     h            -
  1225.     xd           -
  1226.     yd           -
  1227.     zoom         -
  1228.  
  1229.    RESULT
  1230.  
  1231.    SEE ALSO
  1232.  
  1233.  
  1234.