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 Struct Reference
[SoBkgCreditScroll]

Scrolling Credits definition structure. More...

#include <SoBkgCreditScroll.h>


Data Fields

u16 m_Mode
 operation mode

u16 m_Bkg
 Background used for display.

u16 m_ScrollPos
 current vertical scroll position (in pixels)

u16 m_UpdSpeed
 number of ticks per update

u16 m_FrameCnt
 number of ticks elapsed since last update

u16 m_LineCnt
 total number of entries in m_Lines[]

u16 m_LineNum
 current index into m_Lines[]

u16 m_LineArg
 effect argument value (used by PAUSE & SPACE)

const SoBkgCreditLine * m_Lines
 data to be scrolled

Detailed Description

Scrolling Credits definition structure.

A single SoBkgCreditScroll instance represents all of the data displayed in a scrolling credits display. All the members are private. Use the methods instead.

Field Documentation

u16 SoBkgCreditScroll::m_Bkg
 

Background used for display.

For internal use only.

u16 SoBkgCreditScroll::m_FrameCnt
 

number of ticks elapsed since last update

For internal use only.

u16 SoBkgCreditScroll::m_LineArg
 

effect argument value (used by PAUSE & SPACE)

For internal use only.

u16 SoBkgCreditScroll::m_LineCnt
 

total number of entries in m_Lines[]

For internal use only.

u16 SoBkgCreditScroll::m_LineNum
 

current index into m_Lines[]

For internal use only.

const SoBkgCreditLine* SoBkgCreditScroll::m_Lines
 

data to be scrolled

For internal use only.

u16 SoBkgCreditScroll::m_Mode
 

operation mode

For internal use only.

u16 SoBkgCreditScroll::m_ScrollPos
 

current vertical scroll position (in pixels)

For internal use only.

u16 SoBkgCreditScroll::m_UpdSpeed
 

number of ticks per update

For internal use only.

The documentation for this struct was generated from the following file:
Copyright 2002 by the SGADE authors. See SoLicense.h or Visit the SGADE page for more information.