Public API Reference

               

---

csAnimatedPixmap Class Reference

a pixmap with a 2d animation. More...

#include <csanim2d.h>

Inheritance diagram for csAnimatedPixmap:

List of all members.

Public Methods
	csAnimatedPixmap (csAnimationTemplate *tpl)
	create an animated pixmap. More...
virtual	~csAnimatedPixmap ()
	destroy this object. More...
virtual int	Width ()
	return current width of this pixmap. More...
virtual int	Height ()
	return current height of this pixmap. More...
virtual iTextureHandle *	GetTextureHandle ()
	return current texture handle. More...
virtual void	DrawScaled (iGraphics3D *g3d, int sx, int sy, int sw, int sh, uint8 Alpha=0)
	Draw the pixmap given the screen position and new size. More...
virtual void	DrawTiled (iGraphics3D *g3d, int sx, int sy, int sw, int sh, int orgx, int orgy, uint8 Alpha=0)
	Draw the pixmap tiled over an area. More...
virtual void	Advance (csTicks ElapsedTime)
	advance in time. More...

---

Detailed Description

a pixmap with a 2d animation.

Definition at line 77 of file csanim2d.h.

---

Constructor & Destructor Documentation

csAnimatedPixmap::csAnimatedPixmap (  csAnimationTemplate *    tpl )

create an animated pixmap.

virtual csAnimatedPixmap::~csAnimatedPixmap (    )  [virtual]

destroy this object.

---

Member Function Documentation

virtual void csAnimatedPixmap::Advance (  csTicks    ElapsedTime )  [virtual]

advance in time. Implements csPixmap.

virtual void csAnimatedPixmap::DrawScaled (  iGraphics3D *    g3d, int    sx, int    sy, int    sw, int    sh, uint8    Alpha = 0 )  [virtual]

Draw the pixmap given the screen position and new size. Implements csPixmap.

virtual void csAnimatedPixmap::DrawTiled (  iGraphics3D *    g3d, int    sx, int    sy, int    sw, int    sh, int    orgx, int    orgy, uint8    Alpha = 0 )  [virtual]

Draw the pixmap tiled over an area. multiple draw commands with the same texture and same origin values will align properly. The orgx and orgy point to a pixel (perhaps offscreen) where the (0,0) pixel of this pixmap would be drawn. Implements csPixmap.

virtual iTextureHandle* csAnimatedPixmap::GetTextureHandle (    )  [virtual]

return current texture handle. Implements csPixmap.

virtual int csAnimatedPixmap::Height (    )  [virtual]

return current height of this pixmap. Implements csPixmap.

virtual int csAnimatedPixmap::Width (    )  [virtual]

return current width of this pixmap. Implements csPixmap.

---

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

• csanim2d.h

---