The SGADE Documentation

the SGADE The Socrates Gameboy Advance Development Engine

The SGADE is a development library for the Nintendo Gameboy Advance. It's free for all uses and is distributed without guarantees. For more information visit the SGADE page.

Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

SoBkgCreditScroll

Functions to support 'scrolling credits' type display. More...

Files

file  SoBkgCreditScroll.c
file  SoBkgCreditScroll.h

Data Structures

struct  SoBkgCreditLine
 Scrolling Credits line structure. More...

struct  SoBkgCreditScroll
 Scrolling Credits definition structure. More...


Defines

#define SO_CREDIT_CODE_TEXT
 data is the text to display for this line

#define SO_CREDIT_CODE_SPACE
 data is the number of blank lines to insert

#define SO_CREDIT_CODE_SPEED
 data is the number of update calls per move

#define SO_CREDIT_CODE_PAUSE
 data is the number of update calls to wait

#define SO_CREDIT_CODE_FONT
 data is a new SoBkgFont pointer

#define SO_CREDIT_CODE_ALIGNLEFT
 align text left

#define SO_CREDIT_CODE_ALIGNRIGHT
 align text right

#define SO_CREDIT_CODE_ALIGNCENTER
 align text centered

#define SoBkgCreditScrollGetBackground(a_This)
 Retrieves the background index used by the credit scroll.


Functions

void SoBkgCreditScrollInit (SoBkgCreditScroll *a_This, u16 a_Bkg, u16 a_LineCnt, const SoBkgCreditLine *a_Lines)
 Initializes the SoBkgCreditScroll for use.

bool SoBkgCreditScrollUpdate (SoBkgCreditScroll *a_This)
 Updates the scrolling display.

bool SoBkgCreditScrollDone (SoBkgCreditScroll *a_This)
 Checks to see if the scrolling display is done.

Detailed Description

Functions to support 'scrolling credits' type display.

This special-purpose module provides a simple interface to generate a typical scrolling credits type of display normally seen at the end of a movie. It does this using a SoBkg (tile mode) display.

Function Documentation

bool SoBkgCreditScrollDone (  SoBkgCreditScroll *    a_This ) 
 

Checks to see if the scrolling display is done.

Parameters:
a_This  this pointer
This function returns true if the scrolling display defined by the passed pointer has finished.

void SoBkgCreditScrollInit (  SoBkgCreditScroll *    a_This,
u16    a_Bkg,
u16    a_LineCnt,
const SoBkgCreditLine *    a_Lines
) 
 

Initializes the SoBkgCreditScroll for use.

Parameters:
a_This  this pointer
a_Bkg  background to use for display
a_LineCnt  number of entries in a_Lines[]
a_Lines  command & text definitions for scrolling display

bool SoBkgCreditScrollUpdate (  SoBkgCreditScroll *    a_This ) 
 

Updates the scrolling display.

Parameters:
a_This  this pointer
This function processes the commands in the scrolling credit definition structure. It should be called once per frame. Returns true as long as there is more data to be processed.

Copyright 2002 by the SGADE authors. See SoLicense.h or Visit the SGADE page for more information.