star/rendering/XSprite.idl

47 /** Interface to control a sprite object.<p>
49     This is the basic interface to control a sprite object on a
55     /** Set overall transparency of the sprite.<p>
59         Please note that if this sprite is not animated, the
65         New global alpha value to composite this sprite with the
76     /** Move sprite to the specified position.<p>
81         coordinates) of the rendered sprite content.<p>
83         Please note that if this sprite is not animated, the
89         The new position, in user coordinate space, to move the sprite to.
106     /** Apply a local transformation to the sprite.<p>
108         The given transformation matrix locally transforms the sprite
110         components, be aware that sprite content moved beyond the
111         sprite area (a box from (0,0) to (spriteWidth,spriteHeight))
113         <member>XSprite::move</member> to change the sprite location
115         cached representation of the sprite at hand, to transform only
117         re-rendering the sprite from first principles. This is usually
122         Please note that if this sprite is not animated, the
128         The transformation to apply to the sprite shape.
141         coordinate space. As the sprite has its own local coordinate
144         with the sprite's origin. Furthermore, if any sprite
147         has a cached representation of the sprite at hand, to
149         instead of re-rendering the sprite from first principles. This
154         Please note that if this sprite is not animated, the
160         i.e. everything contained in the sprite will be visible
165         clip. That means, nothing from the sprite will be visible.<p>
174     /** Set sprite priority.<p>
176         The sprite priority determines the order of rendering relative
178         priority, the later will the sprite be rendered, or, in other
179         words, the closer to the screen surface the sprite is shown.<p>
182         New sprite priority value to serve as the sort key when
183         determining sprite rendering order. Avoid NaNs and other
191     /** Make the sprite visible.<p>
193         This method makes the sprite visible on the canvas it was
200     /** Make the sprite invisible.<p>
202         This method makes the sprite invisible.<p>