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  

SoImage

For all image handling. More...

Files

file  SoImage.c
file  SoImage.h

Data Structures

struct  SoImage
 Texture structure. More...


Defines

#define SoImageGetWidth(a_This)
 Returns the width of the image (texture).

#define SoImageGetHeight(a_This)
 Returns the height of the image (texture).

#define SoImageGetData(a_This)
 Returns the actual texture data (graphics bytes).

#define SoImageIsPalettized(a_This)
 Tests whether an image is palettized or not (returns true if palettized).

#define SoImageInitialize(a_This, a_Width, a_Height, a_Palettized, a_Data)
 Creates an image from given attributes.


Functions

void SoImageBkgLoad (const SoImage *a_This, u32 a_CharBase, u32 a_BaseIdx)
 Loads image data into background VRAM.


Detailed Description

For all image handling.

This module represents 8bit palettized and 16bit images

You can use the SoConverter.exe tool to convert image data to Socrates compatible header files, ready to be included in the project.


Function Documentation

void SoImageBkgLoad const SoImage   a_This,
u32    a_CharBase,
u32    a_BaseIdx
 

Loads image data into background VRAM.

Parameters:
a_This  this pointer
a_CharBase  charbase bank (0-3)
a_BaseIdx  index value of first tile to copy from SoImage


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