home *** CD-ROM | disk | FTP | other *** search
/ Workbench Designer 2 / Workbench Designer 2.iso / blanker / swazblanker / programmer / autodoc / swazblanker.doc < prev    next >
Encoding:
Text File  |  1995-11-27  |  28.9 KB  |  1,229 lines
  1. TABLE OF CONTENTS
  2.  
  3. swazblanker.library/PrintInfoTagList
  4. swazblanker.library/SB_AddPrefsTaskTagList
  5. swazblanker.library/SB_AllocConfig
  6. swazblanker.library/SB_BecomeBlankerTaskEnd
  7. swazblanker.library/SB_BecomeBlankerTaskTagList
  8. swazblanker.library/SB_BlankerReady
  9. swazblanker.library/SB_CloneFrontScreenTagList
  10. swazblanker.library/SB_CloseAllPrefsTasks
  11. swazblanker.library/SB_CloseColorCycle
  12. swazblanker.library/SB_CloseCopper
  13. swazblanker.library/SB_ClrBlankerScreen
  14. swazblanker.library/SB_CreateBlankerTask
  15. swazblanker.library/SB_FreeBlankerInfo
  16. swazblanker.library/SB_FreeConfig
  17. swazblanker.library/SB_FreeInit
  18. swazblanker.library/SB_FrontScreenModeID
  19. swazblanker.library/SB_GetBaseVarTagList
  20. swazblanker.library/SB_GetConfigVar
  21. swazblanker.library/SB_GotoBlankerHomeDir
  22. swazblanker.library/SB_HelpClose
  23. swazblanker.library/SB_HelpTagList
  24. swazblanker.library/SB_InitTagList
  25. swazblanker.library/SB_KillBlankerTask
  26. swazblanker.library/SB_LockSBBase
  27. swazblanker.library/SB_ModeSupportsCopper
  28. swazblanker.library/SB_OpenColorCycleTagList
  29. swazblanker.library/SB_OpenCopperTagList
  30. swazblanker.library/SB_OpenScreenTagList
  31. swazblanker.library/SB_OpenWindowTagList
  32. swazblanker.library/SB_PingBlankerScreen
  33. swazblanker.library/SB_ReadConfig
  34. swazblanker.library/SB_RemPrefsTask
  35. swazblanker.library/SB_ResetColorCycle
  36. swazblanker.library/SB_ResetCopper
  37. swazblanker.library/SB_ReturnBlankerHomeDir
  38. swazblanker.library/SB_ServerMasterCleanUp
  39. swazblanker.library/SB_ServerMasterSetUpTagList
  40. swazblanker.library/SB_SetBaseVarTagList
  41. swazblanker.library/SB_SetBlankerScreen
  42. swazblanker.library/SB_SetConfigVar
  43. swazblanker.library/SB_SetCopperTagList
  44. swazblanker.library/SB_UnLockSBBase
  45. swazblanker.library/SB_WriteConfig
  46. swazblanker.library/PrintInfoTagList     swazblanker.library/PrintInfoTagList
  47.  
  48.  NAME
  49.     SB_PrintInfoTagList( SBInit, Tags )
  50.  
  51.  SYNOPSIS
  52.     SB_PrintInfoTagList( SBInit, TagList );
  53.                          A0      A1
  54.  
  55.     void SB_PrintInfoTagList( struct SBInit *, struct TagItem * );
  56.  
  57.     void SB_PrintInfoTags( struct SBInit *, Tag1, ... );
  58.  
  59.  FUNCTION
  60.     All blanker modules should call this function when a
  61.     SB_Init method of SBINIT_METHOD_INFO is set.
  62.  
  63.  INPUTS
  64.     TagList - the following tags are supported:
  65.  
  66.     SBINFO_Author (STRPTR) - name of author.
  67.         Eg. "David Swasbrook (Swaz)". Default is NULL
  68.  
  69.     SBINFO_CPU (ULONG) - type of CPU required.
  70.         Default is 68000.
  71.  
  72.     SBINFO_CPULOAD (ULONG) - amount of CPU that the blanker is
  73.         likely to use. Available settings are:
  74.             SBINFOLOAD_NONE    - none or very little
  75.             SBINFOLOAD_LOW
  76.             SBINFOLOAD_LOWMED
  77.             SBINFOLOAD_MEDIUM
  78.             SBINFOLOAD_MEDHIGH
  79.             SBINFOLOAD_HIGH    - lots and lots of CPU time
  80.         Default is SBINFOLOAD_LOW.
  81.  
  82.     SBINFO_EMail (STRPTR) - email address of the author or
  83.         NULL if does not have email. Eg. "Swaz@iconz.co.nz"
  84.         Default is NULL.
  85.     
  86.     SBINFO_Kickstart (ULONG) - minimum kickstart required.
  87.         Default is 39.
  88.  
  89.     SBINFO_LocArray (APTR) - pointer to locale array. See
  90.         matrix.library documentation for frurther details on
  91.         array format. Default is NULL.
  92.  
  93.     SBINFO_LongDesc (STRPTR) - string giving a full desciption
  94.         of the blanker. Default is NULL.
  95.  
  96.     SBINFO_Name (STRPTR) - name of the module.
  97.         Specifying this tag will attempt to open the locale
  98.         catalog file "SwazBlanker/Name.catalog", and place
  99.         the result in SBInfo->Catalog.
  100.  
  101.     SBINFO_Revision (UWORD) - revision. See also SBINFO_Version.
  102.         Default 0.
  103.  
  104.     SBINFO_ShortDesc (STRPTR) - string giving a short few
  105.         words description of the blanker. Default is NULL.
  106.  
  107.     SBINFO_Stack (ULONG) - stack size to allocate to blanker.
  108.         Default is 4096.
  109.  
  110.     SBINFO_Time (STRPTR) - compilation date/time.
  111.         Default is NULL.
  112.  
  113.     SBINFO_Version (UWORD) - version. See also SBINFO_Revision.
  114.         Default 0.
  115.  
  116.  RESULT
  117.     None.
  118.  
  119.  SEE ALSO
  120.     SB_InitTagList().
  121.  
  122. swazblanker.library/SB_AddPrefsTaskTagList swazblanker.library/SB_AddPrefsTaskTagList
  123.  
  124.  NAME
  125.     SB_AddPrefsTaskTagList -- add a prefs process to resident list (V41)
  126.  
  127.  SYNOPSIS
  128.     Node = SB_AddPrefsTaskTagList( Name, TagItems );
  129.     D0                             A0    A1
  130.  
  131.     struct BlankerPrefsNode *SB_AddPrefsTaskTagList( STRPTR, struct TagItem * );
  132.  
  133.     Node = SB_AddPrefsTaskTags( Name, Tag1, ... )
  134.  
  135.     struct BlankerPrefsNode *SB_AddPrefsTaskTags( STRPTR, Tag1, ... );
  136.  
  137.  INPUTS
  138.     Name - name of task
  139.     TagItems - currently NULL.
  140.  
  141.  RESULT
  142.     Returns a pointer to a struct BlankerPrefsNode which you
  143.     pass to SB_RemPrefsTask() when you have finished.
  144.  
  145.  SEE ALSO
  146.     SB_RemPrefsTask().
  147.  
  148. swazblanker.library/SB_AllocConfig         swazblanker.library/SB_AllocConfig
  149.  
  150.  NAME
  151.     SB_AllocConfig -- allocate config data (V43)
  152.  
  153.  SYNOPSIS
  154.     SBConfig = SB_AllocConfig( Name );
  155.  
  156.     APR SB_AllocConfig( STRPTR );
  157.  
  158.  FUNCTION
  159.  
  160.  INPUTS
  161.     Name - name to identify config data.
  162.  
  163.  RESULT
  164.     Returns an allocated SBConfig structure.
  165.  
  166.  SEE ALSO
  167.     SB_FreeConfig().
  168.  
  169. swazblanker.library/SB_BecomeBlankerTaskEnd swazblanker.library/SB_BecomeBlankerTaskEnd
  170.  
  171.  NAME
  172.     SB_BecomeBlankerTaskEnd -- finish being the blanker (V41)
  173.  
  174.  SYNOPSIS
  175.     SB_BecomeBlankerTaskEnd( Message );
  176.                              A0
  177.  
  178.     void SB_BecomeBlankerTaskEnd( struct SBMessage * );
  179.  
  180.  INPUTS
  181.     Message - as returned by SB_BecomeBlankerTaskTagList().
  182.  
  183.  RESULT
  184.     None.
  185.  
  186.  SEE ALSO
  187.     SB_BecomeBlankerTaskTagList().
  188.  
  189. swazblanker.library/SB_BecomeBlankerTaskTagList swazblanker.library/SB_BecomeBlankerTaskTagList
  190.  
  191.  NAME
  192.     SB_BecomeBlankerTaskTagList -- become the blanker task (V41)
  193.  
  194.  SYNOPSIS
  195.     Message = SB_BecomeBlankerTaskTagList( TagItems );
  196.     D0                                     A0
  197.  
  198.     struct SBMessage *SB_BecomeBlankerTaskTagList( struct TagItem * );
  199.  
  200.     struct SBMessage *SB_BecomeBlankerTaskTags( Tag1, ... );
  201.  
  202.  INPUTS
  203.     TagItems - none defined.
  204.  
  205.  RESULT
  206.     Returns a TRUE if have successfully become the blanker
  207.     task. The task should then enter the blanker routine as
  208.     normal and terminate when a SIGBREAK_CTRL_C is received.
  209.       Eg.
  210.             if( lock = SB_BecomeBlankerTaskTagList( NULL ) )
  211.             {
  212.                 Blank();
  213.                 SB_BecomeBlankerTaskEnd( lock );
  214.             }
  215.  
  216.  NOTES
  217.     This function is designed for the 'Test' feature in the
  218.     configuration for each blanker.
  219.  
  220.  SEE ALSO
  221.     SB_BecomeBlankerTaskEnd().
  222.  
  223. swazblanker.library/SB_BlankerReady       swazblanker.library/SB_BlankerReady
  224.  
  225.  NAME
  226.     SB_BlankerReady -- tell server we are running (V41)
  227.  
  228.  SYNOPSIS
  229.     SB_BlankerReady()
  230.  
  231.     void SB_BlankerReady( void );
  232.  
  233.  FUNCTION
  234.     The blanker should call this function as soon as it is
  235.     ready to blank. This is after all required resources
  236.     have been obtained, so that the server knows that the
  237.     blanker running successfully. The server will wait for
  238.     this signal or the signal from the blanker exiting
  239.     before proceeding.
  240.  
  241.  INPUTS
  242.     None.
  243.  
  244.  RESULT
  245.     None.
  246.  
  247.  SEE ALSO
  248.  
  249. swazblanker.library/SB_CloneFrontScreenTagList swazblanker.library/SB_CloneFrontScreenTagList
  250.  
  251.  NAME
  252.     SB_CloneFrontScreenTagList -- open a clone of the frontmost screen (V41)
  253.  
  254.  SYNOPSIS
  255.     Screen = SB_CloneFrontScreenTagList( ScreenPtr, WindowPtr, TagItems );
  256.     D0                                   A0         A1         A2
  257.  
  258.     struct Screen *SB_CloneFrontScreenTagList( struct Screen **,
  259.                 struct Window **, struct TagItem * );
  260.  
  261.     Screen = SB_CloneFrontScreenTags( ScreenPtr, WindowPtr, Tag1, ... );
  262.  
  263.     struct Screen *SB_CloneFrontScreenTags( struct Screen **,
  264.                 struct Window **, Tag1, ... );
  265.  
  266.  INPUTS
  267.     TagItems - pointer to (an array of) TagItem
  268.         structures, terminated by the value of TAG_END.
  269.         Currently there are none defined so always set this
  270.         to NULL.
  271.  
  272.  RESULT
  273.      Screen - an open Intuition screen.  For extended error
  274.         codes see intuition.library/OpenScreen() when Screen
  275.         is returned NULL.
  276.  
  277.  SEE ALSO
  278.     SB_OpenScreenTagList(), SB_OpenWindowTagList(),
  279.     SB_FrontScreenModeID(), intuition.library/OpenScreen()
  280.  
  281. swazblanker.library/SB_CloseAllPrefsTasks swazblanker.library/SB_CloseAllPrefsTasks
  282.  
  283.  NAME
  284.     SB_CloseAllPrefsTasks -- shutdown all preferences (V41)
  285.  
  286.  SYNOPSIS
  287.     SB_CloseAllPrefsTasks( void );
  288.  
  289.     void CloseAllPrefsTasks( void );
  290.  
  291.  FUNCTION
  292.  
  293.  INPUTS
  294.     None.
  295.  
  296.  RESULT
  297.     All the module preferences currently open will be shutdown,
  298.     this is achieved by sending a SIGBREAKF_ABORT to all the
  299.     preferences tasks (provided they have been attached through
  300.     SB_AddPrefsTaskTagList() ).
  301.  
  302.  NOTES
  303.     This function is intended for use by the server.
  304.  
  305.  SEE ALSO
  306.     SB_AddPrefsTaskTagList(), SB_RemPrefsTask().
  307.  
  308. swazblanker.library/SB_CloseColorCycle swazblanker.library/SB_CloseColorCycle
  309.  
  310.  NAME
  311.     SB_CloseColorCycle - stop and free color cycling (V41)
  312.  
  313.  SYNOPSIS
  314.     SB_CloseColorCycle( ColorCyc );
  315.                         A0
  316.  
  317.     void SB_CloseColorCycle( struct SBColorCyc * );
  318.  
  319.  INPUTS
  320.     ColorCyc - pointer as returned by SB_OpenColorCycleTagList().
  321.  
  322.  RESULT
  323.     None.
  324.  
  325.  SEE ALSO
  326.     SB_CloseColorCycleTagList()
  327.  
  328. swazblanker.library/SB_CloseCopper         swazblanker.library/SB_CloseCopper
  329.  
  330.  NAME
  331.     SB_CloseCopper - end copper banding effect (V41)
  332.  
  333.  SYNOPSIS
  334.     SB_CloseCopper( SBCopper );
  335.                     A0
  336.  
  337.     VOID SB_CloseCopper( struct SBCopper * );
  338.  
  339.  INPUTS
  340.     SBCopper - copper structure to detach from screen.
  341.  
  342.  RESULT
  343.     None.
  344.  
  345.  SEE ALSO
  346.     SB_OpenCopperTagList()
  347.  
  348. swazblanker.library/SB_ClrBlankerScreen swazblanker.library/SB_ClrBlankerScreen
  349.  
  350.  NAME
  351.     SB_ClrBlankerScreen -- clear blanker screen/window (V41)
  352.  
  353.  SYNOPSIS
  354.     SB_ClrBlankerScreen( Screen, Window);
  355.                          D0      D1
  356.  
  357.     VOID SB_ClrBlankerScreen( struct *Screen, struct *Window );
  358.  
  359.  INPUTS
  360.     Screen - pointer to screen the blanker was using.
  361.     Window - pointer to the window the blanker was using.
  362.  
  363.  RESULT
  364.     None.
  365.  
  366.  SEE ALSO
  367.     SB_SetBlankerScreen(), SB_PingBlankerScreen()
  368.  
  369. swazblanker.library/SB_CreateBlankerTask swazblanker.library/SB_CreateBlankerTask
  370.  
  371.  NAME
  372.     SB_CreateBlankerTask -- create a blanker process (V41)
  373.  
  374.  SYNOPSIS
  375.     Task = SB_CreateBlankerTask( Entry, SegList, Name, Stack);
  376.     D0                           A0     A1       A2    D0
  377.  
  378.     struct Task *SB_CreateBlankerTask(APTR, BPTR, STRPTR, ULONG);
  379.  
  380.  INPUTS
  381.     entry - entry address of blanker code. This is mutually
  382.         exclusive with the seglist parameter.
  383.     seglist - seglist of blanker module. This is mutually
  384.         exclusive with the entry parameter.
  385.     name - name of the blanker task.
  386.     stack - size of stack for the blanker task.
  387.  
  388.  RESULT
  389.     Returns a pointer to the blanker task if it was started
  390.     successfully.
  391.  
  392.  NOTES
  393.     o This should only be called by the server task.
  394.     o If you pass in a seglist and the blanker was not successfully
  395.       started the seglist will be freed.
  396.  
  397.  SEE ALSO
  398.     SB_KillBlankerTask(), dos.library/LoadSeg(),
  399.     dos.library/UnLoadSeg()
  400.  
  401. swazblanker.library/SB_FreeBlankerInfo swazblanker.library/SB_FreeBlankerInfo
  402.  
  403.  NAME
  404.     SB_FreeBlankerInfo -- Free info about blanker module (V41)
  405.  
  406.  SYNOPSIS
  407.     SB_FreeBlankerInfo( BlankerInfo );
  408.                         A0
  409.  
  410.     VOID SB_FreeBlankerInfo( struct BlankerInfo * );
  411.  
  412.  INPUTS
  413.     BlankerInfo - pointer as returned by SB_BlankerInfoTagList().
  414.  
  415.  RESULT
  416.     None.
  417.  
  418.  SEE ALSO
  419.     SB_BlankerInfo()
  420.  
  421. swazblanker.library/SB_FreeConfig           swazblanker.library/SB_FreeConfig
  422.  
  423.  NAME
  424.     SB_FreeConfig -- deallocate config data (V43)
  425.  
  426.  SYNOPSIS
  427.     SB_FreeConfig( SBConfig );
  428.  
  429.     SB_FreeConfig( APTR );
  430.  
  431.  FUNCTION
  432.  
  433.  INPUTS
  434.     SBConfig - as allocated by SB_AllocConfig().
  435.  
  436.  RESULT
  437.     None.
  438.  
  439.  SEE ALSO
  440.     SB_AllocConfig().
  441.  
  442. swazblanker.library/SB_FreeInit               swazblanker.library/SB_FreeInit
  443.  
  444.  NAME
  445.     SB_FreeInit - free initialization info (V42)
  446.  
  447.  SYNOPSIS
  448.     SB_FreeInit( SBInit );
  449.                   A0
  450.  
  451.     void SB_FreeInit( struct SBInit * );
  452.  
  453.  INPUTS
  454.     SBInit - pointer as returned by SB_Init().
  455.  
  456.  RESULT
  457.     None.
  458.  
  459.  SEE ALSO
  460.     SB_InitTagList().
  461.  
  462. swazblanker.library/SB_FrontScreenModeID swazblanker.library/SB_FrontScreenModeID
  463.  
  464.  NAME
  465.     SB_FrontScreenModeID -- get the displayID of frontmost screen (V41)
  466.  
  467.  SYNOPSIS
  468.     DisplayID = SB_FrontScreenModeID()
  469.     D0
  470.  
  471.     ULONG SB_FrontScreenMode( void );
  472.  
  473.  INPUTS
  474.     None.
  475.  
  476.  RESULT
  477.     The display mode of the frontmost screen.
  478.  
  479.  SEE ALSO
  480.     SB_CloneFrontScreen(), intuition.library/OpenScreen()
  481.  
  482. swazblanker.library/SB_GetBaseVarTagList swazblanker.library/SB_GetBaseVarTagList
  483.  
  484.  NAME
  485.     SB_GetBaseVarTagList -- get swazblanker variables (V41)
  486.  
  487.  SYNOPSIS
  488.     Result = SB_GetBaseVarTagList( TagList );
  489.     D0                             A0
  490.  
  491.     ULONG SB_GetBaseVarTagList( struct TagItem * );
  492.  
  493.     ULONG SB_GetBaseVarTags( Tag1, ... );
  494.  
  495.  INPUTS
  496.     TagList - pointer to a taglist.
  497.  
  498.  TAGS
  499.  
  500.     SBBV_NumberOfPrefsTasks (LONG) - number of module
  501.         preferences tasks open (includes the main server
  502.         task if that is open).
  503.  
  504.     SBBV_TimeString (STRPTR) - the time the library was
  505.         compiled.
  506.  
  507.     See SB_SetBaseVarTagList() for additional tags.
  508.  
  509.  RESULT
  510.     Returns 0 if successful.
  511.  
  512.  SEE ALSO
  513.     SB_SetBaseVarTagList().
  514.  
  515. swazblanker.library/SB_GetConfigVar       swazblanker.library/SB_GetConfigVar
  516.  
  517.  NAME
  518.     SB_GetConfigVar -- get a config variable (V43)
  519.  
  520.  SYNOPSIS
  521.     Length = SB_GetConfigVar( SBConfig, VarName, Buffer, Length );
  522.  
  523.     LONG SB_GetConfigVar( APTR, STRPTR, UBYTE *, LONG );
  524.  
  525.  FUNCTION
  526.  
  527.  INPUTS
  528.     SBConfig - as allocated by SB_AllocConfig().
  529.     VarName - name of variable to find (case insensitive).
  530.     Buffer - buffer to fill.
  531.     Length - length of buffer.
  532.  
  533.  RESULT
  534.     Length of buffer filled.
  535.  
  536.  SEE ALSO
  537.     SB_AllocConfig().
  538.  
  539. swazblanker.library/SB_GotoBlankerHomeDir swazblanker.library/SB_GotoBlankerHomeDir
  540.  
  541.  NAME
  542.     SB_GotoBlankerHomeDir -- change directory to blankers directory (V41)
  543.  
  544.  SYNOPSIS
  545.     lock = SB_GotoBlankerHomeDir()
  546.     D0
  547.  
  548.     APTR SB_GotoBlankerHomeDir( void );
  549.  
  550.  FUNCTION
  551.  
  552.  INPUTS
  553.     None.
  554.  
  555.  RESULT
  556.     The current directory will be changed to the blanker
  557.     directory and the previously locked directory is returned.
  558.  
  559.  SEE ALSO
  560.     SB_ReturnBlankerHomeDir(),dos.library/CurrentDir(),
  561.     dos.library/Lock().
  562.  
  563. swazblanker.library/SB_HelpClose             swazblanker.library/SB_HelpClose
  564.  
  565.  NAME
  566.     SB_HelpClose -- close the help window if its open (V41)
  567.  
  568.  SYNOPSIS
  569.     SB_HelpClose( sbhelp );
  570.                   A0
  571.  
  572.     void SB_HelpClose( APTR );
  573.  
  574.  FUNCTION
  575.     Closes help window opened by SB_HelpTagList().
  576.  
  577.  INPUTS
  578.     sbhelp - pointer as returned by SB_HelpTagList().
  579.  
  580.  SEE ALSO
  581.     SB_HelpTagList(), amigaguide.library/CloseAmigaGuide().
  582.  
  583. swazblanker.library/SB_HelpTagList         swazblanker.library/SB_HelpTagList
  584.  
  585.  NAME
  586.     SB_HelpTagList -- display help file(V41)
  587.  
  588.  SYNOPSIS
  589.     sbhelp = SB_HelpTagList( Filename, Window, TagList );
  590.     D0                       A0        A1      A2
  591.  
  592.     APTR SB_HelpTagList( STRPTR, struct Window *, struct TagItem *);
  593.  
  594.     sbhelp = SB_HelpTags( Filename, Window, Tag1, ... );
  595.  
  596.     APTR SB_HelpTags( STRPTR, struct Window *, Tag1, ... );
  597.  
  598.  FUNCTION
  599.     Displays the helpfile from the SwazBlanker documentation
  600.     directory. This operation runs asyncronusly.
  601.  
  602.  INPUTS
  603.     Filename - name of file to load. This will be loaded from
  604.         the SwazBlanker documentation directory. If you are a
  605.         blanker module you should specify the SBHELP_Directory
  606.         to get the BLANKERS directory. You do not need to
  607.         add the ".guide" to the filename.
  608.     Window - parent window.
  609.     TagList - See below.
  610.  
  611.  TAGS
  612.     SBHELP_BlankerPrefs (struct BlankerPrefsNode *) - set this
  613.         if you have attached to swazblanker.library so that when
  614.         you detach from the library the help window will also be
  615.         closed.
  616.  
  617.     SBHELP_Directory (ULONG) - specify the directory where your
  618.         guide file is located. Blanker modules should have their
  619.         files located in the dir "blankers". If you do not specify
  620.         this tag you will get the path to where the guide files
  621.         are stored and so will need to specify "blankers/module.guide"
  622.         to reference your blanker.
  623.             SBHELPDIR_SYS - default path.
  624.             SBHELPDIR_BLANKERS - recommended path to blanker guides.
  625.  
  626.  RESULT
  627.     returns pointer if successful.
  628.  
  629.  SEE ALSO
  630.     SB_HelpClose(), amigaguide.library/OpenAmigaGuideAsyncA().
  631.  
  632. swazblanker.library/SB_InitTagList         swazblanker.library/SB_InitTagList
  633.  
  634.  NAME
  635.     SB_InitTagList - free initialization info (V42)
  636.  
  637.  SYNOPSIS
  638.     SBInit = SB_InitTagList( TagList );
  639.     D0                       A0
  640.  
  641.     struct SBInit *SB_InitTagList( struct TagItem * );
  642.  
  643.     struct SBInit *SB_InitTags( Tag1, ... );
  644.  
  645.  FUNCTION
  646.     All blanker modules should call this function as soon as
  647.     possible. What this function does is set the correct
  648.     context for the module. Currently the following happens:
  649.  
  650.       o PROGDIR: is set to the PROGDIR: directory of the main
  651.         SwazBlanker program.
  652.  
  653.       o The Current Directory is then changed to PROGDIR:
  654.  
  655.  INPUTS
  656.     TagList - the following tags are supported:
  657.  
  658.     SBINIT_Name (STRPTR) - name of the module.
  659.         Specifying this tag will attempt to open the locale
  660.         catalog file "SwazBlanker/Name.catalog", and place
  661.         the result in SBInfo->Catalog.
  662.  
  663.  RESULT
  664.     Returns pointer to a struct SBInit or NULL if fails.
  665.  
  666.  SEE ALSO
  667.     SB_FreeInit().
  668.  
  669. swazblanker.library/SB_KillBlankerTask swazblanker.library/SB_KillBlankerTask
  670.  
  671.  NAME
  672.     SB_KillBlankerTask -- create a blanker process (V41)
  673.  
  674.  SYNOPSIS
  675.     SB_KillBlankerTask( Task );
  676.                         D0
  677.  
  678.     VOID SB_KillBlankerTask(struct Task *);
  679.  
  680.  INPUTS
  681.     Task - pointer to the blanker task or NULL.
  682.  
  683.  RESULT
  684.     The blanker task will be terminated.
  685.  
  686.  NOTES
  687.     This should only be called by the server task.
  688.  
  689.  SEE ALSO
  690.     SB_CreateBlankerTask()
  691.  
  692. swazblanker.library/SB_LockSBBase           swazblanker.library/SB_LockSBBase
  693.  
  694.  NAME
  695.     SB_LockSBBase -- lock the SBBase for read/write (V41)
  696.  
  697.  SYNOPSIS
  698.     Lock = SB_LockSBBase( Mode, Flags );
  699.     D0                    D0    D1
  700.  
  701.     APTR SB_LockSBBase( ULONG, ULONG );
  702.  
  703.  FUNCTION
  704.  
  705.  INPUTS
  706.     Mode - SBLOCK_READ or SBLOCK_WRITE.
  707.     Flags - currently 0.
  708.  
  709.  RESULT
  710.     Returns Lock on the semaphore, while holding this lock
  711.     you have the read or write/read permission you requested.
  712.  
  713.  SEE ALSO
  714.     SB_UnLockSBBase().
  715.  
  716. swazblanker.library/SB_ModeSupportsCopper swazblanker.library/SB_ModeSupportsCopper
  717.  
  718.  NAME
  719.     SB_ModeSupportsCopper - test if display mode supports copper (V41)
  720.  
  721.  SYNOPSIS
  722.     Result = SB_ModeSupportsCopper( DisplayID );
  723.     D0                              D0
  724.  
  725.     BOOL SB_ModeSupportsCopper( ULONG );
  726.  
  727.  INPUTS
  728.     DisplayID - display mode to test.
  729.  
  730.  RESULT
  731.     Returns TRUE if display mode can support copper list.
  732.  
  733. swazblanker.library/SB_OpenColorCycleTagList swazblanker.library/SB_OpenColorCycleTagList
  734.  
  735.  NAME
  736.     SB_OpenColorCycleTagList - open a color cycling screen (V41)
  737.  
  738.  SYNOPSIS
  739.     ColorCyc = SB_OpenColorCycleTagList( Screen, TagList );
  740.     D0                                   A0      A1
  741.  
  742.     struct SBColorCyc *SB_OpenColorCycleTagList( struct Screen *,
  743.         struct TagItem * );
  744.  
  745.     ColorCyc = SB_OpenColorCycleTags( Screen, Tag1, ... );
  746.  
  747.     struct SBColorCyc *SB_OpenColorCycleTags( struct Screen *,
  748.         Tag1, ... );
  749.  
  750.  INPUTS
  751.     Screen - pointer to screen to color cycle
  752.     TagList - pointer to taglist. Currently no tags are defined.
  753.  
  754.  RESULT
  755.     Retuerns pointer to ColorCyc structure.
  756.  
  757.  SEE ALSO
  758.     SB_CloseColorCycle(), SB_ResetColorCycle()
  759.  
  760. swazblanker.library/SB_OpenCopperTagList swazblanker.library/SB_OpenCopperTagList
  761.  
  762.  NAME
  763.     SB_OpenCopperTagList - copper banding effect (V41)
  764.  
  765.  SYNOPSIS
  766.     SBCopper = SB_OpenCopperTagList( Screen, TagItems );
  767.     D0                               A0      A1
  768.  
  769.     struct SBCopper *SB_OpenCopperTagList( struct Screen *,
  770.         struct TagItem * );
  771.  
  772.     SBCopper = SB_OpenCopperTags( Screen, Tag1, ... );
  773.  
  774.     strcut SBCopper *SB_OpenCopperTags( struct Screen *,
  775.         Tag1, ... );
  776.  
  777.  FUNCTION
  778.     Attaches copperlist effects to a screen.
  779.  INPUTS
  780.     Screen - screen to have copper effect added to. This
  781.         screen must be able to support a copper list. If it
  782.         does not support copperlists then this function will
  783.         return NULL. See SB_ModeSupportsCopper().
  784.     TagItems - pointer to (an array of) TagItem structures, terminated
  785.         by value of TAG_END.
  786.  
  787.  TAGS
  788.     SBCOPPER_Direction - which direction the colors should, currently
  789.         only COPPER_DOWN is supported. Defaults to DOWN.
  790.  
  791.         Applicability is (I).
  792.  
  793.     SBCOPPER_Pen - pen number to use for copper list. Defaults to 1.
  794.  
  795.         Applicability is (I).
  796.  
  797.     SBCOPPER_ScanLinesPerColor - how many scanlines should be used
  798.         before changing the color. Defaults to 8 ( but this may vary
  799.         in the future depending on the display mode )
  800.  
  801.         Applicability is (I).
  802.  
  803.     SBCOPPER_Speed - how fast the copper colors should move up/down
  804.         the screen. This is in scanlines per vertical blank. Setting
  805.         this tag to ZERO results in a stable copper list.
  806.         Defaults to 1.
  807.  
  808.         Applicability is (I).
  809.  
  810.     SBCOPPER_YStart (UWORD) - vertical starting line for copper effects.
  811.  
  812.         Applicability is (IS).
  813.  
  814.     SBCOPPER_YStop (UWORD) - vertical line to stop copper effects at.
  815.  
  816.         Applicability is (IS).
  817.  
  818.     SBCOPPER_Disabled (BOOL) - set to TRUE to turn copper effects off.
  819.         If set to FALSE copper effects will be re-enabled.
  820.         (UNIMPLEMENTED).
  821.  
  822.         Applicability is (IS).
  823.  
  824.  RESULT
  825.     SBCopper - structure allocated to control the copper
  826.         task created to do the copper effect. Or NULL if out
  827.         of memory or the screen display mode does not support
  828.         copper lists.
  829.  
  830.  SEE ALSO
  831.     SB_CloseCopper(), SB_ModeSupportsCopper(), SB_SetCopperTagList().
  832.  
  833. swazblanker.library/SB_OpenScreenTagList swazblanker.library/SB_OpenScreenTagList
  834.  
  835.  NAME
  836.     SB_OpenScreenTagList -- open a screen (V41)
  837.  
  838.  SYNOPSIS
  839.     Screen = SB_OpenScreenTagList( TagItems );
  840.     D0                             A0
  841.  
  842.     struct Screen *SB_OpenScreenTagList( struct TagItem * );
  843.  
  844.     Screen = SB_OpenScreenTags( Tag1, ... );
  845.  
  846.     struct Screen *SB_OpenScreenTags( Tag1, ... );
  847.  
  848.  INPUTS
  849.     TagItems - pointer to (an array of) TagItem
  850.         structures, terminated by the value of TAG_END.
  851.         See intuition.library/OpenScreen() for tag values.
  852.  
  853.  RESULT
  854.      Screen - an open Intuition screen.  For extended error
  855.         codes see intuition.library/OpenScreen() when Screen
  856.         is returned NULL.
  857.  
  858.  SEE ALSO
  859.     SB_FrontScreenModeID(), SB_CloneFrontScreenTagList(),
  860.     intuition.library/OpenScreen()
  861.  
  862. swazblanker.library/SB_OpenWindowTagList swazblanker.library/SB_OpenWindowTagList
  863.  
  864.  NAME
  865.     SB_OpenWindowTagList -- open a Window (V41)
  866.  
  867.  SYNOPSIS
  868.     Window = SB_OpenWindowTagList( TagItems );
  869.     D0                             A0
  870.  
  871.     struct Window *SB_OpenWindowTagList( struct TagItem * );
  872.  
  873.     Window = SB_OpenWindowTags( Tag1, ... );
  874.  
  875.     struct Window *SB_OpenWindowTags( Tag1, ... );
  876.  
  877.  INPUTS
  878.     TagItems - pointer to (an array of) TagItem
  879.         structures, terminated by the value of TAG_END.
  880.         See intuition.library/OpenWindow() for tag values.
  881.  
  882.  RESULT
  883.      Window - an open Intuition Window.  For extended error
  884.         codes see intuition.library/OpenWindow() when Window
  885.         is returned NULL.
  886.  
  887.  SEE ALSO
  888.     SB_CloneFrontScreenTagList(), intuition.library/OpenWindow()
  889.  
  890. swazblanker.library/SB_PingBlankerScreen swazblanker.library/SB_PingBlankerScreen
  891.  
  892.  NAME
  893.     SB_PingBlankerScreen -- bring blanker screen to front (V41)
  894.  
  895.  SYNOPSIS
  896.     SB_PingBlankerScreen()
  897.  
  898.     VOID SB_PingBlankerScreen( void );
  899.  
  900.  INPUTS
  901.     None.
  902.  
  903.  RESULT
  904.     None.
  905.  
  906.  NOTES
  907.     This should only be called by the server task.
  908.  
  909.  SEE ALSO
  910.     SB_SetBlankerScreen(), SB_ClrBlankerScreen()
  911.  
  912. swazblanker.library/SB_ReadConfig           swazblanker.library/SB_ReadConfig
  913.  
  914.  NAME
  915.     SB_ReadConfig -- read config data (V43)
  916.  
  917.  SYNOPSIS
  918.     SB_ReadConfig( SBConfig, FileName );
  919.  
  920.     void SB_ReadConfig( APTR, STRPTR );
  921.  
  922.  FUNCTION
  923.  
  924.  INPUTS
  925.     SBConfig - config structure as allocated by SB_AllocConfig().
  926.     FileName - name of file to read from.
  927.  
  928.  RESULT
  929.     None.
  930.  
  931.  SEE ALSO
  932.     SB_AllocConfig(), SB_WriteConfig().
  933.  
  934. swazblanker.library/SB_RemPrefsTask       swazblanker.library/SB_RemPrefsTask
  935.  
  936.  NAME
  937.     SB_RemPrefsTask -- remove a prefs process to resident list (V41)
  938.  
  939.  SYNOPSIS
  940.     SB_RemPrefsTask( BlankerPrefsNode )
  941.                      A0
  942.  
  943.     VOID SB_AddPrefsTask( struct BlankerPrefsNode * );
  944.  
  945.  INPUTS
  946.     BlankerPrefsNode - pointer as returned by SB_AddPrefsTaskTagList().
  947.  
  948.  RESULT
  949.     None.
  950.  
  951.  SEE ALSO
  952.     SB_AddPrefsTaskTagList().
  953.  
  954. swazblanker.library/SB_ResetColorCycle swazblanker.library/SB_ResetColorCycle
  955.  
  956.  NAME
  957.     SB_ResetColorCycle - reset color cycling (V41)
  958.  
  959.  SYNOPSIS
  960.     SB_ResetColorCycle( ColorCyc );
  961.                         A0
  962.  
  963.     void SB_ResetColorCycle( struct SBColorCyc * );
  964.  
  965.  INPUTS
  966.     ColorCyc - pointer as returned by SB_OpenColorCycleTagList().
  967.  
  968.  RESULT
  969.     None.
  970.  
  971.  SEE ALSO
  972.     SB_OpenColorCycleTagList()
  973.  
  974. swazblanker.library/SB_ResetCopper         swazblanker.library/SB_ResetCopper
  975.  
  976.  NAME
  977.     SB_ResetCopper - reset copper banding effect (V41)
  978.  
  979.  SYNOPSIS
  980.     SB_ResetCopper( SBCopper );
  981.                     A0
  982.  
  983.     VOID SB_ResetCopper( struct SBCopper * );
  984.  
  985.  FUNCTION
  986.     Old function that resets the color for the copperlist.
  987.     See SB_SetCopperTagList().
  988.  INPUTS
  989.     SBCopper - copper structure to reset.
  990.  
  991.  RESULT
  992.     None.
  993.  
  994.  SEE ALSO
  995.     SB_OpenCopperTagList(),SB_SetCopperTagList().
  996.  
  997. swazblanker.library/SB_ReturnBlankerHomeDir swazblanker.library/SB_ReturnBlankerHomeDir
  998.  
  999.  NAME
  1000.     SB_ReturnBlankerHomeDir -- restore original directory (V41)
  1001.  
  1002.  SYNOPSIS
  1003.     SB_ReturnBlankerHomeDir( Lock );
  1004.                              D0
  1005.  
  1006.     void SB_ReturnBlankerHomeDir( APTR );
  1007.  
  1008.  FUNCTION
  1009.  
  1010.  INPUTS
  1011.     lock - the lock as returned by SB_GotoBlankerHomeDir().
  1012.  
  1013.  RESULT
  1014.     Current directory will be restored to the directory as
  1015.     when SB_GotoBlankerHomeDir() was invoked.
  1016.  
  1017.  SEE ALSO
  1018.     SB_GotoBlankerHomeDir(), dos.library/CurrentDir(),
  1019.     dos.library/UnLock().
  1020.  
  1021. swazblanker.library/SB_ServerMasterCleanUp swazblanker.library/SB_ServerMasterCleanUp
  1022.  
  1023.  NAME
  1024.     SB_ServerMasterCleanUp -- cleanup the master task for the server (V41)
  1025.  
  1026.  SYNOPSIS
  1027.     SB_ServerMasterCleanUp();
  1028.  
  1029.     VOID SB_ServerMasterCleanUp( void );
  1030.  
  1031.  INPUTS
  1032.     None.
  1033.  
  1034.  RESULT
  1035.     None.
  1036.  
  1037.  SEE ALSO
  1038.     SB_ServerMasterSetUp()
  1039.  
  1040. swazblanker.library/SB_ServerMasterSetUpTagList swazblanker.library/SB_ServerMasterSetUpTagList
  1041.  
  1042.  NAME
  1043.     SB_ServerMasterSetUpTagList -- setup the master task for the server (V41)
  1044.  
  1045.  SYNOPSIS
  1046.     Success = SB_ServerMasterSetUpTagList( TagList );
  1047.     D0                                     A0
  1048.  
  1049.     BOOL SB_ServerMasterSetUpTagList(struct TagItem *);
  1050.  
  1051.     BOOL SB_ServerMasterSetUpTags( Tag1, ... );
  1052.  
  1053.  INPUTS
  1054.     TagList - array of tag items to specify.
  1055.  
  1056.  TAGS
  1057.     SBBV_DocPath (STRPTR) - full pathname to where the
  1058.         blanker modules are.
  1059.  
  1060.  RESULT
  1061.     Returns TRUE if we were able to initialize the
  1062.     swazblanker.library to service the server task.
  1063.  
  1064.  SEE ALSO
  1065.     SB_ServerMasterCleanUp()
  1066.  
  1067. swazblanker.library/SB_SetBaseVarTagList swazblanker.library/SB_SetBaseVarTagList
  1068.  
  1069.  NAME
  1070.     SB_SetBaseVarTagList -- set swazblanker variables (V41)
  1071.  
  1072.  SYNOPSIS
  1073.     Result = SB_SetBaseVarTagList( TagList );
  1074.     D0                             A0
  1075.  
  1076.     ULONG SB_SetBaseVarTagList( struct TagItem * );
  1077.  
  1078.     ULONG SB_SetBaseVarTags( Tag1, ... );
  1079.  
  1080.  INPUTS
  1081.     TagList - pointer to a taglist.
  1082.  
  1083.  TAGS
  1084.     SBBV_ObtainSemaphore (BOOL) - if TRUE then the
  1085.         SwazBlankerBase->Semaphore will be locked for
  1086.         access. Only set this to FLASE if you already
  1087.         have the correct read/write access to the semaphore.
  1088.  
  1089.     SBBV_FontInfo (STRPTR) - name of the font to use for the
  1090.         user interface for blanker modules.
  1091.  
  1092.     SBBV_PrefsWindow (struct Window *) - pointer to the
  1093.         SwazBlanker preferences window if it is open or NULL
  1094.         if it is not.
  1095.  
  1096.     SBBV_BlankerPath (STRPTR) - full path to the directory
  1097.         where the blanker modules are stored.
  1098.  
  1099.     SBBV_BlankerTaskPri (LONG) - the task priority to run
  1100.         blanker modules at.
  1101.  
  1102.  RESULT
  1103.     Returns 0 if successful.
  1104.  
  1105.  SEE ALSO
  1106.     SB_SetBaseVarTagList().
  1107.  
  1108. swazblanker.library/SB_SetBlankerScreen swazblanker.library/SB_SetBlankerScreen
  1109.  
  1110.  NAME
  1111.     SB_SetBlankerScreen -- set blanker screen/window (V41)
  1112.  
  1113.  SYNOPSIS
  1114.     Error = SB_SetBlankerScreen( Screen, Window);
  1115.     D0                           D0      D1
  1116.  
  1117.     ULONG SB_SetBlankerScreen( struct *Screen, struct *Window );
  1118.  
  1119.  INPUTS
  1120.     Screen - pointer to screen opened by the blanker.
  1121.     Window - pointer to window on the screen.
  1122.  
  1123.  RESULT
  1124.     Returns non zero if error occured.
  1125.  
  1126.  SEE ALSO
  1127.     SB_ClrBlankerScreen(), SB_PingBlankerScreen()
  1128.  
  1129. swazblanker.library/SB_SetConfigVar       swazblanker.library/SB_SetConfigVar
  1130.  
  1131.  NAME
  1132.     SB_GetConfigVar -- get a config variable (V43)
  1133.  
  1134.  SYNOPSIS
  1135.     SB_SetConfigVar( SBConfig, VarName, Buffer );
  1136.  
  1137.     SB_SetConfigVar( APTR, STRPTR, STRPTR );
  1138.  
  1139.  FUNCTION
  1140.  
  1141.  INPUTS
  1142.     SBConfig - as allocated by SB_AllocConfig().
  1143.     VarName - name of variable to find (case insensitive).
  1144.     Buffer - buffer for variable data.
  1145.  
  1146.  RESULT
  1147.     None.
  1148.  
  1149.  SEE ALSO
  1150.     SB_GetConfigVar().
  1151.  
  1152. swazblanker.library/SB_SetCopperTagList swazblanker.library/SB_SetCopperTagList
  1153.  
  1154.  NAME
  1155.     SB_SetCopperTagList - Set copper effect values (V41)
  1156.  
  1157.  SYNOPSIS
  1158.     SB_SetCopperTagList( SBCopper, TagItems );
  1159.                          A0        A1
  1160.  
  1161.     void SB_SetCopperTagList( struct SBCopper *, struct TagItem * );
  1162.  
  1163.     SB_SetCopperTags( SBCopper, Tag1, ... );
  1164.  
  1165.     void SB_SetCopperTags( strcut SBCopper *, Tag1, ... );
  1166.  
  1167.  INPUTS
  1168.     SBCopper - copper structure to reset.
  1169.     TagItems - pointer to (an array of) TagItem structures,
  1170.         terminated by the value of TAG_END. Currently there
  1171.         are none defined so always set this to NULL.
  1172.  
  1173.  TAGS
  1174.     SBCOPPER_RandomiseColors (BOOL) - if set to true then the
  1175.         colors being currently used for the copper will be
  1176.         randomised.
  1177.  
  1178.     See SB_OpenCopperTagList() for additional values.
  1179.  RESULT
  1180.     Copper list effect variables are changed.
  1181.  
  1182.  SEE ALSO
  1183.     SB_OpenCopperTagList(), SB_ResetCopper().
  1184.  
  1185. swazblanker.library/SB_UnLockSBBase       swazblanker.library/SB_UnLockSBBase
  1186.  
  1187.  NAME
  1188.     SB_UnLockSBBase -- unlock the SBBase (V41)
  1189.  
  1190.  SYNOPSIS
  1191.     SB_UnLockSBBase( Lock );
  1192.                      A0
  1193.  
  1194.     SB_UnLockSBBase( APTR );
  1195.  
  1196.  FUNCTION
  1197.  
  1198.  INPUTS
  1199.     Lock - as returned by SB_LockSBBase().
  1200.  
  1201.  RESULT
  1202.     None.
  1203.  
  1204.  SEE ALSO
  1205.     SB_LockSBBase().
  1206.  
  1207. swazblanker.library/SB_WriteConfig         swazblanker.library/SB_WriteConfig
  1208.  
  1209.  NAME
  1210.     SB_WriteConfig -- write config data (V43)
  1211.  
  1212.  SYNOPSIS
  1213.     SB_WriteConfig( SBConfig, FileName );
  1214.  
  1215.     void SB_WriteConfig( APTR, STRPTR );
  1216.  
  1217.  FUNCTION
  1218.  
  1219.  INPUTS
  1220.     SBConfig - config structure as allocated by SB_AllocConfig().
  1221.     FileName - name of file to write to.
  1222.  
  1223.  RESULT
  1224.     None.
  1225.  
  1226.  SEE ALSO
  1227.     SB_AllocConfig(), SB_ReadConfig().
  1228.  
  1229.