UISprite Class Reference

Renders multiple rectangles at the same time. More...

Inheritance diagram for UISprite:
UIElement

List of all members.

Public Member Functions

 UISprite (int maxUnitCount)
 Constructor.
UISpriteUnit GetUnit (int index)
 Obtains the rectangle.

Protected Member Functions

override void DisposeSelf ()
 Frees the unmanaged resources being used with this UISprite.
internal override void Render ()
 Renders a rectangle.

Properties

int UnitCount [get, set]
 Obtains and sets the number of rectangles to display.
int MaxUnitCount [get, set]
 Obtains the maximum number of rectangles.

Detailed Description

Renders multiple rectangles at the same time.

Class used most often to create UI


Constructor & Destructor Documentation

UISprite ( int  maxUnitCount)

Constructor.

Parameters:
maxUnitCountMaximum number of rectangles (1 to )

maxUnitCount is clamped to a value of 1 or more.


Member Function Documentation

UISpriteUnit GetUnit ( int  index)

Obtains the rectangle.

Parameters:
indexIndex of rectangle to be obtained
Returns:
Rectangle

Property Documentation

int UnitCount [get, set]

Obtains and sets the number of rectangles to display.

Exceptions:
ArgumentOutOfRangeExceptionA negative value or a value greater than MaxUnitount is set.