---

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.

---

             

---

SoBkgCreditScroll.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------

#ifndef SO_BKG_CREDIT_SCROLL_H
#define SO_BKG_CREDIT_SCROLL_H

#ifdef __cplusplus
    extern "C" {
#endif

// ---------------------------------------------------------------------------- //! @{
// ----------------------------------------------------------------------------

// ----------------------------------------------------------------------------
// Includes
// ----------------------------------------------------------------------------

#include "SoSystem.h"
#include "SoBkg.h"
#include "SoDisplay.h"
#include "SoTileMap.h"

// ----------------------------------------------------------------------------
// Defines
// ----------------------------------------------------------------------------

#define SO_CREDIT_CODE_TEXT         0x0000  

#define SO_CREDIT_CODE_SPACE        0x0001  
#define SO_CREDIT_CODE_SPEED        0x0002  
#define SO_CREDIT_CODE_PAUSE        0x0003  
#define SO_CREDIT_CODE_FONT         0x0004  

#define SO_CREDIT_CODE_ALIGNLEFT    0x4000  
#define SO_CREDIT_CODE_ALIGNRIGHT   0x8000  
#define SO_CREDIT_CODE_ALIGNCENTER  0xc000  


//#define SO_BKG_CREDIT_MODE_RAW      0x0000  //!< flag - raw mode display
//#define SO_BKG_CREDIT_MODE_DYNAMIC  0x0001  //!< flag - dynamic mode display


// ----------------------------------------------------------------------------
// Typedefs
// ----------------------------------------------------------------------------

typedef struct {
    u32         m_Code; 
    const char *m_Data; 
} SoBkgCreditLine;

typedef struct
{
    u16        m_Mode;          
    u16        m_Bkg;           
    u16        m_ScrollPos;     
    u16        m_UpdSpeed;      
    u16        m_FrameCnt;      
    u16        m_LineCnt;       
    u16        m_LineNum;       
    u16        m_LineArg;       
    const SoBkgCreditLine *m_Lines; 
} SoBkgCreditScroll;


// ----------------------------------------------------------------------------
// Public methods;
// ----------------------------------------------------------------------------

//#define SoBkgCreditScrollIsDynamic(a_This)      ((a_This)->m_Mode & SO_BKG_CREDIT_MODE_DYNAMIC)

#define SoBkgCreditScrollGetBackground(a_This)  ((const u16)((a_This)->m_Bkg))

void SoBkgCreditScrollInit(SoBkgCreditScroll *a_This, u16 a_Bkg, u16 a_LineCnt, const SoBkgCreditLine *a_Lines);
bool SoBkgCreditScrollUpdate(SoBkgCreditScroll *a_This);
bool SoBkgCreditScrollDone(SoBkgCreditScroll *a_This);

// ----------------------------------------------------------------------------
// EOF
// ----------------------------------------------------------------------------


#ifdef __cplusplus
} // extern "C"
#endif

#endif // SO_BKG_CREDIT_SCROLL_H

---

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

---