PutImagePartial Function

Microchip Graphics Library

Microchip Graphics Library
PutImagePartial Function
C
WORD PutImagePartial(
    SHORT left, 
    SHORT top, 
    void * image, 
    BYTE stretch, 
    SHORT xoffset, 
    SHORT yoffset, 
    WORD width, 
    WORD height
);
Overview

This function outputs a full or a partial image starting from left,top coordinates. The partial image starts at xoffset and yoffset. Size is specified by the given width and height parameters.

Description

Input Parameters
Input Parameters 
Description 
SHORT left 
horizontal starting position of full or partial image on the screen 
SHORT top 
vertical starting position of full or partial image on the screen, 
void * image 
pointer to the image location. 
BYTE stretch 
The image stretch factor.  
SHORT xoffset 
Specifies the horizontal offset in pixels of the selected partial image from the left most pixel of the full image. 
SHORT yoffset 
Specifies the vertical offset in pixels of the selected partial image from the top most pixel of the full image. 
WORD width 
width of the partial image to be rendered. xoffset + width must not exceed the full image width. 
WORD height 
height of the partial image to be rendered. yoffset + height must not exceed the full image height. 
Returns

For NON-Blocking configuration:

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

Side Effects

none

Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved