fgl::FGGradient Class Reference

#include <fggradient.h>

List of all members.

---

Detailed Description

Creates the gradient object.

Examples:

gradient.cpp.

Public Types
enum	FGGradientMode { Wrap, Reflect, Repeat }
enum	FGGradientFunction { Linear, LinearXY, Radial, Diamond, Conic, Sqrt }
Public Member Functions
	FGGradient (FGColor &_start_color, FGColor &_end_color)
	FGGradient (FGColor &_start_color, FGColor &_middle_color, FGColor &_end_color)
void	SetFunction (FGGradientFunction f)
void	SetMode (FGGradientMode m)
void	Draw (FGDrawBuffer &image, FGPoint &_start_point, FGPoint &_end_point, FGRect *rectangle=0)
void	Draw (FGDrawBuffer &image, FGRect *rectangle=0)

---

Member Enumeration Documentation

enum fgl::FGGradient::FGGradientFunction

enum fgl::FGGradient::FGGradientMode

---

Constructor & Destructor Documentation

fgl::FGGradient::FGGradient (  FGColor &  _start_color, FGColor &  _end_color )

Build bicolor gradient.

fgl::FGGradient::FGGradient (  FGColor &  _start_color, FGColor &  _middle_color, FGColor &  _end_color )

Build tricolor gradient.

---

Member Function Documentation

void fgl::FGGradient::Draw (  FGDrawBuffer &  image, FGRect *  rectangle = 0 )

Draw the rectangle with color gradient to the buffer. You can't set the start and the end point for gradient, it is the top left for start point and the bottom right for the end point. Parameters: image  desired object rectangle  the rectangle that describes painted area (0 = flat)

void fgl::FGGradient::Draw (  FGDrawBuffer &  image, FGPoint &  _start_point, FGPoint &  _end_point, FGRect *  rectangle = 0 )

Draw the rectangle with color gradient to the buffer. You can set the start and the end point for gradient. Parameters: _start_point  the start point for gradient _end_point  the end point for gradient image  desired object rectangle  the rectangle that describes painted area (0 = flat) Examples: gradient.cpp.

void fgl::FGGradient::SetFunction (  FGGradientFunction  f  )  [inline]

Set drawing function (Linear, LinearXY, Radial, Diamond, Conic or Sqrt). Examples: gradient.cpp.

void fgl::FGGradient::SetMode (  FGGradientMode  m  )  [inline]

Set wrapping mode ( Wrap, Reflect or Repeat ). Examples: gradient.cpp.

---