IGL2DSprites Class Reference

Set of GL2D sprites, based on same texture. More...

#include <gl2d_sprites_interface.h>

Inherits ISDKProperties.

Public Member Functions
virtual void SDK_CALLTYPE	Dump () const =0 throw ()
	Dumps given object.
virtual IGL2DCanvasSP SDK_CALLTYPE	GetParent () const =0 throw ()
	Returns parent canvas object.
virtual GL2DSpritesType SDK_CALLTYPE	GetType () const =0 throw ()
	Returns sprites type.
virtual IGL2DTextureSP SDK_CALLTYPE	GetTexture () const =0 throw ()
	Returns appropriate sprites host texture.
virtual SDKUInt32 SDK_CALLTYPE	GetMemSize () const =0 throw ()
	Returns OpenGL memory size used for sprites (not including texture memory size) Statistics only - value refreshed after FinishEdit call.
virtual SDKUInt32 SDK_CALLTYPE	GetSpritePositionsCount () const =0 throw ()
	Returns total number of sprites positions in given sprite object Statistics only - value refreshed after FinishEdit call.
virtual SDKUInt32 SDK_CALLTYPE	GetSpritesCount () const =0 throw ()
	Returns total number of sprites in collection.
virtual IGL2DSpriteSP SDK_CALLTYPE	GetSpriteByIndex (const SDKUInt32 &index) const =0 throw ()
	Returns sprite by it's index.
virtual IGL2DSpriteSP SDK_CALLTYPE	GetSpriteByID (const SDKString &id) const =0 throw ()
	Returns sprite by it's ID.
virtual SDKResult SDK_CALLTYPE	StartEdit ()=0 throw ()
	Starts sprite collection edit process, call for this method in case you want to change anything in given collection, after all of changes were applied, call for FinishEdit method - this will initiate internal GL buffers regeneration and only after that updated sprites can be displayed.
virtual SDKResult SDK_CALLTYPE	FinishEdit ()=0 throw ()
	Finishes previously started edit sprites collection operation.
virtual bool SDK_CALLTYPE	IsEditing () const =0 throw ()
	Checks, if sprites collection edit operation in progress now.
virtual IGL2DSpriteSP SDK_CALLTYPE	AddSprite (const SDKString &id, const SDKRect2D &texture_rect, const SDKPointF2D &pivot_point)=0 throw ()
	Adds new sprite to sprites collection id - Sprite ID, if sprite with given ID already exist - it will be replaced If empty ID specified - ID will be auto-generated texture_rect - Texture fragment rectangle to use as a sprite image pivot_point - Describes given sprite pivot point (0, 0) coordinate - left/bottom corner of texture rect StartEdit method should be called before calling this one.
virtual SDKResult SDK_CALLTYPE	RemoveSprite (const SDKString &id)=0 throw ()
	Removes sprite from collection by it's ID StartEdit method should be called before calling this one.

Detailed Description

Set of GL2D sprites, based on same texture.

---

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

• gl2d_sprites_interface.h