SFBSprite

Wrapper Class for the ISprite interface.

#include <SFBSprite.h.hpp>

class SFBSprite : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBSprite)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API ISprite

Member

Public Functions
`SFCError`	DrawSprites( `AEESpriteCmd*` cmds ) Cause the sprites in the Cmds array to be drawn.
`SFCError`	DrawTiles( `AEETileMap*` maps ) Cause the tile maps in the Maps array to be drawn.
static `SFBSpriteSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSprite instance.
static `SFBSpriteSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSprite instance.
`SFCError`	ResetDestination( `Void` ) Reset the destination bitmap of the sprite.
`SFCError`	ResetSpriteBuffer( `Void` ) Reset the current sprite buffer.
`SFCError`	ResetTileBuffer( `Void` ) Reset the current title buffer.
`SFCError`	SetDestination( `SFBBitmapSmpConstRef` bmpDest ) Tell the sprite engine where to render sprites and tiles.
`SFCError`	SetSpriteBuffer( `UInt08` size , `SFBBitmapSmpConstRef` bmpBuf ) Tell the sprite engine where to find sprite images for a particular size of sprite.
`SFCError`	SetTileBuffer( `UInt08` size , `SFBBitmapSmpConstRef` bmpBuf ) Tell the sprite engine where to find tile images for a particular size of tile.
`SFCError`	SetTransformTable( `AEETransformMatrix*` transform ) Tell the sprite engine where to lookup transformations for sprites with the SPRITE_MATRIX_TRANSFORM attribute set.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBSprite::DrawSprites

Cause the sprites in the Cmds array to be drawn.

[ public ]
SFCError DrawSprites(
    AEESpriteCmd* cmds   // array of sprite commands
);

Reference

BREW API ISPRITE_DrawSprites | SFBSprite::SetDestination | SFBSprite::SetTransformTable | AEESpriteCmd

SFBSprite::DrawTiles

Cause the tile maps in the Maps array to be drawn.

[ public ]
SFCError DrawTiles(
    AEETileMap* maps   // array of tile maps
);

Reference

BREW API ISPRITE_DrawTiles | SFBSprite::SetDestination | AEETileMap

SFBSprite::NewInstance

Create a new SFBSprite instance.

[ public, static ]
SFBSpriteSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBSpriteSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBSprite::ResetDestination

Reset the destination bitmap of the sprite.

[ public ]
SFCError ResetDestination(Void);

Description

Calling this function is as same as calling SFBSprite::SetDestination( null )

Reference

SFBSprite::SetDestination

SFBSprite::ResetSpriteBuffer

Reset the current sprite buffer.

[ public ]
SFCError ResetSpriteBuffer(Void);

Description

Calling this function is as same as calling SFBSprite::SetSpriteBuffer( 0 , null )

Reference

SFBSprite::SetSpriteBuffer

SFBSprite::ResetTileBuffer

Reset the current title buffer.

[ public ]
SFCError ResetTileBuffer(Void);

Description

Calling this function is as same as calling SFBSprite::SetTileBuffer( 0 , null )

Reference

SFBSprite::SetTileBuffer

SFBSprite::SetDestination

Tell the sprite engine where to render sprites and tiles.

[ public ]
SFCError SetDestination(
    SFBBitmapSmpConstRef bmpDest   // bitmap to be used for destination in drawing operations
);

Reference

BREW API ISPRITE_SetDestination | SFBSprite::DrawSprites | SFBSprite::DrawTiles

SFBSprite::SetSpriteBuffer

Tell the sprite engine where to find sprite images for a particular size of sprite.

[ public ]
SFCError SetSpriteBuffer(
    UInt08 size                   // size of sprites in buffer.
                                  // corresponds to unSpriteSize field of AEESpriteCmd
    SFBBitmapSmpConstRef bmpBuf   // bitmap to be used for sprite buffer
);

Reference

BREW API ISPRITE_SetSpriteBuffer | SFBSprite::SetTileBuffer | SFBSprite::DrawSprites | AEESpriteCmd

SFBSprite::SetTileBuffer

Tell the sprite engine where to find tile images for a particular size of tile.

[ public ]
SFCError SetTileBuffer(
    UInt08 size                   // size of tiles in buffer.
                                  // corresponds to unTileSize field of AEETileMap
    SFBBitmapSmpConstRef bmpBuf   // bitmap to be used for tile buffer
);

Reference

BREW API ISPRITE_SetTransformTable | SFBSprite::SetSpriteBuffer | SFBSprite::SetSpriteBuffer | AEETileMap

SFBSprite::SetTransformTable

Tell the sprite engine where to lookup transformations for sprites with the SPRITE_MATRIX_TRANSFORM attribute set.

[ public ]
SFCError SetTransformTable(
    AEETransformMatrix* transform   // array of AEETransformMatrix structures
);

Reference

BREW API ISPRITE_SetTransformTable | SFBSprite::DrawSprites | AEESpriteCmd