This wiki is out of date, use the continuation of this wiki instead

Start scroll

From FenixWiki

Jump to: navigation, search


Contents

[edit] Definition

INT Start_scroll ( <INT scrollnumber> , <INT fileID> , <INT graphID> , <INT backgroundgraphID> , <INT regionnumber> , <INT lockindicator> )

This creates a scroll window in which it will perform a view against a background graphic. That is, by using a graphic bigger than the display window, a part of this graphic can be shown and shifted in any direction. After this function, the use of the struct scroll makes sense.

[edit] Parameters

INT scrollnumber - The ID for the new scroll window, so it can be referenced to later
INT fileID - The fileID of the file containing the scroll graphics
INT graphID - The graphID of the graphic of the main graphic to be scrolled
INT backgroundgraphID - The graphID of the graphic for the background of the scroll window
INT regionnumber - The region in which to put the scroll window
INT lockindicator - A bit flag defining whether each of the two scroll planes is horizontally/vertically cyclical

[edit] Returns

INT : true

[edit] Notes

The locking indicator can be combinations of the following flags:

1 - The foreground will be displayed horizontally cyclical
2 - The foreground will be displayed vertically cyclical
4 - The background will be displayed horizontally cyclical
8 - The background will be displayed vertically cyclical

Combine them using the bitwise OR operator.

[edit] Using Scrolling

For each process that you want to be part of a scroll window, you must set the local variable ctype to value C_SCROLL. It should also be noted that the local variable c_number is used for selecting in which scroll a process should be displayed. Additionally, you must set the camera property of the scroll structure to the processID of the process you wish to be followed.

[edit] Finish Scrolling

Use function Stop_scroll

Personal tools