home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / DeveloperDisk300794.lha / superview-lib_7_2.LHA / superview-lib / Programmers / Docs / SVDriver_Ref_ENG.doc < prev    next >
Encoding:
Text File  |  1994-07-22  |  8.6 KB  |  443 lines
  1.  
  2.    $VER: SVDriver_Ref_ENG.doc V1.2 (8.7.94)
  3.  
  4.    © 1994 by Andreas R. Kleinert. All rights reserved.
  5.  
  6.    - Feel free to translate this Doc-File into other languages. -
  7.  
  8.        Andreas R. Kleinert,
  9.        Grube Hohe Grethe 23,
  10.        D-57074 Siegen,
  11.        Germany.                        email : Fido 2:2457/345.10
  12.                                                (checked weekly)
  13.  
  14.    * DO _NEVER_ ACCESS ANY SVDRIVERS DIRECTLY.
  15.    * DO NEVER BYPASS superview.library !
  16.  
  17.    THE FOLLOWING NOTES ARE ONLY FOR PROGRAMMERS OF SVDRIVERS :
  18.  
  19.    Here is a listing of the function set, which any of the version 1
  20.    SVDrivers does contain, in an Autodoc-like style of description :
  21.  
  22.     SVD_AllocHandle        ; since Version 1
  23.     SVD_FreeHandle
  24.     SVD_CloseDisplay
  25.     SVD_FreeResources
  26.     SVD_SetGfxBuffer
  27.     SVD_DisplayGfxBuffer
  28.     SVL_SetScreenType
  29.     SVD_SetWindowFlags
  30.     SVD_SetWindowIDCMP
  31.     SVD_GetScreenAddress
  32.     SVD_GetWindowAddress
  33.  
  34.  (you will never find any notes belonging to "BUGS", because any SVDriver
  35.   may have its own ...)
  36.  
  37. -----------------------------------------------------------------------------
  38.    Functions available since Version 1 :
  39. -----------------------------------------------------------------------------
  40.  
  41.    NAME
  42.     SVD_AllocHandle
  43.  
  44.    SYNOPSIS
  45.  
  46.     APTR SVD_AllocHandle(APTR future)
  47.     D0   -$1e         A1
  48.  
  49.    FUNCTION
  50.  
  51.     Allocates a handle for displaying a GfxBuffer via this SVDriver.
  52.  
  53.    INPUT(S)
  54.  
  55.     future - always NULL yet
  56.  
  57.    RESULT
  58.  
  59.     A pointer to a new allocated Handle or NULL, if allocation failed.
  60.  
  61.    WARNING
  62.  
  63.     Test, if the result was NULL, or not !
  64.  
  65.    SINCE
  66.  
  67.     ... Version 1 SVDrivers.
  68.  
  69.    SEE ALSO
  70.  
  71.     SVD_FreeResources, SVD_FreeHandle
  72.  
  73. -----------------------------------------------------------------------------
  74.  
  75.    NAME
  76.     SVD_FreeHandle
  77.  
  78.    SYNOPSIS
  79.  
  80.     VOID SVD_FreeHandle(APTR handle)
  81.     D0   -$24        A1
  82.  
  83.    FUNCTION
  84.  
  85.        Stops showing, frees all Resources and delocates a Handle, which has
  86.        been allocated with SVD_AllocHandle before.
  87.  
  88.  
  89.        For programmers of SVDrivers :
  90.  
  91.        Note, that this function should call
  92.  
  93.       SVD_CloseDisplay(SVHandle);
  94.       SVD_FreeResources(SVHandle);
  95.  
  96.        always. Otherwise memory might be lost.
  97.  
  98.    INPUT(S)
  99.  
  100.     handle - a valid handle
  101.  
  102.    RESULT
  103.  
  104.     -
  105.  
  106.    SINCE
  107.  
  108.     ... Version 1 SVDrivers.
  109.  
  110.    SEE ALSO
  111.  
  112.     SVD_AllocHandle, SVD_CloseDisplay, SVD_FreeResources
  113.  
  114. -----------------------------------------------------------------------------
  115.  
  116.    NAME
  117.     SVD_CloseDisplay
  118.  
  119.    SYNOPSIS
  120.  
  121.     VOID SVD_CloseDisplay(APTR handle)
  122.     D0   -$2a          A1
  123.  
  124.    FUNCTION
  125.  
  126.     Stops showing the Graphic, indentified by the handle.
  127.     The Display-Screen is closed, but no Resources are given free.
  128.  
  129.    INPUT(S)
  130.  
  131.     handle - a valid handle
  132.  
  133.    RESULT
  134.  
  135.     -
  136.  
  137.    SINCE
  138.  
  139.     ... Version 1 SVDrivers.
  140.  
  141.    SEE ALSO
  142.  
  143.     SVD_FreeResources, SVD_FreeHandle
  144.  
  145. -----------------------------------------------------------------------------
  146.  
  147.    NAME
  148.     SVD_FreeResources
  149.  
  150.    SYNOPSIS
  151.  
  152.     VOID SVD_FreeResources(APTR handle)
  153.     D0   -$30           A1
  154.  
  155.    FUNCTION
  156.  
  157.     Frees all resources belonging to the specific Graphic,
  158.     indentified by the handle, which are not needed to just show it.
  159.     The Display will not be closed.
  160.  
  161.    INPUT(S)
  162.  
  163.     handle - a valid handle
  164.  
  165.    RESULT
  166.  
  167.     -
  168.  
  169.    SINCE
  170.  
  171.     ... Version 1 SVDrivers.
  172.  
  173.    SEE ALSO
  174.  
  175.     SVD_AllocHandle, SVD_CloseDisplay, SVD_FreeHandle
  176.  
  177. -----------------------------------------------------------------------------
  178.  
  179.    NAME
  180.     SVD_SetGfxBuffer
  181.  
  182.    SYNOPSIS
  183.  
  184.     ULONG SVD_SetGfxBuffer(APTR handle, struct SV_GfxBuffer *buffer,
  185.     D0    -$36           A1        A2
  186.  
  187.                    ULONG future)
  188.                    A3
  189.  
  190.    FUNCTION
  191.  
  192.     Initializes the given handle with a pointer to a SV_GfxBuffer, which
  193.     should be used with the next call of SVD_DisplayGfxBuffer (see there).
  194.  
  195.     This Buffer STILL HAS TO BE GIVEN FREE the way it has been allocated
  196.     (see documentation of SVObjects and superviewsupport.library)
  197.     and may still be displayed via SVD_DisplayGfxBuffer or saved
  198.     anywhere else.
  199.  
  200.    INPUT(S)
  201.  
  202.     handle      - a valid handle
  203.     buffer      - a pointer to a valid SV_GfxBuffer
  204.     future      - always NULL yet
  205.  
  206.    RESULT
  207.  
  208.     NULL or an adequate SVERR-Errorcode.
  209.  
  210.    SINCE
  211.  
  212.     ... Version 1 SVDrivers.
  213.  
  214.    SEE ALSO
  215.  
  216.     SVD_DisplayGfxBuffer
  217.  
  218. -----------------------------------------------------------------------------
  219.  
  220.    NAME
  221.     SVD_DisplayGfxBuffer
  222.  
  223.    SYNOPSIS
  224.  
  225.     ULONG SVD_DisplayGfxBuffer(APTR handle, future)
  226.     D0    -$3c           A1        A2
  227.  
  228.    FUNCTION
  229.  
  230.     Displays the GfxBuffer (which has been set via SVD_SetGfxBuffer before)
  231.     in the way, which is native to this SVDriver (e.g. on an Intuition
  232.     Screen, an EGS-Screen or into NIL ...)
  233.  
  234.    INPUT(S)
  235.  
  236.     handle      - a valid handle
  237.     future      - always NULL yet
  238.  
  239.    RESULT
  240.  
  241.     NULL or an adequate SVERR-Errorcode.
  242.  
  243.    SINCE
  244.  
  245.     ... Version 1 SVDrivers.
  246.  
  247.    SEE ALSO
  248.  
  249.     SVD_SetGfxBuffer
  250.  
  251. -----------------------------------------------------------------------------
  252.  
  253.    NAME
  254.     SVL_SetScreenType
  255.  
  256.    SYNOPSIS
  257.  
  258.     ULONG SVL_SetScreenType(APTR handle, ULONG type, APTR future)
  259.     D0    -$42        A1         D1      A2
  260.  
  261.    FUNCTION
  262.  
  263.     Specifies, which ScreenType the Screen should have, on which the
  264.     graphic is to be displayed later.
  265.  
  266.     This statement may have no effect, if the SVDriver uses non-Intuition
  267.     ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  268.     ignore this setting more or less).
  269.  
  270.    INPUT(S)
  271.  
  272.     handle - a valid handle
  273.     type   - a ScreenType descriptor, like e.g. CUSTOMSCREEN
  274.     future - always NULL yet
  275.  
  276.    RESULT
  277.  
  278.     NULL or an adequate SVERR-Errorcode.
  279.  
  280.    SINCE
  281.  
  282.     ... Version 1 SVDrivers.
  283.  
  284.    SEE ALSO
  285.  
  286.     SVD_GetScreenAddress
  287.  
  288. -----------------------------------------------------------------------------
  289.  
  290.    NAME
  291.     SVD_SetWindowFlags
  292.  
  293.    SYNOPSIS
  294.  
  295.     ULONG SVD_SetWindowFlags(APTR handle, ULONG flags, APTR future)
  296.     D0    -$48         A1          D1       A2
  297.  
  298.    FUNCTION
  299.  
  300.     Specifies, which Flags the Window should have, on which the
  301.     graphic is to be displayed later.
  302.  
  303.     This statement may have no effect, if the SVDriver uses non-Intuition
  304.     ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  305.     ignore this setting more or less).
  306.  
  307.    INPUT(S)
  308.  
  309.     handle       - a valid handle
  310.     flags       - valid WindowFlags, like e.g. WFLG_BACKDROP
  311.     future       - always NULL yet
  312.  
  313.    RESULT
  314.  
  315.     NULL or an adequate SVERR-Errorcode.
  316.  
  317.    SINCE
  318.  
  319.     ... Version 1 SVDrivers.
  320.  
  321.    SEE ALSO
  322.  
  323.     SVD_SetWindowIDCMP, SVD_GetWindowAddress
  324.  
  325. -----------------------------------------------------------------------------
  326.  
  327.    NAME
  328.     SVD_SetWindowIDCMP
  329.  
  330.    SYNOPSIS
  331.  
  332.     ULONG SVD_SetWindowIDCMP(APTR handle, ULONG idcmp, APTR future)
  333.     D0    -$4e         A1          D1       A2
  334.  
  335.    FUNCTION
  336.  
  337.     Specifies, which IDCMP the Window should have, on which the
  338.     graphic is to be displayed later.
  339.  
  340.     This statement may have no effect, if the SVDriver uses non-Intuition
  341.     ways of displaying or exporting the GfxBuffer (e.g. EGS.svdriver will
  342.     ignore this setting more or less).
  343.  
  344.    INPUT(S)
  345.  
  346.     handle - a valid handle
  347.     idcmp  - a valid set of IDCMP-Flags
  348.     future - always NULL yet
  349.  
  350.    RESULT
  351.  
  352.     NULL or an adequate SVERR-Errorcode.
  353.  
  354.    SINCE
  355.  
  356.     ... Version 1 SVDrivers.
  357.  
  358.    SEE ALSO
  359.  
  360.     SVD_Show
  361.  
  362. -----------------------------------------------------------------------------
  363.  
  364.    NAME
  365.     SVD_GetScreenAddress
  366.  
  367.    SYNOPSIS
  368.  
  369.     struct Screen *SVD_GetScreenAddress(APTR handle, future)
  370.     D0           -$54            A1         A2
  371.  
  372.    FUNCTION
  373.  
  374.     While displaying, the Address of the DisplayScreen can be get
  375.     via this function.
  376.     See description there and example SourceCodes for more and
  377.     detailed information.
  378.  
  379.     This statement may not return a pointer to the real DisplayScreen,
  380.     if the SVDriver uses non-Intuition ways of displaying or exporting
  381.     the GfxBuffer (e.g. EGS.svdriver uses EGS-Screens, which are not
  382.     compatible with Intuition Screens).
  383.     So NULL or a pointer to a Dummy-Screen might be returned sometimes.
  384.  
  385.    INPUT(S)
  386.  
  387.     handle - a valid handle
  388.     future - always NULL yet
  389.  
  390.    RESULT
  391.  
  392.     A valid ScreenPointer or NULL.
  393.  
  394.    SINCE
  395.  
  396.     ... Version 1 SVDrivers.
  397.  
  398.    SEE ALSO
  399.  
  400.     SVD_GetWindowAddress
  401.  
  402. -----------------------------------------------------------------------------
  403.  
  404.    NAME
  405.     SVD_GetWindowAddress
  406.  
  407.    SYNOPSIS
  408.  
  409.     struct Window *SVD_GetWindowAddress(APTR handle, future)
  410.     D0           -$5a            A1         A2
  411.  
  412.    FUNCTION
  413.  
  414.     While displaying, the Address of the DisplayWindow can be get
  415.     via this function.
  416.     See description there and example SourceCodes for more and
  417.     detailed information.
  418.  
  419.     This statement may not return a pointer to the real DisplayWindow,
  420.     if the SVDriver uses non-Intuition ways of displaying or exporting
  421.     the GfxBuffer (e.g. EGS.svdriver uses EGS-Windows, which are not
  422.     compatible with Intuition Windows).
  423.     So NULL or a pointer to a Dummy-Window might be returned sometimes.
  424.  
  425.    INPUT(S)
  426.  
  427.     handle - a valid handle
  428.     future - always NULL yet
  429.  
  430.    RESULT
  431.  
  432.     A valid WindowPointer or NULL.
  433.  
  434.    SINCE
  435.  
  436.     ... Version 1 SVDrivers.
  437.  
  438.    SEE ALSO
  439.  
  440.     SVD_GetScreenAddress
  441.  
  442. -----------------------------------------------------------------------------
  443.