workbench/libs/gadtools/getvisualinfoa.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include <exec/memory.h>
  10 #include <proto/intuition.h>
  11 #include "gadtools_intern.h"
  12
  13 /*********************************************************************
  14
  15     NAME */
  16 #include <proto/gadtools.h>
  17 #include <intuition/screens.h>
  18 #include <utility/tagitem.h>
  19
  20         AROS_LH2(APTR, GetVisualInfoA,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(struct Screen *, screen, A0),
  24         AROS_LHA(struct TagItem *, tagList, A1),
  25
  26 /*  LOCATION */
  27         struct Library *, GadToolsBase, 21, GadTools)
  28
  29 /*  FUNCTION
  30         GetVisualInfoA() creates a visual info structure, which is needed
  31         by several gadtools functions. When you're done using it, you have
  32         to call FreeVisualInfo().
  33
  34     INPUTS
  35         screen -  pointer to the screen to create a visual info structure for
  36                   (may be NULL)
  37         taglist - additional tags (none defined, yet)
  38
  39     RESULT
  40         A (private) visual info structure. NULL indicates an error.
  41
  42     NOTES
  43
  44     EXAMPLE
  45
  46     BUGS
  47
  48     SEE ALSO
  49         FreeVisualInfo()
  50
  51     INTERNALS
  52
  53     HISTORY
  54
  55 ***************************************************************************/
  56 {
  57     AROS_LIBFUNC_INIT
  58
  59     struct VisualInfo *vi;
  60
  61     if (screen == NULL)
  62         return NULL;
  63
  64     vi = AllocVec(sizeof(struct VisualInfo), MEMF_ANY);
  65     if (!vi)
  66         return NULL;
  67
  68     vi->vi_screen = screen;
  69     vi->vi_dri = GetScreenDrawInfo(screen);
  70
  71     return vi;
  72
  73     AROS_LIBFUNC_EXIT
  74
  75 } /* GetVisualInfoA */