Photon 0.0.2
Simple Open Source 2D Game API
photon::
Index

Pen

Class which is used for drawing primitives.

Each instance of pen has a color, and the various members simply draw primitives in that color.

Summary
Pen
Class which is used for drawing primitives.
(Con/ De)structors
Pen
Default constructor, sets color to white.
Pen
Initializing constructor, takes components of color to use for drawing.
Pen
Initializing constructor, takes Color to use for drawing..
Color
setColor
Sets color to use for drawing.
setColor
Sets color to use for drawing.
Drawing
drawPoint
Draws a single point.
drawLine
Draw a line from one point to another.
drawVector
Draw a vector, including small arrow, with base at a given point.
drawRect
Draw an empty rectangle.
fillRect
Draw a filled rectangle.
drawCircle
Draw an empty circle.
fillCircle
Draw a filled circle.

(Con/ De)structors

Pen

Pen()

Default constructor, sets color to white.

Pen

Pen(ubyte r,  
ubyte g,  
ubyte b,  
ubyte a = 255)

Initializing constructor, takes components of color to use for drawing.

Parameters

rValue for red component.
gValue for green component.
bValue for blue component.
aValue for alpha component.  [default: 255]

See Also

setColor

Pen

Pen(const Color &color)

Initializing constructor, takes Color to use for drawing..

Parameters

colorColor to use for drawing.

See Also

setColor

Color

setColor

void setColor(ubyte r,  
ubyte g,  
ubyte b,  
ubyte a = 255)

Sets color to use for drawing.

Parameters

rValue for red component.
gValue for green component.
bValue for blue component.
aValue for alpha component.  [default: 255]

setColor

void setColor(const Color &color)

Sets color to use for drawing.

Parameters

colorColor to use for drawing.

Drawing

drawPoint

void drawPoint(const math::Point2 &point) const

Draws a single point.

Parameters

pointPoint to draw.

drawLine

void drawLine(const math::Point2 &p1,
const math::Point2 &p2) const

Draw a line from one point to another.

Parameters

p1First endpoint of line.
p2Second endpoint of line.

drawVector

void drawVector(const math::Point2 &point,
const math::Vector2 &vector) const

Draw a vector, including small arrow, with base at a given point.

Parameters

pointBase point for vector.
vectorVector to draw.

drawRect

void drawRect(const math::Rect &rect) const

Draw an empty rectangle.

Parameters

rectRect to draw.

fillRect

void fillRect(const math::Rect &rect) const

Draw a filled rectangle.

Parameters

rectRect to draw.

drawCircle

void drawCircle(const math::Circle &circle) const

Draw an empty circle.

Parameters

circleCircle to draw.

fillCircle

void fillCircle(const math::Circle &circle) const

Draw a filled circle.

Parameters

circleCircle to draw.
Documentation for photon. Copyright © 2004-2005 James Turk.  Generated by Natural Docs.
Pen()
Default constructor, sets color to white.
void setColor(ubyte r,  
ubyte g,  
ubyte b,  
ubyte a = 255)
Sets color to use for drawing.
void drawPoint(const math::Point2 &point) const
Draws a single point.
void drawLine(const math::Point2 &p1,
const math::Point2 &p2) const
Draw a line from one point to another.
void drawVector(const math::Point2 &point,
const math::Vector2 &vector) const
Draw a vector, including small arrow, with base at a given point.
void drawRect(const math::Rect &rect) const
Draw an empty rectangle.
void fillRect(const math::Rect &rect) const
Draw a filled rectangle.
void drawCircle(const math::Circle &circle) const
Draw an empty circle.
void fillCircle(const math::Circle &circle) const
Draw a filled circle.
Defines geometric entity known as a rectangle.
Defines geometric entity known as a circle.