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

BgmapTexture Class Reference

#include <BgmapTexture.h>

Inheritance diagram for BgmapTexture:
Texture

# Public Types

typedef const TextureSpec BgmapTextureSpec
typedef const BgmapTextureSpec BgmapTextureROMSpec

# Public Member Functions

void constructor (const BgmapTextureSpec *bgmapTextureSpec, uint16 id)
override bool write (int16 maximumTextureRowsToWrite)
override void rewrite ()
 Rewrite graphical data to the allocated BGMAP space.
void setSegment (int8 segment)
int8 getSegment ()
void setOffsets (int16 xOffset, int16 yOffset)
int16 getXOffset ()
int16 getYOffset ()
void setHorizontalFlip (bool value)
void setVerticalFlip (bool value)
int8 getRemainingRowsToBeWritten ()

# Protected Attributes

int8 segment
 BGMAP segment where the graphical data is allocated.
int8 remainingRowsToBeWritten
 Remaining rows to be written to graphical memory.
int16 xOffset
 X coordinate in tiles of the graphical data inside BGMAP memory.
int16 yOffset
 Y coordinate in tiles of the graphical data inside BGMAP memory.
bool horizontalFlip
 Flag to flip horizontally the texture.
bool verticalFlip
 Flag to flip vertically the texture.

# Additional Inherited Members

- Private Types inherited from Texture
enum  TextureStatus
typedef const TextureSpec TextureROMSpec
- Private Member Functions inherited from Texture
void constructor (const TextureSpec *textureSpec, uint16 id)
override bool onEvent (ListenerObject eventFirer, uint16 eventCode)
uint16 getId ()
void setSpec (TextureSpec *textureSpec)
const TextureSpec * getSpec ()
CharSet getCharSet (uint32 loadIfNeeded)
void increaseUsageCount ()
 Increase the usage count.
bool decreaseUsageCount ()
 Decrease the usage count.
int8 getUsageCount ()
void setPalette (uint8 palette)
uint8 getPalette ()
uint32 getNumberOfFrames ()
void setFrame (uint16 frame)
uint16 getFrame ()
uint32 getCols ()
uint32 getRows ()
bool isWritten ()
bool isShared ()
bool isAnimated ()
bool isSingleFrame ()
bool isMultiframe ()
void addChar (const Point *texturePoint, const uint32 *newChar)
void putChar (const Point *texturePoint, const uint32 *newChar)
void putPixel (const Point *texturePixel, const Pixel *charSetPixel, BYTE newPixelColor)
void prepare ()
bool update (int16 maximumTextureRowsToWrite)

# Detailed Description

Class BgmapTexture

Inherits from Texture

A texture allocated in BGMAP memory.

Definition at line 50 of file BgmapTexture.h.

# Member Typedef Documentation

# BgmapTextureROMSpec

typedef const BgmapTextureSpec BgmapTextureROMSpec

A BgmapTexture spec that is stored in ROM

Definition at line 39 of file BgmapTexture.h.

# BgmapTextureSpec

typedef const TextureSpec BgmapTextureSpec

A BgmapTexture spec

Definition at line 35 of file BgmapTexture.h.

# Member Function Documentation

# constructor()

void BgmapTexture::constructor ( const BgmapTextureSpec * bgmapTextureSpec,
uint16 id )

Class' constructor

Parameters
bgmapTextureSpecSpecification that determines how to configure the texture
idTexture's identificator

Definition at line 34 of file BgmapTexture.c.

# getRemainingRowsToBeWritten()

int8 BgmapTexture::getRemainingRowsToBeWritten ( )

Retrieve the number of remaining rows to be written to graphical memory.

Returns
Number of remaining rows to be written to graphical memory

Definition at line 191 of file BgmapTexture.c.

# getSegment()

int8 BgmapTexture::getSegment ( )

Retriev the BGMAP segment where the graphical data is allocated.

Returns
BGMAP segment where the graphical data is allocated

Definition at line 124 of file BgmapTexture.c.

# getXOffset()

int16 BgmapTexture::getXOffset ( )

Retrieve the X coordinate in tiles of the graphical data inside BGMAP memory.

Returns
X coordinate in tiles of the graphical data inside BGMAP memory

Definition at line 139 of file BgmapTexture.c.

# getYOffset()

int16 BgmapTexture::getYOffset ( )

Retrieve the Y coordinate in tiles of the graphical data inside BGMAP memory.

Returns
Y coordinate in tiles of the graphical data inside BGMAP memory

Definition at line 146 of file BgmapTexture.c.

# rewrite()

void BgmapTexture::rewrite ( )
virtual

Rewrite graphical data to the allocated BGMAP space.

Reimplemented from Texture.

Definition at line 108 of file BgmapTexture.c.

# setHorizontalFlip()

void BgmapTexture::setHorizontalFlip ( bool value)

Set the horizontal flip flag.

Parameters
valueIf true, the texture is flipped horizontally

Definition at line 153 of file BgmapTexture.c.

# setOffsets()

void BgmapTexture::setOffsets ( int16 xOffset,
int16 yOffset )

Set the coordinates in tiles of the graphical data inside BGMAP memory BGMAP segment where the graphical data is allocated.

Parameters
xOffsetX coordinate in tiles of the graphical data inside BGMAP memory
yOffsetY coordinate in tiles of the graphical data inside BGMAP memory

Definition at line 131 of file BgmapTexture.c.

# setSegment()

void BgmapTexture::setSegment ( int8 segment)

Set the BGMAP segment where the graphical data is allocated.

Parameters
segmentBGMAP segment where the graphical data is allocated

Definition at line 117 of file BgmapTexture.c.

# setVerticalFlip()

void BgmapTexture::setVerticalFlip ( bool value)

Set the vertical flip flag.

Parameters
valueIf true, the texture is flipped vertically

Definition at line 172 of file BgmapTexture.c.

# write()

bool BgmapTexture::write ( int16 maximumTextureRowsToWrite)
virtual

Write graphical data to the allocated BGMAP space.

Parameters
maximumTextureRowsToWriteNumber of texture rows to write during this call
Returns
True if the texture was written; false if it fails

Reimplemented from Texture.

Definition at line 59 of file BgmapTexture.c.

# Member Data Documentation

# horizontalFlip

bool BgmapTexture::horizontalFlip
protected

Flag to flip horizontally the texture.

Definition at line 67 of file BgmapTexture.h.

# remainingRowsToBeWritten

int8 BgmapTexture::remainingRowsToBeWritten
protected

Remaining rows to be written to graphical memory.

Definition at line 58 of file BgmapTexture.h.

# segment

int8 BgmapTexture::segment
protected

BGMAP segment where the graphical data is allocated.

Definition at line 55 of file BgmapTexture.h.

# verticalFlip

bool BgmapTexture::verticalFlip
protected

Flag to flip vertically the texture.

Definition at line 70 of file BgmapTexture.h.

# xOffset

int16 BgmapTexture::xOffset
protected

X coordinate in tiles of the graphical data inside BGMAP memory.

Definition at line 61 of file BgmapTexture.h.

# yOffset

int16 BgmapTexture::yOffset
protected

Y coordinate in tiles of the graphical data inside BGMAP memory.

Definition at line 64 of file BgmapTexture.h.


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