---

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.

---

             

---

SoBkg.h

Go to the documentation of this file.

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

#ifndef SO_BKG_H
#define SO_BKG_H

#ifdef __cplusplus
    extern "C" {
#endif

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

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

#include "SoSystem.h"
#include "SoBkgMap.h"
#include "SoBkgFont.h"
#include "SoVector.h"

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

#define SO_BKG_MAX_NUM_BACKGROUNDS  4

#define SO_BKG_NONE 0xffff

// Background option bits
#define SO_BKG_PRIORITY_0         0x0000        
#define SO_BKG_PRIORITY_1         0x0001        
#define SO_BKG_PRIORITY_2         0x0002        
#define SO_BKG_PRIORITY_3         0x0003        

#define SO_BKG_CHARBASE(n)        (((n)&0x3)<<2)    

#define SO_BKG_MOSAIC_DISABLE     0x0000        
#define SO_BKG_MOSAIC_ENABLE      0x0040        

#define SO_BKG_CLRMODE_MASK       0x0080        
#define SO_BKG_CLRMODE_16         0x0000        
#define SO_BKG_CLRMODE_256        0x0080        

#define SO_BKG_SCRBASE_MASK       0x1f00        
#define SO_BKG_SCRBASE(n)         (((n)&0x1f)<<8)   

#define SO_BKG_SIZE_MASK          0xc000        
#define SO_BKG_TEXTSIZE_256x256   0x0000        
#define SO_BKG_TEXTSIZE_512x256   0x4000        
#define SO_BKG_TEXTSIZE_256x512   0x8000        
#define SO_BKG_TEXTSIZE_512x512   0xc000        

#define SO_BKG_ROTSIZE_128x128    0x0000        
#define SO_BKG_ROTSIZE_256x256    0x4000        
#define SO_BKG_ROTSIZE_512x512    0x8000        
#define SO_BKG_ROTSIZE 1024x1024  0xc000        

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

void SoBkgSetup(u32 a_Index, u32 a_Options);
void SoBkgEnable(u32 a_Index, bool a_Enable);

void SoBkgSetMosaicEnable( u32 a_Index, bool a_Enable );
void SoBkgSetPriority(u32 a_Index, u32 a_Priority);

bool SoBkgIsEnabled(u32 a_Index);
//bool SoBkgGetMosaicEnable(u32 a_Index);
//u32  SoBkgGetPriority(u32 a_Index);

void SoBkgSetOffset(u16 a_Index, u16 a_XPos, u16 a_YPos);

u16 *SoBkgGetData(u32 a_Index);

void SoBkgLoadSolidColorTile(u16 a_Index, u32 a_Tilenum, u16 a_ColorIndex);


// Direct mode functions
void SoBkgFill(u16 a_Index, u16 a_Data);
void SoBkgFillBlock(u16 a_index, u16 a_XIndex, u16 a_YIndex, u16 a_Width, u16 a_Height, u16 a_Data);
void SoBkgWrite(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Len, u16 *a_buffer);
void SoBkgWriteV(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Len, u16 *a_buffer);
void SoBkgWriteBlock(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Width, u16 a_Height, u16 a_Pitch,
                     u16 *a_buffer);
void SoBkgWriteBlock16Color(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Width, u16 a_Height, u16 a_Pitch, u16 a_PalIndex, u16 *a_buffer);

// Indirect mode functions (dynamically loaded tiles)
void SoBkgClearIndirect(u16 a_Index);
void SoBkgWriteIndirect(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Len, u16 *a_buffer);
void SoBkgWriteVIndirect(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Len, u16 *a_buffer);
void SoBkgWriteBlockIndirect(u16 a_Index, u16 a_XIndex, u16 a_YIndex, u16 a_Width, u16 a_Height,
                             u16 a_Pitch, u16 *a_buffer);

// Printing functions
void SoBkgPrint(u16 a_Index, const char *a_String);
void SoBkgPrintf(u16 a_Index, const char *a_Format, ...);

#define SoBkgPrintAt(a_Index, a_X, a_Y, a_String) \
    (SoBkgSetTextCursor(a_Index, a_X, a_Y), SoBkgPrint(a_Index, a_String))

void SoBkgSetTextWindow(u16 a_Index, u16 a_UpperLeftX, u16 a_UpperLeftY, u16 a_LowerRightX, u16 a_LowerRightY);
void SoBkgSetTextWrapping(u16 a_Index, bool a_DoWrapping);

void SoBkgSetTextCursor(u16 a_Index, u16 a_X, u16 a_Y);
const SoVector2* SoBkgGetTextCursor(u16 a_Index);
void SoBkgSetFont(u16 a_Index, const SoBkgFont *a_Font);
const SoBkgFont *SoBkgGetFont(u16 a_Index);


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


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

#endif // SO_BKG_H

---

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

---