rom/graphics/setdisplaydrivercallback.c

   1 /*
   2     Copyright © 2010, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Set display driver notification callback
   6     Lang: english
   7 */
   8
   9 #include <aros/debug.h>
  10 #include <graphics/driver.h>
  11 #include <oop/oop.h>
  12 #include <proto/utility.h>
  13
  14 #include "graphics_intern.h"
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19 #include <proto/graphics.h>
  20
  21         AROS_LH2(void, SetDisplayDriverCallback,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(APTR, callback, A0),
  25         AROS_LHA(APTR, userdata, A1),
  26
  27 /*  LOCATION */
  28         struct GfxBase *, GfxBase, 108, Graphics)
  29
  30 /*  FUNCTION
  31         Specify a display driver notification callback.
  32
  33         The callback function is called using "C" calling convention and its
  34         declaration should have a form:
  35
  36         APTR DriverNotify(APTR object, BOOL add, APTR userdata);
  37
  38         The function will be called upon display driver insertion and removal.
  39         Upon insertion the parameters will be the following:
  40           object   - A pointer to a struct MonitorHandle for the new driver
  41           add      - TRUE, indicates driver insertion
  42           userdata - User data originally passed to SetDisplayDriverCallback()
  43         The function should return a pointer to opaque data object which will
  44         be stored in the display driver handle structure.
  45
  46         Upon driver removal the parameters mean:
  47           object   - A pointer to opaque object returned by the callback when
  48                      the driver was added.
  49           add      - FALSE, indicates driver removal.
  50           userdata - User data originally passed to SetDisplayDriverCallback()
  51         Callback return value is ignored in removal mode.
  52
  53     INPUTS
  54         callback - A pointer to a function to call.
  55         userdata - User-defined data, will be passed to the callback function
  56
  57     RESULT
  58         None.
  59
  60     NOTES
  61         This function is private to AROS. Do not use it in any end-user software,
  62         the specification may change at any moment.
  63
  64     EXAMPLE
  65
  66     BUGS
  67
  68     SEE ALSO
  69         AddDisplayDriverA()
  70
  71     INTERNALS
  72
  73     HISTORY
  74
  75 *****************************************************************************/
  76 {
  77     AROS_LIBFUNC_INIT
  78
  79     CDD(GfxBase)->DriverNotify = callback;
  80     CDD(GfxBase)->notify_data  = userdata;
  81
  82     AROS_LIBFUNC_EXIT
  83 }