Current File : //usr/share/man/man3mlib/mlib_GraphicsDrawEllipse.3mlib

'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved 
.TH mlib_GraphicsDrawEllipse 3MLIB "2 Mar 2007" "SunOS 5.11" "mediaLib Library Functions"
.SH NAME
mlib_GraphicsDrawEllipse, mlib_GraphicsDrawEllipse_8, mlib_GraphicsDrawEllipse_32, mlib_GraphicsDrawEllipse_X_8, mlib_GraphicsDrawEllipse_X_32, mlib_GraphicsDrawEllipse_A_8, mlib_GraphicsDrawEllipse_A_32, mlib_GraphicsDrawEllipse_B_8, mlib_GraphicsDrawEllipse_B_32, mlib_GraphicsDrawEllipse_AB_8, mlib_GraphicsDrawEllipse_AB_32 \- draw ellipse
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... \fB-lmlib\fR [ \fIlibrary\fR... ]
#include <mlib.h>

\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_8\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_32\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_X_8\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIc2\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_X_32\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIc2\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_A_8\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_A_32\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_B_8\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIalpha\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_B_32\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIalpha\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_AB_8\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIalpha\fR);
.fi

.LP
.nf
\fBmlib_status\fR \fBmlib_GraphicsDrawEllipse_AB_32\fR(\fBmlib_image *\fR\fIbuffer\fR, \fBmlib_s16\fR \fIx\fR,
     \fBmlib_s16\fR \fIy\fR, \fBmlib_s32\fR \fIa\fR, \fBmlib_s32\fR \fIb\fR, \fBmlib_f32\fR \fIt\fR, \fBmlib_s32\fR \fIc\fR,
     \fBmlib_s32\fR \fIalpha\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Each of the \fBmlib_GraphicsDrawEllipse_*()\fR functions draws an ellipse with the center at (\fIx\fR, \fIy\fR), major semiaxis \fIa\fR, and minor semiaxis \fIb\fR. The angle of the major semiaxis is \fIt\fR counterclockwise from the X axis.
.sp
.LP
Each of the \fBmlib_GraphicsDrawEllipse_X_*()\fR functions draws an ellipse in Xor mode as follows:
.sp
.in +2
.nf
    data[x,y] ^= c ^ c2
.fi
.in -2

.sp
.LP
Each of the \fBmlib_GraphicsDrawEllipse_A_*()\fR functions draws an ellipse with antialiasing.
.sp
.LP
Each of the \fBmlib_GraphicsDrawEllipse_B_*()\fR functions draws an ellipse with alpha blending as follows:
.sp
.in +2
.nf
    data[x,y] = (data[x,y] * (255 - alpha) + c * alpha) / 255
.fi
.in -2

.sp
.LP
Each of the \fBmlib_GraphicsDrawEllipse_A_*()\fR functions draws an ellipse with antialiasing and alpha blending.
.SH PARAMETERS
.sp
.LP
Each of the functions takes some of the following arguments:
.sp
.ne 2
.mk
.na
\fB\fIbuffer\fR\fR
.ad
.RS 10n
.rt  
Pointer to the image into which the function is drawing.
.RE

.sp
.ne 2
.mk
.na
\fB\fIx\fR\fR
.ad
.RS 10n
.rt  
X coordinate of the center.
.RE

.sp
.ne 2
.mk
.na
\fB\fIy\fR\fR
.ad
.RS 10n
.rt  
Y coordinate of the center.
.RE

.sp
.ne 2
.mk
.na
\fB\fIa\fR\fR
.ad
.RS 10n
.rt  
Major semiaxis of the ellipse.
.RE

.sp
.ne 2
.mk
.na
\fB\fIb\fR\fR
.ad
.RS 10n
.rt  
Minor semiaxis of the ellipse.
.RE

.sp
.ne 2
.mk
.na
\fB\fIt\fR\fR
.ad
.RS 10n
.rt  
Angle of major semiaxis in radians.
.RE

.sp
.ne 2
.mk
.na
\fB\fIc\fR\fR
.ad
.RS 10n
.rt  
Color used in the drawing.
.RE

.sp
.ne 2
.mk
.na
\fB\fIc2\fR\fR
.ad
.RS 10n
.rt  
Alternation color.
.RE

.sp
.ne 2
.mk
.na
\fB\fIalpha\fR\fR
.ad
.RS 10n
.rt  
Alpha value for blending. \fB0 \(<= alpha \(<= 255\fR.
.RE

.SH RETURN VALUES
.sp
.LP
Each of the functions returns \fBMLIB_SUCCESS\fR if successful. Otherwise it returns \fBMLIB_FAILURE\fR.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBmlib_GraphicsDrawArc\fR(3MLIB), \fBmlib_GraphicsDrawCircle\fR(3MLIB), \fBattributes\fR(5)