[Overview][Constants][Types][Procedures and functions][Variables][Index] Reference for unit 'agraphics' (#aros)

GetExtSpriteA

Attempt to get a sprite for the extended sprite manager.

Declaration

Source position: agraphics.pas line 2201

function GetExtSpriteA(

  Sprite: PExtSprite;

  Tags: PTagItem

):LongInt;

Arguments

Sprite

  

A Pointer to programmer's ExtSprite (from AllocSpriteData()).

Tags

  

Tags GSTAG_*

Function result

a sprite number or -1 for an error. This call will fail if no sprites could be allocated, or if you try to allocate a sprite which would require a mode change when there are other sprites of incompatible modes in use.

Description

Attempt to allocate one of the eight sprites for private use with the extended sprite manager.

a standard tag list:

GSTAG_SPRITE_NUM
specifies a specific sprite to get by number.
GSTAG_ATTACHED
specifies that you wish to get a sprite pair. the tag data field points to a ExtSprite structure for the second sprite. You must free both sprites.

See also

FreeSprite

  

Return sprite for use by others and virtual sprite machine.

ChangeSprite

  

Change the sprite image pointer.

MoveSprite

  

Move sprite to a point relative to top of viewport.

GetSprite

  

Attempt to get a sprite for the simple sprite manager.


Documentation generated on: 2017-01-10