Public API Reference

ivaria/gradient.h

Go to the documentation of this file.

/*
    Copyright (C) 2003 by Jorrit Tyberghein
              (C) 2003 by Frank Richter
              (C) 2006 by Christopher Nelson

    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_IVARIA_GRADIENT_H__
#define __CS_IVARIA_GRADIENT_H__

#include "iutil/array.h"

#include "csutil/cscolor.h"
#include "csgfx/rgbpixel.h"

struct csGradientShade
{
  csColor4 left;
  csColor4 right;
  float position;
  
  csGradientShade () : left (0, 0, 0, 1.0f), right (0, 0, 0, 1.0f), 
    position (0) {}
      
  csGradientShade (const csColor4& left_color, const csColor4& right_color, 
    float pos)  : left (left_color), right (right_color), position (pos) {}
  explicit csGradientShade (const csColor& left_color, 
    const csColor& right_color, float pos) : left (left_color), 
    right (right_color), position (pos) {}
      
  csGradientShade (const csColor4& color, float pos) : left (color), 
    right (color), position (pos) {}
  explicit csGradientShade (const csColor& color, float pos) : 
    left (color), right (color), position (pos) {}

  bool operator== (const csGradientShade& other)
  { 
    return (left == other.left) && (right == other.right)
      && (position == other.position);
  }
};

struct iGradientShades : public iArrayReadOnly<csGradientShade>
{
  SCF_IARRAYREADONLY_INTERFACE(iGradientShades);
};

struct iGradient : public virtual iBase
{
  SCF_INTERFACE(iGradient, 0, 0, 1);
  

  virtual void AddShade (const csGradientShade& shade) = 0;
  virtual void AddShade (const csColor4& color, float position) = 0;
  virtual void AddShade (const csColor4& left, const csColor4& right, 
    float position) = 0;
  
  virtual void Clear () = 0;
  
  virtual bool Render (csRGBcolor* pal, size_t count, float begin = 0.0f, 
    float end = 1.0f) const = 0;
  
  virtual bool Render (csRGBpixel* pal, size_t count, float begin = 0.0f, 
    float end = 1.0f) const = 0;

  virtual csPtr<iGradientShades> GetShades () = 0;
};


#endif // __CS_IVARIA_GRADIENT_H__

---