Home| base |src.lib|graphic|fbuffer| FrameBufferLine Index

FrameBufferLine

Syntax
int FrameBufferLine(struct FrameBuffer *ptr, int ax,int ay,int bx,int by, unsigned int color,unsigned char m,int width, struct FrameBufferDash *dash, struct FrameBufferClip *clip);
Header
base/rfbuffer.h
Library
rfbuf
Description

The FrameBufferLine function plots a straight line segment.

The argument rplot is a pointer to the frame buffer.

The coordinates of the two points that define the line are given by the arguments ax, ay, and bx, by.

The color used to plot the line is given by the color which is a 32-bit number that represents the alpha,red,green and blue components of the color as 8-bit numbers. The alpha channel occupies the most significant bits and the blue channel occupies the least significant bits. The argument m defines which color channels are active. Setting this argument to 0x0f will output the color to all four channels. The most significant bit controls the alpha channel and the least significant bit controls the blue channel.

The width of the line is controlled using the argument width, a value of zero will plot a hairline. The dot-dash pattern is given by dash. If this is set to a NULL pointer, a solid line is plotted.

The clipping polygon is given by the argument clip. If this is set to a NULL pointer, no clipping is performed.

Returns
Returns zero on success. On error, (-1) is returned.
Errors
On error, (-1) is returned.
Example
None