Bar Function

Microchip Graphics Library

previous page next page
Microchip Graphics Library
Contents | Index | Home
Previous | Up | Next
Bar Function
C
WORD Bar(
    SHORT left, 
    SHORT top, 
    SHORT right, 
    SHORT bottom
);
Overview

This function draws a bar given the left, top and right, bottom corners with the current set color (SetColor()). When alpha blending is enabled the bar is alpha blended with the existing pixels specified by the parameters. The alpha percentage used is the last value set by SetAlpha().

Input Parameters
Input Parameters 
Description 
SHORT left 
x position of the left top corner. 
SHORT top 
y position of the left top corner. 
SHORT right 
x position of the right bottom corner. 
SHORT bottom 
y position of the right bottom corner. 
Returns

For NON-Blocking configuration:

  • Returns 0 when device is busy and the shape is not yet completely drawn.
  • Returns 1 when the shape is completely drawn.
For Blocking configuration:
  • Always return 1.

Side Effects

none

Library API > Graphics Primitive Layer API > Rectangle Functions > Bar Function
Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved
Contents | Index | Home
previous page start next page