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

PrintingSprite Class Reference

#include <PrintingSprite.h>

Inheritance diagram for PrintingSprite:
BgmapSprite

# Public Types

typedef const PrintingSpriteSpec PrintingSpriteROMSpec

# Public Member Functions

void constructor (Entity owner, const PrintingSpriteSpec *printingSpriteSpec)
override int16 doRender (int16 index)
void reset ()
 Reset the sprite's rendering configuration.
void setPrintingBgmapSegment (int8 printingBgmapSegment)
void setGValues (int16 gx, int16 gy, int16 gp)
void setMValues (int16 mx, int16 my, int16 mp)
void setSize (uint16 width, uint16 height)

# Private Attributes

int8 printingBgmapSegment
 BGMAP segment used for printing.
- 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 BgmapTexture

Inherits from Texture

Enables the Printer class to output text to the screen.

Definition at line 45 of file PrintingSprite.h.

# Member Typedef Documentation

# PrintingSpriteROMSpec

typedef const PrintingSpriteSpec PrintingSpriteROMSpec

A PrintingSprite spec that is stored in ROM

Definition at line 34 of file PrintingSprite.h.

# Member Function Documentation

# constructor()

void PrintingSprite::constructor ( Entity owner,
const PrintingSpriteSpec * printingSpriteSpec )

Definition at line 28 of file PrintingSprite.c.

# doRender()

int16 PrintingSprite::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 51 of file PrintingSprite.c.

# reset()

void PrintingSprite::reset ( )

Reset the sprite's rendering configuration.

Definition at line 70 of file PrintingSprite.c.

# setGValues()

void PrintingSprite::setGValues ( int16 gx,
int16 gy,
int16 gp )

Set the G values to be written to the WORLD's entry mananged by the sprite.

Parameters
gxGX coordinate of the WORLD used to display the text
gyGY coordinate of the WORLD used to display the text
gpGP coordinate of the WORLD used to display the text

Definition at line 100 of file PrintingSprite.c.

# setMValues()

void PrintingSprite::setMValues ( int16 mx,
int16 my,
int16 mp )

Set the M values to be written to the WORLD's entry mananged by the sprite.

Parameters
mxMX coordinate of BGMAP area to be used to display the text
myMY coordinate of BGMAP area to be used to display the text
mpMP coordinate of BGMAP area to be used to display the text

Definition at line 111 of file PrintingSprite.c.

# setPrintingBgmapSegment()

void PrintingSprite::setPrintingBgmapSegment ( int8 printingBgmapSegment)

Set the BGMAP segment used for printing.

Parameters
printingBgmapSegmentBGMAP segment to use for printing

Definition at line 88 of file PrintingSprite.c.

# setSize()

void PrintingSprite::setSize ( uint16 width,
uint16 height )

Set the size of the WORLD to by used to display the text

Parameters
widthWidth of the WORLD to by used to display the text
heightHeight of the WORLD to by used to display the text

Definition at line 120 of file PrintingSprite.c.

# Member Data Documentation

# printingBgmapSegment

int8 PrintingSprite::printingBgmapSegment
private

BGMAP segment used for printing.

Definition at line 48 of file PrintingSprite.h.


The documentation for this class was generated from the following files:
  • VUEngine-Core/source/Component/VisualComponent/Sprite/BgmapSprite/PrintingSprite/PrintingSprite.h
  • VUEngine-Core/source/Component/VisualComponent/Sprite/BgmapSprite/PrintingSprite/PrintingSprite.c