rom/graphics/inittmpras.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$        $Log
   4
   5     Desc: Graphics function InitRastPort()
   6     Lang: english
   7 */
   8 #include "graphics_intern.h"
   9 #include <graphics/rastport.h>
  10 #include <proto/exec.h>
  11 #include <proto/graphics.h>
  12
  13 /*****************************************************************************
  14
  15     NAME */
  16
  17         AROS_LH3(struct TmpRas  *, InitTmpRas,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(struct TmpRas  *, tmpras, A0),
  21         AROS_LHA(void *          , buffer, A1),
  22         AROS_LHA(ULONG           , size  , D0),
  23
  24 /*  LOCATION */
  25         struct GfxBase *, GfxBase, 78, Graphics)
  26
  27 /*  FUNCTION
  28         Initializes a TmpRas structure. The user has to connect the
  29         TmpRas structure to the rastport.
  30         Some routines need extra memory in order to be able to operate
  31         properly.
  32
  33     INPUTS
  34         tmpras - pointer to a TmpRas structure to be initialized
  35         buffer - pointer to a piece of chip memory.
  36         size   - size in bytes of buffer.
  37
  38     RESULT
  39         Properly initialized TmpRas structure to link to RastPort structure
  40         for use with functions like Flood(), Text() and AreaEnd().
  41
  42     NOTES
  43         Alltough the RKRM says InitTmpRas is a VOID function every SDK
  44         implements it so that it returns the tmpras argument.
  45
  46     EXAMPLE
  47
  48     BUGS
  49         The function itself is a bug.
  50         Why does this function exist at all? The necessary memory should
  51         be allocated in InitRastPort() or the functions that need it.
  52
  53     SEE ALSO
  54
  55     INTERNALS
  56
  57     HISTORY
  58
  59 *****************************************************************************/
  60 {
  61   AROS_LIBFUNC_INIT
  62
  63   tmpras->RasPtr = buffer;
  64   tmpras->Size   = size;
  65
  66   return tmpras;
  67
  68   AROS_LIBFUNC_EXIT
  69 } /* InitTmpRas */