PgBevelBox()

Draw a beveled box with gradients

Synopsis:

int PgBevelBox( PhPoint_t *ul, 
                PhPoint_t *lr, 
                PgColor_t light_color,
                PgColor_t flat_color,
                PgColor_t dark_color,
                short depth, 
                short width, 
                PgColor_t outline_color, 
                PgColor_t inline_color, 
                int flags );

Library:

ph

Description:

This function draws a beveled box with gradients.

The only difference between this function and PgDrawGradientBevelBox() is that the latter allows separate specifications for the upper-left and the lower-right flat colors. The two flat colors are the same in this function.

The arguments are:

ul, lr

The upper left and lower right corners of the beveled box.

light_color

The lightest color in the bevel gradient.

flat_color

The middle/neutral color in the bevel gradient, and the box's fill color.

dark_color

The darkest color in the bevel gradient.

depth

The number of isochrome lines in the light-to-flat and flat-to-dark bevel gradients. The sign of the depth controls the location of an (imaginary) light source:

• Positive depth -- illuminated from the top left.
• Negative depth -- illuminated from the bottom right.

width

The width of the bevel, not including outlines and inlines.

outline_color

The color of the outline rectangle.

inline_color

The color of the inline rectangle.

flags

Flags that affect the appearance of the beveled box:

• Pg_BVB_FILL -- fill the beveled box with flat-color.
• Pg_BVB_FULL_GRADIENTS -- each bevel has two gradients: light-to-flat and flat-to-dark. If this isn't set, the bevels have only one gradient; see the illustration above.
• Pg_BVB_DRAW_LEFT -- draw the left edge of the beveled box.
• Pg_BVB_DRAW_RIGHT -- draw the right edge of the beveled box.
• Pg_BVB_DRAW_TOP -- draw the top edge of the beveled box.
• Pg_BVB_DRAW_BOTTOM -- draw the bottom edge of the beveled box.
• Pg_BVB_DRAW_ALL -- draw all edges of the beveled box.
• Pg_BVB_DRAW_BITS -- turn on all of the above flag bits.

Returns:

0

Success.

-1

An error occurred.

Classification:

Photon

See also:

PgColor_t, PgContrastBevelBox(), PgDrawGradientBevelBox(), PhPoint_t

"Gradients" in the Raw Drawing and Animation chapter of the Photon Programmer's Guide