1. Home
  2. Documentation
  3. API
  4. FrameBlendBgmapSprite Class Reference

FrameBlendBgmapSprite Class Reference

#include <FrameBlendBgmapSprite.h>

Inheritance diagram for FrameBlendBgmapSprite:
BgmapSprite

# Public Types

typedef const FrameBlendBgmapSpriteSpec FrameBlendBgmapSpriteROMSpec

# Public Member Functions

void constructor (Entity owner, const FrameBlendBgmapSpriteSpec *frameBlendBgmapSpriteSpec)
override int16 doRender (int16 index)

# Private Attributes

uint8 actualFrame
 The frame to show during the game cycle.
- Private Attributes inherited from BgmapSprite
int16 paramTableRow
 Offset that keeps track of where to continue writing in param table.
uint32 param
ParamTableEffectMethod applyParamTableEffect
 Pointer to function that implements the param table based effects.
BgmapTextureSource bgmapTextureSource
 Texture's configuration in BGMAP space.

# Additional Inherited Members

- Private Types inherited from BgmapSprite
typedef const BgmapSpriteSpec BgmapSpriteROMSpec
- Private Member Functions inherited from BgmapSprite
void constructor (Entity owner, const BgmapSpriteSpec *bgmapSpriteSpec)
override bool onEvent (ListenerObject eventFirer, uint16 eventCode)
override ClassPointer getBasicType ()
override void loadTexture (ClassPointer textureClass, bool listenForRewriting)
override bool hasSpecialEffects ()
override void processEffects (int32 maximumParamTableRowsToComputePerCall)
override void setMultiframe (uint16 frame)
override void setRotation (const Rotation *rotation)
override void setScale (const PixelScale *scale)
override int32 getTotalPixels ()
void configureTexture ()
 Configure the sprite's texture.
void setMode (uint16 display, uint16 mode)
void setParam (uint32 param)
uint32 getParam ()
int16 getParamTableRow ()
void invalidateParamTable ()
 Force the rewrite of the sprite's param table during the next rendering cycle.
bool onTextureRewritten (ListenerObject eventFirer)
void applyAffineTransformations ()
 Start rewriting the sprite's param table for affine transformations.
void applyHbiasEffects ()
 Start rewriting the sprite's param table for hbias effects.

# Detailed Description

Class FrameBlendBgmapSprite

Inherits from BgmapSprite

Blends two frames of animation into a single one to achieve hi color images with a single sprite.

Definition at line 45 of file FrameBlendBgmapSprite.h.

# Member Typedef Documentation

# FrameBlendBgmapSpriteROMSpec

typedef const FrameBlendBgmapSpriteSpec FrameBlendBgmapSpriteROMSpec

A FrameBlendBgmapSprite spec that is stored in ROM.

Definition at line 34 of file FrameBlendBgmapSprite.h.

# Member Function Documentation

# constructor()

void FrameBlendBgmapSprite::constructor ( Entity owner,
const FrameBlendBgmapSpriteSpec * frameBlendBgmapSpriteSpec )

Class' constructor

Parameters
ownerEntity to which the sprite attaches to
frameBlendBgmapSpriteSpecSpecification that determines how to configure the sprite

Definition at line 28 of file FrameBlendBgmapSprite.c.

# doRender()

int16 FrameBlendBgmapSprite::doRender ( int16 index)
virtual

Render the sprite by configuring the DRAM assigned to it by means of the provided index.

Parameters
indexDetermines the region of DRAM that this sprite is allowed to configure
Returns
The index that determines the region of DRAM that this sprite manages

Reimplemented from BgmapSprite.

Definition at line 48 of file FrameBlendBgmapSprite.c.

# Member Data Documentation

# actualFrame

uint8 FrameBlendBgmapSprite::actualFrame
private

The frame to show during the game cycle.

Definition at line 48 of file FrameBlendBgmapSprite.h.


The documentation for this class was generated from the following files: