GFXSetupTransition Function

Microchip Graphics Library

Microchip Graphics Library
GFXSetupTransition Function
C
BYTE GFXSetupTransition(
    SHORT left, 
    SHORT top, 
    SHORT right, 
    SHORT bottom, 
    GFX_TRANSITION_TYPE type, 
    WORD delay_ms, 
    WORD param1, 
    WORD param2
);
Overview

This sets up the transition effect using the GFX_TRANSITION_TYPE and the given parameters. The actual transition execution will occur when GFXExecutePendingTransition() is called. When DOUBLE_BUFFERING is enabled, GFXExecutePendingTransition() is executed after the current screen is fully rendered.

Input Parameters
Input Parameters 
Description 
SHORT left 
left x coordinate 
SHORT top 
top y coordinate 
SHORT right 
right x coordinate 
SHORT bottom 
bottom y coordinate 
GFX_TRANSITION_TYPE type 
Transition type 
WORD delay_ms 
Delay in milli seconds between redraws in the screen while executing the transition 
WORD param1 
Transition-type specific parameter 
WORD param2 
Transition-type specific parameter 
Returns

Returns success of the setup

  • 0 : Parameters successfully saved for the new transition
  • -1 : Parameters not saved, there is a pending transition

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