Public API Reference

ivideo/graph2d.h

Go to the documentation of this file.

/*
    Copyright (C) 2001 by Jorrit Tyberghein
    Copyright (C) 1998-2000 by Andrew Zabolotny <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IVIDEO_GRAPH2D_H__
#define __CS_IVIDEO_GRAPH2D_H__

#include "csutil/scf.h"
#include "csgfx/rgbpixel.h"
#include "ivideo/cursor.h"


struct iImage;
struct iFontServer;
struct iFont;
struct iNativeWindow;
struct iGraphics2D;

class csRect;

enum
{
  CS_WRITE_BASELINE    = (1 << 0),
  CS_WRITE_NOANTIALIAS = (1 << 1)
};

struct csPixelCoord
{
  int x;
  int y;
};

struct csPixelFormat
{
  uint32 RedMask, GreenMask, BlueMask, AlphaMask;
  int RedShift, GreenShift, BlueShift, AlphaShift;
  int RedBits, GreenBits, BlueBits, AlphaBits;

  int PalEntries;

  int PixelBytes;

  void complete ()
  {
#define COMPUTE(comp)                                                   \
    {                                                                   \
      unsigned long i, tmp = comp##Mask;                                \
      for (i = 0; tmp && !(tmp & 1); tmp >>= 1, i++) {}                 \
      comp##Shift = i;                                                  \
      for (i = 0; tmp & 1; tmp >>= 1, i++) {}                           \
      comp##Bits = i;                                                   \
    }
    COMPUTE (Red);
    COMPUTE (Green);
    COMPUTE (Blue);
    COMPUTE (Alpha);
#undef COMPUTE
  }
};

struct csImageArea
{
  int x, y, w, h;
  char *data;

  inline csImageArea (int sx, int sy, int sw, int sh)
  { x = sx; y = sy; w = sw; h = sh; data = 0; }
};

SCF_VERSION (iOffscreenCanvasCallback, 1, 0, 0);

struct iOffscreenCanvasCallback : public iBase
{
  virtual void FinishDraw (iGraphics2D* canvas) = 0;
  virtual void SetRGB (iGraphics2D* canvas, int idx, int r, int g, int b) = 0;
};

struct iGraphics2D : public virtual iBase
{
  SCF_INTERFACE (iGraphics2D, 3, 0, 1);
  
  virtual bool Open () = 0;

  virtual void Close () = 0;

  virtual int GetWidth () = 0;

  virtual int GetHeight () = 0;

  virtual int GetPage () = 0;

  virtual bool DoubleBuffer (bool Enable) = 0;

  virtual bool GetDoubleBufferState () = 0;

  virtual csPixelFormat const* GetPixelFormat () = 0;

  virtual int GetPixelBytes () = 0;

  virtual int GetPalEntryCount () = 0;

  virtual csRGBpixel *GetPalette () = 0;

  virtual void SetRGB (int i, int r, int g, int b) = 0;
  virtual int FindRGB (int r, int g, int b, int a = 255) = 0;

  virtual void GetRGB (int color, int& r, int& g, int& b) = 0;
  virtual void GetRGB (int color, int& r, int& g, int& b, int& a) = 0;
  
  virtual void SetClipRect (int nMinX, int nMinY, int nMaxX, int nMaxY) = 0;

  virtual void GetClipRect(int& nMinX, int& nMinY, int& nMaxX, int& nMaxY) = 0;

  virtual bool BeginDraw () = 0;

  virtual void FinishDraw () = 0;

  virtual void Print (csRect const* pArea) = 0;

  virtual void Clear (int color) = 0;

  virtual void ClearAll (int color) = 0;

  virtual void DrawLine(float x1, float y1, float x2, float y2, int color) = 0;

  virtual void DrawBox (int x, int y, int w, int h, int color) = 0;

  virtual bool ClipLine (float& x1, float& y1, float& x2, float& y2,
    int xmin, int ymin, int xmax, int ymax) = 0;

  virtual void DrawPixel (int x, int y, int color) = 0;

  virtual void DrawPixels(csPixelCoord const* pixels, int num_pixels,
     int color) = 0;

  virtual void Blit (int x, int y, int width, int height,
    unsigned char const* data) = 0;

  virtual unsigned char *GetPixelAt (int x, int y) = 0;

  virtual void GetPixel (int x, int y, uint8 &oR, uint8 &oG, uint8 &oB) = 0;
  virtual void GetPixel (int x, int y, uint8 &oR, uint8 &oG, uint8 &oB,
        uint8 &oA) = 0;

  virtual csImageArea *SaveArea (int x, int y, int w, int h) = 0;

  virtual void RestoreArea (csImageArea *Area, bool Free) = 0;

  virtual void FreeArea (csImageArea *Area) = 0;

  virtual void Write (iFont *font, int x, int y, int fg, int bg,
    const char *str, uint flags = 0) = 0;

  CS_DEPRECATED_METHOD_MSG("Use Write() with CS_WRITE_BASELINE flag instead")
  virtual void WriteBaseline (iFont *font, 
    int x, int y, int fg, int bg, const char *str) = 0;

  virtual void AllowResize (bool iAllow) = 0;

  virtual bool Resize (int w, int h) = 0;

  virtual iFontServer *GetFontServer () = 0;

  virtual bool PerformExtension (char const* command, ...) = 0;

  virtual bool PerformExtensionV (char const* command, va_list) = 0;

  virtual csPtr<iImage> ScreenShot () = 0;

  virtual iNativeWindow* GetNativeWindow () = 0;

  virtual bool GetFullScreen () = 0;

  virtual void SetFullScreen (bool b) = 0;

  virtual bool SetMousePosition (int x, int y) = 0;

  virtual bool SetMouseCursor (csMouseCursorID iShape) = 0;

  virtual bool SetMouseCursor (iImage *image, const csRGBcolor* keycolor = 0, 
                               int hotspot_x = 0, int hotspot_y = 0,
                               csRGBcolor fg = csRGBcolor(255,255,255),
                               csRGBcolor bg = csRGBcolor(0,0,0)) = 0;

  virtual bool SetGamma (float gamma) = 0;

  virtual float GetGamma () const = 0;

  virtual const char* GetName () const = 0;

  virtual csPtr<iGraphics2D> CreateOffscreenCanvas (
        void* memory, int width, int height, int depth,
        iOffscreenCanvasCallback* ofscb) = 0;

  virtual void Write (iFont *font, int x, int y, int fg, int bg,
    const wchar_t* str, uint flags = 0) = 0;

};

#endif // __CS_IVIDEO_GRAPH2D_H__

---