The SGADE Documentation

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

SoSprite.h File Reference

#include "SoSystem.h"
#include "SoSpriteAnimation.h"
#include "SoDisplay.h"

Go to the source code of this file.

Data Structures

struct SoSprite

Structure representing a single sprite. More...

Functions

void SoSpriteDisable (SoSprite *a_This)

Disables rendering of this sprite.

void SoSpriteFlipHorizontal (SoSprite *a_This)

Flips the sprite horizontally.

void SoSpriteFlipVertical (SoSprite *a_This)

Flips the sprite vertically.

u32 SoSpriteGetWidth (SoSprite *a_This)

Returns the width of the sprite.

u32 SoSpriteGetHeight (SoSprite *a_This)

Returns the height of the sprite.

void SoSpriteSetTranslate (SoSprite *a_This, s32 a_X, s32 a_Y)

Sets the screen position of the top left corner of the sprite.

void SoSpriteSetMosaicEnable (SoSprite *a_This, bool a_Enable)

Enabs the mosaic for this sprite.

void SoSpriteSetSizeDoubleEnable (SoSprite *a_This, bool a_Enable)

Enables double size for the sprite.

void SoSpriteSetRotationAndScaleEnable (SoSprite *a_This, bool a_Enable)

Enables sprite rotation and scaling.

void SoSpriteSetRotationAndScaleIndex (SoSprite *a_This, u32 a_Index)

Sets the index used for sprite scale and rotation settings.

void SoSpriteSet256ColorMode (SoSprite *a_This, bool a_Enable)

Sets the sprite to 256 color palette mode instead of 16 color palettes.

void SoSpriteSetAnimationIndex (SoSprite *a_This, u32 a_Index)

Sets the animation (character-data) this sprite should use.

u32 SoSpriteGetAnimationIndex (SoSprite *a_This)

Returns the animation index the sprite is using.

void SoSpriteSetSize (SoSprite *a_This, u32 a_Width, u32 a_Height)

Sets the size of the sprite.

void SoSpriteSetPriority (SoSprite *a_This, u32 a_Priority)

changes the display priority for a particular sprite

void SoSpriteCopyPropertiesFromAnimation (SoSprite *a_This, const SoSpriteAnimation *a_Animation)

Copies the size and color attributes from a certain animation.

void SoSpriteSet16ColorPaletteIndex (SoSprite *a_This, u16 a_Index)

set the sprite to use one of the 16 palettes available in 16 color mode

Detailed Description

Author:: Jaap Suter

Date:: Jun 27 2001

See the SoSprite module for more information.


Data Structures
struct	SoSprite
	Structure representing a single sprite. More...
Functions
void	SoSpriteDisable (SoSprite *a_This)
	Disables rendering of this sprite.
void	SoSpriteFlipHorizontal (SoSprite *a_This)
	Flips the sprite horizontally.
void	SoSpriteFlipVertical (SoSprite *a_This)
	Flips the sprite vertically.
u32	SoSpriteGetWidth (SoSprite *a_This)
	Returns the width of the sprite.
u32	SoSpriteGetHeight (SoSprite *a_This)
	Returns the height of the sprite.
void	SoSpriteSetTranslate (SoSprite *a_This, s32 a_X, s32 a_Y)
	Sets the screen position of the top left corner of the sprite.
void	SoSpriteSetMosaicEnable (SoSprite *a_This, bool a_Enable)
	Enabs the mosaic for this sprite.
void	SoSpriteSetSizeDoubleEnable (SoSprite *a_This, bool a_Enable)
	Enables double size for the sprite.
void	SoSpriteSetRotationAndScaleEnable (SoSprite *a_This, bool a_Enable)
	Enables sprite rotation and scaling.
void	SoSpriteSetRotationAndScaleIndex (SoSprite *a_This, u32 a_Index)
	Sets the index used for sprite scale and rotation settings.
void	SoSpriteSet256ColorMode (SoSprite *a_This, bool a_Enable)
	Sets the sprite to 256 color palette mode instead of 16 color palettes.
void	SoSpriteSetAnimationIndex (SoSprite *a_This, u32 a_Index)
	Sets the animation (character-data) this sprite should use.
u32	SoSpriteGetAnimationIndex (SoSprite *a_This)
	Returns the animation index the sprite is using.
void	SoSpriteSetSize (SoSprite *a_This, u32 a_Width, u32 a_Height)
	Sets the size of the sprite.
void	SoSpriteSetPriority (SoSprite *a_This, u32 a_Priority)
	changes the display priority for a particular sprite
void	SoSpriteCopyPropertiesFromAnimation (SoSprite a_This, const SoSpriteAnimation a_Animation)
	Copies the size and color attributes from a certain animation.
void	SoSpriteSet16ColorPaletteIndex (SoSprite *a_This, u16 a_Index)
	set the sprite to use one of the 16 palettes available in 16 color mode