v1.1.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Modules Pages
Public Member Functions | List of all members
Sifteo::SpriteLayer Struct Reference

A SpriteLayer represents the VRAM attributes for the sprite rendering layer in BG0_SPR_BG1 mode. More...

#include <sifteo/video/sprite.h>

Public Member Functions

CubeID cube () const
 Return the CubeID associated with this drawable.
 
void erase ()
 Reset all sprites to their default hidden state.
 
SpriteRef operator[] (unsigned id)
 Return a SpriteRef which references a single sprite on a single VideoBuffer. More...
 
_SYSVideoBuffer & videoBuffer ()
 Return the VideoBuffer associated with this drawable.
 

Detailed Description

A SpriteLayer represents the VRAM attributes for the sprite rendering layer in BG0_SPR_BG1 mode.

Normally, you'll access SpriteLayer as the 'sprite' member in a VideoBuffer.

This class acts as a container for sprites. Individual sprites can be accessed using the indexing operator [].

Member Function Documentation

SpriteRef Sifteo::SpriteLayer::operator[] ( unsigned  id)
inline

Return a SpriteRef which references a single sprite on a single VideoBuffer.

You don't need to store this reference typically; for example:

vbuf.sprites[2].setImage(MyAsset);

The documentation for this struct was generated from the following file: