Content-type: text/html Man page of mlib_GraphicsDrawRectangle

mlib_GraphicsDrawRectangle

Section: mediaLib Library Functions (3MLIB)
Updated: 2 Mar 2007
Index Return to Main Contents
 

NAME

mlib_GraphicsDrawRectangle, mlib_GraphicsDrawRectangle_8, mlib_GraphicsDrawRectangle_32, mlib_GraphicsDrawRectangle_X_8, mlib_GraphicsDrawRectangle_X_32, mlib_GraphicsDrawRectangle_B_8, mlib_GraphicsDrawRectangle_B_32 - draw rectangle  

SYNOPSIS

cc [ flag... ] file... -lmlib [ library... ]
#include <mlib.h>

mlib_status mlib_GraphicsDrawRectangle_8(mlib_image *buffer, mlib_s16 x,
    mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c);

mlib_status mlib_GraphicsDrawRectangle_32(mlib_image *buffer, mlib_s16 x,
    mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c);

mlib_status mlib_GraphicsDrawRectangle_X_8(mlib_image *buffer, mlib_s16 x,
    mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c, mlib_s32 c2);

mlib_status mlib_GraphicsDrawRectangle_X_32(mlib_image *buffer,
    mlib_s16 x, mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c, 
    mlib_s32 c2);

mlib_status mlib_GraphicsDrawRectangle_B_8(mlib_image *buffer, mlib_s16 x,
    mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c, mlib_s32 a);

mlib_status mlib_GraphicsDrawRectangle_B_32(mlib_image *buffer,
    mlib_s16 x, mlib_s16 y, mlib_s32 w, mlib_s32 h, mlib_s32 c, 
    mlib_s32 a);

 

DESCRIPTION

Each of the mlib_GraphicsDrawRectangle_*() functions draws a rectangle with the upper-left corner at (x, y), width w, and height h.

Each of the mlib_GraphicsDrawRectangle_X_*() functions draws a rectangle in Xor mode as follows:

    data[x,y] ^= c ^ c2

Each of the mlib_GraphicsDrawRectangle_B_*() functions draws a rectangle with alpha blending as follows:

    data[x,y] = (data[x,y] * (255 - a) + c * a) / 255

 

PARAMETERS

Each of the functions takes some of the following arguments:

buffer

Pointer to the image into which the function is drawing.

x

X coordinate of the upper-left corner of the rectangle.

y

Y coordinate of the upper-left corner of the rectangle.

w

Width of the rectangle.

h

Height of the rectangle.

c

Color used in the drawing.

c2

Alternation color.

a

Alpha value for blending. 0 ≤ a ≤ 255.

 

RETURN VALUES

Each of the functions returns MLIB_SUCCESS if successful. Otherwise it returns MLIB_FAILURE.  

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE

Interface StabilityCommitted

MT-Level

 

SEE ALSO

mlib_GraphicsFillRectangle(3MLIB), attributes(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
PARAMETERS
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:38:03 GMT, October 02, 2010