SpriteCache Class Reference

#include <spritecache.h>

Collaboration diagram for SpriteCache:

[legend]List of all members.

Public Member Functions
	SpriteCache (Sprite &sprite)
void	EnableRotationCache (std::vector< SpriteFrame > &frames, unsigned int cache_size)
void	EnableFlippingCache (std::vector< SpriteFrame > &frames)
void	EnableLastFrameCache ()
void	DisableLastFrameCache ()
void	InvalidLastFrame ()
Public Attributes
bool	have_rotation_cache
unsigned int	rotation_cache_size
bool	have_flipping_cache
bool	have_lastframe_cache
Surface	last_frame
std::vector< SpriteFrameCache >	frames
Private Attributes
Sprite &	sprite

---

Detailed Description

Definition at line 50 of file spritecache.h.

---

Constructor & Destructor Documentation

SpriteCache::SpriteCache

(

Sprite &

sprite

)

[explicit]

Definition at line 89 of file spritecache.cpp.

                                         :
  sprite(p_sprite)
{
  have_rotation_cache = false;
  have_flipping_cache = false;
  have_lastframe_cache = false;
  rotation_cache_size = 0;
}

---

Member Function Documentation

void SpriteCache::DisableLastFrameCache

(

)

Definition at line 175 of file spritecache.cpp.

                                       {
  //The result of the last call to SDLgfx is kept in memory
  //to display it again if rotation / scale / alpha didn't changed
  assert(!have_rotation_cache);
  assert(!have_flipping_cache);
  have_lastframe_cache = false;
}

void SpriteCache::EnableFlippingCache

(

std::vector< SpriteFrame > &

frames

)

Definition at line 152 of file spritecache.cpp.

                                                                          {
  //For each frame, we pre-render the flipped frame
  assert(!have_flipping_cache);
  assert(!have_lastframe_cache);

  if (frames.empty())
    frames.resize( sprite_frames.size() );
  assert( frames.size() == sprite_frames.size() );

  have_flipping_cache = true;

  for ( unsigned int f = 0 ; f < frames.size() ; f++)
    frames[f].CreateFlippingCache(sprite_frames[f].surface);
}

Here is the caller graph for this function:

void SpriteCache::EnableLastFrameCache

(

)

Definition at line 167 of file spritecache.cpp.

                                      {
  //The result of the last call to SDLgfx is kept in memory
  //to display it again if rotation / scale / alpha didn't changed
  assert(!have_rotation_cache);
  assert(!have_flipping_cache);
  have_lastframe_cache = true;
}

Here is the caller graph for this function:

void SpriteCache::EnableRotationCache	(	std::vector< SpriteFrame > &	frames,
		unsigned int	cache_size
	)

Definition at line 132 of file spritecache.cpp.

                                                                                                   {
  //For each frame, we pre-render 'cache_size' rotated surface
  //At runtime the prerender Surface with the nearest angle to what is asked is displayed
  assert(1 < cache_size and cache_size <= 360);
  assert(!have_lastframe_cache);
  assert(!have_flipping_cache); //Always compute rotation cache before flipping cache!
  assert(!have_rotation_cache);
  have_rotation_cache = true;

  if (frames.empty())
    frames.resize( sprite_frames.size() );
  assert( frames.size() == sprite_frames.size() );
  rotation_cache_size = cache_size;

  for ( unsigned int f = 0 ; f < frames.size() ; f++)
  {
    frames[f].CreateRotationCache(sprite_frames[f].surface, cache_size);
  }
}

Here is the caller graph for this function:

void SpriteCache::InvalidLastFrame

(

)

Definition at line 183 of file spritecache.cpp.

                                  {
  //Free lastframe_cache if the next frame to be displayed
  //is not the same as the last one.
  if(!have_lastframe_cache)
    return;
  last_frame.Free();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

std::vector<SpriteFrameCache> SpriteCache::frames

Definition at line 61 of file spritecache.h.

bool SpriteCache::have_flipping_cache

Definition at line 58 of file spritecache.h.

bool SpriteCache::have_lastframe_cache

Definition at line 59 of file spritecache.h.

bool SpriteCache::have_rotation_cache

Definition at line 56 of file spritecache.h.

Surface SpriteCache::last_frame

Definition at line 60 of file spritecache.h.

unsigned int SpriteCache::rotation_cache_size

Definition at line 57 of file spritecache.h.

Sprite& SpriteCache::sprite [private]

Definition at line 52 of file spritecache.h.

---

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

• src/graphic/spritecache.h
• src/graphic/spritecache.cpp

---